2 * Copyright (c) 2009-2010, 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.4"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 4
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_STRING 0
122 /* Objects encoding. Some kind of objects like Strings and Hashes can be
123 * internally represented in multiple ways. The 'encoding' field of the object
124 * is set to one of this fields for this object. */
125 #define REDIS_ENCODING_RAW 0 /* Raw representation */
126 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
127 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
128 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
130 static char* strencoding
[] = {
131 "raw", "int", "zipmap", "hashtable"
134 /* Object types only used for dumping to disk */
135 #define REDIS_EXPIRETIME 253
136 #define REDIS_SELECTDB 254
137 #define REDIS_EOF 255
139 /* Defines related to the dump file format. To store 32 bits lengths for short
140 * keys requires a lot of space, so we check the most significant 2 bits of
141 * the first byte to interpreter the length:
143 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
144 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
145 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
146 * 11|000000 this means: specially encoded object will follow. The six bits
147 * number specify the kind of object that follows.
148 * See the REDIS_RDB_ENC_* defines.
150 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
151 * values, will fit inside. */
152 #define REDIS_RDB_6BITLEN 0
153 #define REDIS_RDB_14BITLEN 1
154 #define REDIS_RDB_32BITLEN 2
155 #define REDIS_RDB_ENCVAL 3
156 #define REDIS_RDB_LENERR UINT_MAX
158 /* When a length of a string object stored on disk has the first two bits
159 * set, the remaining two bits specify a special encoding for the object
160 * accordingly to the following defines: */
161 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
162 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
163 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
164 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
166 /* Virtual memory object->where field. */
167 #define REDIS_VM_MEMORY 0 /* The object is on memory */
168 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
169 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
170 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
172 /* Virtual memory static configuration stuff.
173 * Check vmFindContiguousPages() to know more about this magic numbers. */
174 #define REDIS_VM_MAX_NEAR_PAGES 65536
175 #define REDIS_VM_MAX_RANDOM_JUMP 4096
176 #define REDIS_VM_MAX_THREADS 32
177 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
178 /* The following is the *percentage* of completed I/O jobs to process when the
179 * handelr is called. While Virtual Memory I/O operations are performed by
180 * threads, this operations must be processed by the main thread when completed
181 * in order to take effect. */
182 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
185 #define REDIS_SLAVE 1 /* This client is a slave server */
186 #define REDIS_MASTER 2 /* This client is a master server */
187 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
188 #define REDIS_MULTI 8 /* This client is in a MULTI context */
189 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
190 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
192 /* Slave replication state - slave side */
193 #define REDIS_REPL_NONE 0 /* No active replication */
194 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
195 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
197 /* Slave replication state - from the point of view of master
198 * Note that in SEND_BULK and ONLINE state the slave receives new updates
199 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
200 * to start the next background saving in order to send updates to it. */
201 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
202 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
203 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
204 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
206 /* List related stuff */
210 /* Sort operations */
211 #define REDIS_SORT_GET 0
212 #define REDIS_SORT_ASC 1
213 #define REDIS_SORT_DESC 2
214 #define REDIS_SORTKEY_MAX 1024
217 #define REDIS_DEBUG 0
218 #define REDIS_VERBOSE 1
219 #define REDIS_NOTICE 2
220 #define REDIS_WARNING 3
222 /* Anti-warning macro... */
223 #define REDIS_NOTUSED(V) ((void) V)
225 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
226 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
228 /* Append only defines */
229 #define APPENDFSYNC_NO 0
230 #define APPENDFSYNC_ALWAYS 1
231 #define APPENDFSYNC_EVERYSEC 2
233 /* Hashes related defaults */
234 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
235 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
237 /* We can print the stacktrace, so our assert is defined this way: */
238 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
239 static void _redisAssert(char *estr
, char *file
, int line
);
241 /*================================= Data types ============================== */
243 /* A redis object, that is a type able to hold a string / list / set */
245 /* The VM object structure */
246 struct redisObjectVM
{
247 off_t page
; /* the page at witch the object is stored on disk */
248 off_t usedpages
; /* number of pages used on disk */
249 time_t atime
; /* Last access time */
252 /* The actual Redis Object */
253 typedef struct redisObject
{
256 unsigned char encoding
;
257 unsigned char storage
; /* If this object is a key, where is the value?
258 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
259 unsigned char vtype
; /* If this object is a key, and value is swapped out,
260 * this is the type of the swapped out object. */
262 /* VM fields, this are only allocated if VM is active, otherwise the
263 * object allocation function will just allocate
264 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
265 * Redis without VM active will not have any overhead. */
266 struct redisObjectVM vm
;
269 /* Macro used to initalize a Redis object allocated on the stack.
270 * Note that this macro is taken near the structure definition to make sure
271 * we'll update it when the structure is changed, to avoid bugs like
272 * bug #85 introduced exactly in this way. */
273 #define initStaticStringObject(_var,_ptr) do { \
275 _var.type = REDIS_STRING; \
276 _var.encoding = REDIS_ENCODING_RAW; \
278 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
281 typedef struct redisDb
{
282 dict
*dict
; /* The keyspace for this DB */
283 dict
*expires
; /* Timeout of keys with a timeout set */
284 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
285 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
289 /* Client MULTI/EXEC state */
290 typedef struct multiCmd
{
293 struct redisCommand
*cmd
;
296 typedef struct multiState
{
297 multiCmd
*commands
; /* Array of MULTI commands */
298 int count
; /* Total number of MULTI commands */
301 /* With multiplexing we need to take per-clinet state.
302 * Clients are taken in a liked list. */
303 typedef struct redisClient
{
308 robj
**argv
, **mbargv
;
310 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
311 int multibulk
; /* multi bulk command format active */
314 time_t lastinteraction
; /* time of the last interaction, used for timeout */
315 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
316 int slaveseldb
; /* slave selected db, if this client is a slave */
317 int authenticated
; /* when requirepass is non-NULL */
318 int replstate
; /* replication state if this is a slave */
319 int repldbfd
; /* replication DB file descriptor */
320 long repldboff
; /* replication DB file offset */
321 off_t repldbsize
; /* replication DB file size */
322 multiState mstate
; /* MULTI/EXEC state */
323 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
324 * operation such as BLPOP. Otherwise NULL. */
325 int blockingkeysnum
; /* Number of blocking keys */
326 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
327 * is >= blockingto then the operation timed out. */
328 list
*io_keys
; /* Keys this client is waiting to be loaded from the
329 * swap file in order to continue. */
337 /* Global server state structure */
342 dict
*sharingpool
; /* Poll used for object sharing */
343 unsigned int sharingpoolsize
;
344 long long dirty
; /* changes to DB from the last save */
346 list
*slaves
, *monitors
;
347 char neterr
[ANET_ERR_LEN
];
349 int cronloops
; /* number of times the cron function run */
350 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
351 time_t lastsave
; /* Unix time of last save succeeede */
352 /* Fields used only for stats */
353 time_t stat_starttime
; /* server start time */
354 long long stat_numcommands
; /* number of processed commands */
355 long long stat_numconnections
; /* number of connections received */
368 pid_t bgsavechildpid
;
369 pid_t bgrewritechildpid
;
370 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
371 struct saveparam
*saveparams
;
376 char *appendfilename
;
380 /* Replication related */
385 redisClient
*master
; /* client that is master for this slave */
387 unsigned int maxclients
;
388 unsigned long long maxmemory
;
389 unsigned int blpop_blocked_clients
;
390 unsigned int vm_blocked_clients
;
391 /* Sort parameters - qsort_r() is only available under BSD so we
392 * have to take this state global, in order to pass it to sortCompare() */
396 /* Virtual memory configuration */
401 unsigned long long vm_max_memory
;
403 size_t hash_max_zipmap_entries
;
404 size_t hash_max_zipmap_value
;
405 /* Virtual memory state */
408 off_t vm_next_page
; /* Next probably empty page */
409 off_t vm_near_pages
; /* Number of pages allocated sequentially */
410 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
411 time_t unixtime
; /* Unix time sampled every second. */
412 /* Virtual memory I/O threads stuff */
413 /* An I/O thread process an element taken from the io_jobs queue and
414 * put the result of the operation in the io_done list. While the
415 * job is being processed, it's put on io_processing queue. */
416 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
417 list
*io_processing
; /* List of VM I/O jobs being processed */
418 list
*io_processed
; /* List of VM I/O jobs already processed */
419 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
420 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
421 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
422 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
423 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
424 int io_active_threads
; /* Number of running I/O threads */
425 int vm_max_threads
; /* Max number of I/O threads running at the same time */
426 /* Our main thread is blocked on the event loop, locking for sockets ready
427 * to be read or written, so when a threaded I/O operation is ready to be
428 * processed by the main thread, the I/O thread will use a unix pipe to
429 * awake the main thread. The followings are the two pipe FDs. */
430 int io_ready_pipe_read
;
431 int io_ready_pipe_write
;
432 /* Virtual memory stats */
433 unsigned long long vm_stats_used_pages
;
434 unsigned long long vm_stats_swapped_objects
;
435 unsigned long long vm_stats_swapouts
;
436 unsigned long long vm_stats_swapins
;
440 typedef void redisCommandProc(redisClient
*c
);
441 struct redisCommand
{
443 redisCommandProc
*proc
;
446 /* What keys should be loaded in background when calling this command? */
447 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
448 int vm_lastkey
; /* THe last argument that's a key */
449 int vm_keystep
; /* The step between first and last key */
452 struct redisFunctionSym
{
454 unsigned long pointer
;
457 typedef struct _redisSortObject
{
465 typedef struct _redisSortOperation
{
468 } redisSortOperation
;
470 /* ZSETs use a specialized version of Skiplists */
472 typedef struct zskiplistNode
{
473 struct zskiplistNode
**forward
;
474 struct zskiplistNode
*backward
;
480 typedef struct zskiplist
{
481 struct zskiplistNode
*header
, *tail
;
482 unsigned long length
;
486 typedef struct zset
{
491 /* Our shared "common" objects */
493 struct sharedObjectsStruct
{
494 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
495 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
496 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
497 *outofrangeerr
, *plus
,
498 *select0
, *select1
, *select2
, *select3
, *select4
,
499 *select5
, *select6
, *select7
, *select8
, *select9
;
502 /* Global vars that are actally used as constants. The following double
503 * values are used for double on-disk serialization, and are initialized
504 * at runtime to avoid strange compiler optimizations. */
506 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
508 /* VM threaded I/O request message */
509 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
510 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
511 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
512 typedef struct iojob
{
513 int type
; /* Request type, REDIS_IOJOB_* */
514 redisDb
*db
;/* Redis database */
515 robj
*key
; /* This I/O request is about swapping this key */
516 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
517 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
518 off_t page
; /* Swap page where to read/write the object */
519 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
520 int canceled
; /* True if this command was canceled by blocking side of VM */
521 pthread_t thread
; /* ID of the thread processing this entry */
524 /*================================ Prototypes =============================== */
526 static void freeStringObject(robj
*o
);
527 static void freeListObject(robj
*o
);
528 static void freeSetObject(robj
*o
);
529 static void decrRefCount(void *o
);
530 static robj
*createObject(int type
, void *ptr
);
531 static void freeClient(redisClient
*c
);
532 static int rdbLoad(char *filename
);
533 static void addReply(redisClient
*c
, robj
*obj
);
534 static void addReplySds(redisClient
*c
, sds s
);
535 static void incrRefCount(robj
*o
);
536 static int rdbSaveBackground(char *filename
);
537 static robj
*createStringObject(char *ptr
, size_t len
);
538 static robj
*dupStringObject(robj
*o
);
539 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
540 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
541 static int syncWithMaster(void);
542 static robj
*tryObjectSharing(robj
*o
);
543 static int tryObjectEncoding(robj
*o
);
544 static robj
*getDecodedObject(robj
*o
);
545 static int removeExpire(redisDb
*db
, robj
*key
);
546 static int expireIfNeeded(redisDb
*db
, robj
*key
);
547 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
548 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
549 static int deleteKey(redisDb
*db
, robj
*key
);
550 static time_t getExpire(redisDb
*db
, robj
*key
);
551 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
552 static void updateSlavesWaitingBgsave(int bgsaveerr
);
553 static void freeMemoryIfNeeded(void);
554 static int processCommand(redisClient
*c
);
555 static void setupSigSegvAction(void);
556 static void rdbRemoveTempFile(pid_t childpid
);
557 static void aofRemoveTempFile(pid_t childpid
);
558 static size_t stringObjectLen(robj
*o
);
559 static void processInputBuffer(redisClient
*c
);
560 static zskiplist
*zslCreate(void);
561 static void zslFree(zskiplist
*zsl
);
562 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
563 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
564 static void initClientMultiState(redisClient
*c
);
565 static void freeClientMultiState(redisClient
*c
);
566 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
567 static void unblockClientWaitingData(redisClient
*c
);
568 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
569 static void vmInit(void);
570 static void vmMarkPagesFree(off_t page
, off_t count
);
571 static robj
*vmLoadObject(robj
*key
);
572 static robj
*vmPreviewObject(robj
*key
);
573 static int vmSwapOneObjectBlocking(void);
574 static int vmSwapOneObjectThreaded(void);
575 static int vmCanSwapOut(void);
576 static int tryFreeOneObjectFromFreelist(void);
577 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
578 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
579 static void vmCancelThreadedIOJob(robj
*o
);
580 static void lockThreadedIO(void);
581 static void unlockThreadedIO(void);
582 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
583 static void freeIOJob(iojob
*j
);
584 static void queueIOJob(iojob
*j
);
585 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
586 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
587 static void waitEmptyIOJobsQueue(void);
588 static void vmReopenSwapFile(void);
589 static int vmFreePage(off_t page
);
590 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
591 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
592 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
593 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
594 static struct redisCommand
*lookupCommand(char *name
);
595 static void call(redisClient
*c
, struct redisCommand
*cmd
);
596 static void resetClient(redisClient
*c
);
597 static void convertToRealHash(robj
*o
);
599 static void authCommand(redisClient
*c
);
600 static void pingCommand(redisClient
*c
);
601 static void echoCommand(redisClient
*c
);
602 static void setCommand(redisClient
*c
);
603 static void setnxCommand(redisClient
*c
);
604 static void getCommand(redisClient
*c
);
605 static void delCommand(redisClient
*c
);
606 static void existsCommand(redisClient
*c
);
607 static void incrCommand(redisClient
*c
);
608 static void decrCommand(redisClient
*c
);
609 static void incrbyCommand(redisClient
*c
);
610 static void decrbyCommand(redisClient
*c
);
611 static void selectCommand(redisClient
*c
);
612 static void randomkeyCommand(redisClient
*c
);
613 static void keysCommand(redisClient
*c
);
614 static void dbsizeCommand(redisClient
*c
);
615 static void lastsaveCommand(redisClient
*c
);
616 static void saveCommand(redisClient
*c
);
617 static void bgsaveCommand(redisClient
*c
);
618 static void bgrewriteaofCommand(redisClient
*c
);
619 static void shutdownCommand(redisClient
*c
);
620 static void moveCommand(redisClient
*c
);
621 static void renameCommand(redisClient
*c
);
622 static void renamenxCommand(redisClient
*c
);
623 static void lpushCommand(redisClient
*c
);
624 static void rpushCommand(redisClient
*c
);
625 static void lpopCommand(redisClient
*c
);
626 static void rpopCommand(redisClient
*c
);
627 static void llenCommand(redisClient
*c
);
628 static void lindexCommand(redisClient
*c
);
629 static void lrangeCommand(redisClient
*c
);
630 static void ltrimCommand(redisClient
*c
);
631 static void typeCommand(redisClient
*c
);
632 static void lsetCommand(redisClient
*c
);
633 static void saddCommand(redisClient
*c
);
634 static void sremCommand(redisClient
*c
);
635 static void smoveCommand(redisClient
*c
);
636 static void sismemberCommand(redisClient
*c
);
637 static void scardCommand(redisClient
*c
);
638 static void spopCommand(redisClient
*c
);
639 static void srandmemberCommand(redisClient
*c
);
640 static void sinterCommand(redisClient
*c
);
641 static void sinterstoreCommand(redisClient
*c
);
642 static void sunionCommand(redisClient
*c
);
643 static void sunionstoreCommand(redisClient
*c
);
644 static void sdiffCommand(redisClient
*c
);
645 static void sdiffstoreCommand(redisClient
*c
);
646 static void syncCommand(redisClient
*c
);
647 static void flushdbCommand(redisClient
*c
);
648 static void flushallCommand(redisClient
*c
);
649 static void sortCommand(redisClient
*c
);
650 static void lremCommand(redisClient
*c
);
651 static void rpoplpushcommand(redisClient
*c
);
652 static void infoCommand(redisClient
*c
);
653 static void mgetCommand(redisClient
*c
);
654 static void monitorCommand(redisClient
*c
);
655 static void expireCommand(redisClient
*c
);
656 static void expireatCommand(redisClient
*c
);
657 static void getsetCommand(redisClient
*c
);
658 static void ttlCommand(redisClient
*c
);
659 static void slaveofCommand(redisClient
*c
);
660 static void debugCommand(redisClient
*c
);
661 static void msetCommand(redisClient
*c
);
662 static void msetnxCommand(redisClient
*c
);
663 static void zaddCommand(redisClient
*c
);
664 static void zincrbyCommand(redisClient
*c
);
665 static void zrangeCommand(redisClient
*c
);
666 static void zrangebyscoreCommand(redisClient
*c
);
667 static void zcountCommand(redisClient
*c
);
668 static void zrevrangeCommand(redisClient
*c
);
669 static void zcardCommand(redisClient
*c
);
670 static void zremCommand(redisClient
*c
);
671 static void zscoreCommand(redisClient
*c
);
672 static void zremrangebyscoreCommand(redisClient
*c
);
673 static void multiCommand(redisClient
*c
);
674 static void execCommand(redisClient
*c
);
675 static void discardCommand(redisClient
*c
);
676 static void blpopCommand(redisClient
*c
);
677 static void brpopCommand(redisClient
*c
);
678 static void appendCommand(redisClient
*c
);
679 static void substrCommand(redisClient
*c
);
680 static void zrankCommand(redisClient
*c
);
681 static void zrevrankCommand(redisClient
*c
);
682 static void hsetCommand(redisClient
*c
);
683 static void hgetCommand(redisClient
*c
);
684 static void hdelCommand(redisClient
*c
);
685 static void hlenCommand(redisClient
*c
);
686 static void zremrangebyrankCommand(redisClient
*c
);
687 static void zunionCommand(redisClient
*c
);
688 static void zinterCommand(redisClient
*c
);
689 static void hkeysCommand(redisClient
*c
);
690 static void hvalsCommand(redisClient
*c
);
691 static void hgetallCommand(redisClient
*c
);
693 /*================================= Globals ================================= */
696 static struct redisServer server
; /* server global state */
697 static struct redisCommand cmdTable
[] = {
698 {"get",getCommand
,2,REDIS_CMD_INLINE
,1,1,1},
699 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
700 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
701 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
702 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,1,1,1},
703 {"del",delCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
704 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
705 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
706 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
707 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,1,-1,1},
708 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
709 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
710 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
711 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
712 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
713 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
714 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
715 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,1,1,1},
716 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
717 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,1,1,1},
718 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,1,1,1},
719 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,1,1,1},
720 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,2,1},
721 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
722 {"srem",sremCommand
,3,REDIS_CMD_BULK
,1,1,1},
723 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,1,2,1},
724 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,1,1,1},
725 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
726 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
727 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,1,1,1},
728 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
729 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
730 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
731 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
732 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
733 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
734 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,1,1,1},
735 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
736 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
737 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,1,1,1},
738 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,1,1,1},
739 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,1,1,1},
740 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,0,0,0},
741 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,0,0,0},
742 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
743 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
744 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,1,1,1},
745 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
746 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
747 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
748 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,1,1,1},
749 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,1,1,1},
750 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
751 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,1,1,1},
752 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,1,1,1},
753 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
754 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,1,1,1},
755 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
756 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,1,1,1},
757 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
758 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
759 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
760 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
761 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
762 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,0,0,0},
763 {"select",selectCommand
,2,REDIS_CMD_INLINE
,0,0,0},
764 {"move",moveCommand
,3,REDIS_CMD_INLINE
,1,1,1},
765 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,1,1,1},
766 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,1,1,1},
767 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,0,0,0},
768 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,0,0,0},
769 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,0,0,0},
770 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,0,0,0},
771 {"auth",authCommand
,2,REDIS_CMD_INLINE
,0,0,0},
772 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,0,0,0},
773 {"echo",echoCommand
,2,REDIS_CMD_BULK
,0,0,0},
774 {"save",saveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
775 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
776 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,0,0,0},
777 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,0,0,0},
778 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
779 {"type",typeCommand
,2,REDIS_CMD_INLINE
,1,1,1},
780 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,0,0,0},
781 {"exec",execCommand
,1,REDIS_CMD_INLINE
,0,0,0},
782 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,0,0,0},
783 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,0,0,0},
784 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,0,0,0},
785 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,0,0,0},
786 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
787 {"info",infoCommand
,1,REDIS_CMD_INLINE
,0,0,0},
788 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,0,0,0},
789 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,1,1,1},
790 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,0,0,0},
791 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
792 {NULL
,NULL
,0,0,0,0,0}
795 /*============================ Utility functions ============================ */
797 /* Glob-style pattern matching. */
798 int stringmatchlen(const char *pattern
, int patternLen
,
799 const char *string
, int stringLen
, int nocase
)
804 while (pattern
[1] == '*') {
809 return 1; /* match */
811 if (stringmatchlen(pattern
+1, patternLen
-1,
812 string
, stringLen
, nocase
))
813 return 1; /* match */
817 return 0; /* no match */
821 return 0; /* no match */
831 not = pattern
[0] == '^';
838 if (pattern
[0] == '\\') {
841 if (pattern
[0] == string
[0])
843 } else if (pattern
[0] == ']') {
845 } else if (patternLen
== 0) {
849 } else if (pattern
[1] == '-' && patternLen
>= 3) {
850 int start
= pattern
[0];
851 int end
= pattern
[2];
859 start
= tolower(start
);
865 if (c
>= start
&& c
<= end
)
869 if (pattern
[0] == string
[0])
872 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
882 return 0; /* no match */
888 if (patternLen
>= 2) {
895 if (pattern
[0] != string
[0])
896 return 0; /* no match */
898 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
899 return 0; /* no match */
907 if (stringLen
== 0) {
908 while(*pattern
== '*') {
915 if (patternLen
== 0 && stringLen
== 0)
920 static void redisLog(int level
, const char *fmt
, ...) {
924 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
928 if (level
>= server
.verbosity
) {
934 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
935 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
936 vfprintf(fp
, fmt
, ap
);
942 if (server
.logfile
) fclose(fp
);
945 /*====================== Hash table type implementation ==================== */
947 /* This is an hash table type that uses the SDS dynamic strings libary as
948 * keys and radis objects as values (objects can hold SDS strings,
951 static void dictVanillaFree(void *privdata
, void *val
)
953 DICT_NOTUSED(privdata
);
957 static void dictListDestructor(void *privdata
, void *val
)
959 DICT_NOTUSED(privdata
);
960 listRelease((list
*)val
);
963 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
967 DICT_NOTUSED(privdata
);
969 l1
= sdslen((sds
)key1
);
970 l2
= sdslen((sds
)key2
);
971 if (l1
!= l2
) return 0;
972 return memcmp(key1
, key2
, l1
) == 0;
975 static void dictRedisObjectDestructor(void *privdata
, void *val
)
977 DICT_NOTUSED(privdata
);
979 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
983 static int dictObjKeyCompare(void *privdata
, const void *key1
,
986 const robj
*o1
= key1
, *o2
= key2
;
987 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
990 static unsigned int dictObjHash(const void *key
) {
992 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
995 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
998 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1001 o1
= getDecodedObject(o1
);
1002 o2
= getDecodedObject(o2
);
1003 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1009 static unsigned int dictEncObjHash(const void *key
) {
1010 robj
*o
= (robj
*) key
;
1012 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1013 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1015 if (o
->encoding
== REDIS_ENCODING_INT
) {
1019 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1020 return dictGenHashFunction((unsigned char*)buf
, len
);
1024 o
= getDecodedObject(o
);
1025 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1032 /* Sets type and expires */
1033 static dictType setDictType
= {
1034 dictEncObjHash
, /* hash function */
1037 dictEncObjKeyCompare
, /* key compare */
1038 dictRedisObjectDestructor
, /* key destructor */
1039 NULL
/* val destructor */
1042 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1043 static dictType zsetDictType
= {
1044 dictEncObjHash
, /* hash function */
1047 dictEncObjKeyCompare
, /* key compare */
1048 dictRedisObjectDestructor
, /* key destructor */
1049 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1053 static dictType dbDictType
= {
1054 dictObjHash
, /* hash function */
1057 dictObjKeyCompare
, /* key compare */
1058 dictRedisObjectDestructor
, /* key destructor */
1059 dictRedisObjectDestructor
/* val destructor */
1063 static dictType keyptrDictType
= {
1064 dictObjHash
, /* hash function */
1067 dictObjKeyCompare
, /* key compare */
1068 dictRedisObjectDestructor
, /* key destructor */
1069 NULL
/* val destructor */
1072 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1073 static dictType hashDictType
= {
1074 dictEncObjHash
, /* hash function */
1077 dictEncObjKeyCompare
, /* key compare */
1078 dictRedisObjectDestructor
, /* key destructor */
1079 dictRedisObjectDestructor
/* val destructor */
1082 /* Keylist hash table type has unencoded redis objects as keys and
1083 * lists as values. It's used for blocking operations (BLPOP) and to
1084 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1085 static dictType keylistDictType
= {
1086 dictObjHash
, /* hash function */
1089 dictObjKeyCompare
, /* key compare */
1090 dictRedisObjectDestructor
, /* key destructor */
1091 dictListDestructor
/* val destructor */
1094 /* ========================= Random utility functions ======================= */
1096 /* Redis generally does not try to recover from out of memory conditions
1097 * when allocating objects or strings, it is not clear if it will be possible
1098 * to report this condition to the client since the networking layer itself
1099 * is based on heap allocation for send buffers, so we simply abort.
1100 * At least the code will be simpler to read... */
1101 static void oom(const char *msg
) {
1102 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1107 /* ====================== Redis server networking stuff ===================== */
1108 static void closeTimedoutClients(void) {
1111 time_t now
= time(NULL
);
1114 listRewind(server
.clients
,&li
);
1115 while ((ln
= listNext(&li
)) != NULL
) {
1116 c
= listNodeValue(ln
);
1117 if (server
.maxidletime
&&
1118 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1119 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1120 (now
- c
->lastinteraction
> server
.maxidletime
))
1122 redisLog(REDIS_VERBOSE
,"Closing idle client");
1124 } else if (c
->flags
& REDIS_BLOCKED
) {
1125 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1126 addReply(c
,shared
.nullmultibulk
);
1127 unblockClientWaitingData(c
);
1133 static int htNeedsResize(dict
*dict
) {
1134 long long size
, used
;
1136 size
= dictSlots(dict
);
1137 used
= dictSize(dict
);
1138 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1139 (used
*100/size
< REDIS_HT_MINFILL
));
1142 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1143 * we resize the hash table to save memory */
1144 static void tryResizeHashTables(void) {
1147 for (j
= 0; j
< server
.dbnum
; j
++) {
1148 if (htNeedsResize(server
.db
[j
].dict
)) {
1149 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1150 dictResize(server
.db
[j
].dict
);
1151 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1153 if (htNeedsResize(server
.db
[j
].expires
))
1154 dictResize(server
.db
[j
].expires
);
1158 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1159 void backgroundSaveDoneHandler(int statloc
) {
1160 int exitcode
= WEXITSTATUS(statloc
);
1161 int bysignal
= WIFSIGNALED(statloc
);
1163 if (!bysignal
&& exitcode
== 0) {
1164 redisLog(REDIS_NOTICE
,
1165 "Background saving terminated with success");
1167 server
.lastsave
= time(NULL
);
1168 } else if (!bysignal
&& exitcode
!= 0) {
1169 redisLog(REDIS_WARNING
, "Background saving error");
1171 redisLog(REDIS_WARNING
,
1172 "Background saving terminated by signal");
1173 rdbRemoveTempFile(server
.bgsavechildpid
);
1175 server
.bgsavechildpid
= -1;
1176 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1177 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1178 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1181 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1183 void backgroundRewriteDoneHandler(int statloc
) {
1184 int exitcode
= WEXITSTATUS(statloc
);
1185 int bysignal
= WIFSIGNALED(statloc
);
1187 if (!bysignal
&& exitcode
== 0) {
1191 redisLog(REDIS_NOTICE
,
1192 "Background append only file rewriting terminated with success");
1193 /* Now it's time to flush the differences accumulated by the parent */
1194 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1195 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1197 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1200 /* Flush our data... */
1201 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1202 (signed) sdslen(server
.bgrewritebuf
)) {
1203 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
));
1207 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1208 /* Now our work is to rename the temp file into the stable file. And
1209 * switch the file descriptor used by the server for append only. */
1210 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1211 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1215 /* Mission completed... almost */
1216 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1217 if (server
.appendfd
!= -1) {
1218 /* If append only is actually enabled... */
1219 close(server
.appendfd
);
1220 server
.appendfd
= fd
;
1222 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1223 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1225 /* If append only is disabled we just generate a dump in this
1226 * format. Why not? */
1229 } else if (!bysignal
&& exitcode
!= 0) {
1230 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1232 redisLog(REDIS_WARNING
,
1233 "Background append only file rewriting terminated by signal");
1236 sdsfree(server
.bgrewritebuf
);
1237 server
.bgrewritebuf
= sdsempty();
1238 aofRemoveTempFile(server
.bgrewritechildpid
);
1239 server
.bgrewritechildpid
= -1;
1242 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1243 int j
, loops
= server
.cronloops
++;
1244 REDIS_NOTUSED(eventLoop
);
1246 REDIS_NOTUSED(clientData
);
1248 /* We take a cached value of the unix time in the global state because
1249 * with virtual memory and aging there is to store the current time
1250 * in objects at every object access, and accuracy is not needed.
1251 * To access a global var is faster than calling time(NULL) */
1252 server
.unixtime
= time(NULL
);
1254 /* Show some info about non-empty databases */
1255 for (j
= 0; j
< server
.dbnum
; j
++) {
1256 long long size
, used
, vkeys
;
1258 size
= dictSlots(server
.db
[j
].dict
);
1259 used
= dictSize(server
.db
[j
].dict
);
1260 vkeys
= dictSize(server
.db
[j
].expires
);
1261 if (!(loops
% 5) && (used
|| vkeys
)) {
1262 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1263 /* dictPrintStats(server.dict); */
1267 /* We don't want to resize the hash tables while a bacground saving
1268 * is in progress: the saving child is created using fork() that is
1269 * implemented with a copy-on-write semantic in most modern systems, so
1270 * if we resize the HT while there is the saving child at work actually
1271 * a lot of memory movements in the parent will cause a lot of pages
1273 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1275 /* Show information about connected clients */
1277 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1278 listLength(server
.clients
)-listLength(server
.slaves
),
1279 listLength(server
.slaves
),
1280 zmalloc_used_memory(),
1281 dictSize(server
.sharingpool
));
1284 /* Close connections of timedout clients */
1285 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1286 closeTimedoutClients();
1288 /* Check if a background saving or AOF rewrite in progress terminated */
1289 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1293 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1294 if (pid
== server
.bgsavechildpid
) {
1295 backgroundSaveDoneHandler(statloc
);
1297 backgroundRewriteDoneHandler(statloc
);
1301 /* If there is not a background saving in progress check if
1302 * we have to save now */
1303 time_t now
= time(NULL
);
1304 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1305 struct saveparam
*sp
= server
.saveparams
+j
;
1307 if (server
.dirty
>= sp
->changes
&&
1308 now
-server
.lastsave
> sp
->seconds
) {
1309 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1310 sp
->changes
, sp
->seconds
);
1311 rdbSaveBackground(server
.dbfilename
);
1317 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1318 * will use few CPU cycles if there are few expiring keys, otherwise
1319 * it will get more aggressive to avoid that too much memory is used by
1320 * keys that can be removed from the keyspace. */
1321 for (j
= 0; j
< server
.dbnum
; j
++) {
1323 redisDb
*db
= server
.db
+j
;
1325 /* Continue to expire if at the end of the cycle more than 25%
1326 * of the keys were expired. */
1328 long num
= dictSize(db
->expires
);
1329 time_t now
= time(NULL
);
1332 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1333 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1338 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1339 t
= (time_t) dictGetEntryVal(de
);
1341 deleteKey(db
,dictGetEntryKey(de
));
1345 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1348 /* Swap a few keys on disk if we are over the memory limit and VM
1349 * is enbled. Try to free objects from the free list first. */
1350 if (vmCanSwapOut()) {
1351 while (server
.vm_enabled
&& zmalloc_used_memory() >
1352 server
.vm_max_memory
)
1356 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1357 retval
= (server
.vm_max_threads
== 0) ?
1358 vmSwapOneObjectBlocking() :
1359 vmSwapOneObjectThreaded();
1360 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1361 zmalloc_used_memory() >
1362 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1364 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1366 /* Note that when using threade I/O we free just one object,
1367 * because anyway when the I/O thread in charge to swap this
1368 * object out will finish, the handler of completed jobs
1369 * will try to swap more objects if we are still out of memory. */
1370 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1374 /* Check if we should connect to a MASTER */
1375 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1376 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1377 if (syncWithMaster() == REDIS_OK
) {
1378 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1384 /* This function gets called every time Redis is entering the
1385 * main loop of the event driven library, that is, before to sleep
1386 * for ready file descriptors. */
1387 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1388 REDIS_NOTUSED(eventLoop
);
1390 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1394 listRewind(server
.io_ready_clients
,&li
);
1395 while((ln
= listNext(&li
))) {
1396 redisClient
*c
= ln
->value
;
1397 struct redisCommand
*cmd
;
1399 /* Resume the client. */
1400 listDelNode(server
.io_ready_clients
,ln
);
1401 c
->flags
&= (~REDIS_IO_WAIT
);
1402 server
.vm_blocked_clients
--;
1403 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1404 readQueryFromClient
, c
);
1405 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1406 assert(cmd
!= NULL
);
1409 /* There may be more data to process in the input buffer. */
1410 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1411 processInputBuffer(c
);
1416 static void createSharedObjects(void) {
1417 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1418 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1419 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1420 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1421 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1422 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1423 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1424 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1425 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1426 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1427 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1428 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1429 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1430 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1431 "-ERR no such key\r\n"));
1432 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1433 "-ERR syntax error\r\n"));
1434 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1435 "-ERR source and destination objects are the same\r\n"));
1436 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1437 "-ERR index out of range\r\n"));
1438 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1439 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1440 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1441 shared
.select0
= createStringObject("select 0\r\n",10);
1442 shared
.select1
= createStringObject("select 1\r\n",10);
1443 shared
.select2
= createStringObject("select 2\r\n",10);
1444 shared
.select3
= createStringObject("select 3\r\n",10);
1445 shared
.select4
= createStringObject("select 4\r\n",10);
1446 shared
.select5
= createStringObject("select 5\r\n",10);
1447 shared
.select6
= createStringObject("select 6\r\n",10);
1448 shared
.select7
= createStringObject("select 7\r\n",10);
1449 shared
.select8
= createStringObject("select 8\r\n",10);
1450 shared
.select9
= createStringObject("select 9\r\n",10);
1453 static void appendServerSaveParams(time_t seconds
, int changes
) {
1454 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1455 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1456 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1457 server
.saveparamslen
++;
1460 static void resetServerSaveParams() {
1461 zfree(server
.saveparams
);
1462 server
.saveparams
= NULL
;
1463 server
.saveparamslen
= 0;
1466 static void initServerConfig() {
1467 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1468 server
.port
= REDIS_SERVERPORT
;
1469 server
.verbosity
= REDIS_VERBOSE
;
1470 server
.maxidletime
= REDIS_MAXIDLETIME
;
1471 server
.saveparams
= NULL
;
1472 server
.logfile
= NULL
; /* NULL = log on standard output */
1473 server
.bindaddr
= NULL
;
1474 server
.glueoutputbuf
= 1;
1475 server
.daemonize
= 0;
1476 server
.appendonly
= 0;
1477 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1478 server
.lastfsync
= time(NULL
);
1479 server
.appendfd
= -1;
1480 server
.appendseldb
= -1; /* Make sure the first time will not match */
1481 server
.pidfile
= "/var/run/redis.pid";
1482 server
.dbfilename
= "dump.rdb";
1483 server
.appendfilename
= "appendonly.aof";
1484 server
.requirepass
= NULL
;
1485 server
.shareobjects
= 0;
1486 server
.rdbcompression
= 1;
1487 server
.sharingpoolsize
= 1024;
1488 server
.maxclients
= 0;
1489 server
.blpop_blocked_clients
= 0;
1490 server
.maxmemory
= 0;
1491 server
.vm_enabled
= 0;
1492 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1493 server
.vm_page_size
= 256; /* 256 bytes per page */
1494 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1495 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1496 server
.vm_max_threads
= 4;
1497 server
.vm_blocked_clients
= 0;
1498 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1499 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1501 resetServerSaveParams();
1503 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1504 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1505 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1506 /* Replication related */
1508 server
.masterauth
= NULL
;
1509 server
.masterhost
= NULL
;
1510 server
.masterport
= 6379;
1511 server
.master
= NULL
;
1512 server
.replstate
= REDIS_REPL_NONE
;
1514 /* Double constants initialization */
1516 R_PosInf
= 1.0/R_Zero
;
1517 R_NegInf
= -1.0/R_Zero
;
1518 R_Nan
= R_Zero
/R_Zero
;
1521 static void initServer() {
1524 signal(SIGHUP
, SIG_IGN
);
1525 signal(SIGPIPE
, SIG_IGN
);
1526 setupSigSegvAction();
1528 server
.devnull
= fopen("/dev/null","w");
1529 if (server
.devnull
== NULL
) {
1530 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1533 server
.clients
= listCreate();
1534 server
.slaves
= listCreate();
1535 server
.monitors
= listCreate();
1536 server
.objfreelist
= listCreate();
1537 createSharedObjects();
1538 server
.el
= aeCreateEventLoop();
1539 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1540 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1541 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1542 if (server
.fd
== -1) {
1543 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1546 for (j
= 0; j
< server
.dbnum
; j
++) {
1547 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1548 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1549 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1550 if (server
.vm_enabled
)
1551 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1552 server
.db
[j
].id
= j
;
1554 server
.cronloops
= 0;
1555 server
.bgsavechildpid
= -1;
1556 server
.bgrewritechildpid
= -1;
1557 server
.bgrewritebuf
= sdsempty();
1558 server
.lastsave
= time(NULL
);
1560 server
.stat_numcommands
= 0;
1561 server
.stat_numconnections
= 0;
1562 server
.stat_starttime
= time(NULL
);
1563 server
.unixtime
= time(NULL
);
1564 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1565 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1566 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1568 if (server
.appendonly
) {
1569 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1570 if (server
.appendfd
== -1) {
1571 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1577 if (server
.vm_enabled
) vmInit();
1580 /* Empty the whole database */
1581 static long long emptyDb() {
1583 long long removed
= 0;
1585 for (j
= 0; j
< server
.dbnum
; j
++) {
1586 removed
+= dictSize(server
.db
[j
].dict
);
1587 dictEmpty(server
.db
[j
].dict
);
1588 dictEmpty(server
.db
[j
].expires
);
1593 static int yesnotoi(char *s
) {
1594 if (!strcasecmp(s
,"yes")) return 1;
1595 else if (!strcasecmp(s
,"no")) return 0;
1599 /* I agree, this is a very rudimental way to load a configuration...
1600 will improve later if the config gets more complex */
1601 static void loadServerConfig(char *filename
) {
1603 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1607 if (filename
[0] == '-' && filename
[1] == '\0')
1610 if ((fp
= fopen(filename
,"r")) == NULL
) {
1611 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1616 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1622 line
= sdstrim(line
," \t\r\n");
1624 /* Skip comments and blank lines*/
1625 if (line
[0] == '#' || line
[0] == '\0') {
1630 /* Split into arguments */
1631 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1632 sdstolower(argv
[0]);
1634 /* Execute config directives */
1635 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1636 server
.maxidletime
= atoi(argv
[1]);
1637 if (server
.maxidletime
< 0) {
1638 err
= "Invalid timeout value"; goto loaderr
;
1640 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1641 server
.port
= atoi(argv
[1]);
1642 if (server
.port
< 1 || server
.port
> 65535) {
1643 err
= "Invalid port"; goto loaderr
;
1645 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1646 server
.bindaddr
= zstrdup(argv
[1]);
1647 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1648 int seconds
= atoi(argv
[1]);
1649 int changes
= atoi(argv
[2]);
1650 if (seconds
< 1 || changes
< 0) {
1651 err
= "Invalid save parameters"; goto loaderr
;
1653 appendServerSaveParams(seconds
,changes
);
1654 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1655 if (chdir(argv
[1]) == -1) {
1656 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1657 argv
[1], strerror(errno
));
1660 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1661 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1662 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1663 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1664 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1666 err
= "Invalid log level. Must be one of debug, notice, warning";
1669 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1672 server
.logfile
= zstrdup(argv
[1]);
1673 if (!strcasecmp(server
.logfile
,"stdout")) {
1674 zfree(server
.logfile
);
1675 server
.logfile
= NULL
;
1677 if (server
.logfile
) {
1678 /* Test if we are able to open the file. The server will not
1679 * be able to abort just for this problem later... */
1680 logfp
= fopen(server
.logfile
,"a");
1681 if (logfp
== NULL
) {
1682 err
= sdscatprintf(sdsempty(),
1683 "Can't open the log file: %s", strerror(errno
));
1688 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1689 server
.dbnum
= atoi(argv
[1]);
1690 if (server
.dbnum
< 1) {
1691 err
= "Invalid number of databases"; goto loaderr
;
1693 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1694 server
.maxclients
= atoi(argv
[1]);
1695 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1696 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1697 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1698 server
.masterhost
= sdsnew(argv
[1]);
1699 server
.masterport
= atoi(argv
[2]);
1700 server
.replstate
= REDIS_REPL_CONNECT
;
1701 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1702 server
.masterauth
= zstrdup(argv
[1]);
1703 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1704 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1705 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1707 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1708 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1709 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1711 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1712 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1713 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1715 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1716 server
.sharingpoolsize
= atoi(argv
[1]);
1717 if (server
.sharingpoolsize
< 1) {
1718 err
= "invalid object sharing pool size"; goto loaderr
;
1720 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1721 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1722 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1724 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1725 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1726 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1728 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1729 if (!strcasecmp(argv
[1],"no")) {
1730 server
.appendfsync
= APPENDFSYNC_NO
;
1731 } else if (!strcasecmp(argv
[1],"always")) {
1732 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1733 } else if (!strcasecmp(argv
[1],"everysec")) {
1734 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1736 err
= "argument must be 'no', 'always' or 'everysec'";
1739 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1740 server
.requirepass
= zstrdup(argv
[1]);
1741 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1742 server
.pidfile
= zstrdup(argv
[1]);
1743 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1744 server
.dbfilename
= zstrdup(argv
[1]);
1745 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1746 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1747 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1749 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1750 zfree(server
.vm_swap_file
);
1751 server
.vm_swap_file
= zstrdup(argv
[1]);
1752 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1753 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1754 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1755 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1756 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1757 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1758 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1759 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1760 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1761 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1762 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1763 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1764 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1765 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1767 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1769 for (j
= 0; j
< argc
; j
++)
1774 if (fp
!= stdin
) fclose(fp
);
1778 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1779 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1780 fprintf(stderr
, ">>> '%s'\n", line
);
1781 fprintf(stderr
, "%s\n", err
);
1785 static void freeClientArgv(redisClient
*c
) {
1788 for (j
= 0; j
< c
->argc
; j
++)
1789 decrRefCount(c
->argv
[j
]);
1790 for (j
= 0; j
< c
->mbargc
; j
++)
1791 decrRefCount(c
->mbargv
[j
]);
1796 static void freeClient(redisClient
*c
) {
1799 /* Note that if the client we are freeing is blocked into a blocking
1800 * call, we have to set querybuf to NULL *before* to call
1801 * unblockClientWaitingData() to avoid processInputBuffer() will get
1802 * called. Also it is important to remove the file events after
1803 * this, because this call adds the READABLE event. */
1804 sdsfree(c
->querybuf
);
1806 if (c
->flags
& REDIS_BLOCKED
)
1807 unblockClientWaitingData(c
);
1809 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1810 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1811 listRelease(c
->reply
);
1814 /* Remove from the list of clients */
1815 ln
= listSearchKey(server
.clients
,c
);
1816 redisAssert(ln
!= NULL
);
1817 listDelNode(server
.clients
,ln
);
1818 /* Remove from the list of clients waiting for swapped keys */
1819 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1820 ln
= listSearchKey(server
.io_ready_clients
,c
);
1822 listDelNode(server
.io_ready_clients
,ln
);
1823 server
.vm_blocked_clients
--;
1826 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1827 ln
= listFirst(c
->io_keys
);
1828 dontWaitForSwappedKey(c
,ln
->value
);
1830 listRelease(c
->io_keys
);
1832 if (c
->flags
& REDIS_SLAVE
) {
1833 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1835 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1836 ln
= listSearchKey(l
,c
);
1837 redisAssert(ln
!= NULL
);
1840 if (c
->flags
& REDIS_MASTER
) {
1841 server
.master
= NULL
;
1842 server
.replstate
= REDIS_REPL_CONNECT
;
1846 freeClientMultiState(c
);
1850 #define GLUEREPLY_UP_TO (1024)
1851 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1853 char buf
[GLUEREPLY_UP_TO
];
1858 listRewind(c
->reply
,&li
);
1859 while((ln
= listNext(&li
))) {
1863 objlen
= sdslen(o
->ptr
);
1864 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1865 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1867 listDelNode(c
->reply
,ln
);
1869 if (copylen
== 0) return;
1873 /* Now the output buffer is empty, add the new single element */
1874 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1875 listAddNodeHead(c
->reply
,o
);
1878 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1879 redisClient
*c
= privdata
;
1880 int nwritten
= 0, totwritten
= 0, objlen
;
1883 REDIS_NOTUSED(mask
);
1885 /* Use writev() if we have enough buffers to send */
1886 if (!server
.glueoutputbuf
&&
1887 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1888 !(c
->flags
& REDIS_MASTER
))
1890 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1894 while(listLength(c
->reply
)) {
1895 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1896 glueReplyBuffersIfNeeded(c
);
1898 o
= listNodeValue(listFirst(c
->reply
));
1899 objlen
= sdslen(o
->ptr
);
1902 listDelNode(c
->reply
,listFirst(c
->reply
));
1906 if (c
->flags
& REDIS_MASTER
) {
1907 /* Don't reply to a master */
1908 nwritten
= objlen
- c
->sentlen
;
1910 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1911 if (nwritten
<= 0) break;
1913 c
->sentlen
+= nwritten
;
1914 totwritten
+= nwritten
;
1915 /* If we fully sent the object on head go to the next one */
1916 if (c
->sentlen
== objlen
) {
1917 listDelNode(c
->reply
,listFirst(c
->reply
));
1920 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1921 * bytes, in a single threaded server it's a good idea to serve
1922 * other clients as well, even if a very large request comes from
1923 * super fast link that is always able to accept data (in real world
1924 * scenario think about 'KEYS *' against the loopback interfae) */
1925 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1927 if (nwritten
== -1) {
1928 if (errno
== EAGAIN
) {
1931 redisLog(REDIS_VERBOSE
,
1932 "Error writing to client: %s", strerror(errno
));
1937 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1938 if (listLength(c
->reply
) == 0) {
1940 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1944 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1946 redisClient
*c
= privdata
;
1947 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1949 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1950 int offset
, ion
= 0;
1952 REDIS_NOTUSED(mask
);
1955 while (listLength(c
->reply
)) {
1956 offset
= c
->sentlen
;
1960 /* fill-in the iov[] array */
1961 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1962 o
= listNodeValue(node
);
1963 objlen
= sdslen(o
->ptr
);
1965 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1968 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1969 break; /* no more iovecs */
1971 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1972 iov
[ion
].iov_len
= objlen
- offset
;
1973 willwrite
+= objlen
- offset
;
1974 offset
= 0; /* just for the first item */
1981 /* write all collected blocks at once */
1982 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1983 if (errno
!= EAGAIN
) {
1984 redisLog(REDIS_VERBOSE
,
1985 "Error writing to client: %s", strerror(errno
));
1992 totwritten
+= nwritten
;
1993 offset
= c
->sentlen
;
1995 /* remove written robjs from c->reply */
1996 while (nwritten
&& listLength(c
->reply
)) {
1997 o
= listNodeValue(listFirst(c
->reply
));
1998 objlen
= sdslen(o
->ptr
);
2000 if(nwritten
>= objlen
- offset
) {
2001 listDelNode(c
->reply
, listFirst(c
->reply
));
2002 nwritten
-= objlen
- offset
;
2006 c
->sentlen
+= nwritten
;
2014 c
->lastinteraction
= time(NULL
);
2016 if (listLength(c
->reply
) == 0) {
2018 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2022 static struct redisCommand
*lookupCommand(char *name
) {
2024 while(cmdTable
[j
].name
!= NULL
) {
2025 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2031 /* resetClient prepare the client to process the next command */
2032 static void resetClient(redisClient
*c
) {
2038 /* Call() is the core of Redis execution of a command */
2039 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2042 dirty
= server
.dirty
;
2044 if (server
.appendonly
&& server
.dirty
-dirty
)
2045 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2046 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2047 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2048 if (listLength(server
.monitors
))
2049 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2050 server
.stat_numcommands
++;
2053 /* If this function gets called we already read a whole
2054 * command, argments are in the client argv/argc fields.
2055 * processCommand() execute the command or prepare the
2056 * server for a bulk read from the client.
2058 * If 1 is returned the client is still alive and valid and
2059 * and other operations can be performed by the caller. Otherwise
2060 * if 0 is returned the client was destroied (i.e. after QUIT). */
2061 static int processCommand(redisClient
*c
) {
2062 struct redisCommand
*cmd
;
2064 /* Free some memory if needed (maxmemory setting) */
2065 if (server
.maxmemory
) freeMemoryIfNeeded();
2067 /* Handle the multi bulk command type. This is an alternative protocol
2068 * supported by Redis in order to receive commands that are composed of
2069 * multiple binary-safe "bulk" arguments. The latency of processing is
2070 * a bit higher but this allows things like multi-sets, so if this
2071 * protocol is used only for MSET and similar commands this is a big win. */
2072 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2073 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2074 if (c
->multibulk
<= 0) {
2078 decrRefCount(c
->argv
[c
->argc
-1]);
2082 } else if (c
->multibulk
) {
2083 if (c
->bulklen
== -1) {
2084 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2085 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2089 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2090 decrRefCount(c
->argv
[0]);
2091 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2093 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2098 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2102 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2103 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2107 if (c
->multibulk
== 0) {
2111 /* Here we need to swap the multi-bulk argc/argv with the
2112 * normal argc/argv of the client structure. */
2114 c
->argv
= c
->mbargv
;
2115 c
->mbargv
= auxargv
;
2118 c
->argc
= c
->mbargc
;
2119 c
->mbargc
= auxargc
;
2121 /* We need to set bulklen to something different than -1
2122 * in order for the code below to process the command without
2123 * to try to read the last argument of a bulk command as
2124 * a special argument. */
2126 /* continue below and process the command */
2133 /* -- end of multi bulk commands processing -- */
2135 /* The QUIT command is handled as a special case. Normal command
2136 * procs are unable to close the client connection safely */
2137 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2142 /* Now lookup the command and check ASAP about trivial error conditions
2143 * such wrong arity, bad command name and so forth. */
2144 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2147 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2148 (char*)c
->argv
[0]->ptr
));
2151 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2152 (c
->argc
< -cmd
->arity
)) {
2154 sdscatprintf(sdsempty(),
2155 "-ERR wrong number of arguments for '%s' command\r\n",
2159 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2160 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2163 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2164 /* This is a bulk command, we have to read the last argument yet. */
2165 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2167 decrRefCount(c
->argv
[c
->argc
-1]);
2168 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2170 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2175 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2176 /* It is possible that the bulk read is already in the
2177 * buffer. Check this condition and handle it accordingly.
2178 * This is just a fast path, alternative to call processInputBuffer().
2179 * It's a good idea since the code is small and this condition
2180 * happens most of the times. */
2181 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2182 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2184 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2186 /* Otherwise return... there is to read the last argument
2187 * from the socket. */
2191 /* Let's try to share objects on the command arguments vector */
2192 if (server
.shareobjects
) {
2194 for(j
= 1; j
< c
->argc
; j
++)
2195 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2197 /* Let's try to encode the bulk object to save space. */
2198 if (cmd
->flags
& REDIS_CMD_BULK
)
2199 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2201 /* Check if the user is authenticated */
2202 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2203 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2208 /* Exec the command */
2209 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2210 queueMultiCommand(c
,cmd
);
2211 addReply(c
,shared
.queued
);
2213 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2214 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2218 /* Prepare the client for the next command */
2223 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2228 /* (args*2)+1 is enough room for args, spaces, newlines */
2229 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2231 if (argc
<= REDIS_STATIC_ARGS
) {
2234 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2237 for (j
= 0; j
< argc
; j
++) {
2238 if (j
!= 0) outv
[outc
++] = shared
.space
;
2239 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2242 lenobj
= createObject(REDIS_STRING
,
2243 sdscatprintf(sdsempty(),"%lu\r\n",
2244 (unsigned long) stringObjectLen(argv
[j
])));
2245 lenobj
->refcount
= 0;
2246 outv
[outc
++] = lenobj
;
2248 outv
[outc
++] = argv
[j
];
2250 outv
[outc
++] = shared
.crlf
;
2252 /* Increment all the refcounts at start and decrement at end in order to
2253 * be sure to free objects if there is no slave in a replication state
2254 * able to be feed with commands */
2255 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2256 listRewind(slaves
,&li
);
2257 while((ln
= listNext(&li
))) {
2258 redisClient
*slave
= ln
->value
;
2260 /* Don't feed slaves that are still waiting for BGSAVE to start */
2261 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2263 /* Feed all the other slaves, MONITORs and so on */
2264 if (slave
->slaveseldb
!= dictid
) {
2268 case 0: selectcmd
= shared
.select0
; break;
2269 case 1: selectcmd
= shared
.select1
; break;
2270 case 2: selectcmd
= shared
.select2
; break;
2271 case 3: selectcmd
= shared
.select3
; break;
2272 case 4: selectcmd
= shared
.select4
; break;
2273 case 5: selectcmd
= shared
.select5
; break;
2274 case 6: selectcmd
= shared
.select6
; break;
2275 case 7: selectcmd
= shared
.select7
; break;
2276 case 8: selectcmd
= shared
.select8
; break;
2277 case 9: selectcmd
= shared
.select9
; break;
2279 selectcmd
= createObject(REDIS_STRING
,
2280 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2281 selectcmd
->refcount
= 0;
2284 addReply(slave
,selectcmd
);
2285 slave
->slaveseldb
= dictid
;
2287 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2289 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2290 if (outv
!= static_outv
) zfree(outv
);
2293 static void processInputBuffer(redisClient
*c
) {
2295 /* Before to process the input buffer, make sure the client is not
2296 * waitig for a blocking operation such as BLPOP. Note that the first
2297 * iteration the client is never blocked, otherwise the processInputBuffer
2298 * would not be called at all, but after the execution of the first commands
2299 * in the input buffer the client may be blocked, and the "goto again"
2300 * will try to reiterate. The following line will make it return asap. */
2301 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2302 if (c
->bulklen
== -1) {
2303 /* Read the first line of the query */
2304 char *p
= strchr(c
->querybuf
,'\n');
2311 query
= c
->querybuf
;
2312 c
->querybuf
= sdsempty();
2313 querylen
= 1+(p
-(query
));
2314 if (sdslen(query
) > querylen
) {
2315 /* leave data after the first line of the query in the buffer */
2316 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2318 *p
= '\0'; /* remove "\n" */
2319 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2320 sdsupdatelen(query
);
2322 /* Now we can split the query in arguments */
2323 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2326 if (c
->argv
) zfree(c
->argv
);
2327 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2329 for (j
= 0; j
< argc
; j
++) {
2330 if (sdslen(argv
[j
])) {
2331 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2339 /* Execute the command. If the client is still valid
2340 * after processCommand() return and there is something
2341 * on the query buffer try to process the next command. */
2342 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2344 /* Nothing to process, argc == 0. Just process the query
2345 * buffer if it's not empty or return to the caller */
2346 if (sdslen(c
->querybuf
)) goto again
;
2349 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2350 redisLog(REDIS_VERBOSE
, "Client protocol error");
2355 /* Bulk read handling. Note that if we are at this point
2356 the client already sent a command terminated with a newline,
2357 we are reading the bulk data that is actually the last
2358 argument of the command. */
2359 int qbl
= sdslen(c
->querybuf
);
2361 if (c
->bulklen
<= qbl
) {
2362 /* Copy everything but the final CRLF as final argument */
2363 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2365 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2366 /* Process the command. If the client is still valid after
2367 * the processing and there is more data in the buffer
2368 * try to parse it. */
2369 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2375 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2376 redisClient
*c
= (redisClient
*) privdata
;
2377 char buf
[REDIS_IOBUF_LEN
];
2380 REDIS_NOTUSED(mask
);
2382 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2384 if (errno
== EAGAIN
) {
2387 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2391 } else if (nread
== 0) {
2392 redisLog(REDIS_VERBOSE
, "Client closed connection");
2397 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2398 c
->lastinteraction
= time(NULL
);
2402 if (!(c
->flags
& REDIS_BLOCKED
))
2403 processInputBuffer(c
);
2406 static int selectDb(redisClient
*c
, int id
) {
2407 if (id
< 0 || id
>= server
.dbnum
)
2409 c
->db
= &server
.db
[id
];
2413 static void *dupClientReplyValue(void *o
) {
2414 incrRefCount((robj
*)o
);
2418 static redisClient
*createClient(int fd
) {
2419 redisClient
*c
= zmalloc(sizeof(*c
));
2421 anetNonBlock(NULL
,fd
);
2422 anetTcpNoDelay(NULL
,fd
);
2423 if (!c
) return NULL
;
2426 c
->querybuf
= sdsempty();
2435 c
->lastinteraction
= time(NULL
);
2436 c
->authenticated
= 0;
2437 c
->replstate
= REDIS_REPL_NONE
;
2438 c
->reply
= listCreate();
2439 listSetFreeMethod(c
->reply
,decrRefCount
);
2440 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2441 c
->blockingkeys
= NULL
;
2442 c
->blockingkeysnum
= 0;
2443 c
->io_keys
= listCreate();
2444 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2445 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2446 readQueryFromClient
, c
) == AE_ERR
) {
2450 listAddNodeTail(server
.clients
,c
);
2451 initClientMultiState(c
);
2455 static void addReply(redisClient
*c
, robj
*obj
) {
2456 if (listLength(c
->reply
) == 0 &&
2457 (c
->replstate
== REDIS_REPL_NONE
||
2458 c
->replstate
== REDIS_REPL_ONLINE
) &&
2459 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2460 sendReplyToClient
, c
) == AE_ERR
) return;
2462 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2463 obj
= dupStringObject(obj
);
2464 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2466 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2469 static void addReplySds(redisClient
*c
, sds s
) {
2470 robj
*o
= createObject(REDIS_STRING
,s
);
2475 static void addReplyDouble(redisClient
*c
, double d
) {
2478 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2479 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2480 (unsigned long) strlen(buf
),buf
));
2483 static void addReplyLong(redisClient
*c
, long l
) {
2488 addReply(c
,shared
.czero
);
2490 } else if (l
== 1) {
2491 addReply(c
,shared
.cone
);
2494 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2495 addReplySds(c
,sdsnewlen(buf
,len
));
2498 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2503 addReply(c
,shared
.czero
);
2505 } else if (ul
== 1) {
2506 addReply(c
,shared
.cone
);
2509 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2510 addReplySds(c
,sdsnewlen(buf
,len
));
2513 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2516 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2517 len
= sdslen(obj
->ptr
);
2519 long n
= (long)obj
->ptr
;
2521 /* Compute how many bytes will take this integer as a radix 10 string */
2527 while((n
= n
/10) != 0) {
2531 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2534 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2535 addReplyBulkLen(c
,obj
);
2537 addReply(c
,shared
.crlf
);
2540 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2545 REDIS_NOTUSED(mask
);
2546 REDIS_NOTUSED(privdata
);
2548 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2549 if (cfd
== AE_ERR
) {
2550 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2553 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2554 if ((c
= createClient(cfd
)) == NULL
) {
2555 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2556 close(cfd
); /* May be already closed, just ingore errors */
2559 /* If maxclient directive is set and this is one client more... close the
2560 * connection. Note that we create the client instead to check before
2561 * for this condition, since now the socket is already set in nonblocking
2562 * mode and we can send an error for free using the Kernel I/O */
2563 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2564 char *err
= "-ERR max number of clients reached\r\n";
2566 /* That's a best effort error message, don't check write errors */
2567 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2568 /* Nothing to do, Just to avoid the warning... */
2573 server
.stat_numconnections
++;
2576 /* ======================= Redis objects implementation ===================== */
2578 static robj
*createObject(int type
, void *ptr
) {
2581 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2582 if (listLength(server
.objfreelist
)) {
2583 listNode
*head
= listFirst(server
.objfreelist
);
2584 o
= listNodeValue(head
);
2585 listDelNode(server
.objfreelist
,head
);
2586 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2588 if (server
.vm_enabled
) {
2589 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2590 o
= zmalloc(sizeof(*o
));
2592 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2596 o
->encoding
= REDIS_ENCODING_RAW
;
2599 if (server
.vm_enabled
) {
2600 /* Note that this code may run in the context of an I/O thread
2601 * and accessing to server.unixtime in theory is an error
2602 * (no locks). But in practice this is safe, and even if we read
2603 * garbage Redis will not fail, as it's just a statistical info */
2604 o
->vm
.atime
= server
.unixtime
;
2605 o
->storage
= REDIS_VM_MEMORY
;
2610 static robj
*createStringObject(char *ptr
, size_t len
) {
2611 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2614 static robj
*dupStringObject(robj
*o
) {
2615 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2616 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2619 static robj
*createListObject(void) {
2620 list
*l
= listCreate();
2622 listSetFreeMethod(l
,decrRefCount
);
2623 return createObject(REDIS_LIST
,l
);
2626 static robj
*createSetObject(void) {
2627 dict
*d
= dictCreate(&setDictType
,NULL
);
2628 return createObject(REDIS_SET
,d
);
2631 static robj
*createHashObject(void) {
2632 /* All the Hashes start as zipmaps. Will be automatically converted
2633 * into hash tables if there are enough elements or big elements
2635 unsigned char *zm
= zipmapNew();
2636 robj
*o
= createObject(REDIS_HASH
,zm
);
2637 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2641 static robj
*createZsetObject(void) {
2642 zset
*zs
= zmalloc(sizeof(*zs
));
2644 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2645 zs
->zsl
= zslCreate();
2646 return createObject(REDIS_ZSET
,zs
);
2649 static void freeStringObject(robj
*o
) {
2650 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2655 static void freeListObject(robj
*o
) {
2656 listRelease((list
*) o
->ptr
);
2659 static void freeSetObject(robj
*o
) {
2660 dictRelease((dict
*) o
->ptr
);
2663 static void freeZsetObject(robj
*o
) {
2666 dictRelease(zs
->dict
);
2671 static void freeHashObject(robj
*o
) {
2672 switch (o
->encoding
) {
2673 case REDIS_ENCODING_HT
:
2674 dictRelease((dict
*) o
->ptr
);
2676 case REDIS_ENCODING_ZIPMAP
:
2685 static void incrRefCount(robj
*o
) {
2686 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2690 static void decrRefCount(void *obj
) {
2693 /* Object is a key of a swapped out value, or in the process of being
2695 if (server
.vm_enabled
&&
2696 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2698 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2699 redisAssert(o
->refcount
== 1);
2701 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2702 redisAssert(o
->type
== REDIS_STRING
);
2703 freeStringObject(o
);
2704 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2705 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2706 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2707 !listAddNodeHead(server
.objfreelist
,o
))
2709 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2710 server
.vm_stats_swapped_objects
--;
2713 /* Object is in memory, or in the process of being swapped out. */
2714 if (--(o
->refcount
) == 0) {
2715 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2716 vmCancelThreadedIOJob(obj
);
2718 case REDIS_STRING
: freeStringObject(o
); break;
2719 case REDIS_LIST
: freeListObject(o
); break;
2720 case REDIS_SET
: freeSetObject(o
); break;
2721 case REDIS_ZSET
: freeZsetObject(o
); break;
2722 case REDIS_HASH
: freeHashObject(o
); break;
2723 default: redisAssert(0); break;
2725 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2726 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2727 !listAddNodeHead(server
.objfreelist
,o
))
2729 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2733 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2734 dictEntry
*de
= dictFind(db
->dict
,key
);
2736 robj
*key
= dictGetEntryKey(de
);
2737 robj
*val
= dictGetEntryVal(de
);
2739 if (server
.vm_enabled
) {
2740 if (key
->storage
== REDIS_VM_MEMORY
||
2741 key
->storage
== REDIS_VM_SWAPPING
)
2743 /* If we were swapping the object out, stop it, this key
2745 if (key
->storage
== REDIS_VM_SWAPPING
)
2746 vmCancelThreadedIOJob(key
);
2747 /* Update the access time of the key for the aging algorithm. */
2748 key
->vm
.atime
= server
.unixtime
;
2750 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2752 /* Our value was swapped on disk. Bring it at home. */
2753 redisAssert(val
== NULL
);
2754 val
= vmLoadObject(key
);
2755 dictGetEntryVal(de
) = val
;
2757 /* Clients blocked by the VM subsystem may be waiting for
2759 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2768 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2769 expireIfNeeded(db
,key
);
2770 return lookupKey(db
,key
);
2773 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2774 deleteIfVolatile(db
,key
);
2775 return lookupKey(db
,key
);
2778 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2779 robj
*o
= lookupKeyRead(c
->db
, key
);
2780 if (!o
) addReply(c
,reply
);
2784 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2785 robj
*o
= lookupKeyWrite(c
->db
, key
);
2786 if (!o
) addReply(c
,reply
);
2790 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2791 if (o
->type
!= type
) {
2792 addReply(c
,shared
.wrongtypeerr
);
2798 static int deleteKey(redisDb
*db
, robj
*key
) {
2801 /* We need to protect key from destruction: after the first dictDelete()
2802 * it may happen that 'key' is no longer valid if we don't increment
2803 * it's count. This may happen when we get the object reference directly
2804 * from the hash table with dictRandomKey() or dict iterators */
2806 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2807 retval
= dictDelete(db
->dict
,key
);
2810 return retval
== DICT_OK
;
2813 /* Try to share an object against the shared objects pool */
2814 static robj
*tryObjectSharing(robj
*o
) {
2815 struct dictEntry
*de
;
2818 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2820 redisAssert(o
->type
== REDIS_STRING
);
2821 de
= dictFind(server
.sharingpool
,o
);
2823 robj
*shared
= dictGetEntryKey(de
);
2825 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2826 dictGetEntryVal(de
) = (void*) c
;
2827 incrRefCount(shared
);
2831 /* Here we are using a stream algorihtm: Every time an object is
2832 * shared we increment its count, everytime there is a miss we
2833 * recrement the counter of a random object. If this object reaches
2834 * zero we remove the object and put the current object instead. */
2835 if (dictSize(server
.sharingpool
) >=
2836 server
.sharingpoolsize
) {
2837 de
= dictGetRandomKey(server
.sharingpool
);
2838 redisAssert(de
!= NULL
);
2839 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2840 dictGetEntryVal(de
) = (void*) c
;
2842 dictDelete(server
.sharingpool
,de
->key
);
2845 c
= 0; /* If the pool is empty we want to add this object */
2850 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2851 redisAssert(retval
== DICT_OK
);
2858 /* Check if the nul-terminated string 's' can be represented by a long
2859 * (that is, is a number that fits into long without any other space or
2860 * character before or after the digits).
2862 * If so, the function returns REDIS_OK and *longval is set to the value
2863 * of the number. Otherwise REDIS_ERR is returned */
2864 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2865 char buf
[32], *endptr
;
2869 value
= strtol(s
, &endptr
, 10);
2870 if (endptr
[0] != '\0') return REDIS_ERR
;
2871 slen
= snprintf(buf
,32,"%ld",value
);
2873 /* If the number converted back into a string is not identical
2874 * then it's not possible to encode the string as integer */
2875 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2876 if (longval
) *longval
= value
;
2880 /* Try to encode a string object in order to save space */
2881 static int tryObjectEncoding(robj
*o
) {
2885 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2886 return REDIS_ERR
; /* Already encoded */
2888 /* It's not save to encode shared objects: shared objects can be shared
2889 * everywhere in the "object space" of Redis. Encoded objects can only
2890 * appear as "values" (and not, for instance, as keys) */
2891 if (o
->refcount
> 1) return REDIS_ERR
;
2893 /* Currently we try to encode only strings */
2894 redisAssert(o
->type
== REDIS_STRING
);
2896 /* Check if we can represent this string as a long integer */
2897 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2899 /* Ok, this object can be encoded */
2900 o
->encoding
= REDIS_ENCODING_INT
;
2902 o
->ptr
= (void*) value
;
2906 /* Get a decoded version of an encoded object (returned as a new object).
2907 * If the object is already raw-encoded just increment the ref count. */
2908 static robj
*getDecodedObject(robj
*o
) {
2911 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2915 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2918 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2919 dec
= createStringObject(buf
,strlen(buf
));
2922 redisAssert(1 != 1);
2926 /* Compare two string objects via strcmp() or alike.
2927 * Note that the objects may be integer-encoded. In such a case we
2928 * use snprintf() to get a string representation of the numbers on the stack
2929 * and compare the strings, it's much faster than calling getDecodedObject().
2931 * Important note: if objects are not integer encoded, but binary-safe strings,
2932 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2934 static int compareStringObjects(robj
*a
, robj
*b
) {
2935 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2936 char bufa
[128], bufb
[128], *astr
, *bstr
;
2939 if (a
== b
) return 0;
2940 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2941 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2947 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2948 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2954 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2957 static size_t stringObjectLen(robj
*o
) {
2958 redisAssert(o
->type
== REDIS_STRING
);
2959 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2960 return sdslen(o
->ptr
);
2964 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2968 /*============================ RDB saving/loading =========================== */
2970 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2971 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2975 static int rdbSaveTime(FILE *fp
, time_t t
) {
2976 int32_t t32
= (int32_t) t
;
2977 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2981 /* check rdbLoadLen() comments for more info */
2982 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2983 unsigned char buf
[2];
2986 /* Save a 6 bit len */
2987 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2988 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2989 } else if (len
< (1<<14)) {
2990 /* Save a 14 bit len */
2991 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2993 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2995 /* Save a 32 bit len */
2996 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2997 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2999 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3004 /* String objects in the form "2391" "-100" without any space and with a
3005 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3006 * encoded as integers to save space */
3007 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3009 char *endptr
, buf
[32];
3011 /* Check if it's possible to encode this value as a number */
3012 value
= strtoll(s
, &endptr
, 10);
3013 if (endptr
[0] != '\0') return 0;
3014 snprintf(buf
,32,"%lld",value
);
3016 /* If the number converted back into a string is not identical
3017 * then it's not possible to encode the string as integer */
3018 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3020 /* Finally check if it fits in our ranges */
3021 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3022 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3023 enc
[1] = value
&0xFF;
3025 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3026 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3027 enc
[1] = value
&0xFF;
3028 enc
[2] = (value
>>8)&0xFF;
3030 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3031 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3032 enc
[1] = value
&0xFF;
3033 enc
[2] = (value
>>8)&0xFF;
3034 enc
[3] = (value
>>16)&0xFF;
3035 enc
[4] = (value
>>24)&0xFF;
3042 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3043 size_t comprlen
, outlen
;
3047 /* We require at least four bytes compression for this to be worth it */
3048 if (len
<= 4) return 0;
3050 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3051 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3052 if (comprlen
== 0) {
3056 /* Data compressed! Let's save it on disk */
3057 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3058 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3059 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3060 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3061 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3070 /* Save a string objet as [len][data] on disk. If the object is a string
3071 * representation of an integer value we try to safe it in a special form */
3072 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3075 /* Try integer encoding */
3077 unsigned char buf
[5];
3078 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3079 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3084 /* Try LZF compression - under 20 bytes it's unable to compress even
3085 * aaaaaaaaaaaaaaaaaa so skip it */
3086 if (server
.rdbcompression
&& len
> 20) {
3089 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3090 if (retval
== -1) return -1;
3091 if (retval
> 0) return 0;
3092 /* retval == 0 means data can't be compressed, save the old way */
3095 /* Store verbatim */
3096 if (rdbSaveLen(fp
,len
) == -1) return -1;
3097 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3101 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3102 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3105 /* Avoid incr/decr ref count business when possible.
3106 * This plays well with copy-on-write given that we are probably
3107 * in a child process (BGSAVE). Also this makes sure key objects
3108 * of swapped objects are not incRefCount-ed (an assert does not allow
3109 * this in order to avoid bugs) */
3110 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3111 obj
= getDecodedObject(obj
);
3112 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3115 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3120 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3121 * 8 bit integer specifing the length of the representation.
3122 * This 8 bit integer has special values in order to specify the following
3128 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3129 unsigned char buf
[128];
3135 } else if (!isfinite(val
)) {
3137 buf
[0] = (val
< 0) ? 255 : 254;
3139 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3140 buf
[0] = strlen((char*)buf
+1);
3143 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3147 /* Save a Redis object. */
3148 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3149 if (o
->type
== REDIS_STRING
) {
3150 /* Save a string value */
3151 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3152 } else if (o
->type
== REDIS_LIST
) {
3153 /* Save a list value */
3154 list
*list
= o
->ptr
;
3158 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3159 listRewind(list
,&li
);
3160 while((ln
= listNext(&li
))) {
3161 robj
*eleobj
= listNodeValue(ln
);
3163 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3165 } else if (o
->type
== REDIS_SET
) {
3166 /* Save a set value */
3168 dictIterator
*di
= dictGetIterator(set
);
3171 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3172 while((de
= dictNext(di
)) != NULL
) {
3173 robj
*eleobj
= dictGetEntryKey(de
);
3175 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3177 dictReleaseIterator(di
);
3178 } else if (o
->type
== REDIS_ZSET
) {
3179 /* Save a set value */
3181 dictIterator
*di
= dictGetIterator(zs
->dict
);
3184 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3185 while((de
= dictNext(di
)) != NULL
) {
3186 robj
*eleobj
= dictGetEntryKey(de
);
3187 double *score
= dictGetEntryVal(de
);
3189 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3190 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3192 dictReleaseIterator(di
);
3193 } else if (o
->type
== REDIS_HASH
) {
3194 /* Save a hash value */
3195 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3196 unsigned char *p
= zipmapRewind(o
->ptr
);
3197 unsigned int count
= zipmapLen(o
->ptr
);
3198 unsigned char *key
, *val
;
3199 unsigned int klen
, vlen
;
3201 if (rdbSaveLen(fp
,count
) == -1) return -1;
3202 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3203 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3204 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3207 dictIterator
*di
= dictGetIterator(o
->ptr
);
3210 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3211 while((de
= dictNext(di
)) != NULL
) {
3212 robj
*key
= dictGetEntryKey(de
);
3213 robj
*val
= dictGetEntryVal(de
);
3215 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3216 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3218 dictReleaseIterator(di
);
3226 /* Return the length the object will have on disk if saved with
3227 * the rdbSaveObject() function. Currently we use a trick to get
3228 * this length with very little changes to the code. In the future
3229 * we could switch to a faster solution. */
3230 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3231 if (fp
== NULL
) fp
= server
.devnull
;
3233 assert(rdbSaveObject(fp
,o
) != 1);
3237 /* Return the number of pages required to save this object in the swap file */
3238 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3239 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3241 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3244 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3245 static int rdbSave(char *filename
) {
3246 dictIterator
*di
= NULL
;
3251 time_t now
= time(NULL
);
3253 /* Wait for I/O therads to terminate, just in case this is a
3254 * foreground-saving, to avoid seeking the swap file descriptor at the
3256 if (server
.vm_enabled
)
3257 waitEmptyIOJobsQueue();
3259 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3260 fp
= fopen(tmpfile
,"w");
3262 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3265 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3266 for (j
= 0; j
< server
.dbnum
; j
++) {
3267 redisDb
*db
= server
.db
+j
;
3269 if (dictSize(d
) == 0) continue;
3270 di
= dictGetIterator(d
);
3276 /* Write the SELECT DB opcode */
3277 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3278 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3280 /* Iterate this DB writing every entry */
3281 while((de
= dictNext(di
)) != NULL
) {
3282 robj
*key
= dictGetEntryKey(de
);
3283 robj
*o
= dictGetEntryVal(de
);
3284 time_t expiretime
= getExpire(db
,key
);
3286 /* Save the expire time */
3287 if (expiretime
!= -1) {
3288 /* If this key is already expired skip it */
3289 if (expiretime
< now
) continue;
3290 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3291 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3293 /* Save the key and associated value. This requires special
3294 * handling if the value is swapped out. */
3295 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3296 key
->storage
== REDIS_VM_SWAPPING
) {
3297 /* Save type, key, value */
3298 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3299 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3300 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3302 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3304 /* Get a preview of the object in memory */
3305 po
= vmPreviewObject(key
);
3306 /* Save type, key, value */
3307 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3308 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3309 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3310 /* Remove the loaded object from memory */
3314 dictReleaseIterator(di
);
3317 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3319 /* Make sure data will not remain on the OS's output buffers */
3324 /* Use RENAME to make sure the DB file is changed atomically only
3325 * if the generate DB file is ok. */
3326 if (rename(tmpfile
,filename
) == -1) {
3327 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3331 redisLog(REDIS_NOTICE
,"DB saved on disk");
3333 server
.lastsave
= time(NULL
);
3339 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3340 if (di
) dictReleaseIterator(di
);
3344 static int rdbSaveBackground(char *filename
) {
3347 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3348 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3349 if ((childpid
= fork()) == 0) {
3351 if (server
.vm_enabled
) vmReopenSwapFile();
3353 if (rdbSave(filename
) == REDIS_OK
) {
3360 if (childpid
== -1) {
3361 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3365 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3366 server
.bgsavechildpid
= childpid
;
3369 return REDIS_OK
; /* unreached */
3372 static void rdbRemoveTempFile(pid_t childpid
) {
3375 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3379 static int rdbLoadType(FILE *fp
) {
3381 if (fread(&type
,1,1,fp
) == 0) return -1;
3385 static time_t rdbLoadTime(FILE *fp
) {
3387 if (fread(&t32
,4,1,fp
) == 0) return -1;
3388 return (time_t) t32
;
3391 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3392 * of this file for a description of how this are stored on disk.
3394 * isencoded is set to 1 if the readed length is not actually a length but
3395 * an "encoding type", check the above comments for more info */
3396 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3397 unsigned char buf
[2];
3401 if (isencoded
) *isencoded
= 0;
3402 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3403 type
= (buf
[0]&0xC0)>>6;
3404 if (type
== REDIS_RDB_6BITLEN
) {
3405 /* Read a 6 bit len */
3407 } else if (type
== REDIS_RDB_ENCVAL
) {
3408 /* Read a 6 bit len encoding type */
3409 if (isencoded
) *isencoded
= 1;
3411 } else if (type
== REDIS_RDB_14BITLEN
) {
3412 /* Read a 14 bit len */
3413 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3414 return ((buf
[0]&0x3F)<<8)|buf
[1];
3416 /* Read a 32 bit len */
3417 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3422 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3423 unsigned char enc
[4];
3426 if (enctype
== REDIS_RDB_ENC_INT8
) {
3427 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3428 val
= (signed char)enc
[0];
3429 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3431 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3432 v
= enc
[0]|(enc
[1]<<8);
3434 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3436 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3437 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3440 val
= 0; /* anti-warning */
3443 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3446 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3447 unsigned int len
, clen
;
3448 unsigned char *c
= NULL
;
3451 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3452 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3453 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3454 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3455 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3456 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3458 return createObject(REDIS_STRING
,val
);
3465 static robj
*rdbLoadStringObject(FILE*fp
) {
3470 len
= rdbLoadLen(fp
,&isencoded
);
3473 case REDIS_RDB_ENC_INT8
:
3474 case REDIS_RDB_ENC_INT16
:
3475 case REDIS_RDB_ENC_INT32
:
3476 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3477 case REDIS_RDB_ENC_LZF
:
3478 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3484 if (len
== REDIS_RDB_LENERR
) return NULL
;
3485 val
= sdsnewlen(NULL
,len
);
3486 if (len
&& fread(val
,len
,1,fp
) == 0) {
3490 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3493 /* For information about double serialization check rdbSaveDoubleValue() */
3494 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3498 if (fread(&len
,1,1,fp
) == 0) return -1;
3500 case 255: *val
= R_NegInf
; return 0;
3501 case 254: *val
= R_PosInf
; return 0;
3502 case 253: *val
= R_Nan
; return 0;
3504 if (fread(buf
,len
,1,fp
) == 0) return -1;
3506 sscanf(buf
, "%lg", val
);
3511 /* Load a Redis object of the specified type from the specified file.
3512 * On success a newly allocated object is returned, otherwise NULL. */
3513 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3516 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3517 if (type
== REDIS_STRING
) {
3518 /* Read string value */
3519 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3520 tryObjectEncoding(o
);
3521 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3522 /* Read list/set value */
3525 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3526 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3527 /* It's faster to expand the dict to the right size asap in order
3528 * to avoid rehashing */
3529 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3530 dictExpand(o
->ptr
,listlen
);
3531 /* Load every single element of the list/set */
3535 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3536 tryObjectEncoding(ele
);
3537 if (type
== REDIS_LIST
) {
3538 listAddNodeTail((list
*)o
->ptr
,ele
);
3540 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3543 } else if (type
== REDIS_ZSET
) {
3544 /* Read list/set value */
3548 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3549 o
= createZsetObject();
3551 /* Load every single element of the list/set */
3554 double *score
= zmalloc(sizeof(double));
3556 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3557 tryObjectEncoding(ele
);
3558 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3559 dictAdd(zs
->dict
,ele
,score
);
3560 zslInsert(zs
->zsl
,*score
,ele
);
3561 incrRefCount(ele
); /* added to skiplist */
3563 } else if (type
== REDIS_HASH
) {
3566 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3567 o
= createHashObject();
3568 /* Too many entries? Use an hash table. */
3569 if (hashlen
> server
.hash_max_zipmap_entries
)
3570 convertToRealHash(o
);
3571 /* Load every key/value, then set it into the zipmap or hash
3572 * table, as needed. */
3576 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3577 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3578 /* If we are using a zipmap and there are too big values
3579 * the object is converted to real hash table encoding. */
3580 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3581 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3582 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3584 convertToRealHash(o
);
3587 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3588 unsigned char *zm
= o
->ptr
;
3590 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3591 val
->ptr
,sdslen(val
->ptr
),NULL
);
3596 tryObjectEncoding(key
);
3597 tryObjectEncoding(val
);
3598 dictAdd((dict
*)o
->ptr
,key
,val
);
3607 static int rdbLoad(char *filename
) {
3609 robj
*keyobj
= NULL
;
3611 int type
, retval
, rdbver
;
3612 dict
*d
= server
.db
[0].dict
;
3613 redisDb
*db
= server
.db
+0;
3615 time_t expiretime
= -1, now
= time(NULL
);
3616 long long loadedkeys
= 0;
3618 fp
= fopen(filename
,"r");
3619 if (!fp
) return REDIS_ERR
;
3620 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3622 if (memcmp(buf
,"REDIS",5) != 0) {
3624 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3627 rdbver
= atoi(buf
+5);
3630 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3637 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3638 if (type
== REDIS_EXPIRETIME
) {
3639 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3640 /* We read the time so we need to read the object type again */
3641 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3643 if (type
== REDIS_EOF
) break;
3644 /* Handle SELECT DB opcode as a special case */
3645 if (type
== REDIS_SELECTDB
) {
3646 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3648 if (dbid
>= (unsigned)server
.dbnum
) {
3649 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3652 db
= server
.db
+dbid
;
3657 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3659 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3660 /* Add the new object in the hash table */
3661 retval
= dictAdd(d
,keyobj
,o
);
3662 if (retval
== DICT_ERR
) {
3663 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3666 /* Set the expire time if needed */
3667 if (expiretime
!= -1) {
3668 setExpire(db
,keyobj
,expiretime
);
3669 /* Delete this key if already expired */
3670 if (expiretime
< now
) deleteKey(db
,keyobj
);
3674 /* Handle swapping while loading big datasets when VM is on */
3676 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3677 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3678 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3685 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3686 if (keyobj
) decrRefCount(keyobj
);
3687 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3689 return REDIS_ERR
; /* Just to avoid warning */
3692 /*================================== Commands =============================== */
3694 static void authCommand(redisClient
*c
) {
3695 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3696 c
->authenticated
= 1;
3697 addReply(c
,shared
.ok
);
3699 c
->authenticated
= 0;
3700 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3704 static void pingCommand(redisClient
*c
) {
3705 addReply(c
,shared
.pong
);
3708 static void echoCommand(redisClient
*c
) {
3709 addReplyBulk(c
,c
->argv
[1]);
3712 /*=================================== Strings =============================== */
3714 static void setGenericCommand(redisClient
*c
, int nx
) {
3717 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3718 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3719 if (retval
== DICT_ERR
) {
3721 /* If the key is about a swapped value, we want a new key object
3722 * to overwrite the old. So we delete the old key in the database.
3723 * This will also make sure that swap pages about the old object
3724 * will be marked as free. */
3725 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3726 incrRefCount(c
->argv
[1]);
3727 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3728 incrRefCount(c
->argv
[2]);
3730 addReply(c
,shared
.czero
);
3734 incrRefCount(c
->argv
[1]);
3735 incrRefCount(c
->argv
[2]);
3738 removeExpire(c
->db
,c
->argv
[1]);
3739 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3742 static void setCommand(redisClient
*c
) {
3743 setGenericCommand(c
,0);
3746 static void setnxCommand(redisClient
*c
) {
3747 setGenericCommand(c
,1);
3750 static int getGenericCommand(redisClient
*c
) {
3753 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3756 if (o
->type
!= REDIS_STRING
) {
3757 addReply(c
,shared
.wrongtypeerr
);
3765 static void getCommand(redisClient
*c
) {
3766 getGenericCommand(c
);
3769 static void getsetCommand(redisClient
*c
) {
3770 if (getGenericCommand(c
) == REDIS_ERR
) return;
3771 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3772 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3774 incrRefCount(c
->argv
[1]);
3776 incrRefCount(c
->argv
[2]);
3778 removeExpire(c
->db
,c
->argv
[1]);
3781 static void mgetCommand(redisClient
*c
) {
3784 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3785 for (j
= 1; j
< c
->argc
; j
++) {
3786 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3788 addReply(c
,shared
.nullbulk
);
3790 if (o
->type
!= REDIS_STRING
) {
3791 addReply(c
,shared
.nullbulk
);
3799 static void msetGenericCommand(redisClient
*c
, int nx
) {
3800 int j
, busykeys
= 0;
3802 if ((c
->argc
% 2) == 0) {
3803 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3806 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3807 * set nothing at all if at least one already key exists. */
3809 for (j
= 1; j
< c
->argc
; j
+= 2) {
3810 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3816 addReply(c
, shared
.czero
);
3820 for (j
= 1; j
< c
->argc
; j
+= 2) {
3823 tryObjectEncoding(c
->argv
[j
+1]);
3824 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3825 if (retval
== DICT_ERR
) {
3826 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3827 incrRefCount(c
->argv
[j
+1]);
3829 incrRefCount(c
->argv
[j
]);
3830 incrRefCount(c
->argv
[j
+1]);
3832 removeExpire(c
->db
,c
->argv
[j
]);
3834 server
.dirty
+= (c
->argc
-1)/2;
3835 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3838 static void msetCommand(redisClient
*c
) {
3839 msetGenericCommand(c
,0);
3842 static void msetnxCommand(redisClient
*c
) {
3843 msetGenericCommand(c
,1);
3846 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3851 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3855 if (o
->type
!= REDIS_STRING
) {
3860 if (o
->encoding
== REDIS_ENCODING_RAW
)
3861 value
= strtoll(o
->ptr
, &eptr
, 10);
3862 else if (o
->encoding
== REDIS_ENCODING_INT
)
3863 value
= (long)o
->ptr
;
3865 redisAssert(1 != 1);
3870 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3871 tryObjectEncoding(o
);
3872 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3873 if (retval
== DICT_ERR
) {
3874 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3875 removeExpire(c
->db
,c
->argv
[1]);
3877 incrRefCount(c
->argv
[1]);
3880 addReply(c
,shared
.colon
);
3882 addReply(c
,shared
.crlf
);
3885 static void incrCommand(redisClient
*c
) {
3886 incrDecrCommand(c
,1);
3889 static void decrCommand(redisClient
*c
) {
3890 incrDecrCommand(c
,-1);
3893 static void incrbyCommand(redisClient
*c
) {
3894 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3895 incrDecrCommand(c
,incr
);
3898 static void decrbyCommand(redisClient
*c
) {
3899 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3900 incrDecrCommand(c
,-incr
);
3903 static void appendCommand(redisClient
*c
) {
3908 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3910 /* Create the key */
3911 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3912 incrRefCount(c
->argv
[1]);
3913 incrRefCount(c
->argv
[2]);
3914 totlen
= stringObjectLen(c
->argv
[2]);
3918 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3921 o
= dictGetEntryVal(de
);
3922 if (o
->type
!= REDIS_STRING
) {
3923 addReply(c
,shared
.wrongtypeerr
);
3926 /* If the object is specially encoded or shared we have to make
3928 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3929 robj
*decoded
= getDecodedObject(o
);
3931 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3932 decrRefCount(decoded
);
3933 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3936 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3937 o
->ptr
= sdscatlen(o
->ptr
,
3938 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3940 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3941 (unsigned long) c
->argv
[2]->ptr
);
3943 totlen
= sdslen(o
->ptr
);
3946 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3949 static void substrCommand(redisClient
*c
) {
3951 long start
= atoi(c
->argv
[2]->ptr
);
3952 long end
= atoi(c
->argv
[3]->ptr
);
3953 size_t rangelen
, strlen
;
3956 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
3957 checkType(c
,o
,REDIS_STRING
)) return;
3959 o
= getDecodedObject(o
);
3960 strlen
= sdslen(o
->ptr
);
3962 /* convert negative indexes */
3963 if (start
< 0) start
= strlen
+start
;
3964 if (end
< 0) end
= strlen
+end
;
3965 if (start
< 0) start
= 0;
3966 if (end
< 0) end
= 0;
3968 /* indexes sanity checks */
3969 if (start
> end
|| (size_t)start
>= strlen
) {
3970 /* Out of range start or start > end result in null reply */
3971 addReply(c
,shared
.nullbulk
);
3975 if ((size_t)end
>= strlen
) end
= strlen
-1;
3976 rangelen
= (end
-start
)+1;
3978 /* Return the result */
3979 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
3980 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
3981 addReplySds(c
,range
);
3982 addReply(c
,shared
.crlf
);
3986 /* ========================= Type agnostic commands ========================= */
3988 static void delCommand(redisClient
*c
) {
3991 for (j
= 1; j
< c
->argc
; j
++) {
3992 if (deleteKey(c
->db
,c
->argv
[j
])) {
3997 addReplyLong(c
,deleted
);
4000 static void existsCommand(redisClient
*c
) {
4001 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4004 static void selectCommand(redisClient
*c
) {
4005 int id
= atoi(c
->argv
[1]->ptr
);
4007 if (selectDb(c
,id
) == REDIS_ERR
) {
4008 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4010 addReply(c
,shared
.ok
);
4014 static void randomkeyCommand(redisClient
*c
) {
4018 de
= dictGetRandomKey(c
->db
->dict
);
4019 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4022 addReply(c
,shared
.plus
);
4023 addReply(c
,shared
.crlf
);
4025 addReply(c
,shared
.plus
);
4026 addReply(c
,dictGetEntryKey(de
));
4027 addReply(c
,shared
.crlf
);
4031 static void keysCommand(redisClient
*c
) {
4034 sds pattern
= c
->argv
[1]->ptr
;
4035 int plen
= sdslen(pattern
);
4036 unsigned long numkeys
= 0;
4037 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4039 di
= dictGetIterator(c
->db
->dict
);
4041 decrRefCount(lenobj
);
4042 while((de
= dictNext(di
)) != NULL
) {
4043 robj
*keyobj
= dictGetEntryKey(de
);
4045 sds key
= keyobj
->ptr
;
4046 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4047 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4048 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4049 addReplyBulk(c
,keyobj
);
4054 dictReleaseIterator(di
);
4055 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4058 static void dbsizeCommand(redisClient
*c
) {
4060 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4063 static void lastsaveCommand(redisClient
*c
) {
4065 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4068 static void typeCommand(redisClient
*c
) {
4072 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4077 case REDIS_STRING
: type
= "+string"; break;
4078 case REDIS_LIST
: type
= "+list"; break;
4079 case REDIS_SET
: type
= "+set"; break;
4080 case REDIS_ZSET
: type
= "+zset"; break;
4081 case REDIS_HASH
: type
= "+hash"; break;
4082 default: type
= "+unknown"; break;
4085 addReplySds(c
,sdsnew(type
));
4086 addReply(c
,shared
.crlf
);
4089 static void saveCommand(redisClient
*c
) {
4090 if (server
.bgsavechildpid
!= -1) {
4091 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4094 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4095 addReply(c
,shared
.ok
);
4097 addReply(c
,shared
.err
);
4101 static void bgsaveCommand(redisClient
*c
) {
4102 if (server
.bgsavechildpid
!= -1) {
4103 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4106 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4107 char *status
= "+Background saving started\r\n";
4108 addReplySds(c
,sdsnew(status
));
4110 addReply(c
,shared
.err
);
4114 static void shutdownCommand(redisClient
*c
) {
4115 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4116 /* Kill the saving child if there is a background saving in progress.
4117 We want to avoid race conditions, for instance our saving child may
4118 overwrite the synchronous saving did by SHUTDOWN. */
4119 if (server
.bgsavechildpid
!= -1) {
4120 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4121 kill(server
.bgsavechildpid
,SIGKILL
);
4122 rdbRemoveTempFile(server
.bgsavechildpid
);
4124 if (server
.appendonly
) {
4125 /* Append only file: fsync() the AOF and exit */
4126 fsync(server
.appendfd
);
4127 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4130 /* Snapshotting. Perform a SYNC SAVE and exit */
4131 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4132 if (server
.daemonize
)
4133 unlink(server
.pidfile
);
4134 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4135 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4136 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4139 /* Ooops.. error saving! The best we can do is to continue
4140 * operating. Note that if there was a background saving process,
4141 * in the next cron() Redis will be notified that the background
4142 * saving aborted, handling special stuff like slaves pending for
4143 * synchronization... */
4144 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4146 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4151 static void renameGenericCommand(redisClient
*c
, int nx
) {
4154 /* To use the same key as src and dst is probably an error */
4155 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4156 addReply(c
,shared
.sameobjecterr
);
4160 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4164 deleteIfVolatile(c
->db
,c
->argv
[2]);
4165 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4168 addReply(c
,shared
.czero
);
4171 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4173 incrRefCount(c
->argv
[2]);
4175 deleteKey(c
->db
,c
->argv
[1]);
4177 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4180 static void renameCommand(redisClient
*c
) {
4181 renameGenericCommand(c
,0);
4184 static void renamenxCommand(redisClient
*c
) {
4185 renameGenericCommand(c
,1);
4188 static void moveCommand(redisClient
*c
) {
4193 /* Obtain source and target DB pointers */
4196 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4197 addReply(c
,shared
.outofrangeerr
);
4201 selectDb(c
,srcid
); /* Back to the source DB */
4203 /* If the user is moving using as target the same
4204 * DB as the source DB it is probably an error. */
4206 addReply(c
,shared
.sameobjecterr
);
4210 /* Check if the element exists and get a reference */
4211 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4213 addReply(c
,shared
.czero
);
4217 /* Try to add the element to the target DB */
4218 deleteIfVolatile(dst
,c
->argv
[1]);
4219 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4220 addReply(c
,shared
.czero
);
4223 incrRefCount(c
->argv
[1]);
4226 /* OK! key moved, free the entry in the source DB */
4227 deleteKey(src
,c
->argv
[1]);
4229 addReply(c
,shared
.cone
);
4232 /* =================================== Lists ================================ */
4233 static void pushGenericCommand(redisClient
*c
, int where
) {
4237 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4239 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4240 addReply(c
,shared
.cone
);
4243 lobj
= createListObject();
4245 if (where
== REDIS_HEAD
) {
4246 listAddNodeHead(list
,c
->argv
[2]);
4248 listAddNodeTail(list
,c
->argv
[2]);
4250 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4251 incrRefCount(c
->argv
[1]);
4252 incrRefCount(c
->argv
[2]);
4254 if (lobj
->type
!= REDIS_LIST
) {
4255 addReply(c
,shared
.wrongtypeerr
);
4258 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4259 addReply(c
,shared
.cone
);
4263 if (where
== REDIS_HEAD
) {
4264 listAddNodeHead(list
,c
->argv
[2]);
4266 listAddNodeTail(list
,c
->argv
[2]);
4268 incrRefCount(c
->argv
[2]);
4271 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4274 static void lpushCommand(redisClient
*c
) {
4275 pushGenericCommand(c
,REDIS_HEAD
);
4278 static void rpushCommand(redisClient
*c
) {
4279 pushGenericCommand(c
,REDIS_TAIL
);
4282 static void llenCommand(redisClient
*c
) {
4286 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4287 checkType(c
,o
,REDIS_LIST
)) return;
4290 addReplyUlong(c
,listLength(l
));
4293 static void lindexCommand(redisClient
*c
) {
4295 int index
= atoi(c
->argv
[2]->ptr
);
4299 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4300 checkType(c
,o
,REDIS_LIST
)) return;
4303 ln
= listIndex(list
, index
);
4305 addReply(c
,shared
.nullbulk
);
4307 robj
*ele
= listNodeValue(ln
);
4308 addReplyBulk(c
,ele
);
4312 static void lsetCommand(redisClient
*c
) {
4314 int index
= atoi(c
->argv
[2]->ptr
);
4318 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4319 checkType(c
,o
,REDIS_LIST
)) return;
4322 ln
= listIndex(list
, index
);
4324 addReply(c
,shared
.outofrangeerr
);
4326 robj
*ele
= listNodeValue(ln
);
4329 listNodeValue(ln
) = c
->argv
[3];
4330 incrRefCount(c
->argv
[3]);
4331 addReply(c
,shared
.ok
);
4336 static void popGenericCommand(redisClient
*c
, int where
) {
4341 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4342 checkType(c
,o
,REDIS_LIST
)) return;
4345 if (where
== REDIS_HEAD
)
4346 ln
= listFirst(list
);
4348 ln
= listLast(list
);
4351 addReply(c
,shared
.nullbulk
);
4353 robj
*ele
= listNodeValue(ln
);
4354 addReplyBulk(c
,ele
);
4355 listDelNode(list
,ln
);
4360 static void lpopCommand(redisClient
*c
) {
4361 popGenericCommand(c
,REDIS_HEAD
);
4364 static void rpopCommand(redisClient
*c
) {
4365 popGenericCommand(c
,REDIS_TAIL
);
4368 static void lrangeCommand(redisClient
*c
) {
4370 int start
= atoi(c
->argv
[2]->ptr
);
4371 int end
= atoi(c
->argv
[3]->ptr
);
4378 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4379 checkType(c
,o
,REDIS_LIST
)) return;
4381 llen
= listLength(list
);
4383 /* convert negative indexes */
4384 if (start
< 0) start
= llen
+start
;
4385 if (end
< 0) end
= llen
+end
;
4386 if (start
< 0) start
= 0;
4387 if (end
< 0) end
= 0;
4389 /* indexes sanity checks */
4390 if (start
> end
|| start
>= llen
) {
4391 /* Out of range start or start > end result in empty list */
4392 addReply(c
,shared
.emptymultibulk
);
4395 if (end
>= llen
) end
= llen
-1;
4396 rangelen
= (end
-start
)+1;
4398 /* Return the result in form of a multi-bulk reply */
4399 ln
= listIndex(list
, start
);
4400 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4401 for (j
= 0; j
< rangelen
; j
++) {
4402 ele
= listNodeValue(ln
);
4403 addReplyBulk(c
,ele
);
4408 static void ltrimCommand(redisClient
*c
) {
4410 int start
= atoi(c
->argv
[2]->ptr
);
4411 int end
= atoi(c
->argv
[3]->ptr
);
4413 int j
, ltrim
, rtrim
;
4417 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4418 checkType(c
,o
,REDIS_LIST
)) return;
4420 llen
= listLength(list
);
4422 /* convert negative indexes */
4423 if (start
< 0) start
= llen
+start
;
4424 if (end
< 0) end
= llen
+end
;
4425 if (start
< 0) start
= 0;
4426 if (end
< 0) end
= 0;
4428 /* indexes sanity checks */
4429 if (start
> end
|| start
>= llen
) {
4430 /* Out of range start or start > end result in empty list */
4434 if (end
>= llen
) end
= llen
-1;
4439 /* Remove list elements to perform the trim */
4440 for (j
= 0; j
< ltrim
; j
++) {
4441 ln
= listFirst(list
);
4442 listDelNode(list
,ln
);
4444 for (j
= 0; j
< rtrim
; j
++) {
4445 ln
= listLast(list
);
4446 listDelNode(list
,ln
);
4449 addReply(c
,shared
.ok
);
4452 static void lremCommand(redisClient
*c
) {
4455 listNode
*ln
, *next
;
4456 int toremove
= atoi(c
->argv
[2]->ptr
);
4460 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4461 checkType(c
,o
,REDIS_LIST
)) return;
4465 toremove
= -toremove
;
4468 ln
= fromtail
? list
->tail
: list
->head
;
4470 robj
*ele
= listNodeValue(ln
);
4472 next
= fromtail
? ln
->prev
: ln
->next
;
4473 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4474 listDelNode(list
,ln
);
4477 if (toremove
&& removed
== toremove
) break;
4481 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4484 /* This is the semantic of this command:
4485 * RPOPLPUSH srclist dstlist:
4486 * IF LLEN(srclist) > 0
4487 * element = RPOP srclist
4488 * LPUSH dstlist element
4495 * The idea is to be able to get an element from a list in a reliable way
4496 * since the element is not just returned but pushed against another list
4497 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4499 static void rpoplpushcommand(redisClient
*c
) {
4504 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4505 checkType(c
,sobj
,REDIS_LIST
)) return;
4506 srclist
= sobj
->ptr
;
4507 ln
= listLast(srclist
);
4510 addReply(c
,shared
.nullbulk
);
4512 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4513 robj
*ele
= listNodeValue(ln
);
4516 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4517 addReply(c
,shared
.wrongtypeerr
);
4521 /* Add the element to the target list (unless it's directly
4522 * passed to some BLPOP-ing client */
4523 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4525 /* Create the list if the key does not exist */
4526 dobj
= createListObject();
4527 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4528 incrRefCount(c
->argv
[2]);
4530 dstlist
= dobj
->ptr
;
4531 listAddNodeHead(dstlist
,ele
);
4535 /* Send the element to the client as reply as well */
4536 addReplyBulk(c
,ele
);
4538 /* Finally remove the element from the source list */
4539 listDelNode(srclist
,ln
);
4544 /* ==================================== Sets ================================ */
4546 static void saddCommand(redisClient
*c
) {
4549 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4551 set
= createSetObject();
4552 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4553 incrRefCount(c
->argv
[1]);
4555 if (set
->type
!= REDIS_SET
) {
4556 addReply(c
,shared
.wrongtypeerr
);
4560 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4561 incrRefCount(c
->argv
[2]);
4563 addReply(c
,shared
.cone
);
4565 addReply(c
,shared
.czero
);
4569 static void sremCommand(redisClient
*c
) {
4572 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4573 checkType(c
,set
,REDIS_SET
)) return;
4575 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4577 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4578 addReply(c
,shared
.cone
);
4580 addReply(c
,shared
.czero
);
4584 static void smoveCommand(redisClient
*c
) {
4585 robj
*srcset
, *dstset
;
4587 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4588 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4590 /* If the source key does not exist return 0, if it's of the wrong type
4592 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4593 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4596 /* Error if the destination key is not a set as well */
4597 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4598 addReply(c
,shared
.wrongtypeerr
);
4601 /* Remove the element from the source set */
4602 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4603 /* Key not found in the src set! return zero */
4604 addReply(c
,shared
.czero
);
4608 /* Add the element to the destination set */
4610 dstset
= createSetObject();
4611 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4612 incrRefCount(c
->argv
[2]);
4614 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4615 incrRefCount(c
->argv
[3]);
4616 addReply(c
,shared
.cone
);
4619 static void sismemberCommand(redisClient
*c
) {
4622 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4623 checkType(c
,set
,REDIS_SET
)) return;
4625 if (dictFind(set
->ptr
,c
->argv
[2]))
4626 addReply(c
,shared
.cone
);
4628 addReply(c
,shared
.czero
);
4631 static void scardCommand(redisClient
*c
) {
4635 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4636 checkType(c
,o
,REDIS_SET
)) return;
4639 addReplyUlong(c
,dictSize(s
));
4642 static void spopCommand(redisClient
*c
) {
4646 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4647 checkType(c
,set
,REDIS_SET
)) return;
4649 de
= dictGetRandomKey(set
->ptr
);
4651 addReply(c
,shared
.nullbulk
);
4653 robj
*ele
= dictGetEntryKey(de
);
4655 addReplyBulk(c
,ele
);
4656 dictDelete(set
->ptr
,ele
);
4657 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4662 static void srandmemberCommand(redisClient
*c
) {
4666 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4667 checkType(c
,set
,REDIS_SET
)) return;
4669 de
= dictGetRandomKey(set
->ptr
);
4671 addReply(c
,shared
.nullbulk
);
4673 robj
*ele
= dictGetEntryKey(de
);
4675 addReplyBulk(c
,ele
);
4679 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4680 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4682 return dictSize(*d1
)-dictSize(*d2
);
4685 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4686 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4689 robj
*lenobj
= NULL
, *dstset
= NULL
;
4690 unsigned long j
, cardinality
= 0;
4692 for (j
= 0; j
< setsnum
; j
++) {
4696 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4697 lookupKeyRead(c
->db
,setskeys
[j
]);
4701 if (deleteKey(c
->db
,dstkey
))
4703 addReply(c
,shared
.czero
);
4705 addReply(c
,shared
.nullmultibulk
);
4709 if (setobj
->type
!= REDIS_SET
) {
4711 addReply(c
,shared
.wrongtypeerr
);
4714 dv
[j
] = setobj
->ptr
;
4716 /* Sort sets from the smallest to largest, this will improve our
4717 * algorithm's performace */
4718 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4720 /* The first thing we should output is the total number of elements...
4721 * since this is a multi-bulk write, but at this stage we don't know
4722 * the intersection set size, so we use a trick, append an empty object
4723 * to the output list and save the pointer to later modify it with the
4726 lenobj
= createObject(REDIS_STRING
,NULL
);
4728 decrRefCount(lenobj
);
4730 /* If we have a target key where to store the resulting set
4731 * create this key with an empty set inside */
4732 dstset
= createSetObject();
4735 /* Iterate all the elements of the first (smallest) set, and test
4736 * the element against all the other sets, if at least one set does
4737 * not include the element it is discarded */
4738 di
= dictGetIterator(dv
[0]);
4740 while((de
= dictNext(di
)) != NULL
) {
4743 for (j
= 1; j
< setsnum
; j
++)
4744 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4746 continue; /* at least one set does not contain the member */
4747 ele
= dictGetEntryKey(de
);
4749 addReplyBulk(c
,ele
);
4752 dictAdd(dstset
->ptr
,ele
,NULL
);
4756 dictReleaseIterator(di
);
4759 /* Store the resulting set into the target */
4760 deleteKey(c
->db
,dstkey
);
4761 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4762 incrRefCount(dstkey
);
4766 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4768 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4769 dictSize((dict
*)dstset
->ptr
)));
4775 static void sinterCommand(redisClient
*c
) {
4776 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4779 static void sinterstoreCommand(redisClient
*c
) {
4780 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4783 #define REDIS_OP_UNION 0
4784 #define REDIS_OP_DIFF 1
4785 #define REDIS_OP_INTER 2
4787 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4788 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4791 robj
*dstset
= NULL
;
4792 int j
, cardinality
= 0;
4794 for (j
= 0; j
< setsnum
; j
++) {
4798 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4799 lookupKeyRead(c
->db
,setskeys
[j
]);
4804 if (setobj
->type
!= REDIS_SET
) {
4806 addReply(c
,shared
.wrongtypeerr
);
4809 dv
[j
] = setobj
->ptr
;
4812 /* We need a temp set object to store our union. If the dstkey
4813 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4814 * this set object will be the resulting object to set into the target key*/
4815 dstset
= createSetObject();
4817 /* Iterate all the elements of all the sets, add every element a single
4818 * time to the result set */
4819 for (j
= 0; j
< setsnum
; j
++) {
4820 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4821 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4823 di
= dictGetIterator(dv
[j
]);
4825 while((de
= dictNext(di
)) != NULL
) {
4828 /* dictAdd will not add the same element multiple times */
4829 ele
= dictGetEntryKey(de
);
4830 if (op
== REDIS_OP_UNION
|| j
== 0) {
4831 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4835 } else if (op
== REDIS_OP_DIFF
) {
4836 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4841 dictReleaseIterator(di
);
4843 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4846 /* Output the content of the resulting set, if not in STORE mode */
4848 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4849 di
= dictGetIterator(dstset
->ptr
);
4850 while((de
= dictNext(di
)) != NULL
) {
4853 ele
= dictGetEntryKey(de
);
4854 addReplyBulk(c
,ele
);
4856 dictReleaseIterator(di
);
4858 /* If we have a target key where to store the resulting set
4859 * create this key with the result set inside */
4860 deleteKey(c
->db
,dstkey
);
4861 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4862 incrRefCount(dstkey
);
4867 decrRefCount(dstset
);
4869 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4870 dictSize((dict
*)dstset
->ptr
)));
4876 static void sunionCommand(redisClient
*c
) {
4877 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4880 static void sunionstoreCommand(redisClient
*c
) {
4881 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4884 static void sdiffCommand(redisClient
*c
) {
4885 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4888 static void sdiffstoreCommand(redisClient
*c
) {
4889 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4892 /* ==================================== ZSets =============================== */
4894 /* ZSETs are ordered sets using two data structures to hold the same elements
4895 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4898 * The elements are added to an hash table mapping Redis objects to scores.
4899 * At the same time the elements are added to a skip list mapping scores
4900 * to Redis objects (so objects are sorted by scores in this "view"). */
4902 /* This skiplist implementation is almost a C translation of the original
4903 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4904 * Alternative to Balanced Trees", modified in three ways:
4905 * a) this implementation allows for repeated values.
4906 * b) the comparison is not just by key (our 'score') but by satellite data.
4907 * c) there is a back pointer, so it's a doubly linked list with the back
4908 * pointers being only at "level 1". This allows to traverse the list
4909 * from tail to head, useful for ZREVRANGE. */
4911 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4912 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4914 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4916 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4922 static zskiplist
*zslCreate(void) {
4926 zsl
= zmalloc(sizeof(*zsl
));
4929 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4930 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4931 zsl
->header
->forward
[j
] = NULL
;
4933 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4934 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4935 zsl
->header
->span
[j
] = 0;
4937 zsl
->header
->backward
= NULL
;
4942 static void zslFreeNode(zskiplistNode
*node
) {
4943 decrRefCount(node
->obj
);
4944 zfree(node
->forward
);
4949 static void zslFree(zskiplist
*zsl
) {
4950 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4952 zfree(zsl
->header
->forward
);
4953 zfree(zsl
->header
->span
);
4956 next
= node
->forward
[0];
4963 static int zslRandomLevel(void) {
4965 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4970 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4971 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4972 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
4976 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4977 /* store rank that is crossed to reach the insert position */
4978 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
4980 while (x
->forward
[i
] &&
4981 (x
->forward
[i
]->score
< score
||
4982 (x
->forward
[i
]->score
== score
&&
4983 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
4984 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
4989 /* we assume the key is not already inside, since we allow duplicated
4990 * scores, and the re-insertion of score and redis object should never
4991 * happpen since the caller of zslInsert() should test in the hash table
4992 * if the element is already inside or not. */
4993 level
= zslRandomLevel();
4994 if (level
> zsl
->level
) {
4995 for (i
= zsl
->level
; i
< level
; i
++) {
4997 update
[i
] = zsl
->header
;
4998 update
[i
]->span
[i
-1] = zsl
->length
;
5002 x
= zslCreateNode(level
,score
,obj
);
5003 for (i
= 0; i
< level
; i
++) {
5004 x
->forward
[i
] = update
[i
]->forward
[i
];
5005 update
[i
]->forward
[i
] = x
;
5007 /* update span covered by update[i] as x is inserted here */
5009 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5010 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5014 /* increment span for untouched levels */
5015 for (i
= level
; i
< zsl
->level
; i
++) {
5016 update
[i
]->span
[i
-1]++;
5019 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5021 x
->forward
[0]->backward
= x
;
5027 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5028 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5030 for (i
= 0; i
< zsl
->level
; i
++) {
5031 if (update
[i
]->forward
[i
] == x
) {
5033 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5035 update
[i
]->forward
[i
] = x
->forward
[i
];
5037 /* invariant: i > 0, because update[0]->forward[0]
5038 * is always equal to x */
5039 update
[i
]->span
[i
-1] -= 1;
5042 if (x
->forward
[0]) {
5043 x
->forward
[0]->backward
= x
->backward
;
5045 zsl
->tail
= x
->backward
;
5047 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5052 /* Delete an element with matching score/object from the skiplist. */
5053 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5054 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5058 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5059 while (x
->forward
[i
] &&
5060 (x
->forward
[i
]->score
< score
||
5061 (x
->forward
[i
]->score
== score
&&
5062 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5066 /* We may have multiple elements with the same score, what we need
5067 * is to find the element with both the right score and object. */
5069 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5070 zslDeleteNode(zsl
, x
, update
);
5074 return 0; /* not found */
5076 return 0; /* not found */
5079 /* Delete all the elements with score between min and max from the skiplist.
5080 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5081 * Note that this function takes the reference to the hash table view of the
5082 * sorted set, in order to remove the elements from the hash table too. */
5083 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5084 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5085 unsigned long removed
= 0;
5089 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5090 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5094 /* We may have multiple elements with the same score, what we need
5095 * is to find the element with both the right score and object. */
5097 while (x
&& x
->score
<= max
) {
5098 zskiplistNode
*next
= x
->forward
[0];
5099 zslDeleteNode(zsl
, x
, update
);
5100 dictDelete(dict
,x
->obj
);
5105 return removed
; /* not found */
5108 /* Delete all the elements with rank between start and end from the skiplist.
5109 * Start and end are inclusive. Note that start and end need to be 1-based */
5110 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5111 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5112 unsigned long traversed
= 0, removed
= 0;
5116 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5117 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5118 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5126 while (x
&& traversed
<= end
) {
5127 zskiplistNode
*next
= x
->forward
[0];
5128 zslDeleteNode(zsl
, x
, update
);
5129 dictDelete(dict
,x
->obj
);
5138 /* Find the first node having a score equal or greater than the specified one.
5139 * Returns NULL if there is no match. */
5140 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5145 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5146 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5149 /* We may have multiple elements with the same score, what we need
5150 * is to find the element with both the right score and object. */
5151 return x
->forward
[0];
5154 /* Find the rank for an element by both score and key.
5155 * Returns 0 when the element cannot be found, rank otherwise.
5156 * Note that the rank is 1-based due to the span of zsl->header to the
5158 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5160 unsigned long rank
= 0;
5164 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5165 while (x
->forward
[i
] &&
5166 (x
->forward
[i
]->score
< score
||
5167 (x
->forward
[i
]->score
== score
&&
5168 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5169 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5173 /* x might be equal to zsl->header, so test if obj is non-NULL */
5174 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5181 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5182 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5184 unsigned long traversed
= 0;
5188 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5189 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5191 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5194 if (traversed
== rank
) {
5201 /* The actual Z-commands implementations */
5203 /* This generic command implements both ZADD and ZINCRBY.
5204 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5205 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5206 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5211 zsetobj
= lookupKeyWrite(c
->db
,key
);
5212 if (zsetobj
== NULL
) {
5213 zsetobj
= createZsetObject();
5214 dictAdd(c
->db
->dict
,key
,zsetobj
);
5217 if (zsetobj
->type
!= REDIS_ZSET
) {
5218 addReply(c
,shared
.wrongtypeerr
);
5224 /* Ok now since we implement both ZADD and ZINCRBY here the code
5225 * needs to handle the two different conditions. It's all about setting
5226 * '*score', that is, the new score to set, to the right value. */
5227 score
= zmalloc(sizeof(double));
5231 /* Read the old score. If the element was not present starts from 0 */
5232 de
= dictFind(zs
->dict
,ele
);
5234 double *oldscore
= dictGetEntryVal(de
);
5235 *score
= *oldscore
+ scoreval
;
5243 /* What follows is a simple remove and re-insert operation that is common
5244 * to both ZADD and ZINCRBY... */
5245 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5246 /* case 1: New element */
5247 incrRefCount(ele
); /* added to hash */
5248 zslInsert(zs
->zsl
,*score
,ele
);
5249 incrRefCount(ele
); /* added to skiplist */
5252 addReplyDouble(c
,*score
);
5254 addReply(c
,shared
.cone
);
5259 /* case 2: Score update operation */
5260 de
= dictFind(zs
->dict
,ele
);
5261 redisAssert(de
!= NULL
);
5262 oldscore
= dictGetEntryVal(de
);
5263 if (*score
!= *oldscore
) {
5266 /* Remove and insert the element in the skip list with new score */
5267 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5268 redisAssert(deleted
!= 0);
5269 zslInsert(zs
->zsl
,*score
,ele
);
5271 /* Update the score in the hash table */
5272 dictReplace(zs
->dict
,ele
,score
);
5278 addReplyDouble(c
,*score
);
5280 addReply(c
,shared
.czero
);
5284 static void zaddCommand(redisClient
*c
) {
5287 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5288 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5291 static void zincrbyCommand(redisClient
*c
) {
5294 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5295 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5298 static void zremCommand(redisClient
*c
) {
5305 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5306 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5309 de
= dictFind(zs
->dict
,c
->argv
[2]);
5311 addReply(c
,shared
.czero
);
5314 /* Delete from the skiplist */
5315 oldscore
= dictGetEntryVal(de
);
5316 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5317 redisAssert(deleted
!= 0);
5319 /* Delete from the hash table */
5320 dictDelete(zs
->dict
,c
->argv
[2]);
5321 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5323 addReply(c
,shared
.cone
);
5326 static void zremrangebyscoreCommand(redisClient
*c
) {
5327 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5328 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5333 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5334 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5337 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5338 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5339 server
.dirty
+= deleted
;
5340 addReplyLong(c
,deleted
);
5343 static void zremrangebyrankCommand(redisClient
*c
) {
5344 int start
= atoi(c
->argv
[2]->ptr
);
5345 int end
= atoi(c
->argv
[3]->ptr
);
5351 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5352 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5354 llen
= zs
->zsl
->length
;
5356 /* convert negative indexes */
5357 if (start
< 0) start
= llen
+start
;
5358 if (end
< 0) end
= llen
+end
;
5359 if (start
< 0) start
= 0;
5360 if (end
< 0) end
= 0;
5362 /* indexes sanity checks */
5363 if (start
> end
|| start
>= llen
) {
5364 addReply(c
,shared
.czero
);
5367 if (end
>= llen
) end
= llen
-1;
5369 /* increment start and end because zsl*Rank functions
5370 * use 1-based rank */
5371 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5372 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5373 server
.dirty
+= deleted
;
5374 addReplyLong(c
, deleted
);
5382 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5383 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5384 unsigned long size1
, size2
;
5385 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5386 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5387 return size1
- size2
;
5390 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5398 /* expect zsetnum input keys to be given */
5399 zsetnum
= atoi(c
->argv
[2]->ptr
);
5401 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5405 /* test if the expected number of keys would overflow */
5406 if (3+zsetnum
> c
->argc
) {
5407 addReply(c
,shared
.syntaxerr
);
5411 /* read keys to be used for input */
5412 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5413 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5414 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5418 if (zsetobj
->type
!= REDIS_ZSET
) {
5420 addReply(c
,shared
.wrongtypeerr
);
5423 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5426 /* default all weights to 1 */
5427 src
[i
].weight
= 1.0;
5430 /* parse optional extra arguments */
5432 int remaining
= c
->argc
-j
;
5435 if (!strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5437 if (remaining
< zsetnum
) {
5439 addReplySds(c
,sdsnew("-ERR not enough weights for ZUNION/ZINTER\r\n"));
5442 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5443 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5447 addReply(c
,shared
.syntaxerr
);
5453 dstobj
= createZsetObject();
5454 dstzset
= dstobj
->ptr
;
5456 if (op
== REDIS_OP_INTER
) {
5457 /* sort sets from the smallest to largest, this will improve our
5458 * algorithm's performance */
5459 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5461 /* skip going over all entries if the smallest zset is NULL or empty */
5462 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5463 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5464 * from small to large, all src[i > 0].dict are non-empty too */
5465 di
= dictGetIterator(src
[0].dict
);
5466 while((de
= dictNext(di
)) != NULL
) {
5467 double *score
= zmalloc(sizeof(double));
5470 for (j
= 0; j
< zsetnum
; j
++) {
5471 dictEntry
*other
= (j
== 0) ? de
: dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5473 *score
= *score
+ src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5479 /* skip entry when not present in every source dict */
5483 robj
*o
= dictGetEntryKey(de
);
5484 dictAdd(dstzset
->dict
,o
,score
);
5485 incrRefCount(o
); /* added to dictionary */
5486 zslInsert(dstzset
->zsl
,*score
,o
);
5487 incrRefCount(o
); /* added to skiplist */
5490 dictReleaseIterator(di
);
5492 } else if (op
== REDIS_OP_UNION
) {
5493 for (i
= 0; i
< zsetnum
; i
++) {
5494 if (!src
[i
].dict
) continue;
5496 di
= dictGetIterator(src
[i
].dict
);
5497 while((de
= dictNext(di
)) != NULL
) {
5498 /* skip key when already processed */
5499 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5501 double *score
= zmalloc(sizeof(double));
5503 for (j
= 0; j
< zsetnum
; j
++) {
5504 if (!src
[j
].dict
) continue;
5506 dictEntry
*other
= (i
== j
) ? de
: dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5508 *score
= *score
+ src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5512 robj
*o
= dictGetEntryKey(de
);
5513 dictAdd(dstzset
->dict
,o
,score
);
5514 incrRefCount(o
); /* added to dictionary */
5515 zslInsert(dstzset
->zsl
,*score
,o
);
5516 incrRefCount(o
); /* added to skiplist */
5518 dictReleaseIterator(di
);
5521 /* unknown operator */
5522 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5525 deleteKey(c
->db
,dstkey
);
5526 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5527 incrRefCount(dstkey
);
5529 addReplyLong(c
, dstzset
->zsl
->length
);
5534 static void zunionCommand(redisClient
*c
) {
5535 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5538 static void zinterCommand(redisClient
*c
) {
5539 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5542 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5544 int start
= atoi(c
->argv
[2]->ptr
);
5545 int end
= atoi(c
->argv
[3]->ptr
);
5554 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5556 } else if (c
->argc
>= 5) {
5557 addReply(c
,shared
.syntaxerr
);
5561 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5562 checkType(c
,o
,REDIS_ZSET
)) return;
5567 /* convert negative indexes */
5568 if (start
< 0) start
= llen
+start
;
5569 if (end
< 0) end
= llen
+end
;
5570 if (start
< 0) start
= 0;
5571 if (end
< 0) end
= 0;
5573 /* indexes sanity checks */
5574 if (start
> end
|| start
>= llen
) {
5575 /* Out of range start or start > end result in empty list */
5576 addReply(c
,shared
.emptymultibulk
);
5579 if (end
>= llen
) end
= llen
-1;
5580 rangelen
= (end
-start
)+1;
5582 /* check if starting point is trivial, before searching
5583 * the element in log(N) time */
5585 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5588 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5591 /* Return the result in form of a multi-bulk reply */
5592 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5593 withscores
? (rangelen
*2) : rangelen
));
5594 for (j
= 0; j
< rangelen
; j
++) {
5596 addReplyBulk(c
,ele
);
5598 addReplyDouble(c
,ln
->score
);
5599 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5603 static void zrangeCommand(redisClient
*c
) {
5604 zrangeGenericCommand(c
,0);
5607 static void zrevrangeCommand(redisClient
*c
) {
5608 zrangeGenericCommand(c
,1);
5611 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5612 * If justcount is non-zero, just the count is returned. */
5613 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5616 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5617 int offset
= 0, limit
= -1;
5621 /* Parse the min-max interval. If one of the values is prefixed
5622 * by the "(" character, it's considered "open". For instance
5623 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5624 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5625 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5626 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5629 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5631 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5632 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5635 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5638 /* Parse "WITHSCORES": note that if the command was called with
5639 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5640 * enter the following paths to parse WITHSCORES and LIMIT. */
5641 if (c
->argc
== 5 || c
->argc
== 8) {
5642 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5647 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5651 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5656 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5657 addReply(c
,shared
.syntaxerr
);
5659 } else if (c
->argc
== (7 + withscores
)) {
5660 offset
= atoi(c
->argv
[5]->ptr
);
5661 limit
= atoi(c
->argv
[6]->ptr
);
5662 if (offset
< 0) offset
= 0;
5665 /* Ok, lookup the key and get the range */
5666 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5668 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5670 if (o
->type
!= REDIS_ZSET
) {
5671 addReply(c
,shared
.wrongtypeerr
);
5673 zset
*zsetobj
= o
->ptr
;
5674 zskiplist
*zsl
= zsetobj
->zsl
;
5676 robj
*ele
, *lenobj
= NULL
;
5677 unsigned long rangelen
= 0;
5679 /* Get the first node with the score >= min, or with
5680 * score > min if 'minex' is true. */
5681 ln
= zslFirstWithScore(zsl
,min
);
5682 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5685 /* No element matching the speciifed interval */
5686 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5690 /* We don't know in advance how many matching elements there
5691 * are in the list, so we push this object that will represent
5692 * the multi-bulk length in the output buffer, and will "fix"
5695 lenobj
= createObject(REDIS_STRING
,NULL
);
5697 decrRefCount(lenobj
);
5700 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5703 ln
= ln
->forward
[0];
5706 if (limit
== 0) break;
5709 addReplyBulk(c
,ele
);
5711 addReplyDouble(c
,ln
->score
);
5713 ln
= ln
->forward
[0];
5715 if (limit
> 0) limit
--;
5718 addReplyLong(c
,(long)rangelen
);
5720 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5721 withscores
? (rangelen
*2) : rangelen
);
5727 static void zrangebyscoreCommand(redisClient
*c
) {
5728 genericZrangebyscoreCommand(c
,0);
5731 static void zcountCommand(redisClient
*c
) {
5732 genericZrangebyscoreCommand(c
,1);
5735 static void zcardCommand(redisClient
*c
) {
5739 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5740 checkType(c
,o
,REDIS_ZSET
)) return;
5743 addReplyUlong(c
,zs
->zsl
->length
);
5746 static void zscoreCommand(redisClient
*c
) {
5751 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5752 checkType(c
,o
,REDIS_ZSET
)) return;
5755 de
= dictFind(zs
->dict
,c
->argv
[2]);
5757 addReply(c
,shared
.nullbulk
);
5759 double *score
= dictGetEntryVal(de
);
5761 addReplyDouble(c
,*score
);
5765 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5773 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5774 checkType(c
,o
,REDIS_ZSET
)) return;
5778 de
= dictFind(zs
->dict
,c
->argv
[2]);
5780 addReply(c
,shared
.nullbulk
);
5784 score
= dictGetEntryVal(de
);
5785 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5788 addReplyLong(c
, zsl
->length
- rank
);
5790 addReplyLong(c
, rank
-1);
5793 addReply(c
,shared
.nullbulk
);
5797 static void zrankCommand(redisClient
*c
) {
5798 zrankGenericCommand(c
, 0);
5801 static void zrevrankCommand(redisClient
*c
) {
5802 zrankGenericCommand(c
, 1);
5805 /* =================================== Hashes =============================== */
5806 static void hsetCommand(redisClient
*c
) {
5808 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5811 o
= createHashObject();
5812 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5813 incrRefCount(c
->argv
[1]);
5815 if (o
->type
!= REDIS_HASH
) {
5816 addReply(c
,shared
.wrongtypeerr
);
5820 /* We want to convert the zipmap into an hash table right now if the
5821 * entry to be added is too big. Note that we check if the object
5822 * is integer encoded before to try fetching the length in the test below.
5823 * This is because integers are small, but currently stringObjectLen()
5824 * performs a slow conversion: not worth it. */
5825 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5826 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5827 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5828 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5829 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5831 convertToRealHash(o
);
5834 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5835 unsigned char *zm
= o
->ptr
;
5836 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5838 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5839 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
5840 decrRefCount(valobj
);
5843 /* And here there is the second check for hash conversion...
5844 * we want to do it only if the operation was not just an update as
5845 * zipmapLen() is O(N). */
5846 if (!update
&& zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
5847 convertToRealHash(o
);
5849 tryObjectEncoding(c
->argv
[2]);
5850 /* note that c->argv[3] is already encoded, as the latest arg
5851 * of a bulk command is always integer encoded if possible. */
5852 if (dictAdd(o
->ptr
,c
->argv
[2],c
->argv
[3]) == DICT_OK
) {
5853 incrRefCount(c
->argv
[2]);
5857 incrRefCount(c
->argv
[3]);
5860 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
5863 static void hgetCommand(redisClient
*c
) {
5866 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5867 checkType(c
,o
,REDIS_HASH
)) return;
5869 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5870 unsigned char *zm
= o
->ptr
;
5875 field
= getDecodedObject(c
->argv
[2]);
5876 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
5877 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
5878 addReplySds(c
,sdsnewlen(val
,vlen
));
5879 addReply(c
,shared
.crlf
);
5880 decrRefCount(field
);
5883 addReply(c
,shared
.nullbulk
);
5884 decrRefCount(field
);
5888 struct dictEntry
*de
;
5890 de
= dictFind(o
->ptr
,c
->argv
[2]);
5892 addReply(c
,shared
.nullbulk
);
5894 robj
*e
= dictGetEntryVal(de
);
5901 static void hdelCommand(redisClient
*c
) {
5905 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5906 checkType(c
,o
,REDIS_HASH
)) return;
5908 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5909 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
5910 (unsigned char*) c
->argv
[2]->ptr
,
5911 sdslen(c
->argv
[2]->ptr
), &deleted
);
5913 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
5915 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
5918 static void hlenCommand(redisClient
*c
) {
5922 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5923 checkType(c
,o
,REDIS_HASH
)) return;
5925 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
5926 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
5927 addReplyUlong(c
,len
);
5930 #define REDIS_GETALL_KEYS 1
5931 #define REDIS_GETALL_VALS 2
5932 static void genericHgetallCommand(redisClient
*c
, int flags
) {
5934 unsigned long count
= 0;
5936 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
5937 || checkType(c
,o
,REDIS_HASH
)) return;
5939 lenobj
= createObject(REDIS_STRING
,NULL
);
5941 decrRefCount(lenobj
);
5943 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5944 unsigned char *p
= zipmapRewind(o
->ptr
);
5945 unsigned char *field
, *val
;
5946 unsigned int flen
, vlen
;
5948 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
5951 if (flags
& REDIS_GETALL_KEYS
) {
5952 aux
= createStringObject((char*)field
,flen
);
5953 addReplyBulk(c
,aux
);
5957 if (flags
& REDIS_GETALL_VALS
) {
5958 aux
= createStringObject((char*)val
,vlen
);
5959 addReplyBulk(c
,aux
);
5965 dictIterator
*di
= dictGetIterator(o
->ptr
);
5968 while((de
= dictNext(di
)) != NULL
) {
5969 robj
*fieldobj
= dictGetEntryKey(de
);
5970 robj
*valobj
= dictGetEntryVal(de
);
5972 if (flags
& REDIS_GETALL_KEYS
) {
5973 addReplyBulk(c
,fieldobj
);
5976 if (flags
& REDIS_GETALL_VALS
) {
5977 addReplyBulk(c
,valobj
);
5981 dictReleaseIterator(di
);
5983 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
5986 static void hkeysCommand(redisClient
*c
) {
5987 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
5990 static void hvalsCommand(redisClient
*c
) {
5991 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
5994 static void hgetallCommand(redisClient
*c
) {
5995 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
5998 static void convertToRealHash(robj
*o
) {
5999 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6000 unsigned int klen
, vlen
;
6001 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6003 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6004 p
= zipmapRewind(zm
);
6005 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6006 robj
*keyobj
, *valobj
;
6008 keyobj
= createStringObject((char*)key
,klen
);
6009 valobj
= createStringObject((char*)val
,vlen
);
6010 tryObjectEncoding(keyobj
);
6011 tryObjectEncoding(valobj
);
6012 dictAdd(dict
,keyobj
,valobj
);
6014 o
->encoding
= REDIS_ENCODING_HT
;
6019 /* ========================= Non type-specific commands ==================== */
6021 static void flushdbCommand(redisClient
*c
) {
6022 server
.dirty
+= dictSize(c
->db
->dict
);
6023 dictEmpty(c
->db
->dict
);
6024 dictEmpty(c
->db
->expires
);
6025 addReply(c
,shared
.ok
);
6028 static void flushallCommand(redisClient
*c
) {
6029 server
.dirty
+= emptyDb();
6030 addReply(c
,shared
.ok
);
6031 rdbSave(server
.dbfilename
);
6035 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6036 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6038 so
->pattern
= pattern
;
6042 /* Return the value associated to the key with a name obtained
6043 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6044 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6048 int prefixlen
, sublen
, postfixlen
;
6049 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6053 char buf
[REDIS_SORTKEY_MAX
+1];
6056 /* If the pattern is "#" return the substitution object itself in order
6057 * to implement the "SORT ... GET #" feature. */
6058 spat
= pattern
->ptr
;
6059 if (spat
[0] == '#' && spat
[1] == '\0') {
6063 /* The substitution object may be specially encoded. If so we create
6064 * a decoded object on the fly. Otherwise getDecodedObject will just
6065 * increment the ref count, that we'll decrement later. */
6066 subst
= getDecodedObject(subst
);
6069 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6070 p
= strchr(spat
,'*');
6072 decrRefCount(subst
);
6077 sublen
= sdslen(ssub
);
6078 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6079 memcpy(keyname
.buf
,spat
,prefixlen
);
6080 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6081 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6082 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6083 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6085 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6086 decrRefCount(subst
);
6088 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6089 return lookupKeyRead(db
,&keyobj
);
6092 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6093 * the additional parameter is not standard but a BSD-specific we have to
6094 * pass sorting parameters via the global 'server' structure */
6095 static int sortCompare(const void *s1
, const void *s2
) {
6096 const redisSortObject
*so1
= s1
, *so2
= s2
;
6099 if (!server
.sort_alpha
) {
6100 /* Numeric sorting. Here it's trivial as we precomputed scores */
6101 if (so1
->u
.score
> so2
->u
.score
) {
6103 } else if (so1
->u
.score
< so2
->u
.score
) {
6109 /* Alphanumeric sorting */
6110 if (server
.sort_bypattern
) {
6111 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6112 /* At least one compare object is NULL */
6113 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6115 else if (so1
->u
.cmpobj
== NULL
)
6120 /* We have both the objects, use strcoll */
6121 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6124 /* Compare elements directly */
6127 dec1
= getDecodedObject(so1
->obj
);
6128 dec2
= getDecodedObject(so2
->obj
);
6129 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6134 return server
.sort_desc
? -cmp
: cmp
;
6137 /* The SORT command is the most complex command in Redis. Warning: this code
6138 * is optimized for speed and a bit less for readability */
6139 static void sortCommand(redisClient
*c
) {
6142 int desc
= 0, alpha
= 0;
6143 int limit_start
= 0, limit_count
= -1, start
, end
;
6144 int j
, dontsort
= 0, vectorlen
;
6145 int getop
= 0; /* GET operation counter */
6146 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6147 redisSortObject
*vector
; /* Resulting vector to sort */
6149 /* Lookup the key to sort. It must be of the right types */
6150 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6151 if (sortval
== NULL
) {
6152 addReply(c
,shared
.nullmultibulk
);
6155 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6156 sortval
->type
!= REDIS_ZSET
)
6158 addReply(c
,shared
.wrongtypeerr
);
6162 /* Create a list of operations to perform for every sorted element.
6163 * Operations can be GET/DEL/INCR/DECR */
6164 operations
= listCreate();
6165 listSetFreeMethod(operations
,zfree
);
6168 /* Now we need to protect sortval incrementing its count, in the future
6169 * SORT may have options able to overwrite/delete keys during the sorting
6170 * and the sorted key itself may get destroied */
6171 incrRefCount(sortval
);
6173 /* The SORT command has an SQL-alike syntax, parse it */
6174 while(j
< c
->argc
) {
6175 int leftargs
= c
->argc
-j
-1;
6176 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6178 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6180 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6182 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6183 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6184 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6186 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6187 storekey
= c
->argv
[j
+1];
6189 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6190 sortby
= c
->argv
[j
+1];
6191 /* If the BY pattern does not contain '*', i.e. it is constant,
6192 * we don't need to sort nor to lookup the weight keys. */
6193 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6195 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6196 listAddNodeTail(operations
,createSortOperation(
6197 REDIS_SORT_GET
,c
->argv
[j
+1]));
6201 decrRefCount(sortval
);
6202 listRelease(operations
);
6203 addReply(c
,shared
.syntaxerr
);
6209 /* Load the sorting vector with all the objects to sort */
6210 switch(sortval
->type
) {
6211 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6212 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6213 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6214 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6216 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6219 if (sortval
->type
== REDIS_LIST
) {
6220 list
*list
= sortval
->ptr
;
6224 listRewind(list
,&li
);
6225 while((ln
= listNext(&li
))) {
6226 robj
*ele
= ln
->value
;
6227 vector
[j
].obj
= ele
;
6228 vector
[j
].u
.score
= 0;
6229 vector
[j
].u
.cmpobj
= NULL
;
6237 if (sortval
->type
== REDIS_SET
) {
6240 zset
*zs
= sortval
->ptr
;
6244 di
= dictGetIterator(set
);
6245 while((setele
= dictNext(di
)) != NULL
) {
6246 vector
[j
].obj
= dictGetEntryKey(setele
);
6247 vector
[j
].u
.score
= 0;
6248 vector
[j
].u
.cmpobj
= NULL
;
6251 dictReleaseIterator(di
);
6253 redisAssert(j
== vectorlen
);
6255 /* Now it's time to load the right scores in the sorting vector */
6256 if (dontsort
== 0) {
6257 for (j
= 0; j
< vectorlen
; j
++) {
6261 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6262 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6264 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6266 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6267 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6269 /* Don't need to decode the object if it's
6270 * integer-encoded (the only encoding supported) so
6271 * far. We can just cast it */
6272 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6273 vector
[j
].u
.score
= (long)byval
->ptr
;
6275 redisAssert(1 != 1);
6280 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6281 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6283 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6284 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6286 redisAssert(1 != 1);
6293 /* We are ready to sort the vector... perform a bit of sanity check
6294 * on the LIMIT option too. We'll use a partial version of quicksort. */
6295 start
= (limit_start
< 0) ? 0 : limit_start
;
6296 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6297 if (start
>= vectorlen
) {
6298 start
= vectorlen
-1;
6301 if (end
>= vectorlen
) end
= vectorlen
-1;
6303 if (dontsort
== 0) {
6304 server
.sort_desc
= desc
;
6305 server
.sort_alpha
= alpha
;
6306 server
.sort_bypattern
= sortby
? 1 : 0;
6307 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6308 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6310 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6313 /* Send command output to the output buffer, performing the specified
6314 * GET/DEL/INCR/DECR operations if any. */
6315 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6316 if (storekey
== NULL
) {
6317 /* STORE option not specified, sent the sorting result to client */
6318 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6319 for (j
= start
; j
<= end
; j
++) {
6323 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6324 listRewind(operations
,&li
);
6325 while((ln
= listNext(&li
))) {
6326 redisSortOperation
*sop
= ln
->value
;
6327 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6330 if (sop
->type
== REDIS_SORT_GET
) {
6331 if (!val
|| val
->type
!= REDIS_STRING
) {
6332 addReply(c
,shared
.nullbulk
);
6334 addReplyBulk(c
,val
);
6337 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6342 robj
*listObject
= createListObject();
6343 list
*listPtr
= (list
*) listObject
->ptr
;
6345 /* STORE option specified, set the sorting result as a List object */
6346 for (j
= start
; j
<= end
; j
++) {
6351 listAddNodeTail(listPtr
,vector
[j
].obj
);
6352 incrRefCount(vector
[j
].obj
);
6354 listRewind(operations
,&li
);
6355 while((ln
= listNext(&li
))) {
6356 redisSortOperation
*sop
= ln
->value
;
6357 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6360 if (sop
->type
== REDIS_SORT_GET
) {
6361 if (!val
|| val
->type
!= REDIS_STRING
) {
6362 listAddNodeTail(listPtr
,createStringObject("",0));
6364 listAddNodeTail(listPtr
,val
);
6368 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6372 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6373 incrRefCount(storekey
);
6375 /* Note: we add 1 because the DB is dirty anyway since even if the
6376 * SORT result is empty a new key is set and maybe the old content
6378 server
.dirty
+= 1+outputlen
;
6379 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6383 decrRefCount(sortval
);
6384 listRelease(operations
);
6385 for (j
= 0; j
< vectorlen
; j
++) {
6386 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6387 decrRefCount(vector
[j
].u
.cmpobj
);
6392 /* Convert an amount of bytes into a human readable string in the form
6393 * of 100B, 2G, 100M, 4K, and so forth. */
6394 static void bytesToHuman(char *s
, unsigned long long n
) {
6399 sprintf(s
,"%lluB",n
);
6401 } else if (n
< (1024*1024)) {
6402 d
= (double)n
/(1024);
6403 sprintf(s
,"%.2fK",d
);
6404 } else if (n
< (1024LL*1024*1024)) {
6405 d
= (double)n
/(1024*1024);
6406 sprintf(s
,"%.2fM",d
);
6407 } else if (n
< (1024LL*1024*1024*1024)) {
6408 d
= (double)n
/(1024LL*1024*1024);
6409 sprintf(s
,"%.2fG",d
);
6413 /* Create the string returned by the INFO command. This is decoupled
6414 * by the INFO command itself as we need to report the same information
6415 * on memory corruption problems. */
6416 static sds
genRedisInfoString(void) {
6418 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6422 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
6423 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
6425 bytesToHuman(hmem
,zmalloc_used_memory());
6426 info
= sdscatprintf(sdsempty(),
6427 "redis_version:%s\r\n"
6429 "multiplexing_api:%s\r\n"
6430 "process_id:%ld\r\n"
6431 "uptime_in_seconds:%ld\r\n"
6432 "uptime_in_days:%ld\r\n"
6433 "connected_clients:%d\r\n"
6434 "connected_slaves:%d\r\n"
6435 "blocked_clients:%d\r\n"
6436 "used_memory:%zu\r\n"
6437 "used_memory_human:%s\r\n"
6438 "changes_since_last_save:%lld\r\n"
6439 "bgsave_in_progress:%d\r\n"
6440 "last_save_time:%ld\r\n"
6441 "bgrewriteaof_in_progress:%d\r\n"
6442 "total_connections_received:%lld\r\n"
6443 "total_commands_processed:%lld\r\n"
6444 "hash_max_zipmap_entries:%ld\r\n"
6445 "hash_max_zipmap_value:%ld\r\n"
6449 (sizeof(long) == 8) ? "64" : "32",
6454 listLength(server
.clients
)-listLength(server
.slaves
),
6455 listLength(server
.slaves
),
6456 server
.blpop_blocked_clients
,
6457 zmalloc_used_memory(),
6460 server
.bgsavechildpid
!= -1,
6462 server
.bgrewritechildpid
!= -1,
6463 server
.stat_numconnections
,
6464 server
.stat_numcommands
,
6465 server
.hash_max_zipmap_entries
,
6466 server
.hash_max_zipmap_value
,
6467 server
.vm_enabled
!= 0,
6468 server
.masterhost
== NULL
? "master" : "slave"
6470 if (server
.masterhost
) {
6471 info
= sdscatprintf(info
,
6472 "master_host:%s\r\n"
6473 "master_port:%d\r\n"
6474 "master_link_status:%s\r\n"
6475 "master_last_io_seconds_ago:%d\r\n"
6478 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6480 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6483 if (server
.vm_enabled
) {
6485 info
= sdscatprintf(info
,
6486 "vm_conf_max_memory:%llu\r\n"
6487 "vm_conf_page_size:%llu\r\n"
6488 "vm_conf_pages:%llu\r\n"
6489 "vm_stats_used_pages:%llu\r\n"
6490 "vm_stats_swapped_objects:%llu\r\n"
6491 "vm_stats_swappin_count:%llu\r\n"
6492 "vm_stats_swappout_count:%llu\r\n"
6493 "vm_stats_io_newjobs_len:%lu\r\n"
6494 "vm_stats_io_processing_len:%lu\r\n"
6495 "vm_stats_io_processed_len:%lu\r\n"
6496 "vm_stats_io_active_threads:%lu\r\n"
6497 "vm_stats_blocked_clients:%lu\r\n"
6498 ,(unsigned long long) server
.vm_max_memory
,
6499 (unsigned long long) server
.vm_page_size
,
6500 (unsigned long long) server
.vm_pages
,
6501 (unsigned long long) server
.vm_stats_used_pages
,
6502 (unsigned long long) server
.vm_stats_swapped_objects
,
6503 (unsigned long long) server
.vm_stats_swapins
,
6504 (unsigned long long) server
.vm_stats_swapouts
,
6505 (unsigned long) listLength(server
.io_newjobs
),
6506 (unsigned long) listLength(server
.io_processing
),
6507 (unsigned long) listLength(server
.io_processed
),
6508 (unsigned long) server
.io_active_threads
,
6509 (unsigned long) server
.vm_blocked_clients
6513 for (j
= 0; j
< server
.dbnum
; j
++) {
6514 long long keys
, vkeys
;
6516 keys
= dictSize(server
.db
[j
].dict
);
6517 vkeys
= dictSize(server
.db
[j
].expires
);
6518 if (keys
|| vkeys
) {
6519 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6526 static void infoCommand(redisClient
*c
) {
6527 sds info
= genRedisInfoString();
6528 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6529 (unsigned long)sdslen(info
)));
6530 addReplySds(c
,info
);
6531 addReply(c
,shared
.crlf
);
6534 static void monitorCommand(redisClient
*c
) {
6535 /* ignore MONITOR if aleady slave or in monitor mode */
6536 if (c
->flags
& REDIS_SLAVE
) return;
6538 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6540 listAddNodeTail(server
.monitors
,c
);
6541 addReply(c
,shared
.ok
);
6544 /* ================================= Expire ================================= */
6545 static int removeExpire(redisDb
*db
, robj
*key
) {
6546 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6553 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6554 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6562 /* Return the expire time of the specified key, or -1 if no expire
6563 * is associated with this key (i.e. the key is non volatile) */
6564 static time_t getExpire(redisDb
*db
, robj
*key
) {
6567 /* No expire? return ASAP */
6568 if (dictSize(db
->expires
) == 0 ||
6569 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6571 return (time_t) dictGetEntryVal(de
);
6574 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6578 /* No expire? return ASAP */
6579 if (dictSize(db
->expires
) == 0 ||
6580 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6582 /* Lookup the expire */
6583 when
= (time_t) dictGetEntryVal(de
);
6584 if (time(NULL
) <= when
) return 0;
6586 /* Delete the key */
6587 dictDelete(db
->expires
,key
);
6588 return dictDelete(db
->dict
,key
) == DICT_OK
;
6591 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6594 /* No expire? return ASAP */
6595 if (dictSize(db
->expires
) == 0 ||
6596 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6598 /* Delete the key */
6600 dictDelete(db
->expires
,key
);
6601 return dictDelete(db
->dict
,key
) == DICT_OK
;
6604 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6607 de
= dictFind(c
->db
->dict
,key
);
6609 addReply(c
,shared
.czero
);
6613 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6614 addReply(c
, shared
.cone
);
6617 time_t when
= time(NULL
)+seconds
;
6618 if (setExpire(c
->db
,key
,when
)) {
6619 addReply(c
,shared
.cone
);
6622 addReply(c
,shared
.czero
);
6628 static void expireCommand(redisClient
*c
) {
6629 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6632 static void expireatCommand(redisClient
*c
) {
6633 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6636 static void ttlCommand(redisClient
*c
) {
6640 expire
= getExpire(c
->db
,c
->argv
[1]);
6642 ttl
= (int) (expire
-time(NULL
));
6643 if (ttl
< 0) ttl
= -1;
6645 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6648 /* ================================ MULTI/EXEC ============================== */
6650 /* Client state initialization for MULTI/EXEC */
6651 static void initClientMultiState(redisClient
*c
) {
6652 c
->mstate
.commands
= NULL
;
6653 c
->mstate
.count
= 0;
6656 /* Release all the resources associated with MULTI/EXEC state */
6657 static void freeClientMultiState(redisClient
*c
) {
6660 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6662 multiCmd
*mc
= c
->mstate
.commands
+j
;
6664 for (i
= 0; i
< mc
->argc
; i
++)
6665 decrRefCount(mc
->argv
[i
]);
6668 zfree(c
->mstate
.commands
);
6671 /* Add a new command into the MULTI commands queue */
6672 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6676 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6677 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6678 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6681 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6682 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6683 for (j
= 0; j
< c
->argc
; j
++)
6684 incrRefCount(mc
->argv
[j
]);
6688 static void multiCommand(redisClient
*c
) {
6689 c
->flags
|= REDIS_MULTI
;
6690 addReply(c
,shared
.ok
);
6693 static void discardCommand(redisClient
*c
) {
6694 if (!(c
->flags
& REDIS_MULTI
)) {
6695 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6699 freeClientMultiState(c
);
6700 initClientMultiState(c
);
6701 c
->flags
&= (~REDIS_MULTI
);
6702 addReply(c
,shared
.ok
);
6705 static void execCommand(redisClient
*c
) {
6710 if (!(c
->flags
& REDIS_MULTI
)) {
6711 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6715 orig_argv
= c
->argv
;
6716 orig_argc
= c
->argc
;
6717 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6718 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6719 c
->argc
= c
->mstate
.commands
[j
].argc
;
6720 c
->argv
= c
->mstate
.commands
[j
].argv
;
6721 call(c
,c
->mstate
.commands
[j
].cmd
);
6723 c
->argv
= orig_argv
;
6724 c
->argc
= orig_argc
;
6725 freeClientMultiState(c
);
6726 initClientMultiState(c
);
6727 c
->flags
&= (~REDIS_MULTI
);
6730 /* =========================== Blocking Operations ========================= */
6732 /* Currently Redis blocking operations support is limited to list POP ops,
6733 * so the current implementation is not fully generic, but it is also not
6734 * completely specific so it will not require a rewrite to support new
6735 * kind of blocking operations in the future.
6737 * Still it's important to note that list blocking operations can be already
6738 * used as a notification mechanism in order to implement other blocking
6739 * operations at application level, so there must be a very strong evidence
6740 * of usefulness and generality before new blocking operations are implemented.
6742 * This is how the current blocking POP works, we use BLPOP as example:
6743 * - If the user calls BLPOP and the key exists and contains a non empty list
6744 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6745 * if there is not to block.
6746 * - If instead BLPOP is called and the key does not exists or the list is
6747 * empty we need to block. In order to do so we remove the notification for
6748 * new data to read in the client socket (so that we'll not serve new
6749 * requests if the blocking request is not served). Also we put the client
6750 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6751 * blocking for this keys.
6752 * - If a PUSH operation against a key with blocked clients waiting is
6753 * performed, we serve the first in the list: basically instead to push
6754 * the new element inside the list we return it to the (first / oldest)
6755 * blocking client, unblock the client, and remove it form the list.
6757 * The above comment and the source code should be enough in order to understand
6758 * the implementation and modify / fix it later.
6761 /* Set a client in blocking mode for the specified key, with the specified
6763 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6768 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6769 c
->blockingkeysnum
= numkeys
;
6770 c
->blockingto
= timeout
;
6771 for (j
= 0; j
< numkeys
; j
++) {
6772 /* Add the key in the client structure, to map clients -> keys */
6773 c
->blockingkeys
[j
] = keys
[j
];
6774 incrRefCount(keys
[j
]);
6776 /* And in the other "side", to map keys -> clients */
6777 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6781 /* For every key we take a list of clients blocked for it */
6783 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6784 incrRefCount(keys
[j
]);
6785 assert(retval
== DICT_OK
);
6787 l
= dictGetEntryVal(de
);
6789 listAddNodeTail(l
,c
);
6791 /* Mark the client as a blocked client */
6792 c
->flags
|= REDIS_BLOCKED
;
6793 server
.blpop_blocked_clients
++;
6796 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6797 static void unblockClientWaitingData(redisClient
*c
) {
6802 assert(c
->blockingkeys
!= NULL
);
6803 /* The client may wait for multiple keys, so unblock it for every key. */
6804 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6805 /* Remove this client from the list of clients waiting for this key. */
6806 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6808 l
= dictGetEntryVal(de
);
6809 listDelNode(l
,listSearchKey(l
,c
));
6810 /* If the list is empty we need to remove it to avoid wasting memory */
6811 if (listLength(l
) == 0)
6812 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6813 decrRefCount(c
->blockingkeys
[j
]);
6815 /* Cleanup the client structure */
6816 zfree(c
->blockingkeys
);
6817 c
->blockingkeys
= NULL
;
6818 c
->flags
&= (~REDIS_BLOCKED
);
6819 server
.blpop_blocked_clients
--;
6820 /* We want to process data if there is some command waiting
6821 * in the input buffer. Note that this is safe even if
6822 * unblockClientWaitingData() gets called from freeClient() because
6823 * freeClient() will be smart enough to call this function
6824 * *after* c->querybuf was set to NULL. */
6825 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6828 /* This should be called from any function PUSHing into lists.
6829 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6830 * 'ele' is the element pushed.
6832 * If the function returns 0 there was no client waiting for a list push
6835 * If the function returns 1 there was a client waiting for a list push
6836 * against this key, the element was passed to this client thus it's not
6837 * needed to actually add it to the list and the caller should return asap. */
6838 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6839 struct dictEntry
*de
;
6840 redisClient
*receiver
;
6844 de
= dictFind(c
->db
->blockingkeys
,key
);
6845 if (de
== NULL
) return 0;
6846 l
= dictGetEntryVal(de
);
6849 receiver
= ln
->value
;
6851 addReplySds(receiver
,sdsnew("*2\r\n"));
6852 addReplyBulk(receiver
,key
);
6853 addReplyBulk(receiver
,ele
);
6854 unblockClientWaitingData(receiver
);
6858 /* Blocking RPOP/LPOP */
6859 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6864 for (j
= 1; j
< c
->argc
-1; j
++) {
6865 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6867 if (o
->type
!= REDIS_LIST
) {
6868 addReply(c
,shared
.wrongtypeerr
);
6871 list
*list
= o
->ptr
;
6872 if (listLength(list
) != 0) {
6873 /* If the list contains elements fall back to the usual
6874 * non-blocking POP operation */
6875 robj
*argv
[2], **orig_argv
;
6878 /* We need to alter the command arguments before to call
6879 * popGenericCommand() as the command takes a single key. */
6880 orig_argv
= c
->argv
;
6881 orig_argc
= c
->argc
;
6882 argv
[1] = c
->argv
[j
];
6886 /* Also the return value is different, we need to output
6887 * the multi bulk reply header and the key name. The
6888 * "real" command will add the last element (the value)
6889 * for us. If this souds like an hack to you it's just
6890 * because it is... */
6891 addReplySds(c
,sdsnew("*2\r\n"));
6892 addReplyBulk(c
,argv
[1]);
6893 popGenericCommand(c
,where
);
6895 /* Fix the client structure with the original stuff */
6896 c
->argv
= orig_argv
;
6897 c
->argc
= orig_argc
;
6903 /* If the list is empty or the key does not exists we must block */
6904 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6905 if (timeout
> 0) timeout
+= time(NULL
);
6906 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6909 static void blpopCommand(redisClient
*c
) {
6910 blockingPopGenericCommand(c
,REDIS_HEAD
);
6913 static void brpopCommand(redisClient
*c
) {
6914 blockingPopGenericCommand(c
,REDIS_TAIL
);
6917 /* =============================== Replication ============================= */
6919 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6920 ssize_t nwritten
, ret
= size
;
6921 time_t start
= time(NULL
);
6925 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6926 nwritten
= write(fd
,ptr
,size
);
6927 if (nwritten
== -1) return -1;
6931 if ((time(NULL
)-start
) > timeout
) {
6939 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6940 ssize_t nread
, totread
= 0;
6941 time_t start
= time(NULL
);
6945 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6946 nread
= read(fd
,ptr
,size
);
6947 if (nread
== -1) return -1;
6952 if ((time(NULL
)-start
) > timeout
) {
6960 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6967 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6970 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6981 static void syncCommand(redisClient
*c
) {
6982 /* ignore SYNC if aleady slave or in monitor mode */
6983 if (c
->flags
& REDIS_SLAVE
) return;
6985 /* SYNC can't be issued when the server has pending data to send to
6986 * the client about already issued commands. We need a fresh reply
6987 * buffer registering the differences between the BGSAVE and the current
6988 * dataset, so that we can copy to other slaves if needed. */
6989 if (listLength(c
->reply
) != 0) {
6990 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6994 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6995 /* Here we need to check if there is a background saving operation
6996 * in progress, or if it is required to start one */
6997 if (server
.bgsavechildpid
!= -1) {
6998 /* Ok a background save is in progress. Let's check if it is a good
6999 * one for replication, i.e. if there is another slave that is
7000 * registering differences since the server forked to save */
7005 listRewind(server
.slaves
,&li
);
7006 while((ln
= listNext(&li
))) {
7008 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7011 /* Perfect, the server is already registering differences for
7012 * another slave. Set the right state, and copy the buffer. */
7013 listRelease(c
->reply
);
7014 c
->reply
= listDup(slave
->reply
);
7015 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7016 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7018 /* No way, we need to wait for the next BGSAVE in order to
7019 * register differences */
7020 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7021 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7024 /* Ok we don't have a BGSAVE in progress, let's start one */
7025 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7026 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7027 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7028 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7031 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7034 c
->flags
|= REDIS_SLAVE
;
7036 listAddNodeTail(server
.slaves
,c
);
7040 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7041 redisClient
*slave
= privdata
;
7043 REDIS_NOTUSED(mask
);
7044 char buf
[REDIS_IOBUF_LEN
];
7045 ssize_t nwritten
, buflen
;
7047 if (slave
->repldboff
== 0) {
7048 /* Write the bulk write count before to transfer the DB. In theory here
7049 * we don't know how much room there is in the output buffer of the
7050 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7051 * operations) will never be smaller than the few bytes we need. */
7054 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7056 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7064 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7065 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7067 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7068 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7072 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7073 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7078 slave
->repldboff
+= nwritten
;
7079 if (slave
->repldboff
== slave
->repldbsize
) {
7080 close(slave
->repldbfd
);
7081 slave
->repldbfd
= -1;
7082 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7083 slave
->replstate
= REDIS_REPL_ONLINE
;
7084 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7085 sendReplyToClient
, slave
) == AE_ERR
) {
7089 addReplySds(slave
,sdsempty());
7090 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7094 /* This function is called at the end of every backgrond saving.
7095 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7096 * otherwise REDIS_ERR is passed to the function.
7098 * The goal of this function is to handle slaves waiting for a successful
7099 * background saving in order to perform non-blocking synchronization. */
7100 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7102 int startbgsave
= 0;
7105 listRewind(server
.slaves
,&li
);
7106 while((ln
= listNext(&li
))) {
7107 redisClient
*slave
= ln
->value
;
7109 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7111 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7112 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7113 struct redis_stat buf
;
7115 if (bgsaveerr
!= REDIS_OK
) {
7117 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7120 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7121 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7123 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7126 slave
->repldboff
= 0;
7127 slave
->repldbsize
= buf
.st_size
;
7128 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7129 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7130 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7137 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7140 listRewind(server
.slaves
,&li
);
7141 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7142 while((ln
= listNext(&li
))) {
7143 redisClient
*slave
= ln
->value
;
7145 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7152 static int syncWithMaster(void) {
7153 char buf
[1024], tmpfile
[256], authcmd
[1024];
7155 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7156 int dfd
, maxtries
= 5;
7159 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7164 /* AUTH with the master if required. */
7165 if(server
.masterauth
) {
7166 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7167 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7169 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7173 /* Read the AUTH result. */
7174 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7176 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7180 if (buf
[0] != '+') {
7182 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7187 /* Issue the SYNC command */
7188 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7190 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7194 /* Read the bulk write count */
7195 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7197 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7201 if (buf
[0] != '$') {
7203 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7206 dumpsize
= strtol(buf
+1,NULL
,10);
7207 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7208 /* Read the bulk write data on a temp file */
7210 snprintf(tmpfile
,256,
7211 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7212 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7213 if (dfd
!= -1) break;
7218 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7222 int nread
, nwritten
;
7224 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7226 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7232 nwritten
= write(dfd
,buf
,nread
);
7233 if (nwritten
== -1) {
7234 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7242 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7243 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7249 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7250 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7254 server
.master
= createClient(fd
);
7255 server
.master
->flags
|= REDIS_MASTER
;
7256 server
.master
->authenticated
= 1;
7257 server
.replstate
= REDIS_REPL_CONNECTED
;
7261 static void slaveofCommand(redisClient
*c
) {
7262 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7263 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7264 if (server
.masterhost
) {
7265 sdsfree(server
.masterhost
);
7266 server
.masterhost
= NULL
;
7267 if (server
.master
) freeClient(server
.master
);
7268 server
.replstate
= REDIS_REPL_NONE
;
7269 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7272 sdsfree(server
.masterhost
);
7273 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7274 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7275 if (server
.master
) freeClient(server
.master
);
7276 server
.replstate
= REDIS_REPL_CONNECT
;
7277 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7278 server
.masterhost
, server
.masterport
);
7280 addReply(c
,shared
.ok
);
7283 /* ============================ Maxmemory directive ======================== */
7285 /* Try to free one object form the pre-allocated objects free list.
7286 * This is useful under low mem conditions as by default we take 1 million
7287 * free objects allocated. On success REDIS_OK is returned, otherwise
7289 static int tryFreeOneObjectFromFreelist(void) {
7292 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7293 if (listLength(server
.objfreelist
)) {
7294 listNode
*head
= listFirst(server
.objfreelist
);
7295 o
= listNodeValue(head
);
7296 listDelNode(server
.objfreelist
,head
);
7297 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7301 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7306 /* This function gets called when 'maxmemory' is set on the config file to limit
7307 * the max memory used by the server, and we are out of memory.
7308 * This function will try to, in order:
7310 * - Free objects from the free list
7311 * - Try to remove keys with an EXPIRE set
7313 * It is not possible to free enough memory to reach used-memory < maxmemory
7314 * the server will start refusing commands that will enlarge even more the
7317 static void freeMemoryIfNeeded(void) {
7318 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7319 int j
, k
, freed
= 0;
7321 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7322 for (j
= 0; j
< server
.dbnum
; j
++) {
7324 robj
*minkey
= NULL
;
7325 struct dictEntry
*de
;
7327 if (dictSize(server
.db
[j
].expires
)) {
7329 /* From a sample of three keys drop the one nearest to
7330 * the natural expire */
7331 for (k
= 0; k
< 3; k
++) {
7334 de
= dictGetRandomKey(server
.db
[j
].expires
);
7335 t
= (time_t) dictGetEntryVal(de
);
7336 if (minttl
== -1 || t
< minttl
) {
7337 minkey
= dictGetEntryKey(de
);
7341 deleteKey(server
.db
+j
,minkey
);
7344 if (!freed
) return; /* nothing to free... */
7348 /* ============================== Append Only file ========================== */
7350 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7351 sds buf
= sdsempty();
7357 /* The DB this command was targetting is not the same as the last command
7358 * we appendend. To issue a SELECT command is needed. */
7359 if (dictid
!= server
.appendseldb
) {
7362 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7363 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7364 (unsigned long)strlen(seldb
),seldb
);
7365 server
.appendseldb
= dictid
;
7368 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7369 * EXPIREs into EXPIREATs calls */
7370 if (cmd
->proc
== expireCommand
) {
7373 tmpargv
[0] = createStringObject("EXPIREAT",8);
7374 tmpargv
[1] = argv
[1];
7375 incrRefCount(argv
[1]);
7376 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7377 tmpargv
[2] = createObject(REDIS_STRING
,
7378 sdscatprintf(sdsempty(),"%ld",when
));
7382 /* Append the actual command */
7383 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7384 for (j
= 0; j
< argc
; j
++) {
7387 o
= getDecodedObject(o
);
7388 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7389 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7390 buf
= sdscatlen(buf
,"\r\n",2);
7394 /* Free the objects from the modified argv for EXPIREAT */
7395 if (cmd
->proc
== expireCommand
) {
7396 for (j
= 0; j
< 3; j
++)
7397 decrRefCount(argv
[j
]);
7400 /* We want to perform a single write. This should be guaranteed atomic
7401 * at least if the filesystem we are writing is a real physical one.
7402 * While this will save us against the server being killed I don't think
7403 * there is much to do about the whole server stopping for power problems
7405 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7406 if (nwritten
!= (signed)sdslen(buf
)) {
7407 /* Ooops, we are in troubles. The best thing to do for now is
7408 * to simply exit instead to give the illusion that everything is
7409 * working as expected. */
7410 if (nwritten
== -1) {
7411 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7413 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7417 /* If a background append only file rewriting is in progress we want to
7418 * accumulate the differences between the child DB and the current one
7419 * in a buffer, so that when the child process will do its work we
7420 * can append the differences to the new append only file. */
7421 if (server
.bgrewritechildpid
!= -1)
7422 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7426 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7427 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7428 now
-server
.lastfsync
> 1))
7430 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7431 server
.lastfsync
= now
;
7435 /* In Redis commands are always executed in the context of a client, so in
7436 * order to load the append only file we need to create a fake client. */
7437 static struct redisClient
*createFakeClient(void) {
7438 struct redisClient
*c
= zmalloc(sizeof(*c
));
7442 c
->querybuf
= sdsempty();
7446 /* We set the fake client as a slave waiting for the synchronization
7447 * so that Redis will not try to send replies to this client. */
7448 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7449 c
->reply
= listCreate();
7450 listSetFreeMethod(c
->reply
,decrRefCount
);
7451 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7455 static void freeFakeClient(struct redisClient
*c
) {
7456 sdsfree(c
->querybuf
);
7457 listRelease(c
->reply
);
7461 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7462 * error (the append only file is zero-length) REDIS_ERR is returned. On
7463 * fatal error an error message is logged and the program exists. */
7464 int loadAppendOnlyFile(char *filename
) {
7465 struct redisClient
*fakeClient
;
7466 FILE *fp
= fopen(filename
,"r");
7467 struct redis_stat sb
;
7468 unsigned long long loadedkeys
= 0;
7470 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7474 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7478 fakeClient
= createFakeClient();
7485 struct redisCommand
*cmd
;
7487 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7493 if (buf
[0] != '*') goto fmterr
;
7495 argv
= zmalloc(sizeof(robj
*)*argc
);
7496 for (j
= 0; j
< argc
; j
++) {
7497 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7498 if (buf
[0] != '$') goto fmterr
;
7499 len
= strtol(buf
+1,NULL
,10);
7500 argsds
= sdsnewlen(NULL
,len
);
7501 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7502 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7503 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7506 /* Command lookup */
7507 cmd
= lookupCommand(argv
[0]->ptr
);
7509 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7512 /* Try object sharing and encoding */
7513 if (server
.shareobjects
) {
7515 for(j
= 1; j
< argc
; j
++)
7516 argv
[j
] = tryObjectSharing(argv
[j
]);
7518 if (cmd
->flags
& REDIS_CMD_BULK
)
7519 tryObjectEncoding(argv
[argc
-1]);
7520 /* Run the command in the context of a fake client */
7521 fakeClient
->argc
= argc
;
7522 fakeClient
->argv
= argv
;
7523 cmd
->proc(fakeClient
);
7524 /* Discard the reply objects list from the fake client */
7525 while(listLength(fakeClient
->reply
))
7526 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7527 /* Clean up, ready for the next command */
7528 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7530 /* Handle swapping while loading big datasets when VM is on */
7532 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7533 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7534 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7539 freeFakeClient(fakeClient
);
7544 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7546 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7550 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7554 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7555 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7559 /* Avoid the incr/decr ref count business if possible to help
7560 * copy-on-write (we are often in a child process when this function
7562 * Also makes sure that key objects don't get incrRefCount-ed when VM
7564 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7565 obj
= getDecodedObject(obj
);
7568 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7569 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7570 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7572 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7573 if (decrrc
) decrRefCount(obj
);
7576 if (decrrc
) decrRefCount(obj
);
7580 /* Write binary-safe string into a file in the bulkformat
7581 * $<count>\r\n<payload>\r\n */
7582 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7585 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7586 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7587 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7588 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7592 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7593 static int fwriteBulkDouble(FILE *fp
, double d
) {
7594 char buf
[128], dbuf
[128];
7596 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7597 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7598 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7599 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7603 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7604 static int fwriteBulkLong(FILE *fp
, long l
) {
7605 char buf
[128], lbuf
[128];
7607 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7608 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7609 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7610 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7614 /* Write a sequence of commands able to fully rebuild the dataset into
7615 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7616 static int rewriteAppendOnlyFile(char *filename
) {
7617 dictIterator
*di
= NULL
;
7622 time_t now
= time(NULL
);
7624 /* Note that we have to use a different temp name here compared to the
7625 * one used by rewriteAppendOnlyFileBackground() function. */
7626 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7627 fp
= fopen(tmpfile
,"w");
7629 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7632 for (j
= 0; j
< server
.dbnum
; j
++) {
7633 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7634 redisDb
*db
= server
.db
+j
;
7636 if (dictSize(d
) == 0) continue;
7637 di
= dictGetIterator(d
);
7643 /* SELECT the new DB */
7644 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7645 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7647 /* Iterate this DB writing every entry */
7648 while((de
= dictNext(di
)) != NULL
) {
7653 key
= dictGetEntryKey(de
);
7654 /* If the value for this key is swapped, load a preview in memory.
7655 * We use a "swapped" flag to remember if we need to free the
7656 * value object instead to just increment the ref count anyway
7657 * in order to avoid copy-on-write of pages if we are forked() */
7658 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7659 key
->storage
== REDIS_VM_SWAPPING
) {
7660 o
= dictGetEntryVal(de
);
7663 o
= vmPreviewObject(key
);
7666 expiretime
= getExpire(db
,key
);
7668 /* Save the key and associated value */
7669 if (o
->type
== REDIS_STRING
) {
7670 /* Emit a SET command */
7671 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7672 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7674 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7675 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7676 } else if (o
->type
== REDIS_LIST
) {
7677 /* Emit the RPUSHes needed to rebuild the list */
7678 list
*list
= o
->ptr
;
7682 listRewind(list
,&li
);
7683 while((ln
= listNext(&li
))) {
7684 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7685 robj
*eleobj
= listNodeValue(ln
);
7687 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7688 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7689 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7691 } else if (o
->type
== REDIS_SET
) {
7692 /* Emit the SADDs needed to rebuild the set */
7694 dictIterator
*di
= dictGetIterator(set
);
7697 while((de
= dictNext(di
)) != NULL
) {
7698 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7699 robj
*eleobj
= dictGetEntryKey(de
);
7701 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7702 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7703 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7705 dictReleaseIterator(di
);
7706 } else if (o
->type
== REDIS_ZSET
) {
7707 /* Emit the ZADDs needed to rebuild the sorted set */
7709 dictIterator
*di
= dictGetIterator(zs
->dict
);
7712 while((de
= dictNext(di
)) != NULL
) {
7713 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7714 robj
*eleobj
= dictGetEntryKey(de
);
7715 double *score
= dictGetEntryVal(de
);
7717 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7718 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7719 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7720 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7722 dictReleaseIterator(di
);
7723 } else if (o
->type
== REDIS_HASH
) {
7724 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7726 /* Emit the HSETs needed to rebuild the hash */
7727 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7728 unsigned char *p
= zipmapRewind(o
->ptr
);
7729 unsigned char *field
, *val
;
7730 unsigned int flen
, vlen
;
7732 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
7733 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7734 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7735 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
7737 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
7741 dictIterator
*di
= dictGetIterator(o
->ptr
);
7744 while((de
= dictNext(di
)) != NULL
) {
7745 robj
*field
= dictGetEntryKey(de
);
7746 robj
*val
= dictGetEntryVal(de
);
7748 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7749 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7750 if (fwriteBulkObject(fp
,field
) == -1) return -1;
7751 if (fwriteBulkObject(fp
,val
) == -1) return -1;
7753 dictReleaseIterator(di
);
7758 /* Save the expire time */
7759 if (expiretime
!= -1) {
7760 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7761 /* If this key is already expired skip it */
7762 if (expiretime
< now
) continue;
7763 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7764 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7765 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7767 if (swapped
) decrRefCount(o
);
7769 dictReleaseIterator(di
);
7772 /* Make sure data will not remain on the OS's output buffers */
7777 /* Use RENAME to make sure the DB file is changed atomically only
7778 * if the generate DB file is ok. */
7779 if (rename(tmpfile
,filename
) == -1) {
7780 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7784 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7790 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7791 if (di
) dictReleaseIterator(di
);
7795 /* This is how rewriting of the append only file in background works:
7797 * 1) The user calls BGREWRITEAOF
7798 * 2) Redis calls this function, that forks():
7799 * 2a) the child rewrite the append only file in a temp file.
7800 * 2b) the parent accumulates differences in server.bgrewritebuf.
7801 * 3) When the child finished '2a' exists.
7802 * 4) The parent will trap the exit code, if it's OK, will append the
7803 * data accumulated into server.bgrewritebuf into the temp file, and
7804 * finally will rename(2) the temp file in the actual file name.
7805 * The the new file is reopened as the new append only file. Profit!
7807 static int rewriteAppendOnlyFileBackground(void) {
7810 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7811 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7812 if ((childpid
= fork()) == 0) {
7816 if (server
.vm_enabled
) vmReopenSwapFile();
7818 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7819 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7826 if (childpid
== -1) {
7827 redisLog(REDIS_WARNING
,
7828 "Can't rewrite append only file in background: fork: %s",
7832 redisLog(REDIS_NOTICE
,
7833 "Background append only file rewriting started by pid %d",childpid
);
7834 server
.bgrewritechildpid
= childpid
;
7835 /* We set appendseldb to -1 in order to force the next call to the
7836 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7837 * accumulated by the parent into server.bgrewritebuf will start
7838 * with a SELECT statement and it will be safe to merge. */
7839 server
.appendseldb
= -1;
7842 return REDIS_OK
; /* unreached */
7845 static void bgrewriteaofCommand(redisClient
*c
) {
7846 if (server
.bgrewritechildpid
!= -1) {
7847 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7850 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7851 char *status
= "+Background append only file rewriting started\r\n";
7852 addReplySds(c
,sdsnew(status
));
7854 addReply(c
,shared
.err
);
7858 static void aofRemoveTempFile(pid_t childpid
) {
7861 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7865 /* Virtual Memory is composed mainly of two subsystems:
7866 * - Blocking Virutal Memory
7867 * - Threaded Virtual Memory I/O
7868 * The two parts are not fully decoupled, but functions are split among two
7869 * different sections of the source code (delimited by comments) in order to
7870 * make more clear what functionality is about the blocking VM and what about
7871 * the threaded (not blocking) VM.
7875 * Redis VM is a blocking VM (one that blocks reading swapped values from
7876 * disk into memory when a value swapped out is needed in memory) that is made
7877 * unblocking by trying to examine the command argument vector in order to
7878 * load in background values that will likely be needed in order to exec
7879 * the command. The command is executed only once all the relevant keys
7880 * are loaded into memory.
7882 * This basically is almost as simple of a blocking VM, but almost as parallel
7883 * as a fully non-blocking VM.
7886 /* =================== Virtual Memory - Blocking Side ====================== */
7888 /* substitute the first occurrence of '%p' with the process pid in the
7889 * swap file name. */
7890 static void expandVmSwapFilename(void) {
7891 char *p
= strstr(server
.vm_swap_file
,"%p");
7897 new = sdscat(new,server
.vm_swap_file
);
7898 new = sdscatprintf(new,"%ld",(long) getpid());
7899 new = sdscat(new,p
+2);
7900 zfree(server
.vm_swap_file
);
7901 server
.vm_swap_file
= new;
7904 static void vmInit(void) {
7909 if (server
.vm_max_threads
!= 0)
7910 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7912 expandVmSwapFilename();
7913 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7914 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7915 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7917 if (server
.vm_fp
== NULL
) {
7918 redisLog(REDIS_WARNING
,
7919 "Impossible to open the swap file: %s. Exiting.",
7923 server
.vm_fd
= fileno(server
.vm_fp
);
7924 server
.vm_next_page
= 0;
7925 server
.vm_near_pages
= 0;
7926 server
.vm_stats_used_pages
= 0;
7927 server
.vm_stats_swapped_objects
= 0;
7928 server
.vm_stats_swapouts
= 0;
7929 server
.vm_stats_swapins
= 0;
7930 totsize
= server
.vm_pages
*server
.vm_page_size
;
7931 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7932 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7933 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7937 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7939 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7940 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7941 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7942 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7944 /* Initialize threaded I/O (used by Virtual Memory) */
7945 server
.io_newjobs
= listCreate();
7946 server
.io_processing
= listCreate();
7947 server
.io_processed
= listCreate();
7948 server
.io_ready_clients
= listCreate();
7949 pthread_mutex_init(&server
.io_mutex
,NULL
);
7950 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7951 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7952 server
.io_active_threads
= 0;
7953 if (pipe(pipefds
) == -1) {
7954 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7958 server
.io_ready_pipe_read
= pipefds
[0];
7959 server
.io_ready_pipe_write
= pipefds
[1];
7960 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7961 /* LZF requires a lot of stack */
7962 pthread_attr_init(&server
.io_threads_attr
);
7963 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7964 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7965 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7966 /* Listen for events in the threaded I/O pipe */
7967 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7968 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7969 oom("creating file event");
7972 /* Mark the page as used */
7973 static void vmMarkPageUsed(off_t page
) {
7974 off_t byte
= page
/8;
7976 redisAssert(vmFreePage(page
) == 1);
7977 server
.vm_bitmap
[byte
] |= 1<<bit
;
7980 /* Mark N contiguous pages as used, with 'page' being the first. */
7981 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7984 for (j
= 0; j
< count
; j
++)
7985 vmMarkPageUsed(page
+j
);
7986 server
.vm_stats_used_pages
+= count
;
7987 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
7988 (long long)count
, (long long)page
);
7991 /* Mark the page as free */
7992 static void vmMarkPageFree(off_t page
) {
7993 off_t byte
= page
/8;
7995 redisAssert(vmFreePage(page
) == 0);
7996 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7999 /* Mark N contiguous pages as free, with 'page' being the first. */
8000 static void vmMarkPagesFree(off_t page
, off_t count
) {
8003 for (j
= 0; j
< count
; j
++)
8004 vmMarkPageFree(page
+j
);
8005 server
.vm_stats_used_pages
-= count
;
8006 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8007 (long long)count
, (long long)page
);
8010 /* Test if the page is free */
8011 static int vmFreePage(off_t page
) {
8012 off_t byte
= page
/8;
8014 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8017 /* Find N contiguous free pages storing the first page of the cluster in *first.
8018 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8019 * REDIS_ERR is returned.
8021 * This function uses a simple algorithm: we try to allocate
8022 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8023 * again from the start of the swap file searching for free spaces.
8025 * If it looks pretty clear that there are no free pages near our offset
8026 * we try to find less populated places doing a forward jump of
8027 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8028 * without hurry, and then we jump again and so forth...
8030 * This function can be improved using a free list to avoid to guess
8031 * too much, since we could collect data about freed pages.
8033 * note: I implemented this function just after watching an episode of
8034 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8036 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8037 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8039 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8040 server
.vm_near_pages
= 0;
8041 server
.vm_next_page
= 0;
8043 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8044 base
= server
.vm_next_page
;
8046 while(offset
< server
.vm_pages
) {
8047 off_t
this = base
+offset
;
8049 /* If we overflow, restart from page zero */
8050 if (this >= server
.vm_pages
) {
8051 this -= server
.vm_pages
;
8053 /* Just overflowed, what we found on tail is no longer
8054 * interesting, as it's no longer contiguous. */
8058 if (vmFreePage(this)) {
8059 /* This is a free page */
8061 /* Already got N free pages? Return to the caller, with success */
8063 *first
= this-(n
-1);
8064 server
.vm_next_page
= this+1;
8065 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8069 /* The current one is not a free page */
8073 /* Fast-forward if the current page is not free and we already
8074 * searched enough near this place. */
8076 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8077 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8079 /* Note that even if we rewind after the jump, we are don't need
8080 * to make sure numfree is set to zero as we only jump *if* it
8081 * is set to zero. */
8083 /* Otherwise just check the next page */
8090 /* Write the specified object at the specified page of the swap file */
8091 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8092 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8093 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8094 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8095 redisLog(REDIS_WARNING
,
8096 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8100 rdbSaveObject(server
.vm_fp
,o
);
8101 fflush(server
.vm_fp
);
8102 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8106 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8107 * needed to later retrieve the object into the key object.
8108 * If we can't find enough contiguous empty pages to swap the object on disk
8109 * REDIS_ERR is returned. */
8110 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8111 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8114 assert(key
->storage
== REDIS_VM_MEMORY
);
8115 assert(key
->refcount
== 1);
8116 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8117 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8118 key
->vm
.page
= page
;
8119 key
->vm
.usedpages
= pages
;
8120 key
->storage
= REDIS_VM_SWAPPED
;
8121 key
->vtype
= val
->type
;
8122 decrRefCount(val
); /* Deallocate the object from memory. */
8123 vmMarkPagesUsed(page
,pages
);
8124 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8125 (unsigned char*) key
->ptr
,
8126 (unsigned long long) page
, (unsigned long long) pages
);
8127 server
.vm_stats_swapped_objects
++;
8128 server
.vm_stats_swapouts
++;
8132 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8135 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8136 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8137 redisLog(REDIS_WARNING
,
8138 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8142 o
= rdbLoadObject(type
,server
.vm_fp
);
8144 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8147 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8151 /* Load the value object relative to the 'key' object from swap to memory.
8152 * The newly allocated object is returned.
8154 * If preview is true the unserialized object is returned to the caller but
8155 * no changes are made to the key object, nor the pages are marked as freed */
8156 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8159 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8160 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8162 key
->storage
= REDIS_VM_MEMORY
;
8163 key
->vm
.atime
= server
.unixtime
;
8164 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8165 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8166 (unsigned char*) key
->ptr
);
8167 server
.vm_stats_swapped_objects
--;
8169 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8170 (unsigned char*) key
->ptr
);
8172 server
.vm_stats_swapins
++;
8176 /* Plain object loading, from swap to memory */
8177 static robj
*vmLoadObject(robj
*key
) {
8178 /* If we are loading the object in background, stop it, we
8179 * need to load this object synchronously ASAP. */
8180 if (key
->storage
== REDIS_VM_LOADING
)
8181 vmCancelThreadedIOJob(key
);
8182 return vmGenericLoadObject(key
,0);
8185 /* Just load the value on disk, without to modify the key.
8186 * This is useful when we want to perform some operation on the value
8187 * without to really bring it from swap to memory, like while saving the
8188 * dataset or rewriting the append only log. */
8189 static robj
*vmPreviewObject(robj
*key
) {
8190 return vmGenericLoadObject(key
,1);
8193 /* How a good candidate is this object for swapping?
8194 * The better candidate it is, the greater the returned value.
8196 * Currently we try to perform a fast estimation of the object size in
8197 * memory, and combine it with aging informations.
8199 * Basically swappability = idle-time * log(estimated size)
8201 * Bigger objects are preferred over smaller objects, but not
8202 * proportionally, this is why we use the logarithm. This algorithm is
8203 * just a first try and will probably be tuned later. */
8204 static double computeObjectSwappability(robj
*o
) {
8205 time_t age
= server
.unixtime
- o
->vm
.atime
;
8209 struct dictEntry
*de
;
8212 if (age
<= 0) return 0;
8215 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8218 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8223 listNode
*ln
= listFirst(l
);
8225 asize
= sizeof(list
);
8227 robj
*ele
= ln
->value
;
8230 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8231 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8233 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8238 z
= (o
->type
== REDIS_ZSET
);
8239 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8241 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8242 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8247 de
= dictGetRandomKey(d
);
8248 ele
= dictGetEntryKey(de
);
8249 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8250 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8252 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8253 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8257 return (double)age
*log(1+asize
);
8260 /* Try to swap an object that's a good candidate for swapping.
8261 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8262 * to swap any object at all.
8264 * If 'usethreaded' is true, Redis will try to swap the object in background
8265 * using I/O threads. */
8266 static int vmSwapOneObject(int usethreads
) {
8268 struct dictEntry
*best
= NULL
;
8269 double best_swappability
= 0;
8270 redisDb
*best_db
= NULL
;
8273 for (j
= 0; j
< server
.dbnum
; j
++) {
8274 redisDb
*db
= server
.db
+j
;
8275 /* Why maxtries is set to 100?
8276 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8277 * are swappable objects */
8280 if (dictSize(db
->dict
) == 0) continue;
8281 for (i
= 0; i
< 5; i
++) {
8283 double swappability
;
8285 if (maxtries
) maxtries
--;
8286 de
= dictGetRandomKey(db
->dict
);
8287 key
= dictGetEntryKey(de
);
8288 val
= dictGetEntryVal(de
);
8289 /* Only swap objects that are currently in memory.
8291 * Also don't swap shared objects if threaded VM is on, as we
8292 * try to ensure that the main thread does not touch the
8293 * object while the I/O thread is using it, but we can't
8294 * control other keys without adding additional mutex. */
8295 if (key
->storage
!= REDIS_VM_MEMORY
||
8296 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8297 if (maxtries
) i
--; /* don't count this try */
8300 swappability
= computeObjectSwappability(val
);
8301 if (!best
|| swappability
> best_swappability
) {
8303 best_swappability
= swappability
;
8308 if (best
== NULL
) return REDIS_ERR
;
8309 key
= dictGetEntryKey(best
);
8310 val
= dictGetEntryVal(best
);
8312 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8313 key
->ptr
, best_swappability
);
8315 /* Unshare the key if needed */
8316 if (key
->refcount
> 1) {
8317 robj
*newkey
= dupStringObject(key
);
8319 key
= dictGetEntryKey(best
) = newkey
;
8323 vmSwapObjectThreaded(key
,val
,best_db
);
8326 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8327 dictGetEntryVal(best
) = NULL
;
8335 static int vmSwapOneObjectBlocking() {
8336 return vmSwapOneObject(0);
8339 static int vmSwapOneObjectThreaded() {
8340 return vmSwapOneObject(1);
8343 /* Return true if it's safe to swap out objects in a given moment.
8344 * Basically we don't want to swap objects out while there is a BGSAVE
8345 * or a BGAEOREWRITE running in backgroud. */
8346 static int vmCanSwapOut(void) {
8347 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8350 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8351 * and was deleted. Otherwise 0 is returned. */
8352 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8356 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8357 foundkey
= dictGetEntryKey(de
);
8358 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8363 /* =================== Virtual Memory - Threaded I/O ======================= */
8365 static void freeIOJob(iojob
*j
) {
8366 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8367 j
->type
== REDIS_IOJOB_DO_SWAP
||
8368 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8369 decrRefCount(j
->val
);
8370 decrRefCount(j
->key
);
8374 /* Every time a thread finished a Job, it writes a byte into the write side
8375 * of an unix pipe in order to "awake" the main thread, and this function
8377 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8381 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8383 REDIS_NOTUSED(mask
);
8384 REDIS_NOTUSED(privdata
);
8386 /* For every byte we read in the read side of the pipe, there is one
8387 * I/O job completed to process. */
8388 while((retval
= read(fd
,buf
,1)) == 1) {
8392 struct dictEntry
*de
;
8394 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8396 /* Get the processed element (the oldest one) */
8398 assert(listLength(server
.io_processed
) != 0);
8399 if (toprocess
== -1) {
8400 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8401 if (toprocess
<= 0) toprocess
= 1;
8403 ln
= listFirst(server
.io_processed
);
8405 listDelNode(server
.io_processed
,ln
);
8407 /* If this job is marked as canceled, just ignore it */
8412 /* Post process it in the main thread, as there are things we
8413 * can do just here to avoid race conditions and/or invasive locks */
8414 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
);
8415 de
= dictFind(j
->db
->dict
,j
->key
);
8417 key
= dictGetEntryKey(de
);
8418 if (j
->type
== REDIS_IOJOB_LOAD
) {
8421 /* Key loaded, bring it at home */
8422 key
->storage
= REDIS_VM_MEMORY
;
8423 key
->vm
.atime
= server
.unixtime
;
8424 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8425 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8426 (unsigned char*) key
->ptr
);
8427 server
.vm_stats_swapped_objects
--;
8428 server
.vm_stats_swapins
++;
8429 dictGetEntryVal(de
) = j
->val
;
8430 incrRefCount(j
->val
);
8433 /* Handle clients waiting for this key to be loaded. */
8434 handleClientsBlockedOnSwappedKey(db
,key
);
8435 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8436 /* Now we know the amount of pages required to swap this object.
8437 * Let's find some space for it, and queue this task again
8438 * rebranded as REDIS_IOJOB_DO_SWAP. */
8439 if (!vmCanSwapOut() ||
8440 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8442 /* Ooops... no space or we can't swap as there is
8443 * a fork()ed Redis trying to save stuff on disk. */
8445 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8447 /* Note that we need to mark this pages as used now,
8448 * if the job will be canceled, we'll mark them as freed
8450 vmMarkPagesUsed(j
->page
,j
->pages
);
8451 j
->type
= REDIS_IOJOB_DO_SWAP
;
8456 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8459 /* Key swapped. We can finally free some memory. */
8460 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8461 printf("key->storage: %d\n",key
->storage
);
8462 printf("key->name: %s\n",(char*)key
->ptr
);
8463 printf("key->refcount: %d\n",key
->refcount
);
8464 printf("val: %p\n",(void*)j
->val
);
8465 printf("val->type: %d\n",j
->val
->type
);
8466 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8468 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8469 val
= dictGetEntryVal(de
);
8470 key
->vm
.page
= j
->page
;
8471 key
->vm
.usedpages
= j
->pages
;
8472 key
->storage
= REDIS_VM_SWAPPED
;
8473 key
->vtype
= j
->val
->type
;
8474 decrRefCount(val
); /* Deallocate the object from memory. */
8475 dictGetEntryVal(de
) = NULL
;
8476 redisLog(REDIS_DEBUG
,
8477 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8478 (unsigned char*) key
->ptr
,
8479 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8480 server
.vm_stats_swapped_objects
++;
8481 server
.vm_stats_swapouts
++;
8483 /* Put a few more swap requests in queue if we are still
8485 if (trytoswap
&& vmCanSwapOut() &&
8486 zmalloc_used_memory() > server
.vm_max_memory
)
8491 more
= listLength(server
.io_newjobs
) <
8492 (unsigned) server
.vm_max_threads
;
8494 /* Don't waste CPU time if swappable objects are rare. */
8495 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8503 if (processed
== toprocess
) return;
8505 if (retval
< 0 && errno
!= EAGAIN
) {
8506 redisLog(REDIS_WARNING
,
8507 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8512 static void lockThreadedIO(void) {
8513 pthread_mutex_lock(&server
.io_mutex
);
8516 static void unlockThreadedIO(void) {
8517 pthread_mutex_unlock(&server
.io_mutex
);
8520 /* Remove the specified object from the threaded I/O queue if still not
8521 * processed, otherwise make sure to flag it as canceled. */
8522 static void vmCancelThreadedIOJob(robj
*o
) {
8524 server
.io_newjobs
, /* 0 */
8525 server
.io_processing
, /* 1 */
8526 server
.io_processed
/* 2 */
8530 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8533 /* Search for a matching key in one of the queues */
8534 for (i
= 0; i
< 3; i
++) {
8538 listRewind(lists
[i
],&li
);
8539 while ((ln
= listNext(&li
)) != NULL
) {
8540 iojob
*job
= ln
->value
;
8542 if (job
->canceled
) continue; /* Skip this, already canceled. */
8543 if (compareStringObjects(job
->key
,o
) == 0) {
8544 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8545 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8546 /* Mark the pages as free since the swap didn't happened
8547 * or happened but is now discarded. */
8548 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8549 vmMarkPagesFree(job
->page
,job
->pages
);
8550 /* Cancel the job. It depends on the list the job is
8553 case 0: /* io_newjobs */
8554 /* If the job was yet not processed the best thing to do
8555 * is to remove it from the queue at all */
8557 listDelNode(lists
[i
],ln
);
8559 case 1: /* io_processing */
8560 /* Oh Shi- the thread is messing with the Job:
8562 * Probably it's accessing the object if this is a
8563 * PREPARE_SWAP or DO_SWAP job.
8564 * If it's a LOAD job it may be reading from disk and
8565 * if we don't wait for the job to terminate before to
8566 * cancel it, maybe in a few microseconds data can be
8567 * corrupted in this pages. So the short story is:
8569 * Better to wait for the job to move into the
8570 * next queue (processed)... */
8572 /* We try again and again until the job is completed. */
8574 /* But let's wait some time for the I/O thread
8575 * to finish with this job. After all this condition
8576 * should be very rare. */
8579 case 2: /* io_processed */
8580 /* The job was already processed, that's easy...
8581 * just mark it as canceled so that we'll ignore it
8582 * when processing completed jobs. */
8586 /* Finally we have to adjust the storage type of the object
8587 * in order to "UNDO" the operaiton. */
8588 if (o
->storage
== REDIS_VM_LOADING
)
8589 o
->storage
= REDIS_VM_SWAPPED
;
8590 else if (o
->storage
== REDIS_VM_SWAPPING
)
8591 o
->storage
= REDIS_VM_MEMORY
;
8598 assert(1 != 1); /* We should never reach this */
8601 static void *IOThreadEntryPoint(void *arg
) {
8606 pthread_detach(pthread_self());
8608 /* Get a new job to process */
8610 if (listLength(server
.io_newjobs
) == 0) {
8611 /* No new jobs in queue, exit. */
8612 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8613 (long) pthread_self());
8614 server
.io_active_threads
--;
8618 ln
= listFirst(server
.io_newjobs
);
8620 listDelNode(server
.io_newjobs
,ln
);
8621 /* Add the job in the processing queue */
8622 j
->thread
= pthread_self();
8623 listAddNodeTail(server
.io_processing
,j
);
8624 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8626 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8627 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8629 /* Process the Job */
8630 if (j
->type
== REDIS_IOJOB_LOAD
) {
8631 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8632 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8633 FILE *fp
= fopen("/dev/null","w+");
8634 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8636 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8637 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8641 /* Done: insert the job into the processed queue */
8642 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8643 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8645 listDelNode(server
.io_processing
,ln
);
8646 listAddNodeTail(server
.io_processed
,j
);
8649 /* Signal the main thread there is new stuff to process */
8650 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8652 return NULL
; /* never reached */
8655 static void spawnIOThread(void) {
8657 sigset_t mask
, omask
;
8660 sigaddset(&mask
,SIGCHLD
);
8661 sigaddset(&mask
,SIGHUP
);
8662 sigaddset(&mask
,SIGPIPE
);
8663 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8664 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
8665 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8666 server
.io_active_threads
++;
8669 /* We need to wait for the last thread to exit before we are able to
8670 * fork() in order to BGSAVE or BGREWRITEAOF. */
8671 static void waitEmptyIOJobsQueue(void) {
8673 int io_processed_len
;
8676 if (listLength(server
.io_newjobs
) == 0 &&
8677 listLength(server
.io_processing
) == 0 &&
8678 server
.io_active_threads
== 0)
8683 /* While waiting for empty jobs queue condition we post-process some
8684 * finshed job, as I/O threads may be hanging trying to write against
8685 * the io_ready_pipe_write FD but there are so much pending jobs that
8687 io_processed_len
= listLength(server
.io_processed
);
8689 if (io_processed_len
) {
8690 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8691 usleep(1000); /* 1 millisecond */
8693 usleep(10000); /* 10 milliseconds */
8698 static void vmReopenSwapFile(void) {
8699 /* Note: we don't close the old one as we are in the child process
8700 * and don't want to mess at all with the original file object. */
8701 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8702 if (server
.vm_fp
== NULL
) {
8703 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8704 server
.vm_swap_file
);
8707 server
.vm_fd
= fileno(server
.vm_fp
);
8710 /* This function must be called while with threaded IO locked */
8711 static void queueIOJob(iojob
*j
) {
8712 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8713 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8714 listAddNodeTail(server
.io_newjobs
,j
);
8715 if (server
.io_active_threads
< server
.vm_max_threads
)
8719 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8722 assert(key
->storage
== REDIS_VM_MEMORY
);
8723 assert(key
->refcount
== 1);
8725 j
= zmalloc(sizeof(*j
));
8726 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8728 j
->key
= dupStringObject(key
);
8732 j
->thread
= (pthread_t
) -1;
8733 key
->storage
= REDIS_VM_SWAPPING
;
8741 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8743 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8744 * If there is not already a job loading the key, it is craeted.
8745 * The key is added to the io_keys list in the client structure, and also
8746 * in the hash table mapping swapped keys to waiting clients, that is,
8747 * server.io_waited_keys. */
8748 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8749 struct dictEntry
*de
;
8753 /* If the key does not exist or is already in RAM we don't need to
8754 * block the client at all. */
8755 de
= dictFind(c
->db
->dict
,key
);
8756 if (de
== NULL
) return 0;
8757 o
= dictGetEntryKey(de
);
8758 if (o
->storage
== REDIS_VM_MEMORY
) {
8760 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8761 /* We were swapping the key, undo it! */
8762 vmCancelThreadedIOJob(o
);
8766 /* OK: the key is either swapped, or being loaded just now. */
8768 /* Add the key to the list of keys this client is waiting for.
8769 * This maps clients to keys they are waiting for. */
8770 listAddNodeTail(c
->io_keys
,key
);
8773 /* Add the client to the swapped keys => clients waiting map. */
8774 de
= dictFind(c
->db
->io_keys
,key
);
8778 /* For every key we take a list of clients blocked for it */
8780 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8782 assert(retval
== DICT_OK
);
8784 l
= dictGetEntryVal(de
);
8786 listAddNodeTail(l
,c
);
8788 /* Are we already loading the key from disk? If not create a job */
8789 if (o
->storage
== REDIS_VM_SWAPPED
) {
8792 o
->storage
= REDIS_VM_LOADING
;
8793 j
= zmalloc(sizeof(*j
));
8794 j
->type
= REDIS_IOJOB_LOAD
;
8796 j
->key
= dupStringObject(key
);
8797 j
->key
->vtype
= o
->vtype
;
8798 j
->page
= o
->vm
.page
;
8801 j
->thread
= (pthread_t
) -1;
8809 /* Is this client attempting to run a command against swapped keys?
8810 * If so, block it ASAP, load the keys in background, then resume it.
8812 * The important idea about this function is that it can fail! If keys will
8813 * still be swapped when the client is resumed, this key lookups will
8814 * just block loading keys from disk. In practical terms this should only
8815 * happen with SORT BY command or if there is a bug in this function.
8817 * Return 1 if the client is marked as blocked, 0 if the client can
8818 * continue as the keys it is going to access appear to be in memory. */
8819 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8822 if (cmd
->vm_firstkey
== 0) return 0;
8823 last
= cmd
->vm_lastkey
;
8824 if (last
< 0) last
= c
->argc
+last
;
8825 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8826 waitForSwappedKey(c
,c
->argv
[j
]);
8827 /* If the client was blocked for at least one key, mark it as blocked. */
8828 if (listLength(c
->io_keys
)) {
8829 c
->flags
|= REDIS_IO_WAIT
;
8830 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8831 server
.vm_blocked_clients
++;
8838 /* Remove the 'key' from the list of blocked keys for a given client.
8840 * The function returns 1 when there are no longer blocking keys after
8841 * the current one was removed (and the client can be unblocked). */
8842 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8846 struct dictEntry
*de
;
8848 /* Remove the key from the list of keys this client is waiting for. */
8849 listRewind(c
->io_keys
,&li
);
8850 while ((ln
= listNext(&li
)) != NULL
) {
8851 if (compareStringObjects(ln
->value
,key
) == 0) {
8852 listDelNode(c
->io_keys
,ln
);
8858 /* Remove the client form the key => waiting clients map. */
8859 de
= dictFind(c
->db
->io_keys
,key
);
8861 l
= dictGetEntryVal(de
);
8862 ln
= listSearchKey(l
,c
);
8865 if (listLength(l
) == 0)
8866 dictDelete(c
->db
->io_keys
,key
);
8868 return listLength(c
->io_keys
) == 0;
8871 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8872 struct dictEntry
*de
;
8877 de
= dictFind(db
->io_keys
,key
);
8880 l
= dictGetEntryVal(de
);
8881 len
= listLength(l
);
8882 /* Note: we can't use something like while(listLength(l)) as the list
8883 * can be freed by the calling function when we remove the last element. */
8886 redisClient
*c
= ln
->value
;
8888 if (dontWaitForSwappedKey(c
,key
)) {
8889 /* Put the client in the list of clients ready to go as we
8890 * loaded all the keys about it. */
8891 listAddNodeTail(server
.io_ready_clients
,c
);
8896 /* ================================= Debugging ============================== */
8898 static void debugCommand(redisClient
*c
) {
8899 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8901 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8902 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8903 addReply(c
,shared
.err
);
8907 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8908 addReply(c
,shared
.err
);
8911 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8912 addReply(c
,shared
.ok
);
8913 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8915 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8916 addReply(c
,shared
.err
);
8919 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8920 addReply(c
,shared
.ok
);
8921 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8922 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8926 addReply(c
,shared
.nokeyerr
);
8929 key
= dictGetEntryKey(de
);
8930 val
= dictGetEntryVal(de
);
8931 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8932 key
->storage
== REDIS_VM_SWAPPING
)) {
8936 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
8937 strenc
= strencoding
[val
->encoding
];
8939 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
8942 addReplySds(c
,sdscatprintf(sdsempty(),
8943 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8944 "encoding:%s serializedlength:%lld\r\n",
8945 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8946 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
8948 addReplySds(c
,sdscatprintf(sdsempty(),
8949 "+Key at:%p refcount:%d, value swapped at: page %llu "
8950 "using %llu pages\r\n",
8951 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8952 (unsigned long long) key
->vm
.usedpages
));
8954 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8955 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8958 if (!server
.vm_enabled
) {
8959 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8963 addReply(c
,shared
.nokeyerr
);
8966 key
= dictGetEntryKey(de
);
8967 val
= dictGetEntryVal(de
);
8968 /* If the key is shared we want to create a copy */
8969 if (key
->refcount
> 1) {
8970 robj
*newkey
= dupStringObject(key
);
8972 key
= dictGetEntryKey(de
) = newkey
;
8975 if (key
->storage
!= REDIS_VM_MEMORY
) {
8976 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8977 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8978 dictGetEntryVal(de
) = NULL
;
8979 addReply(c
,shared
.ok
);
8981 addReply(c
,shared
.err
);
8984 addReplySds(c
,sdsnew(
8985 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8989 static void _redisAssert(char *estr
, char *file
, int line
) {
8990 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8991 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8992 #ifdef HAVE_BACKTRACE
8993 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8998 /* =================================== Main! ================================ */
9001 int linuxOvercommitMemoryValue(void) {
9002 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9006 if (fgets(buf
,64,fp
) == NULL
) {
9015 void linuxOvercommitMemoryWarning(void) {
9016 if (linuxOvercommitMemoryValue() == 0) {
9017 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.");
9020 #endif /* __linux__ */
9022 static void daemonize(void) {
9026 if (fork() != 0) exit(0); /* parent exits */
9027 setsid(); /* create a new session */
9029 /* Every output goes to /dev/null. If Redis is daemonized but
9030 * the 'logfile' is set to 'stdout' in the configuration file
9031 * it will not log at all. */
9032 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9033 dup2(fd
, STDIN_FILENO
);
9034 dup2(fd
, STDOUT_FILENO
);
9035 dup2(fd
, STDERR_FILENO
);
9036 if (fd
> STDERR_FILENO
) close(fd
);
9038 /* Try to write the pid file */
9039 fp
= fopen(server
.pidfile
,"w");
9041 fprintf(fp
,"%d\n",getpid());
9046 int main(int argc
, char **argv
) {
9051 resetServerSaveParams();
9052 loadServerConfig(argv
[1]);
9053 } else if (argc
> 2) {
9054 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9057 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'");
9059 if (server
.daemonize
) daemonize();
9061 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9063 linuxOvercommitMemoryWarning();
9066 if (server
.appendonly
) {
9067 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9068 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9070 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9071 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9073 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9074 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9076 aeDeleteEventLoop(server
.el
);
9080 /* ============================= Backtrace support ========================= */
9082 #ifdef HAVE_BACKTRACE
9083 static char *findFuncName(void *pointer
, unsigned long *offset
);
9085 static void *getMcontextEip(ucontext_t
*uc
) {
9086 #if defined(__FreeBSD__)
9087 return (void*) uc
->uc_mcontext
.mc_eip
;
9088 #elif defined(__dietlibc__)
9089 return (void*) uc
->uc_mcontext
.eip
;
9090 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9092 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9094 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9096 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9097 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9098 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9100 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9102 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9103 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9104 #elif defined(__ia64__) /* Linux IA64 */
9105 return (void*) uc
->uc_mcontext
.sc_ip
;
9111 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9113 char **messages
= NULL
;
9114 int i
, trace_size
= 0;
9115 unsigned long offset
=0;
9116 ucontext_t
*uc
= (ucontext_t
*) secret
;
9118 REDIS_NOTUSED(info
);
9120 redisLog(REDIS_WARNING
,
9121 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9122 infostring
= genRedisInfoString();
9123 redisLog(REDIS_WARNING
, "%s",infostring
);
9124 /* It's not safe to sdsfree() the returned string under memory
9125 * corruption conditions. Let it leak as we are going to abort */
9127 trace_size
= backtrace(trace
, 100);
9128 /* overwrite sigaction with caller's address */
9129 if (getMcontextEip(uc
) != NULL
) {
9130 trace
[1] = getMcontextEip(uc
);
9132 messages
= backtrace_symbols(trace
, trace_size
);
9134 for (i
=1; i
<trace_size
; ++i
) {
9135 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9137 p
= strchr(messages
[i
],'+');
9138 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9139 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9141 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9144 /* free(messages); Don't call free() with possibly corrupted memory. */
9148 static void setupSigSegvAction(void) {
9149 struct sigaction act
;
9151 sigemptyset (&act
.sa_mask
);
9152 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9153 * is used. Otherwise, sa_handler is used */
9154 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9155 act
.sa_sigaction
= segvHandler
;
9156 sigaction (SIGSEGV
, &act
, NULL
);
9157 sigaction (SIGBUS
, &act
, NULL
);
9158 sigaction (SIGFPE
, &act
, NULL
);
9159 sigaction (SIGILL
, &act
, NULL
);
9160 sigaction (SIGBUS
, &act
, NULL
);
9164 #include "staticsymbols.h"
9165 /* This function try to convert a pointer into a function name. It's used in
9166 * oreder to provide a backtrace under segmentation fault that's able to
9167 * display functions declared as static (otherwise the backtrace is useless). */
9168 static char *findFuncName(void *pointer
, unsigned long *offset
){
9170 unsigned long off
, minoff
= 0;
9172 /* Try to match against the Symbol with the smallest offset */
9173 for (i
=0; symsTable
[i
].pointer
; i
++) {
9174 unsigned long lp
= (unsigned long) pointer
;
9176 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9177 off
=lp
-symsTable
[i
].pointer
;
9178 if (ret
< 0 || off
< minoff
) {
9184 if (ret
== -1) return NULL
;
9186 return symsTable
[ret
].name
;
9188 #else /* HAVE_BACKTRACE */
9189 static void setupSigSegvAction(void) {
9191 #endif /* HAVE_BACKTRACE */