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.7"
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 /* Use a function to determine which keys need to be loaded
447 * in the background prior to executing this command. Takes precedence
448 * over vm_firstkey and others, ignored when NULL */
449 redisCommandProc
*vm_preload_proc
;
450 /* What keys should be loaded in background when calling this command? */
451 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
452 int vm_lastkey
; /* THe last argument that's a key */
453 int vm_keystep
; /* The step between first and last key */
456 struct redisFunctionSym
{
458 unsigned long pointer
;
461 typedef struct _redisSortObject
{
469 typedef struct _redisSortOperation
{
472 } redisSortOperation
;
474 /* ZSETs use a specialized version of Skiplists */
476 typedef struct zskiplistNode
{
477 struct zskiplistNode
**forward
;
478 struct zskiplistNode
*backward
;
484 typedef struct zskiplist
{
485 struct zskiplistNode
*header
, *tail
;
486 unsigned long length
;
490 typedef struct zset
{
495 /* Our shared "common" objects */
497 struct sharedObjectsStruct
{
498 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
499 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
500 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
501 *outofrangeerr
, *plus
,
502 *select0
, *select1
, *select2
, *select3
, *select4
,
503 *select5
, *select6
, *select7
, *select8
, *select9
;
506 /* Global vars that are actally used as constants. The following double
507 * values are used for double on-disk serialization, and are initialized
508 * at runtime to avoid strange compiler optimizations. */
510 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
512 /* VM threaded I/O request message */
513 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
514 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
515 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
516 typedef struct iojob
{
517 int type
; /* Request type, REDIS_IOJOB_* */
518 redisDb
*db
;/* Redis database */
519 robj
*key
; /* This I/O request is about swapping this key */
520 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
521 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
522 off_t page
; /* Swap page where to read/write the object */
523 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
524 int canceled
; /* True if this command was canceled by blocking side of VM */
525 pthread_t thread
; /* ID of the thread processing this entry */
528 /*================================ Prototypes =============================== */
530 static void freeStringObject(robj
*o
);
531 static void freeListObject(robj
*o
);
532 static void freeSetObject(robj
*o
);
533 static void decrRefCount(void *o
);
534 static robj
*createObject(int type
, void *ptr
);
535 static void freeClient(redisClient
*c
);
536 static int rdbLoad(char *filename
);
537 static void addReply(redisClient
*c
, robj
*obj
);
538 static void addReplySds(redisClient
*c
, sds s
);
539 static void incrRefCount(robj
*o
);
540 static int rdbSaveBackground(char *filename
);
541 static robj
*createStringObject(char *ptr
, size_t len
);
542 static robj
*dupStringObject(robj
*o
);
543 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
544 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
545 static int syncWithMaster(void);
546 static robj
*tryObjectSharing(robj
*o
);
547 static int tryObjectEncoding(robj
*o
);
548 static robj
*getDecodedObject(robj
*o
);
549 static int removeExpire(redisDb
*db
, robj
*key
);
550 static int expireIfNeeded(redisDb
*db
, robj
*key
);
551 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
552 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
553 static int deleteKey(redisDb
*db
, robj
*key
);
554 static time_t getExpire(redisDb
*db
, robj
*key
);
555 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
556 static void updateSlavesWaitingBgsave(int bgsaveerr
);
557 static void freeMemoryIfNeeded(void);
558 static int processCommand(redisClient
*c
);
559 static void setupSigSegvAction(void);
560 static void rdbRemoveTempFile(pid_t childpid
);
561 static void aofRemoveTempFile(pid_t childpid
);
562 static size_t stringObjectLen(robj
*o
);
563 static void processInputBuffer(redisClient
*c
);
564 static zskiplist
*zslCreate(void);
565 static void zslFree(zskiplist
*zsl
);
566 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
567 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
568 static void initClientMultiState(redisClient
*c
);
569 static void freeClientMultiState(redisClient
*c
);
570 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
571 static void unblockClientWaitingData(redisClient
*c
);
572 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
573 static void vmInit(void);
574 static void vmMarkPagesFree(off_t page
, off_t count
);
575 static robj
*vmLoadObject(robj
*key
);
576 static robj
*vmPreviewObject(robj
*key
);
577 static int vmSwapOneObjectBlocking(void);
578 static int vmSwapOneObjectThreaded(void);
579 static int vmCanSwapOut(void);
580 static int tryFreeOneObjectFromFreelist(void);
581 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
582 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
583 static void vmCancelThreadedIOJob(robj
*o
);
584 static void lockThreadedIO(void);
585 static void unlockThreadedIO(void);
586 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
587 static void freeIOJob(iojob
*j
);
588 static void queueIOJob(iojob
*j
);
589 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
590 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
591 static void waitEmptyIOJobsQueue(void);
592 static void vmReopenSwapFile(void);
593 static int vmFreePage(off_t page
);
594 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
595 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
596 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
597 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
598 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static struct redisCommand
*lookupCommand(char *name
);
600 static void call(redisClient
*c
, struct redisCommand
*cmd
);
601 static void resetClient(redisClient
*c
);
602 static void convertToRealHash(robj
*o
);
604 static void authCommand(redisClient
*c
);
605 static void pingCommand(redisClient
*c
);
606 static void echoCommand(redisClient
*c
);
607 static void setCommand(redisClient
*c
);
608 static void setnxCommand(redisClient
*c
);
609 static void getCommand(redisClient
*c
);
610 static void delCommand(redisClient
*c
);
611 static void existsCommand(redisClient
*c
);
612 static void incrCommand(redisClient
*c
);
613 static void decrCommand(redisClient
*c
);
614 static void incrbyCommand(redisClient
*c
);
615 static void decrbyCommand(redisClient
*c
);
616 static void selectCommand(redisClient
*c
);
617 static void randomkeyCommand(redisClient
*c
);
618 static void keysCommand(redisClient
*c
);
619 static void dbsizeCommand(redisClient
*c
);
620 static void lastsaveCommand(redisClient
*c
);
621 static void saveCommand(redisClient
*c
);
622 static void bgsaveCommand(redisClient
*c
);
623 static void bgrewriteaofCommand(redisClient
*c
);
624 static void shutdownCommand(redisClient
*c
);
625 static void moveCommand(redisClient
*c
);
626 static void renameCommand(redisClient
*c
);
627 static void renamenxCommand(redisClient
*c
);
628 static void lpushCommand(redisClient
*c
);
629 static void rpushCommand(redisClient
*c
);
630 static void lpopCommand(redisClient
*c
);
631 static void rpopCommand(redisClient
*c
);
632 static void llenCommand(redisClient
*c
);
633 static void lindexCommand(redisClient
*c
);
634 static void lrangeCommand(redisClient
*c
);
635 static void ltrimCommand(redisClient
*c
);
636 static void typeCommand(redisClient
*c
);
637 static void lsetCommand(redisClient
*c
);
638 static void saddCommand(redisClient
*c
);
639 static void sremCommand(redisClient
*c
);
640 static void smoveCommand(redisClient
*c
);
641 static void sismemberCommand(redisClient
*c
);
642 static void scardCommand(redisClient
*c
);
643 static void spopCommand(redisClient
*c
);
644 static void srandmemberCommand(redisClient
*c
);
645 static void sinterCommand(redisClient
*c
);
646 static void sinterstoreCommand(redisClient
*c
);
647 static void sunionCommand(redisClient
*c
);
648 static void sunionstoreCommand(redisClient
*c
);
649 static void sdiffCommand(redisClient
*c
);
650 static void sdiffstoreCommand(redisClient
*c
);
651 static void syncCommand(redisClient
*c
);
652 static void flushdbCommand(redisClient
*c
);
653 static void flushallCommand(redisClient
*c
);
654 static void sortCommand(redisClient
*c
);
655 static void lremCommand(redisClient
*c
);
656 static void rpoplpushcommand(redisClient
*c
);
657 static void infoCommand(redisClient
*c
);
658 static void mgetCommand(redisClient
*c
);
659 static void monitorCommand(redisClient
*c
);
660 static void expireCommand(redisClient
*c
);
661 static void expireatCommand(redisClient
*c
);
662 static void getsetCommand(redisClient
*c
);
663 static void ttlCommand(redisClient
*c
);
664 static void slaveofCommand(redisClient
*c
);
665 static void debugCommand(redisClient
*c
);
666 static void msetCommand(redisClient
*c
);
667 static void msetnxCommand(redisClient
*c
);
668 static void zaddCommand(redisClient
*c
);
669 static void zincrbyCommand(redisClient
*c
);
670 static void zrangeCommand(redisClient
*c
);
671 static void zrangebyscoreCommand(redisClient
*c
);
672 static void zcountCommand(redisClient
*c
);
673 static void zrevrangeCommand(redisClient
*c
);
674 static void zcardCommand(redisClient
*c
);
675 static void zremCommand(redisClient
*c
);
676 static void zscoreCommand(redisClient
*c
);
677 static void zremrangebyscoreCommand(redisClient
*c
);
678 static void multiCommand(redisClient
*c
);
679 static void execCommand(redisClient
*c
);
680 static void discardCommand(redisClient
*c
);
681 static void blpopCommand(redisClient
*c
);
682 static void brpopCommand(redisClient
*c
);
683 static void appendCommand(redisClient
*c
);
684 static void substrCommand(redisClient
*c
);
685 static void zrankCommand(redisClient
*c
);
686 static void zrevrankCommand(redisClient
*c
);
687 static void hsetCommand(redisClient
*c
);
688 static void hgetCommand(redisClient
*c
);
689 static void hdelCommand(redisClient
*c
);
690 static void hlenCommand(redisClient
*c
);
691 static void zremrangebyrankCommand(redisClient
*c
);
692 static void zunionCommand(redisClient
*c
);
693 static void zinterCommand(redisClient
*c
);
694 static void hkeysCommand(redisClient
*c
);
695 static void hvalsCommand(redisClient
*c
);
696 static void hgetallCommand(redisClient
*c
);
697 static void hexistsCommand(redisClient
*c
);
699 /*================================= Globals ================================= */
702 static struct redisServer server
; /* server global state */
703 static struct redisCommand cmdTable
[] = {
704 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
705 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
706 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
707 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
708 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
709 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
710 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
711 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
712 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
713 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
714 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
715 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
716 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
717 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
718 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
719 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
720 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
721 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
722 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
723 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
724 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
725 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
726 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
727 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
728 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
729 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
730 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
731 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
732 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
733 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
734 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
735 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
736 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
737 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
738 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
739 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
740 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
742 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
743 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
744 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
747 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
748 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
754 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
755 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
756 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
757 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
759 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
764 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
766 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
767 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
768 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
769 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
770 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
771 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
772 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
775 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
776 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
777 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
778 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
779 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
780 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
781 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
782 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
783 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
784 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
785 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
786 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
788 {"exec",execCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
789 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
790 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
791 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
792 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
793 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
795 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
796 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
797 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
798 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
799 {NULL
,NULL
,0,0,NULL
,0,0,0}
804 /*============================ Utility functions ============================ */
806 /* Glob-style pattern matching. */
807 int stringmatchlen(const char *pattern
, int patternLen
,
808 const char *string
, int stringLen
, int nocase
)
813 while (pattern
[1] == '*') {
818 return 1; /* match */
820 if (stringmatchlen(pattern
+1, patternLen
-1,
821 string
, stringLen
, nocase
))
822 return 1; /* match */
826 return 0; /* no match */
830 return 0; /* no match */
840 not = pattern
[0] == '^';
847 if (pattern
[0] == '\\') {
850 if (pattern
[0] == string
[0])
852 } else if (pattern
[0] == ']') {
854 } else if (patternLen
== 0) {
858 } else if (pattern
[1] == '-' && patternLen
>= 3) {
859 int start
= pattern
[0];
860 int end
= pattern
[2];
868 start
= tolower(start
);
874 if (c
>= start
&& c
<= end
)
878 if (pattern
[0] == string
[0])
881 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
891 return 0; /* no match */
897 if (patternLen
>= 2) {
904 if (pattern
[0] != string
[0])
905 return 0; /* no match */
907 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
908 return 0; /* no match */
916 if (stringLen
== 0) {
917 while(*pattern
== '*') {
924 if (patternLen
== 0 && stringLen
== 0)
929 static void redisLog(int level
, const char *fmt
, ...) {
933 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
937 if (level
>= server
.verbosity
) {
943 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
944 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
945 vfprintf(fp
, fmt
, ap
);
951 if (server
.logfile
) fclose(fp
);
954 /*====================== Hash table type implementation ==================== */
956 /* This is an hash table type that uses the SDS dynamic strings libary as
957 * keys and radis objects as values (objects can hold SDS strings,
960 static void dictVanillaFree(void *privdata
, void *val
)
962 DICT_NOTUSED(privdata
);
966 static void dictListDestructor(void *privdata
, void *val
)
968 DICT_NOTUSED(privdata
);
969 listRelease((list
*)val
);
972 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
976 DICT_NOTUSED(privdata
);
978 l1
= sdslen((sds
)key1
);
979 l2
= sdslen((sds
)key2
);
980 if (l1
!= l2
) return 0;
981 return memcmp(key1
, key2
, l1
) == 0;
984 static void dictRedisObjectDestructor(void *privdata
, void *val
)
986 DICT_NOTUSED(privdata
);
988 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
992 static int dictObjKeyCompare(void *privdata
, const void *key1
,
995 const robj
*o1
= key1
, *o2
= key2
;
996 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
999 static unsigned int dictObjHash(const void *key
) {
1000 const robj
*o
= key
;
1001 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1004 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1007 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1010 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1011 o2
->encoding
== REDIS_ENCODING_INT
&&
1012 o1
->ptr
== o2
->ptr
) return 1;
1014 o1
= getDecodedObject(o1
);
1015 o2
= getDecodedObject(o2
);
1016 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1022 static unsigned int dictEncObjHash(const void *key
) {
1023 robj
*o
= (robj
*) key
;
1025 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1026 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1028 if (o
->encoding
== REDIS_ENCODING_INT
) {
1032 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1033 return dictGenHashFunction((unsigned char*)buf
, len
);
1037 o
= getDecodedObject(o
);
1038 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1045 /* Sets type and expires */
1046 static dictType setDictType
= {
1047 dictEncObjHash
, /* hash function */
1050 dictEncObjKeyCompare
, /* key compare */
1051 dictRedisObjectDestructor
, /* key destructor */
1052 NULL
/* val destructor */
1055 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1056 static dictType zsetDictType
= {
1057 dictEncObjHash
, /* hash function */
1060 dictEncObjKeyCompare
, /* key compare */
1061 dictRedisObjectDestructor
, /* key destructor */
1062 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1066 static dictType dbDictType
= {
1067 dictObjHash
, /* hash function */
1070 dictObjKeyCompare
, /* key compare */
1071 dictRedisObjectDestructor
, /* key destructor */
1072 dictRedisObjectDestructor
/* val destructor */
1076 static dictType keyptrDictType
= {
1077 dictObjHash
, /* hash function */
1080 dictObjKeyCompare
, /* key compare */
1081 dictRedisObjectDestructor
, /* key destructor */
1082 NULL
/* val destructor */
1085 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1086 static dictType hashDictType
= {
1087 dictEncObjHash
, /* hash function */
1090 dictEncObjKeyCompare
, /* key compare */
1091 dictRedisObjectDestructor
, /* key destructor */
1092 dictRedisObjectDestructor
/* val destructor */
1095 /* Keylist hash table type has unencoded redis objects as keys and
1096 * lists as values. It's used for blocking operations (BLPOP) and to
1097 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1098 static dictType keylistDictType
= {
1099 dictObjHash
, /* hash function */
1102 dictObjKeyCompare
, /* key compare */
1103 dictRedisObjectDestructor
, /* key destructor */
1104 dictListDestructor
/* val destructor */
1107 static void version();
1109 /* ========================= Random utility functions ======================= */
1111 /* Redis generally does not try to recover from out of memory conditions
1112 * when allocating objects or strings, it is not clear if it will be possible
1113 * to report this condition to the client since the networking layer itself
1114 * is based on heap allocation for send buffers, so we simply abort.
1115 * At least the code will be simpler to read... */
1116 static void oom(const char *msg
) {
1117 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1122 /* ====================== Redis server networking stuff ===================== */
1123 static void closeTimedoutClients(void) {
1126 time_t now
= time(NULL
);
1129 listRewind(server
.clients
,&li
);
1130 while ((ln
= listNext(&li
)) != NULL
) {
1131 c
= listNodeValue(ln
);
1132 if (server
.maxidletime
&&
1133 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1134 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1135 (now
- c
->lastinteraction
> server
.maxidletime
))
1137 redisLog(REDIS_VERBOSE
,"Closing idle client");
1139 } else if (c
->flags
& REDIS_BLOCKED
) {
1140 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1141 addReply(c
,shared
.nullmultibulk
);
1142 unblockClientWaitingData(c
);
1148 static int htNeedsResize(dict
*dict
) {
1149 long long size
, used
;
1151 size
= dictSlots(dict
);
1152 used
= dictSize(dict
);
1153 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1154 (used
*100/size
< REDIS_HT_MINFILL
));
1157 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1158 * we resize the hash table to save memory */
1159 static void tryResizeHashTables(void) {
1162 for (j
= 0; j
< server
.dbnum
; j
++) {
1163 if (htNeedsResize(server
.db
[j
].dict
)) {
1164 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1165 dictResize(server
.db
[j
].dict
);
1166 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1168 if (htNeedsResize(server
.db
[j
].expires
))
1169 dictResize(server
.db
[j
].expires
);
1173 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1174 void backgroundSaveDoneHandler(int statloc
) {
1175 int exitcode
= WEXITSTATUS(statloc
);
1176 int bysignal
= WIFSIGNALED(statloc
);
1178 if (!bysignal
&& exitcode
== 0) {
1179 redisLog(REDIS_NOTICE
,
1180 "Background saving terminated with success");
1182 server
.lastsave
= time(NULL
);
1183 } else if (!bysignal
&& exitcode
!= 0) {
1184 redisLog(REDIS_WARNING
, "Background saving error");
1186 redisLog(REDIS_WARNING
,
1187 "Background saving terminated by signal");
1188 rdbRemoveTempFile(server
.bgsavechildpid
);
1190 server
.bgsavechildpid
= -1;
1191 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1192 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1193 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1196 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1198 void backgroundRewriteDoneHandler(int statloc
) {
1199 int exitcode
= WEXITSTATUS(statloc
);
1200 int bysignal
= WIFSIGNALED(statloc
);
1202 if (!bysignal
&& exitcode
== 0) {
1206 redisLog(REDIS_NOTICE
,
1207 "Background append only file rewriting terminated with success");
1208 /* Now it's time to flush the differences accumulated by the parent */
1209 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1210 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1212 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1215 /* Flush our data... */
1216 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1217 (signed) sdslen(server
.bgrewritebuf
)) {
1218 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
));
1222 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1223 /* Now our work is to rename the temp file into the stable file. And
1224 * switch the file descriptor used by the server for append only. */
1225 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1226 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1230 /* Mission completed... almost */
1231 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1232 if (server
.appendfd
!= -1) {
1233 /* If append only is actually enabled... */
1234 close(server
.appendfd
);
1235 server
.appendfd
= fd
;
1237 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1238 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1240 /* If append only is disabled we just generate a dump in this
1241 * format. Why not? */
1244 } else if (!bysignal
&& exitcode
!= 0) {
1245 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1247 redisLog(REDIS_WARNING
,
1248 "Background append only file rewriting terminated by signal");
1251 sdsfree(server
.bgrewritebuf
);
1252 server
.bgrewritebuf
= sdsempty();
1253 aofRemoveTempFile(server
.bgrewritechildpid
);
1254 server
.bgrewritechildpid
= -1;
1257 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1258 int j
, loops
= server
.cronloops
++;
1259 REDIS_NOTUSED(eventLoop
);
1261 REDIS_NOTUSED(clientData
);
1263 /* We take a cached value of the unix time in the global state because
1264 * with virtual memory and aging there is to store the current time
1265 * in objects at every object access, and accuracy is not needed.
1266 * To access a global var is faster than calling time(NULL) */
1267 server
.unixtime
= time(NULL
);
1269 /* Show some info about non-empty databases */
1270 for (j
= 0; j
< server
.dbnum
; j
++) {
1271 long long size
, used
, vkeys
;
1273 size
= dictSlots(server
.db
[j
].dict
);
1274 used
= dictSize(server
.db
[j
].dict
);
1275 vkeys
= dictSize(server
.db
[j
].expires
);
1276 if (!(loops
% 5) && (used
|| vkeys
)) {
1277 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1278 /* dictPrintStats(server.dict); */
1282 /* We don't want to resize the hash tables while a bacground saving
1283 * is in progress: the saving child is created using fork() that is
1284 * implemented with a copy-on-write semantic in most modern systems, so
1285 * if we resize the HT while there is the saving child at work actually
1286 * a lot of memory movements in the parent will cause a lot of pages
1288 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1290 /* Show information about connected clients */
1292 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1293 listLength(server
.clients
)-listLength(server
.slaves
),
1294 listLength(server
.slaves
),
1295 zmalloc_used_memory(),
1296 dictSize(server
.sharingpool
));
1299 /* Close connections of timedout clients */
1300 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1301 closeTimedoutClients();
1303 /* Check if a background saving or AOF rewrite in progress terminated */
1304 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1308 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1309 if (pid
== server
.bgsavechildpid
) {
1310 backgroundSaveDoneHandler(statloc
);
1312 backgroundRewriteDoneHandler(statloc
);
1316 /* If there is not a background saving in progress check if
1317 * we have to save now */
1318 time_t now
= time(NULL
);
1319 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1320 struct saveparam
*sp
= server
.saveparams
+j
;
1322 if (server
.dirty
>= sp
->changes
&&
1323 now
-server
.lastsave
> sp
->seconds
) {
1324 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1325 sp
->changes
, sp
->seconds
);
1326 rdbSaveBackground(server
.dbfilename
);
1332 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1333 * will use few CPU cycles if there are few expiring keys, otherwise
1334 * it will get more aggressive to avoid that too much memory is used by
1335 * keys that can be removed from the keyspace. */
1336 for (j
= 0; j
< server
.dbnum
; j
++) {
1338 redisDb
*db
= server
.db
+j
;
1340 /* Continue to expire if at the end of the cycle more than 25%
1341 * of the keys were expired. */
1343 long num
= dictSize(db
->expires
);
1344 time_t now
= time(NULL
);
1347 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1348 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1353 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1354 t
= (time_t) dictGetEntryVal(de
);
1356 deleteKey(db
,dictGetEntryKey(de
));
1360 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1363 /* Swap a few keys on disk if we are over the memory limit and VM
1364 * is enbled. Try to free objects from the free list first. */
1365 if (vmCanSwapOut()) {
1366 while (server
.vm_enabled
&& zmalloc_used_memory() >
1367 server
.vm_max_memory
)
1371 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1372 retval
= (server
.vm_max_threads
== 0) ?
1373 vmSwapOneObjectBlocking() :
1374 vmSwapOneObjectThreaded();
1375 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1376 zmalloc_used_memory() >
1377 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1379 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1381 /* Note that when using threade I/O we free just one object,
1382 * because anyway when the I/O thread in charge to swap this
1383 * object out will finish, the handler of completed jobs
1384 * will try to swap more objects if we are still out of memory. */
1385 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1389 /* Check if we should connect to a MASTER */
1390 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1391 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1392 if (syncWithMaster() == REDIS_OK
) {
1393 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1399 /* This function gets called every time Redis is entering the
1400 * main loop of the event driven library, that is, before to sleep
1401 * for ready file descriptors. */
1402 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1403 REDIS_NOTUSED(eventLoop
);
1405 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1409 listRewind(server
.io_ready_clients
,&li
);
1410 while((ln
= listNext(&li
))) {
1411 redisClient
*c
= ln
->value
;
1412 struct redisCommand
*cmd
;
1414 /* Resume the client. */
1415 listDelNode(server
.io_ready_clients
,ln
);
1416 c
->flags
&= (~REDIS_IO_WAIT
);
1417 server
.vm_blocked_clients
--;
1418 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1419 readQueryFromClient
, c
);
1420 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1421 assert(cmd
!= NULL
);
1424 /* There may be more data to process in the input buffer. */
1425 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1426 processInputBuffer(c
);
1431 static void createSharedObjects(void) {
1432 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1433 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1434 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1435 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1436 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1437 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1438 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1439 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1440 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1441 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1442 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1443 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1444 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1445 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1446 "-ERR no such key\r\n"));
1447 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1448 "-ERR syntax error\r\n"));
1449 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1450 "-ERR source and destination objects are the same\r\n"));
1451 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1452 "-ERR index out of range\r\n"));
1453 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1454 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1455 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1456 shared
.select0
= createStringObject("select 0\r\n",10);
1457 shared
.select1
= createStringObject("select 1\r\n",10);
1458 shared
.select2
= createStringObject("select 2\r\n",10);
1459 shared
.select3
= createStringObject("select 3\r\n",10);
1460 shared
.select4
= createStringObject("select 4\r\n",10);
1461 shared
.select5
= createStringObject("select 5\r\n",10);
1462 shared
.select6
= createStringObject("select 6\r\n",10);
1463 shared
.select7
= createStringObject("select 7\r\n",10);
1464 shared
.select8
= createStringObject("select 8\r\n",10);
1465 shared
.select9
= createStringObject("select 9\r\n",10);
1468 static void appendServerSaveParams(time_t seconds
, int changes
) {
1469 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1470 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1471 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1472 server
.saveparamslen
++;
1475 static void resetServerSaveParams() {
1476 zfree(server
.saveparams
);
1477 server
.saveparams
= NULL
;
1478 server
.saveparamslen
= 0;
1481 static void initServerConfig() {
1482 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1483 server
.port
= REDIS_SERVERPORT
;
1484 server
.verbosity
= REDIS_VERBOSE
;
1485 server
.maxidletime
= REDIS_MAXIDLETIME
;
1486 server
.saveparams
= NULL
;
1487 server
.logfile
= NULL
; /* NULL = log on standard output */
1488 server
.bindaddr
= NULL
;
1489 server
.glueoutputbuf
= 1;
1490 server
.daemonize
= 0;
1491 server
.appendonly
= 0;
1492 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1493 server
.lastfsync
= time(NULL
);
1494 server
.appendfd
= -1;
1495 server
.appendseldb
= -1; /* Make sure the first time will not match */
1496 server
.pidfile
= "/var/run/redis.pid";
1497 server
.dbfilename
= "dump.rdb";
1498 server
.appendfilename
= "appendonly.aof";
1499 server
.requirepass
= NULL
;
1500 server
.shareobjects
= 0;
1501 server
.rdbcompression
= 1;
1502 server
.sharingpoolsize
= 1024;
1503 server
.maxclients
= 0;
1504 server
.blpop_blocked_clients
= 0;
1505 server
.maxmemory
= 0;
1506 server
.vm_enabled
= 0;
1507 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1508 server
.vm_page_size
= 256; /* 256 bytes per page */
1509 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1510 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1511 server
.vm_max_threads
= 4;
1512 server
.vm_blocked_clients
= 0;
1513 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1514 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1516 resetServerSaveParams();
1518 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1519 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1520 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1521 /* Replication related */
1523 server
.masterauth
= NULL
;
1524 server
.masterhost
= NULL
;
1525 server
.masterport
= 6379;
1526 server
.master
= NULL
;
1527 server
.replstate
= REDIS_REPL_NONE
;
1529 /* Double constants initialization */
1531 R_PosInf
= 1.0/R_Zero
;
1532 R_NegInf
= -1.0/R_Zero
;
1533 R_Nan
= R_Zero
/R_Zero
;
1536 static void initServer() {
1539 signal(SIGHUP
, SIG_IGN
);
1540 signal(SIGPIPE
, SIG_IGN
);
1541 setupSigSegvAction();
1543 server
.devnull
= fopen("/dev/null","w");
1544 if (server
.devnull
== NULL
) {
1545 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1548 server
.clients
= listCreate();
1549 server
.slaves
= listCreate();
1550 server
.monitors
= listCreate();
1551 server
.objfreelist
= listCreate();
1552 createSharedObjects();
1553 server
.el
= aeCreateEventLoop();
1554 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1555 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1556 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1557 if (server
.fd
== -1) {
1558 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1561 for (j
= 0; j
< server
.dbnum
; j
++) {
1562 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1563 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1564 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1565 if (server
.vm_enabled
)
1566 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1567 server
.db
[j
].id
= j
;
1569 server
.cronloops
= 0;
1570 server
.bgsavechildpid
= -1;
1571 server
.bgrewritechildpid
= -1;
1572 server
.bgrewritebuf
= sdsempty();
1573 server
.lastsave
= time(NULL
);
1575 server
.stat_numcommands
= 0;
1576 server
.stat_numconnections
= 0;
1577 server
.stat_starttime
= time(NULL
);
1578 server
.unixtime
= time(NULL
);
1579 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1580 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1581 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1583 if (server
.appendonly
) {
1584 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1585 if (server
.appendfd
== -1) {
1586 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1592 if (server
.vm_enabled
) vmInit();
1595 /* Empty the whole database */
1596 static long long emptyDb() {
1598 long long removed
= 0;
1600 for (j
= 0; j
< server
.dbnum
; j
++) {
1601 removed
+= dictSize(server
.db
[j
].dict
);
1602 dictEmpty(server
.db
[j
].dict
);
1603 dictEmpty(server
.db
[j
].expires
);
1608 static int yesnotoi(char *s
) {
1609 if (!strcasecmp(s
,"yes")) return 1;
1610 else if (!strcasecmp(s
,"no")) return 0;
1614 /* I agree, this is a very rudimental way to load a configuration...
1615 will improve later if the config gets more complex */
1616 static void loadServerConfig(char *filename
) {
1618 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1621 char *errormsg
= "Fatal error, can't open config file '%s'";
1622 char *errorbuf
= zmalloc(sizeof(char)*(strlen(errormsg
)+strlen(filename
)));
1623 sprintf(errorbuf
, errormsg
, filename
);
1625 if (filename
[0] == '-' && filename
[1] == '\0')
1628 if ((fp
= fopen(filename
,"r")) == NULL
) {
1629 redisLog(REDIS_WARNING
, errorbuf
);
1634 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1640 line
= sdstrim(line
," \t\r\n");
1642 /* Skip comments and blank lines*/
1643 if (line
[0] == '#' || line
[0] == '\0') {
1648 /* Split into arguments */
1649 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1650 sdstolower(argv
[0]);
1652 /* Execute config directives */
1653 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1654 server
.maxidletime
= atoi(argv
[1]);
1655 if (server
.maxidletime
< 0) {
1656 err
= "Invalid timeout value"; goto loaderr
;
1658 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1659 server
.port
= atoi(argv
[1]);
1660 if (server
.port
< 1 || server
.port
> 65535) {
1661 err
= "Invalid port"; goto loaderr
;
1663 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1664 server
.bindaddr
= zstrdup(argv
[1]);
1665 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1666 int seconds
= atoi(argv
[1]);
1667 int changes
= atoi(argv
[2]);
1668 if (seconds
< 1 || changes
< 0) {
1669 err
= "Invalid save parameters"; goto loaderr
;
1671 appendServerSaveParams(seconds
,changes
);
1672 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1673 if (chdir(argv
[1]) == -1) {
1674 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1675 argv
[1], strerror(errno
));
1678 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1679 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1680 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1681 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1682 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1684 err
= "Invalid log level. Must be one of debug, notice, warning";
1687 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1690 server
.logfile
= zstrdup(argv
[1]);
1691 if (!strcasecmp(server
.logfile
,"stdout")) {
1692 zfree(server
.logfile
);
1693 server
.logfile
= NULL
;
1695 if (server
.logfile
) {
1696 /* Test if we are able to open the file. The server will not
1697 * be able to abort just for this problem later... */
1698 logfp
= fopen(server
.logfile
,"a");
1699 if (logfp
== NULL
) {
1700 err
= sdscatprintf(sdsempty(),
1701 "Can't open the log file: %s", strerror(errno
));
1706 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1707 server
.dbnum
= atoi(argv
[1]);
1708 if (server
.dbnum
< 1) {
1709 err
= "Invalid number of databases"; goto loaderr
;
1711 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1712 loadServerConfig(argv
[1]);
1713 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1714 server
.maxclients
= atoi(argv
[1]);
1715 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1716 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1717 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1718 server
.masterhost
= sdsnew(argv
[1]);
1719 server
.masterport
= atoi(argv
[2]);
1720 server
.replstate
= REDIS_REPL_CONNECT
;
1721 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1722 server
.masterauth
= zstrdup(argv
[1]);
1723 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1724 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1725 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1727 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1728 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1729 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1731 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1732 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1733 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1735 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1736 server
.sharingpoolsize
= atoi(argv
[1]);
1737 if (server
.sharingpoolsize
< 1) {
1738 err
= "invalid object sharing pool size"; goto loaderr
;
1740 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1741 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1742 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1744 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1745 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1746 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1748 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1749 if (!strcasecmp(argv
[1],"no")) {
1750 server
.appendfsync
= APPENDFSYNC_NO
;
1751 } else if (!strcasecmp(argv
[1],"always")) {
1752 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1753 } else if (!strcasecmp(argv
[1],"everysec")) {
1754 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1756 err
= "argument must be 'no', 'always' or 'everysec'";
1759 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1760 server
.requirepass
= zstrdup(argv
[1]);
1761 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1762 server
.pidfile
= zstrdup(argv
[1]);
1763 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1764 server
.dbfilename
= zstrdup(argv
[1]);
1765 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1766 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1767 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1769 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1770 zfree(server
.vm_swap_file
);
1771 server
.vm_swap_file
= zstrdup(argv
[1]);
1772 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1773 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1774 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1775 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1776 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1777 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1778 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1779 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1780 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1781 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1782 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1783 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1784 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1785 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1787 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1789 for (j
= 0; j
< argc
; j
++)
1794 if (fp
!= stdin
) fclose(fp
);
1798 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1799 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1800 fprintf(stderr
, ">>> '%s'\n", line
);
1801 fprintf(stderr
, "%s\n", err
);
1805 static void freeClientArgv(redisClient
*c
) {
1808 for (j
= 0; j
< c
->argc
; j
++)
1809 decrRefCount(c
->argv
[j
]);
1810 for (j
= 0; j
< c
->mbargc
; j
++)
1811 decrRefCount(c
->mbargv
[j
]);
1816 static void freeClient(redisClient
*c
) {
1819 /* Note that if the client we are freeing is blocked into a blocking
1820 * call, we have to set querybuf to NULL *before* to call
1821 * unblockClientWaitingData() to avoid processInputBuffer() will get
1822 * called. Also it is important to remove the file events after
1823 * this, because this call adds the READABLE event. */
1824 sdsfree(c
->querybuf
);
1826 if (c
->flags
& REDIS_BLOCKED
)
1827 unblockClientWaitingData(c
);
1829 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1830 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1831 listRelease(c
->reply
);
1834 /* Remove from the list of clients */
1835 ln
= listSearchKey(server
.clients
,c
);
1836 redisAssert(ln
!= NULL
);
1837 listDelNode(server
.clients
,ln
);
1838 /* Remove from the list of clients waiting for swapped keys */
1839 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1840 ln
= listSearchKey(server
.io_ready_clients
,c
);
1842 listDelNode(server
.io_ready_clients
,ln
);
1843 server
.vm_blocked_clients
--;
1846 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1847 ln
= listFirst(c
->io_keys
);
1848 dontWaitForSwappedKey(c
,ln
->value
);
1850 listRelease(c
->io_keys
);
1852 if (c
->flags
& REDIS_SLAVE
) {
1853 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1855 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1856 ln
= listSearchKey(l
,c
);
1857 redisAssert(ln
!= NULL
);
1860 if (c
->flags
& REDIS_MASTER
) {
1861 server
.master
= NULL
;
1862 server
.replstate
= REDIS_REPL_CONNECT
;
1866 freeClientMultiState(c
);
1870 #define GLUEREPLY_UP_TO (1024)
1871 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1873 char buf
[GLUEREPLY_UP_TO
];
1878 listRewind(c
->reply
,&li
);
1879 while((ln
= listNext(&li
))) {
1883 objlen
= sdslen(o
->ptr
);
1884 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1885 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1887 listDelNode(c
->reply
,ln
);
1889 if (copylen
== 0) return;
1893 /* Now the output buffer is empty, add the new single element */
1894 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1895 listAddNodeHead(c
->reply
,o
);
1898 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1899 redisClient
*c
= privdata
;
1900 int nwritten
= 0, totwritten
= 0, objlen
;
1903 REDIS_NOTUSED(mask
);
1905 /* Use writev() if we have enough buffers to send */
1906 if (!server
.glueoutputbuf
&&
1907 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1908 !(c
->flags
& REDIS_MASTER
))
1910 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1914 while(listLength(c
->reply
)) {
1915 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1916 glueReplyBuffersIfNeeded(c
);
1918 o
= listNodeValue(listFirst(c
->reply
));
1919 objlen
= sdslen(o
->ptr
);
1922 listDelNode(c
->reply
,listFirst(c
->reply
));
1926 if (c
->flags
& REDIS_MASTER
) {
1927 /* Don't reply to a master */
1928 nwritten
= objlen
- c
->sentlen
;
1930 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1931 if (nwritten
<= 0) break;
1933 c
->sentlen
+= nwritten
;
1934 totwritten
+= nwritten
;
1935 /* If we fully sent the object on head go to the next one */
1936 if (c
->sentlen
== objlen
) {
1937 listDelNode(c
->reply
,listFirst(c
->reply
));
1940 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1941 * bytes, in a single threaded server it's a good idea to serve
1942 * other clients as well, even if a very large request comes from
1943 * super fast link that is always able to accept data (in real world
1944 * scenario think about 'KEYS *' against the loopback interfae) */
1945 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1947 if (nwritten
== -1) {
1948 if (errno
== EAGAIN
) {
1951 redisLog(REDIS_VERBOSE
,
1952 "Error writing to client: %s", strerror(errno
));
1957 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1958 if (listLength(c
->reply
) == 0) {
1960 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1964 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1966 redisClient
*c
= privdata
;
1967 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1969 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1970 int offset
, ion
= 0;
1972 REDIS_NOTUSED(mask
);
1975 while (listLength(c
->reply
)) {
1976 offset
= c
->sentlen
;
1980 /* fill-in the iov[] array */
1981 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1982 o
= listNodeValue(node
);
1983 objlen
= sdslen(o
->ptr
);
1985 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1988 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1989 break; /* no more iovecs */
1991 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1992 iov
[ion
].iov_len
= objlen
- offset
;
1993 willwrite
+= objlen
- offset
;
1994 offset
= 0; /* just for the first item */
2001 /* write all collected blocks at once */
2002 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2003 if (errno
!= EAGAIN
) {
2004 redisLog(REDIS_VERBOSE
,
2005 "Error writing to client: %s", strerror(errno
));
2012 totwritten
+= nwritten
;
2013 offset
= c
->sentlen
;
2015 /* remove written robjs from c->reply */
2016 while (nwritten
&& listLength(c
->reply
)) {
2017 o
= listNodeValue(listFirst(c
->reply
));
2018 objlen
= sdslen(o
->ptr
);
2020 if(nwritten
>= objlen
- offset
) {
2021 listDelNode(c
->reply
, listFirst(c
->reply
));
2022 nwritten
-= objlen
- offset
;
2026 c
->sentlen
+= nwritten
;
2034 c
->lastinteraction
= time(NULL
);
2036 if (listLength(c
->reply
) == 0) {
2038 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2042 static struct redisCommand
*lookupCommand(char *name
) {
2044 while(cmdTable
[j
].name
!= NULL
) {
2045 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2051 /* resetClient prepare the client to process the next command */
2052 static void resetClient(redisClient
*c
) {
2058 /* Call() is the core of Redis execution of a command */
2059 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2062 dirty
= server
.dirty
;
2064 if (server
.appendonly
&& server
.dirty
-dirty
)
2065 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2066 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2067 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2068 if (listLength(server
.monitors
))
2069 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2070 server
.stat_numcommands
++;
2073 /* If this function gets called we already read a whole
2074 * command, argments are in the client argv/argc fields.
2075 * processCommand() execute the command or prepare the
2076 * server for a bulk read from the client.
2078 * If 1 is returned the client is still alive and valid and
2079 * and other operations can be performed by the caller. Otherwise
2080 * if 0 is returned the client was destroied (i.e. after QUIT). */
2081 static int processCommand(redisClient
*c
) {
2082 struct redisCommand
*cmd
;
2084 /* Free some memory if needed (maxmemory setting) */
2085 if (server
.maxmemory
) freeMemoryIfNeeded();
2087 /* Handle the multi bulk command type. This is an alternative protocol
2088 * supported by Redis in order to receive commands that are composed of
2089 * multiple binary-safe "bulk" arguments. The latency of processing is
2090 * a bit higher but this allows things like multi-sets, so if this
2091 * protocol is used only for MSET and similar commands this is a big win. */
2092 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2093 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2094 if (c
->multibulk
<= 0) {
2098 decrRefCount(c
->argv
[c
->argc
-1]);
2102 } else if (c
->multibulk
) {
2103 if (c
->bulklen
== -1) {
2104 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2105 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2109 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2110 decrRefCount(c
->argv
[0]);
2111 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2113 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2118 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2122 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2123 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2127 if (c
->multibulk
== 0) {
2131 /* Here we need to swap the multi-bulk argc/argv with the
2132 * normal argc/argv of the client structure. */
2134 c
->argv
= c
->mbargv
;
2135 c
->mbargv
= auxargv
;
2138 c
->argc
= c
->mbargc
;
2139 c
->mbargc
= auxargc
;
2141 /* We need to set bulklen to something different than -1
2142 * in order for the code below to process the command without
2143 * to try to read the last argument of a bulk command as
2144 * a special argument. */
2146 /* continue below and process the command */
2153 /* -- end of multi bulk commands processing -- */
2155 /* The QUIT command is handled as a special case. Normal command
2156 * procs are unable to close the client connection safely */
2157 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2162 /* Now lookup the command and check ASAP about trivial error conditions
2163 * such wrong arity, bad command name and so forth. */
2164 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2167 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2168 (char*)c
->argv
[0]->ptr
));
2171 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2172 (c
->argc
< -cmd
->arity
)) {
2174 sdscatprintf(sdsempty(),
2175 "-ERR wrong number of arguments for '%s' command\r\n",
2179 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2180 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2183 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2184 /* This is a bulk command, we have to read the last argument yet. */
2185 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2187 decrRefCount(c
->argv
[c
->argc
-1]);
2188 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2190 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2195 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2196 /* It is possible that the bulk read is already in the
2197 * buffer. Check this condition and handle it accordingly.
2198 * This is just a fast path, alternative to call processInputBuffer().
2199 * It's a good idea since the code is small and this condition
2200 * happens most of the times. */
2201 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2202 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2204 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2206 /* Otherwise return... there is to read the last argument
2207 * from the socket. */
2211 /* Let's try to share objects on the command arguments vector */
2212 if (server
.shareobjects
) {
2214 for(j
= 1; j
< c
->argc
; j
++)
2215 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2217 /* Let's try to encode the bulk object to save space. */
2218 if (cmd
->flags
& REDIS_CMD_BULK
)
2219 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2221 /* Check if the user is authenticated */
2222 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2223 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2228 /* Exec the command */
2229 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2230 queueMultiCommand(c
,cmd
);
2231 addReply(c
,shared
.queued
);
2233 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2234 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2238 /* Prepare the client for the next command */
2243 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2248 /* (args*2)+1 is enough room for args, spaces, newlines */
2249 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2251 if (argc
<= REDIS_STATIC_ARGS
) {
2254 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2257 for (j
= 0; j
< argc
; j
++) {
2258 if (j
!= 0) outv
[outc
++] = shared
.space
;
2259 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2262 lenobj
= createObject(REDIS_STRING
,
2263 sdscatprintf(sdsempty(),"%lu\r\n",
2264 (unsigned long) stringObjectLen(argv
[j
])));
2265 lenobj
->refcount
= 0;
2266 outv
[outc
++] = lenobj
;
2268 outv
[outc
++] = argv
[j
];
2270 outv
[outc
++] = shared
.crlf
;
2272 /* Increment all the refcounts at start and decrement at end in order to
2273 * be sure to free objects if there is no slave in a replication state
2274 * able to be feed with commands */
2275 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2276 listRewind(slaves
,&li
);
2277 while((ln
= listNext(&li
))) {
2278 redisClient
*slave
= ln
->value
;
2280 /* Don't feed slaves that are still waiting for BGSAVE to start */
2281 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2283 /* Feed all the other slaves, MONITORs and so on */
2284 if (slave
->slaveseldb
!= dictid
) {
2288 case 0: selectcmd
= shared
.select0
; break;
2289 case 1: selectcmd
= shared
.select1
; break;
2290 case 2: selectcmd
= shared
.select2
; break;
2291 case 3: selectcmd
= shared
.select3
; break;
2292 case 4: selectcmd
= shared
.select4
; break;
2293 case 5: selectcmd
= shared
.select5
; break;
2294 case 6: selectcmd
= shared
.select6
; break;
2295 case 7: selectcmd
= shared
.select7
; break;
2296 case 8: selectcmd
= shared
.select8
; break;
2297 case 9: selectcmd
= shared
.select9
; break;
2299 selectcmd
= createObject(REDIS_STRING
,
2300 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2301 selectcmd
->refcount
= 0;
2304 addReply(slave
,selectcmd
);
2305 slave
->slaveseldb
= dictid
;
2307 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2309 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2310 if (outv
!= static_outv
) zfree(outv
);
2313 static void processInputBuffer(redisClient
*c
) {
2315 /* Before to process the input buffer, make sure the client is not
2316 * waitig for a blocking operation such as BLPOP. Note that the first
2317 * iteration the client is never blocked, otherwise the processInputBuffer
2318 * would not be called at all, but after the execution of the first commands
2319 * in the input buffer the client may be blocked, and the "goto again"
2320 * will try to reiterate. The following line will make it return asap. */
2321 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2322 if (c
->bulklen
== -1) {
2323 /* Read the first line of the query */
2324 char *p
= strchr(c
->querybuf
,'\n');
2331 query
= c
->querybuf
;
2332 c
->querybuf
= sdsempty();
2333 querylen
= 1+(p
-(query
));
2334 if (sdslen(query
) > querylen
) {
2335 /* leave data after the first line of the query in the buffer */
2336 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2338 *p
= '\0'; /* remove "\n" */
2339 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2340 sdsupdatelen(query
);
2342 /* Now we can split the query in arguments */
2343 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2346 if (c
->argv
) zfree(c
->argv
);
2347 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2349 for (j
= 0; j
< argc
; j
++) {
2350 if (sdslen(argv
[j
])) {
2351 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2359 /* Execute the command. If the client is still valid
2360 * after processCommand() return and there is something
2361 * on the query buffer try to process the next command. */
2362 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2364 /* Nothing to process, argc == 0. Just process the query
2365 * buffer if it's not empty or return to the caller */
2366 if (sdslen(c
->querybuf
)) goto again
;
2369 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2370 redisLog(REDIS_VERBOSE
, "Client protocol error");
2375 /* Bulk read handling. Note that if we are at this point
2376 the client already sent a command terminated with a newline,
2377 we are reading the bulk data that is actually the last
2378 argument of the command. */
2379 int qbl
= sdslen(c
->querybuf
);
2381 if (c
->bulklen
<= qbl
) {
2382 /* Copy everything but the final CRLF as final argument */
2383 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2385 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2386 /* Process the command. If the client is still valid after
2387 * the processing and there is more data in the buffer
2388 * try to parse it. */
2389 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2395 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2396 redisClient
*c
= (redisClient
*) privdata
;
2397 char buf
[REDIS_IOBUF_LEN
];
2400 REDIS_NOTUSED(mask
);
2402 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2404 if (errno
== EAGAIN
) {
2407 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2411 } else if (nread
== 0) {
2412 redisLog(REDIS_VERBOSE
, "Client closed connection");
2417 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2418 c
->lastinteraction
= time(NULL
);
2422 if (!(c
->flags
& REDIS_BLOCKED
))
2423 processInputBuffer(c
);
2426 static int selectDb(redisClient
*c
, int id
) {
2427 if (id
< 0 || id
>= server
.dbnum
)
2429 c
->db
= &server
.db
[id
];
2433 static void *dupClientReplyValue(void *o
) {
2434 incrRefCount((robj
*)o
);
2438 static redisClient
*createClient(int fd
) {
2439 redisClient
*c
= zmalloc(sizeof(*c
));
2441 anetNonBlock(NULL
,fd
);
2442 anetTcpNoDelay(NULL
,fd
);
2443 if (!c
) return NULL
;
2446 c
->querybuf
= sdsempty();
2455 c
->lastinteraction
= time(NULL
);
2456 c
->authenticated
= 0;
2457 c
->replstate
= REDIS_REPL_NONE
;
2458 c
->reply
= listCreate();
2459 listSetFreeMethod(c
->reply
,decrRefCount
);
2460 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2461 c
->blockingkeys
= NULL
;
2462 c
->blockingkeysnum
= 0;
2463 c
->io_keys
= listCreate();
2464 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2465 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2466 readQueryFromClient
, c
) == AE_ERR
) {
2470 listAddNodeTail(server
.clients
,c
);
2471 initClientMultiState(c
);
2475 static void addReply(redisClient
*c
, robj
*obj
) {
2476 if (listLength(c
->reply
) == 0 &&
2477 (c
->replstate
== REDIS_REPL_NONE
||
2478 c
->replstate
== REDIS_REPL_ONLINE
) &&
2479 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2480 sendReplyToClient
, c
) == AE_ERR
) return;
2482 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2483 obj
= dupStringObject(obj
);
2484 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2486 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2489 static void addReplySds(redisClient
*c
, sds s
) {
2490 robj
*o
= createObject(REDIS_STRING
,s
);
2495 static void addReplyDouble(redisClient
*c
, double d
) {
2498 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2499 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2500 (unsigned long) strlen(buf
),buf
));
2503 static void addReplyLong(redisClient
*c
, long l
) {
2508 addReply(c
,shared
.czero
);
2510 } else if (l
== 1) {
2511 addReply(c
,shared
.cone
);
2514 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2515 addReplySds(c
,sdsnewlen(buf
,len
));
2518 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2523 addReply(c
,shared
.czero
);
2525 } else if (ul
== 1) {
2526 addReply(c
,shared
.cone
);
2529 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2530 addReplySds(c
,sdsnewlen(buf
,len
));
2533 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2536 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2537 len
= sdslen(obj
->ptr
);
2539 long n
= (long)obj
->ptr
;
2541 /* Compute how many bytes will take this integer as a radix 10 string */
2547 while((n
= n
/10) != 0) {
2551 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2554 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2555 addReplyBulkLen(c
,obj
);
2557 addReply(c
,shared
.crlf
);
2560 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2565 REDIS_NOTUSED(mask
);
2566 REDIS_NOTUSED(privdata
);
2568 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2569 if (cfd
== AE_ERR
) {
2570 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2573 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2574 if ((c
= createClient(cfd
)) == NULL
) {
2575 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2576 close(cfd
); /* May be already closed, just ingore errors */
2579 /* If maxclient directive is set and this is one client more... close the
2580 * connection. Note that we create the client instead to check before
2581 * for this condition, since now the socket is already set in nonblocking
2582 * mode and we can send an error for free using the Kernel I/O */
2583 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2584 char *err
= "-ERR max number of clients reached\r\n";
2586 /* That's a best effort error message, don't check write errors */
2587 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2588 /* Nothing to do, Just to avoid the warning... */
2593 server
.stat_numconnections
++;
2596 /* ======================= Redis objects implementation ===================== */
2598 static robj
*createObject(int type
, void *ptr
) {
2601 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2602 if (listLength(server
.objfreelist
)) {
2603 listNode
*head
= listFirst(server
.objfreelist
);
2604 o
= listNodeValue(head
);
2605 listDelNode(server
.objfreelist
,head
);
2606 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2608 if (server
.vm_enabled
) {
2609 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2610 o
= zmalloc(sizeof(*o
));
2612 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2616 o
->encoding
= REDIS_ENCODING_RAW
;
2619 if (server
.vm_enabled
) {
2620 /* Note that this code may run in the context of an I/O thread
2621 * and accessing to server.unixtime in theory is an error
2622 * (no locks). But in practice this is safe, and even if we read
2623 * garbage Redis will not fail, as it's just a statistical info */
2624 o
->vm
.atime
= server
.unixtime
;
2625 o
->storage
= REDIS_VM_MEMORY
;
2630 static robj
*createStringObject(char *ptr
, size_t len
) {
2631 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2634 static robj
*dupStringObject(robj
*o
) {
2635 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2636 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2639 static robj
*createListObject(void) {
2640 list
*l
= listCreate();
2642 listSetFreeMethod(l
,decrRefCount
);
2643 return createObject(REDIS_LIST
,l
);
2646 static robj
*createSetObject(void) {
2647 dict
*d
= dictCreate(&setDictType
,NULL
);
2648 return createObject(REDIS_SET
,d
);
2651 static robj
*createHashObject(void) {
2652 /* All the Hashes start as zipmaps. Will be automatically converted
2653 * into hash tables if there are enough elements or big elements
2655 unsigned char *zm
= zipmapNew();
2656 robj
*o
= createObject(REDIS_HASH
,zm
);
2657 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2661 static robj
*createZsetObject(void) {
2662 zset
*zs
= zmalloc(sizeof(*zs
));
2664 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2665 zs
->zsl
= zslCreate();
2666 return createObject(REDIS_ZSET
,zs
);
2669 static void freeStringObject(robj
*o
) {
2670 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2675 static void freeListObject(robj
*o
) {
2676 listRelease((list
*) o
->ptr
);
2679 static void freeSetObject(robj
*o
) {
2680 dictRelease((dict
*) o
->ptr
);
2683 static void freeZsetObject(robj
*o
) {
2686 dictRelease(zs
->dict
);
2691 static void freeHashObject(robj
*o
) {
2692 switch (o
->encoding
) {
2693 case REDIS_ENCODING_HT
:
2694 dictRelease((dict
*) o
->ptr
);
2696 case REDIS_ENCODING_ZIPMAP
:
2705 static void incrRefCount(robj
*o
) {
2706 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2710 static void decrRefCount(void *obj
) {
2713 /* Object is a key of a swapped out value, or in the process of being
2715 if (server
.vm_enabled
&&
2716 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2718 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2719 redisAssert(o
->refcount
== 1);
2721 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2722 redisAssert(o
->type
== REDIS_STRING
);
2723 freeStringObject(o
);
2724 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2725 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2726 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2727 !listAddNodeHead(server
.objfreelist
,o
))
2729 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2730 server
.vm_stats_swapped_objects
--;
2733 /* Object is in memory, or in the process of being swapped out. */
2734 if (--(o
->refcount
) == 0) {
2735 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2736 vmCancelThreadedIOJob(obj
);
2738 case REDIS_STRING
: freeStringObject(o
); break;
2739 case REDIS_LIST
: freeListObject(o
); break;
2740 case REDIS_SET
: freeSetObject(o
); break;
2741 case REDIS_ZSET
: freeZsetObject(o
); break;
2742 case REDIS_HASH
: freeHashObject(o
); break;
2743 default: redisAssert(0); break;
2745 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2746 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2747 !listAddNodeHead(server
.objfreelist
,o
))
2749 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2753 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2754 dictEntry
*de
= dictFind(db
->dict
,key
);
2756 robj
*key
= dictGetEntryKey(de
);
2757 robj
*val
= dictGetEntryVal(de
);
2759 if (server
.vm_enabled
) {
2760 if (key
->storage
== REDIS_VM_MEMORY
||
2761 key
->storage
== REDIS_VM_SWAPPING
)
2763 /* If we were swapping the object out, stop it, this key
2765 if (key
->storage
== REDIS_VM_SWAPPING
)
2766 vmCancelThreadedIOJob(key
);
2767 /* Update the access time of the key for the aging algorithm. */
2768 key
->vm
.atime
= server
.unixtime
;
2770 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2772 /* Our value was swapped on disk. Bring it at home. */
2773 redisAssert(val
== NULL
);
2774 val
= vmLoadObject(key
);
2775 dictGetEntryVal(de
) = val
;
2777 /* Clients blocked by the VM subsystem may be waiting for
2779 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2788 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2789 expireIfNeeded(db
,key
);
2790 return lookupKey(db
,key
);
2793 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2794 deleteIfVolatile(db
,key
);
2795 return lookupKey(db
,key
);
2798 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2799 robj
*o
= lookupKeyRead(c
->db
, key
);
2800 if (!o
) addReply(c
,reply
);
2804 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2805 robj
*o
= lookupKeyWrite(c
->db
, key
);
2806 if (!o
) addReply(c
,reply
);
2810 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2811 if (o
->type
!= type
) {
2812 addReply(c
,shared
.wrongtypeerr
);
2818 static int deleteKey(redisDb
*db
, robj
*key
) {
2821 /* We need to protect key from destruction: after the first dictDelete()
2822 * it may happen that 'key' is no longer valid if we don't increment
2823 * it's count. This may happen when we get the object reference directly
2824 * from the hash table with dictRandomKey() or dict iterators */
2826 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2827 retval
= dictDelete(db
->dict
,key
);
2830 return retval
== DICT_OK
;
2833 /* Try to share an object against the shared objects pool */
2834 static robj
*tryObjectSharing(robj
*o
) {
2835 struct dictEntry
*de
;
2838 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2840 redisAssert(o
->type
== REDIS_STRING
);
2841 de
= dictFind(server
.sharingpool
,o
);
2843 robj
*shared
= dictGetEntryKey(de
);
2845 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2846 dictGetEntryVal(de
) = (void*) c
;
2847 incrRefCount(shared
);
2851 /* Here we are using a stream algorihtm: Every time an object is
2852 * shared we increment its count, everytime there is a miss we
2853 * recrement the counter of a random object. If this object reaches
2854 * zero we remove the object and put the current object instead. */
2855 if (dictSize(server
.sharingpool
) >=
2856 server
.sharingpoolsize
) {
2857 de
= dictGetRandomKey(server
.sharingpool
);
2858 redisAssert(de
!= NULL
);
2859 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2860 dictGetEntryVal(de
) = (void*) c
;
2862 dictDelete(server
.sharingpool
,de
->key
);
2865 c
= 0; /* If the pool is empty we want to add this object */
2870 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2871 redisAssert(retval
== DICT_OK
);
2878 /* Check if the nul-terminated string 's' can be represented by a long
2879 * (that is, is a number that fits into long without any other space or
2880 * character before or after the digits).
2882 * If so, the function returns REDIS_OK and *longval is set to the value
2883 * of the number. Otherwise REDIS_ERR is returned */
2884 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2885 char buf
[32], *endptr
;
2889 value
= strtol(s
, &endptr
, 10);
2890 if (endptr
[0] != '\0') return REDIS_ERR
;
2891 slen
= snprintf(buf
,32,"%ld",value
);
2893 /* If the number converted back into a string is not identical
2894 * then it's not possible to encode the string as integer */
2895 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2896 if (longval
) *longval
= value
;
2900 /* Try to encode a string object in order to save space */
2901 static int tryObjectEncoding(robj
*o
) {
2905 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2906 return REDIS_ERR
; /* Already encoded */
2908 /* It's not save to encode shared objects: shared objects can be shared
2909 * everywhere in the "object space" of Redis. Encoded objects can only
2910 * appear as "values" (and not, for instance, as keys) */
2911 if (o
->refcount
> 1) return REDIS_ERR
;
2913 /* Currently we try to encode only strings */
2914 redisAssert(o
->type
== REDIS_STRING
);
2916 /* Check if we can represent this string as a long integer */
2917 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2919 /* Ok, this object can be encoded */
2920 o
->encoding
= REDIS_ENCODING_INT
;
2922 o
->ptr
= (void*) value
;
2926 /* Get a decoded version of an encoded object (returned as a new object).
2927 * If the object is already raw-encoded just increment the ref count. */
2928 static robj
*getDecodedObject(robj
*o
) {
2931 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2935 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2938 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2939 dec
= createStringObject(buf
,strlen(buf
));
2942 redisAssert(1 != 1);
2946 /* Compare two string objects via strcmp() or alike.
2947 * Note that the objects may be integer-encoded. In such a case we
2948 * use snprintf() to get a string representation of the numbers on the stack
2949 * and compare the strings, it's much faster than calling getDecodedObject().
2951 * Important note: if objects are not integer encoded, but binary-safe strings,
2952 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2954 static int compareStringObjects(robj
*a
, robj
*b
) {
2955 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2956 char bufa
[128], bufb
[128], *astr
, *bstr
;
2959 if (a
== b
) return 0;
2960 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2961 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2967 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2968 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2974 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2977 static size_t stringObjectLen(robj
*o
) {
2978 redisAssert(o
->type
== REDIS_STRING
);
2979 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2980 return sdslen(o
->ptr
);
2984 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2988 /*============================ RDB saving/loading =========================== */
2990 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2991 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2995 static int rdbSaveTime(FILE *fp
, time_t t
) {
2996 int32_t t32
= (int32_t) t
;
2997 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3001 /* check rdbLoadLen() comments for more info */
3002 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3003 unsigned char buf
[2];
3006 /* Save a 6 bit len */
3007 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3008 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3009 } else if (len
< (1<<14)) {
3010 /* Save a 14 bit len */
3011 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3013 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3015 /* Save a 32 bit len */
3016 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3017 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3019 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3024 /* String objects in the form "2391" "-100" without any space and with a
3025 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3026 * encoded as integers to save space */
3027 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3029 char *endptr
, buf
[32];
3031 /* Check if it's possible to encode this value as a number */
3032 value
= strtoll(s
, &endptr
, 10);
3033 if (endptr
[0] != '\0') return 0;
3034 snprintf(buf
,32,"%lld",value
);
3036 /* If the number converted back into a string is not identical
3037 * then it's not possible to encode the string as integer */
3038 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3040 /* Finally check if it fits in our ranges */
3041 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3042 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3043 enc
[1] = value
&0xFF;
3045 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3046 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3047 enc
[1] = value
&0xFF;
3048 enc
[2] = (value
>>8)&0xFF;
3050 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3051 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3052 enc
[1] = value
&0xFF;
3053 enc
[2] = (value
>>8)&0xFF;
3054 enc
[3] = (value
>>16)&0xFF;
3055 enc
[4] = (value
>>24)&0xFF;
3062 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3063 size_t comprlen
, outlen
;
3067 /* We require at least four bytes compression for this to be worth it */
3068 if (len
<= 4) return 0;
3070 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3071 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3072 if (comprlen
== 0) {
3076 /* Data compressed! Let's save it on disk */
3077 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3078 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3079 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3080 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3081 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3090 /* Save a string objet as [len][data] on disk. If the object is a string
3091 * representation of an integer value we try to safe it in a special form */
3092 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3095 /* Try integer encoding */
3097 unsigned char buf
[5];
3098 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3099 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3104 /* Try LZF compression - under 20 bytes it's unable to compress even
3105 * aaaaaaaaaaaaaaaaaa so skip it */
3106 if (server
.rdbcompression
&& len
> 20) {
3109 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3110 if (retval
== -1) return -1;
3111 if (retval
> 0) return 0;
3112 /* retval == 0 means data can't be compressed, save the old way */
3115 /* Store verbatim */
3116 if (rdbSaveLen(fp
,len
) == -1) return -1;
3117 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3121 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3122 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3125 /* Avoid incr/decr ref count business when possible.
3126 * This plays well with copy-on-write given that we are probably
3127 * in a child process (BGSAVE). Also this makes sure key objects
3128 * of swapped objects are not incRefCount-ed (an assert does not allow
3129 * this in order to avoid bugs) */
3130 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3131 obj
= getDecodedObject(obj
);
3132 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3135 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3140 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3141 * 8 bit integer specifing the length of the representation.
3142 * This 8 bit integer has special values in order to specify the following
3148 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3149 unsigned char buf
[128];
3155 } else if (!isfinite(val
)) {
3157 buf
[0] = (val
< 0) ? 255 : 254;
3159 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3160 buf
[0] = strlen((char*)buf
+1);
3163 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3167 /* Save a Redis object. */
3168 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3169 if (o
->type
== REDIS_STRING
) {
3170 /* Save a string value */
3171 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3172 } else if (o
->type
== REDIS_LIST
) {
3173 /* Save a list value */
3174 list
*list
= o
->ptr
;
3178 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3179 listRewind(list
,&li
);
3180 while((ln
= listNext(&li
))) {
3181 robj
*eleobj
= listNodeValue(ln
);
3183 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3185 } else if (o
->type
== REDIS_SET
) {
3186 /* Save a set value */
3188 dictIterator
*di
= dictGetIterator(set
);
3191 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3192 while((de
= dictNext(di
)) != NULL
) {
3193 robj
*eleobj
= dictGetEntryKey(de
);
3195 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3197 dictReleaseIterator(di
);
3198 } else if (o
->type
== REDIS_ZSET
) {
3199 /* Save a set value */
3201 dictIterator
*di
= dictGetIterator(zs
->dict
);
3204 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3205 while((de
= dictNext(di
)) != NULL
) {
3206 robj
*eleobj
= dictGetEntryKey(de
);
3207 double *score
= dictGetEntryVal(de
);
3209 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3210 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3212 dictReleaseIterator(di
);
3213 } else if (o
->type
== REDIS_HASH
) {
3214 /* Save a hash value */
3215 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3216 unsigned char *p
= zipmapRewind(o
->ptr
);
3217 unsigned int count
= zipmapLen(o
->ptr
);
3218 unsigned char *key
, *val
;
3219 unsigned int klen
, vlen
;
3221 if (rdbSaveLen(fp
,count
) == -1) return -1;
3222 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3223 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3224 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3227 dictIterator
*di
= dictGetIterator(o
->ptr
);
3230 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3231 while((de
= dictNext(di
)) != NULL
) {
3232 robj
*key
= dictGetEntryKey(de
);
3233 robj
*val
= dictGetEntryVal(de
);
3235 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3236 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3238 dictReleaseIterator(di
);
3246 /* Return the length the object will have on disk if saved with
3247 * the rdbSaveObject() function. Currently we use a trick to get
3248 * this length with very little changes to the code. In the future
3249 * we could switch to a faster solution. */
3250 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3251 if (fp
== NULL
) fp
= server
.devnull
;
3253 assert(rdbSaveObject(fp
,o
) != 1);
3257 /* Return the number of pages required to save this object in the swap file */
3258 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3259 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3261 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3264 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3265 static int rdbSave(char *filename
) {
3266 dictIterator
*di
= NULL
;
3271 time_t now
= time(NULL
);
3273 /* Wait for I/O therads to terminate, just in case this is a
3274 * foreground-saving, to avoid seeking the swap file descriptor at the
3276 if (server
.vm_enabled
)
3277 waitEmptyIOJobsQueue();
3279 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3280 fp
= fopen(tmpfile
,"w");
3282 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3285 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3286 for (j
= 0; j
< server
.dbnum
; j
++) {
3287 redisDb
*db
= server
.db
+j
;
3289 if (dictSize(d
) == 0) continue;
3290 di
= dictGetIterator(d
);
3296 /* Write the SELECT DB opcode */
3297 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3298 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3300 /* Iterate this DB writing every entry */
3301 while((de
= dictNext(di
)) != NULL
) {
3302 robj
*key
= dictGetEntryKey(de
);
3303 robj
*o
= dictGetEntryVal(de
);
3304 time_t expiretime
= getExpire(db
,key
);
3306 /* Save the expire time */
3307 if (expiretime
!= -1) {
3308 /* If this key is already expired skip it */
3309 if (expiretime
< now
) continue;
3310 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3311 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3313 /* Save the key and associated value. This requires special
3314 * handling if the value is swapped out. */
3315 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3316 key
->storage
== REDIS_VM_SWAPPING
) {
3317 /* Save type, key, value */
3318 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3319 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3320 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3322 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3324 /* Get a preview of the object in memory */
3325 po
= vmPreviewObject(key
);
3326 /* Save type, key, value */
3327 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3328 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3329 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3330 /* Remove the loaded object from memory */
3334 dictReleaseIterator(di
);
3337 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3339 /* Make sure data will not remain on the OS's output buffers */
3344 /* Use RENAME to make sure the DB file is changed atomically only
3345 * if the generate DB file is ok. */
3346 if (rename(tmpfile
,filename
) == -1) {
3347 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3351 redisLog(REDIS_NOTICE
,"DB saved on disk");
3353 server
.lastsave
= time(NULL
);
3359 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3360 if (di
) dictReleaseIterator(di
);
3364 static int rdbSaveBackground(char *filename
) {
3367 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3368 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3369 if ((childpid
= fork()) == 0) {
3371 if (server
.vm_enabled
) vmReopenSwapFile();
3373 if (rdbSave(filename
) == REDIS_OK
) {
3380 if (childpid
== -1) {
3381 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3385 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3386 server
.bgsavechildpid
= childpid
;
3389 return REDIS_OK
; /* unreached */
3392 static void rdbRemoveTempFile(pid_t childpid
) {
3395 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3399 static int rdbLoadType(FILE *fp
) {
3401 if (fread(&type
,1,1,fp
) == 0) return -1;
3405 static time_t rdbLoadTime(FILE *fp
) {
3407 if (fread(&t32
,4,1,fp
) == 0) return -1;
3408 return (time_t) t32
;
3411 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3412 * of this file for a description of how this are stored on disk.
3414 * isencoded is set to 1 if the readed length is not actually a length but
3415 * an "encoding type", check the above comments for more info */
3416 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3417 unsigned char buf
[2];
3421 if (isencoded
) *isencoded
= 0;
3422 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3423 type
= (buf
[0]&0xC0)>>6;
3424 if (type
== REDIS_RDB_6BITLEN
) {
3425 /* Read a 6 bit len */
3427 } else if (type
== REDIS_RDB_ENCVAL
) {
3428 /* Read a 6 bit len encoding type */
3429 if (isencoded
) *isencoded
= 1;
3431 } else if (type
== REDIS_RDB_14BITLEN
) {
3432 /* Read a 14 bit len */
3433 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3434 return ((buf
[0]&0x3F)<<8)|buf
[1];
3436 /* Read a 32 bit len */
3437 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3442 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3443 unsigned char enc
[4];
3446 if (enctype
== REDIS_RDB_ENC_INT8
) {
3447 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3448 val
= (signed char)enc
[0];
3449 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3451 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3452 v
= enc
[0]|(enc
[1]<<8);
3454 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3456 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3457 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3460 val
= 0; /* anti-warning */
3463 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3466 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3467 unsigned int len
, clen
;
3468 unsigned char *c
= NULL
;
3471 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3472 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3473 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3474 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3475 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3476 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3478 return createObject(REDIS_STRING
,val
);
3485 static robj
*rdbLoadStringObject(FILE*fp
) {
3490 len
= rdbLoadLen(fp
,&isencoded
);
3493 case REDIS_RDB_ENC_INT8
:
3494 case REDIS_RDB_ENC_INT16
:
3495 case REDIS_RDB_ENC_INT32
:
3496 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3497 case REDIS_RDB_ENC_LZF
:
3498 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3504 if (len
== REDIS_RDB_LENERR
) return NULL
;
3505 val
= sdsnewlen(NULL
,len
);
3506 if (len
&& fread(val
,len
,1,fp
) == 0) {
3510 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3513 /* For information about double serialization check rdbSaveDoubleValue() */
3514 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3518 if (fread(&len
,1,1,fp
) == 0) return -1;
3520 case 255: *val
= R_NegInf
; return 0;
3521 case 254: *val
= R_PosInf
; return 0;
3522 case 253: *val
= R_Nan
; return 0;
3524 if (fread(buf
,len
,1,fp
) == 0) return -1;
3526 sscanf(buf
, "%lg", val
);
3531 /* Load a Redis object of the specified type from the specified file.
3532 * On success a newly allocated object is returned, otherwise NULL. */
3533 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3536 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3537 if (type
== REDIS_STRING
) {
3538 /* Read string value */
3539 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3540 tryObjectEncoding(o
);
3541 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3542 /* Read list/set value */
3545 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3546 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3547 /* It's faster to expand the dict to the right size asap in order
3548 * to avoid rehashing */
3549 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3550 dictExpand(o
->ptr
,listlen
);
3551 /* Load every single element of the list/set */
3555 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3556 tryObjectEncoding(ele
);
3557 if (type
== REDIS_LIST
) {
3558 listAddNodeTail((list
*)o
->ptr
,ele
);
3560 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3563 } else if (type
== REDIS_ZSET
) {
3564 /* Read list/set value */
3568 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3569 o
= createZsetObject();
3571 /* Load every single element of the list/set */
3574 double *score
= zmalloc(sizeof(double));
3576 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3577 tryObjectEncoding(ele
);
3578 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3579 dictAdd(zs
->dict
,ele
,score
);
3580 zslInsert(zs
->zsl
,*score
,ele
);
3581 incrRefCount(ele
); /* added to skiplist */
3583 } else if (type
== REDIS_HASH
) {
3586 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3587 o
= createHashObject();
3588 /* Too many entries? Use an hash table. */
3589 if (hashlen
> server
.hash_max_zipmap_entries
)
3590 convertToRealHash(o
);
3591 /* Load every key/value, then set it into the zipmap or hash
3592 * table, as needed. */
3596 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3597 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3598 /* If we are using a zipmap and there are too big values
3599 * the object is converted to real hash table encoding. */
3600 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3601 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3602 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3604 convertToRealHash(o
);
3607 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3608 unsigned char *zm
= o
->ptr
;
3610 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3611 val
->ptr
,sdslen(val
->ptr
),NULL
);
3616 tryObjectEncoding(key
);
3617 tryObjectEncoding(val
);
3618 dictAdd((dict
*)o
->ptr
,key
,val
);
3627 static int rdbLoad(char *filename
) {
3629 robj
*keyobj
= NULL
;
3631 int type
, retval
, rdbver
;
3632 dict
*d
= server
.db
[0].dict
;
3633 redisDb
*db
= server
.db
+0;
3635 time_t expiretime
= -1, now
= time(NULL
);
3636 long long loadedkeys
= 0;
3638 fp
= fopen(filename
,"r");
3639 if (!fp
) return REDIS_ERR
;
3640 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3642 if (memcmp(buf
,"REDIS",5) != 0) {
3644 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3647 rdbver
= atoi(buf
+5);
3650 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3657 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3658 if (type
== REDIS_EXPIRETIME
) {
3659 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3660 /* We read the time so we need to read the object type again */
3661 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3663 if (type
== REDIS_EOF
) break;
3664 /* Handle SELECT DB opcode as a special case */
3665 if (type
== REDIS_SELECTDB
) {
3666 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3668 if (dbid
>= (unsigned)server
.dbnum
) {
3669 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3672 db
= server
.db
+dbid
;
3677 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3679 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3680 /* Add the new object in the hash table */
3681 retval
= dictAdd(d
,keyobj
,o
);
3682 if (retval
== DICT_ERR
) {
3683 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3686 /* Set the expire time if needed */
3687 if (expiretime
!= -1) {
3688 setExpire(db
,keyobj
,expiretime
);
3689 /* Delete this key if already expired */
3690 if (expiretime
< now
) deleteKey(db
,keyobj
);
3694 /* Handle swapping while loading big datasets when VM is on */
3696 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3697 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3698 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3705 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3706 if (keyobj
) decrRefCount(keyobj
);
3707 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3709 return REDIS_ERR
; /* Just to avoid warning */
3712 /*================================== Commands =============================== */
3714 static void authCommand(redisClient
*c
) {
3715 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3716 c
->authenticated
= 1;
3717 addReply(c
,shared
.ok
);
3719 c
->authenticated
= 0;
3720 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3724 static void pingCommand(redisClient
*c
) {
3725 addReply(c
,shared
.pong
);
3728 static void echoCommand(redisClient
*c
) {
3729 addReplyBulk(c
,c
->argv
[1]);
3732 /*=================================== Strings =============================== */
3734 static void setGenericCommand(redisClient
*c
, int nx
) {
3737 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3738 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3739 if (retval
== DICT_ERR
) {
3741 /* If the key is about a swapped value, we want a new key object
3742 * to overwrite the old. So we delete the old key in the database.
3743 * This will also make sure that swap pages about the old object
3744 * will be marked as free. */
3745 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3746 incrRefCount(c
->argv
[1]);
3747 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3748 incrRefCount(c
->argv
[2]);
3750 addReply(c
,shared
.czero
);
3754 incrRefCount(c
->argv
[1]);
3755 incrRefCount(c
->argv
[2]);
3758 removeExpire(c
->db
,c
->argv
[1]);
3759 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3762 static void setCommand(redisClient
*c
) {
3763 setGenericCommand(c
,0);
3766 static void setnxCommand(redisClient
*c
) {
3767 setGenericCommand(c
,1);
3770 static int getGenericCommand(redisClient
*c
) {
3773 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3776 if (o
->type
!= REDIS_STRING
) {
3777 addReply(c
,shared
.wrongtypeerr
);
3785 static void getCommand(redisClient
*c
) {
3786 getGenericCommand(c
);
3789 static void getsetCommand(redisClient
*c
) {
3790 if (getGenericCommand(c
) == REDIS_ERR
) return;
3791 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3792 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3794 incrRefCount(c
->argv
[1]);
3796 incrRefCount(c
->argv
[2]);
3798 removeExpire(c
->db
,c
->argv
[1]);
3801 static void mgetCommand(redisClient
*c
) {
3804 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3805 for (j
= 1; j
< c
->argc
; j
++) {
3806 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3808 addReply(c
,shared
.nullbulk
);
3810 if (o
->type
!= REDIS_STRING
) {
3811 addReply(c
,shared
.nullbulk
);
3819 static void msetGenericCommand(redisClient
*c
, int nx
) {
3820 int j
, busykeys
= 0;
3822 if ((c
->argc
% 2) == 0) {
3823 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3826 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3827 * set nothing at all if at least one already key exists. */
3829 for (j
= 1; j
< c
->argc
; j
+= 2) {
3830 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3836 addReply(c
, shared
.czero
);
3840 for (j
= 1; j
< c
->argc
; j
+= 2) {
3843 tryObjectEncoding(c
->argv
[j
+1]);
3844 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3845 if (retval
== DICT_ERR
) {
3846 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3847 incrRefCount(c
->argv
[j
+1]);
3849 incrRefCount(c
->argv
[j
]);
3850 incrRefCount(c
->argv
[j
+1]);
3852 removeExpire(c
->db
,c
->argv
[j
]);
3854 server
.dirty
+= (c
->argc
-1)/2;
3855 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3858 static void msetCommand(redisClient
*c
) {
3859 msetGenericCommand(c
,0);
3862 static void msetnxCommand(redisClient
*c
) {
3863 msetGenericCommand(c
,1);
3866 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3871 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3875 if (o
->type
!= REDIS_STRING
) {
3880 if (o
->encoding
== REDIS_ENCODING_RAW
)
3881 value
= strtoll(o
->ptr
, &eptr
, 10);
3882 else if (o
->encoding
== REDIS_ENCODING_INT
)
3883 value
= (long)o
->ptr
;
3885 redisAssert(1 != 1);
3890 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3891 tryObjectEncoding(o
);
3892 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3893 if (retval
== DICT_ERR
) {
3894 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3895 removeExpire(c
->db
,c
->argv
[1]);
3897 incrRefCount(c
->argv
[1]);
3900 addReply(c
,shared
.colon
);
3902 addReply(c
,shared
.crlf
);
3905 static void incrCommand(redisClient
*c
) {
3906 incrDecrCommand(c
,1);
3909 static void decrCommand(redisClient
*c
) {
3910 incrDecrCommand(c
,-1);
3913 static void incrbyCommand(redisClient
*c
) {
3914 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3915 incrDecrCommand(c
,incr
);
3918 static void decrbyCommand(redisClient
*c
) {
3919 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3920 incrDecrCommand(c
,-incr
);
3923 static void appendCommand(redisClient
*c
) {
3928 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3930 /* Create the key */
3931 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3932 incrRefCount(c
->argv
[1]);
3933 incrRefCount(c
->argv
[2]);
3934 totlen
= stringObjectLen(c
->argv
[2]);
3938 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3941 o
= dictGetEntryVal(de
);
3942 if (o
->type
!= REDIS_STRING
) {
3943 addReply(c
,shared
.wrongtypeerr
);
3946 /* If the object is specially encoded or shared we have to make
3948 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3949 robj
*decoded
= getDecodedObject(o
);
3951 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3952 decrRefCount(decoded
);
3953 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3956 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3957 o
->ptr
= sdscatlen(o
->ptr
,
3958 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3960 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3961 (unsigned long) c
->argv
[2]->ptr
);
3963 totlen
= sdslen(o
->ptr
);
3966 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3969 static void substrCommand(redisClient
*c
) {
3971 long start
= atoi(c
->argv
[2]->ptr
);
3972 long end
= atoi(c
->argv
[3]->ptr
);
3973 size_t rangelen
, strlen
;
3976 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
3977 checkType(c
,o
,REDIS_STRING
)) return;
3979 o
= getDecodedObject(o
);
3980 strlen
= sdslen(o
->ptr
);
3982 /* convert negative indexes */
3983 if (start
< 0) start
= strlen
+start
;
3984 if (end
< 0) end
= strlen
+end
;
3985 if (start
< 0) start
= 0;
3986 if (end
< 0) end
= 0;
3988 /* indexes sanity checks */
3989 if (start
> end
|| (size_t)start
>= strlen
) {
3990 /* Out of range start or start > end result in null reply */
3991 addReply(c
,shared
.nullbulk
);
3995 if ((size_t)end
>= strlen
) end
= strlen
-1;
3996 rangelen
= (end
-start
)+1;
3998 /* Return the result */
3999 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4000 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4001 addReplySds(c
,range
);
4002 addReply(c
,shared
.crlf
);
4006 /* ========================= Type agnostic commands ========================= */
4008 static void delCommand(redisClient
*c
) {
4011 for (j
= 1; j
< c
->argc
; j
++) {
4012 if (deleteKey(c
->db
,c
->argv
[j
])) {
4017 addReplyLong(c
,deleted
);
4020 static void existsCommand(redisClient
*c
) {
4021 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4024 static void selectCommand(redisClient
*c
) {
4025 int id
= atoi(c
->argv
[1]->ptr
);
4027 if (selectDb(c
,id
) == REDIS_ERR
) {
4028 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4030 addReply(c
,shared
.ok
);
4034 static void randomkeyCommand(redisClient
*c
) {
4038 de
= dictGetRandomKey(c
->db
->dict
);
4039 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4042 addReply(c
,shared
.plus
);
4043 addReply(c
,shared
.crlf
);
4045 addReply(c
,shared
.plus
);
4046 addReply(c
,dictGetEntryKey(de
));
4047 addReply(c
,shared
.crlf
);
4051 static void keysCommand(redisClient
*c
) {
4054 sds pattern
= c
->argv
[1]->ptr
;
4055 int plen
= sdslen(pattern
);
4056 unsigned long numkeys
= 0;
4057 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4059 di
= dictGetIterator(c
->db
->dict
);
4061 decrRefCount(lenobj
);
4062 while((de
= dictNext(di
)) != NULL
) {
4063 robj
*keyobj
= dictGetEntryKey(de
);
4065 sds key
= keyobj
->ptr
;
4066 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4067 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4068 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4069 addReplyBulk(c
,keyobj
);
4074 dictReleaseIterator(di
);
4075 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4078 static void dbsizeCommand(redisClient
*c
) {
4080 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4083 static void lastsaveCommand(redisClient
*c
) {
4085 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4088 static void typeCommand(redisClient
*c
) {
4092 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4097 case REDIS_STRING
: type
= "+string"; break;
4098 case REDIS_LIST
: type
= "+list"; break;
4099 case REDIS_SET
: type
= "+set"; break;
4100 case REDIS_ZSET
: type
= "+zset"; break;
4101 case REDIS_HASH
: type
= "+hash"; break;
4102 default: type
= "+unknown"; break;
4105 addReplySds(c
,sdsnew(type
));
4106 addReply(c
,shared
.crlf
);
4109 static void saveCommand(redisClient
*c
) {
4110 if (server
.bgsavechildpid
!= -1) {
4111 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4114 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4115 addReply(c
,shared
.ok
);
4117 addReply(c
,shared
.err
);
4121 static void bgsaveCommand(redisClient
*c
) {
4122 if (server
.bgsavechildpid
!= -1) {
4123 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4126 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4127 char *status
= "+Background saving started\r\n";
4128 addReplySds(c
,sdsnew(status
));
4130 addReply(c
,shared
.err
);
4134 static void shutdownCommand(redisClient
*c
) {
4135 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4136 /* Kill the saving child if there is a background saving in progress.
4137 We want to avoid race conditions, for instance our saving child may
4138 overwrite the synchronous saving did by SHUTDOWN. */
4139 if (server
.bgsavechildpid
!= -1) {
4140 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4141 kill(server
.bgsavechildpid
,SIGKILL
);
4142 rdbRemoveTempFile(server
.bgsavechildpid
);
4144 if (server
.appendonly
) {
4145 /* Append only file: fsync() the AOF and exit */
4146 fsync(server
.appendfd
);
4147 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4150 /* Snapshotting. Perform a SYNC SAVE and exit */
4151 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4152 if (server
.daemonize
)
4153 unlink(server
.pidfile
);
4154 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4155 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4156 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4159 /* Ooops.. error saving! The best we can do is to continue
4160 * operating. Note that if there was a background saving process,
4161 * in the next cron() Redis will be notified that the background
4162 * saving aborted, handling special stuff like slaves pending for
4163 * synchronization... */
4164 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4166 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4171 static void renameGenericCommand(redisClient
*c
, int nx
) {
4174 /* To use the same key as src and dst is probably an error */
4175 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4176 addReply(c
,shared
.sameobjecterr
);
4180 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4184 deleteIfVolatile(c
->db
,c
->argv
[2]);
4185 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4188 addReply(c
,shared
.czero
);
4191 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4193 incrRefCount(c
->argv
[2]);
4195 deleteKey(c
->db
,c
->argv
[1]);
4197 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4200 static void renameCommand(redisClient
*c
) {
4201 renameGenericCommand(c
,0);
4204 static void renamenxCommand(redisClient
*c
) {
4205 renameGenericCommand(c
,1);
4208 static void moveCommand(redisClient
*c
) {
4213 /* Obtain source and target DB pointers */
4216 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4217 addReply(c
,shared
.outofrangeerr
);
4221 selectDb(c
,srcid
); /* Back to the source DB */
4223 /* If the user is moving using as target the same
4224 * DB as the source DB it is probably an error. */
4226 addReply(c
,shared
.sameobjecterr
);
4230 /* Check if the element exists and get a reference */
4231 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4233 addReply(c
,shared
.czero
);
4237 /* Try to add the element to the target DB */
4238 deleteIfVolatile(dst
,c
->argv
[1]);
4239 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4240 addReply(c
,shared
.czero
);
4243 incrRefCount(c
->argv
[1]);
4246 /* OK! key moved, free the entry in the source DB */
4247 deleteKey(src
,c
->argv
[1]);
4249 addReply(c
,shared
.cone
);
4252 /* =================================== Lists ================================ */
4253 static void pushGenericCommand(redisClient
*c
, int where
) {
4257 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4259 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4260 addReply(c
,shared
.cone
);
4263 lobj
= createListObject();
4265 if (where
== REDIS_HEAD
) {
4266 listAddNodeHead(list
,c
->argv
[2]);
4268 listAddNodeTail(list
,c
->argv
[2]);
4270 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4271 incrRefCount(c
->argv
[1]);
4272 incrRefCount(c
->argv
[2]);
4274 if (lobj
->type
!= REDIS_LIST
) {
4275 addReply(c
,shared
.wrongtypeerr
);
4278 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4279 addReply(c
,shared
.cone
);
4283 if (where
== REDIS_HEAD
) {
4284 listAddNodeHead(list
,c
->argv
[2]);
4286 listAddNodeTail(list
,c
->argv
[2]);
4288 incrRefCount(c
->argv
[2]);
4291 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4294 static void lpushCommand(redisClient
*c
) {
4295 pushGenericCommand(c
,REDIS_HEAD
);
4298 static void rpushCommand(redisClient
*c
) {
4299 pushGenericCommand(c
,REDIS_TAIL
);
4302 static void llenCommand(redisClient
*c
) {
4306 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4307 checkType(c
,o
,REDIS_LIST
)) return;
4310 addReplyUlong(c
,listLength(l
));
4313 static void lindexCommand(redisClient
*c
) {
4315 int index
= atoi(c
->argv
[2]->ptr
);
4319 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4320 checkType(c
,o
,REDIS_LIST
)) return;
4323 ln
= listIndex(list
, index
);
4325 addReply(c
,shared
.nullbulk
);
4327 robj
*ele
= listNodeValue(ln
);
4328 addReplyBulk(c
,ele
);
4332 static void lsetCommand(redisClient
*c
) {
4334 int index
= atoi(c
->argv
[2]->ptr
);
4338 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4339 checkType(c
,o
,REDIS_LIST
)) return;
4342 ln
= listIndex(list
, index
);
4344 addReply(c
,shared
.outofrangeerr
);
4346 robj
*ele
= listNodeValue(ln
);
4349 listNodeValue(ln
) = c
->argv
[3];
4350 incrRefCount(c
->argv
[3]);
4351 addReply(c
,shared
.ok
);
4356 static void popGenericCommand(redisClient
*c
, int where
) {
4361 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4362 checkType(c
,o
,REDIS_LIST
)) return;
4365 if (where
== REDIS_HEAD
)
4366 ln
= listFirst(list
);
4368 ln
= listLast(list
);
4371 addReply(c
,shared
.nullbulk
);
4373 robj
*ele
= listNodeValue(ln
);
4374 addReplyBulk(c
,ele
);
4375 listDelNode(list
,ln
);
4376 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4381 static void lpopCommand(redisClient
*c
) {
4382 popGenericCommand(c
,REDIS_HEAD
);
4385 static void rpopCommand(redisClient
*c
) {
4386 popGenericCommand(c
,REDIS_TAIL
);
4389 static void lrangeCommand(redisClient
*c
) {
4391 int start
= atoi(c
->argv
[2]->ptr
);
4392 int end
= atoi(c
->argv
[3]->ptr
);
4399 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4400 checkType(c
,o
,REDIS_LIST
)) return;
4402 llen
= listLength(list
);
4404 /* convert negative indexes */
4405 if (start
< 0) start
= llen
+start
;
4406 if (end
< 0) end
= llen
+end
;
4407 if (start
< 0) start
= 0;
4408 if (end
< 0) end
= 0;
4410 /* indexes sanity checks */
4411 if (start
> end
|| start
>= llen
) {
4412 /* Out of range start or start > end result in empty list */
4413 addReply(c
,shared
.emptymultibulk
);
4416 if (end
>= llen
) end
= llen
-1;
4417 rangelen
= (end
-start
)+1;
4419 /* Return the result in form of a multi-bulk reply */
4420 ln
= listIndex(list
, start
);
4421 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4422 for (j
= 0; j
< rangelen
; j
++) {
4423 ele
= listNodeValue(ln
);
4424 addReplyBulk(c
,ele
);
4429 static void ltrimCommand(redisClient
*c
) {
4431 int start
= atoi(c
->argv
[2]->ptr
);
4432 int end
= atoi(c
->argv
[3]->ptr
);
4434 int j
, ltrim
, rtrim
;
4438 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4439 checkType(c
,o
,REDIS_LIST
)) return;
4441 llen
= listLength(list
);
4443 /* convert negative indexes */
4444 if (start
< 0) start
= llen
+start
;
4445 if (end
< 0) end
= llen
+end
;
4446 if (start
< 0) start
= 0;
4447 if (end
< 0) end
= 0;
4449 /* indexes sanity checks */
4450 if (start
> end
|| start
>= llen
) {
4451 /* Out of range start or start > end result in empty list */
4455 if (end
>= llen
) end
= llen
-1;
4460 /* Remove list elements to perform the trim */
4461 for (j
= 0; j
< ltrim
; j
++) {
4462 ln
= listFirst(list
);
4463 listDelNode(list
,ln
);
4465 for (j
= 0; j
< rtrim
; j
++) {
4466 ln
= listLast(list
);
4467 listDelNode(list
,ln
);
4469 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4471 addReply(c
,shared
.ok
);
4474 static void lremCommand(redisClient
*c
) {
4477 listNode
*ln
, *next
;
4478 int toremove
= atoi(c
->argv
[2]->ptr
);
4482 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4483 checkType(c
,o
,REDIS_LIST
)) return;
4487 toremove
= -toremove
;
4490 ln
= fromtail
? list
->tail
: list
->head
;
4492 robj
*ele
= listNodeValue(ln
);
4494 next
= fromtail
? ln
->prev
: ln
->next
;
4495 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4496 listDelNode(list
,ln
);
4499 if (toremove
&& removed
== toremove
) break;
4503 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4504 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4507 /* This is the semantic of this command:
4508 * RPOPLPUSH srclist dstlist:
4509 * IF LLEN(srclist) > 0
4510 * element = RPOP srclist
4511 * LPUSH dstlist element
4518 * The idea is to be able to get an element from a list in a reliable way
4519 * since the element is not just returned but pushed against another list
4520 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4522 static void rpoplpushcommand(redisClient
*c
) {
4527 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4528 checkType(c
,sobj
,REDIS_LIST
)) return;
4529 srclist
= sobj
->ptr
;
4530 ln
= listLast(srclist
);
4533 addReply(c
,shared
.nullbulk
);
4535 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4536 robj
*ele
= listNodeValue(ln
);
4539 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4540 addReply(c
,shared
.wrongtypeerr
);
4544 /* Add the element to the target list (unless it's directly
4545 * passed to some BLPOP-ing client */
4546 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4548 /* Create the list if the key does not exist */
4549 dobj
= createListObject();
4550 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4551 incrRefCount(c
->argv
[2]);
4553 dstlist
= dobj
->ptr
;
4554 listAddNodeHead(dstlist
,ele
);
4558 /* Send the element to the client as reply as well */
4559 addReplyBulk(c
,ele
);
4561 /* Finally remove the element from the source list */
4562 listDelNode(srclist
,ln
);
4563 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4568 /* ==================================== Sets ================================ */
4570 static void saddCommand(redisClient
*c
) {
4573 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4575 set
= createSetObject();
4576 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4577 incrRefCount(c
->argv
[1]);
4579 if (set
->type
!= REDIS_SET
) {
4580 addReply(c
,shared
.wrongtypeerr
);
4584 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4585 incrRefCount(c
->argv
[2]);
4587 addReply(c
,shared
.cone
);
4589 addReply(c
,shared
.czero
);
4593 static void sremCommand(redisClient
*c
) {
4596 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4597 checkType(c
,set
,REDIS_SET
)) return;
4599 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4601 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4602 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4603 addReply(c
,shared
.cone
);
4605 addReply(c
,shared
.czero
);
4609 static void smoveCommand(redisClient
*c
) {
4610 robj
*srcset
, *dstset
;
4612 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4613 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4615 /* If the source key does not exist return 0, if it's of the wrong type
4617 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4618 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4621 /* Error if the destination key is not a set as well */
4622 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4623 addReply(c
,shared
.wrongtypeerr
);
4626 /* Remove the element from the source set */
4627 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4628 /* Key not found in the src set! return zero */
4629 addReply(c
,shared
.czero
);
4632 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4633 deleteKey(c
->db
,c
->argv
[1]);
4635 /* Add the element to the destination set */
4637 dstset
= createSetObject();
4638 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4639 incrRefCount(c
->argv
[2]);
4641 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4642 incrRefCount(c
->argv
[3]);
4643 addReply(c
,shared
.cone
);
4646 static void sismemberCommand(redisClient
*c
) {
4649 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4650 checkType(c
,set
,REDIS_SET
)) return;
4652 if (dictFind(set
->ptr
,c
->argv
[2]))
4653 addReply(c
,shared
.cone
);
4655 addReply(c
,shared
.czero
);
4658 static void scardCommand(redisClient
*c
) {
4662 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4663 checkType(c
,o
,REDIS_SET
)) return;
4666 addReplyUlong(c
,dictSize(s
));
4669 static void spopCommand(redisClient
*c
) {
4673 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4674 checkType(c
,set
,REDIS_SET
)) return;
4676 de
= dictGetRandomKey(set
->ptr
);
4678 addReply(c
,shared
.nullbulk
);
4680 robj
*ele
= dictGetEntryKey(de
);
4682 addReplyBulk(c
,ele
);
4683 dictDelete(set
->ptr
,ele
);
4684 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4685 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4690 static void srandmemberCommand(redisClient
*c
) {
4694 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4695 checkType(c
,set
,REDIS_SET
)) return;
4697 de
= dictGetRandomKey(set
->ptr
);
4699 addReply(c
,shared
.nullbulk
);
4701 robj
*ele
= dictGetEntryKey(de
);
4703 addReplyBulk(c
,ele
);
4707 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4708 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4710 return dictSize(*d1
)-dictSize(*d2
);
4713 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4714 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4717 robj
*lenobj
= NULL
, *dstset
= NULL
;
4718 unsigned long j
, cardinality
= 0;
4720 for (j
= 0; j
< setsnum
; j
++) {
4724 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4725 lookupKeyRead(c
->db
,setskeys
[j
]);
4729 if (deleteKey(c
->db
,dstkey
))
4731 addReply(c
,shared
.czero
);
4733 addReply(c
,shared
.nullmultibulk
);
4737 if (setobj
->type
!= REDIS_SET
) {
4739 addReply(c
,shared
.wrongtypeerr
);
4742 dv
[j
] = setobj
->ptr
;
4744 /* Sort sets from the smallest to largest, this will improve our
4745 * algorithm's performace */
4746 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4748 /* The first thing we should output is the total number of elements...
4749 * since this is a multi-bulk write, but at this stage we don't know
4750 * the intersection set size, so we use a trick, append an empty object
4751 * to the output list and save the pointer to later modify it with the
4754 lenobj
= createObject(REDIS_STRING
,NULL
);
4756 decrRefCount(lenobj
);
4758 /* If we have a target key where to store the resulting set
4759 * create this key with an empty set inside */
4760 dstset
= createSetObject();
4763 /* Iterate all the elements of the first (smallest) set, and test
4764 * the element against all the other sets, if at least one set does
4765 * not include the element it is discarded */
4766 di
= dictGetIterator(dv
[0]);
4768 while((de
= dictNext(di
)) != NULL
) {
4771 for (j
= 1; j
< setsnum
; j
++)
4772 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4774 continue; /* at least one set does not contain the member */
4775 ele
= dictGetEntryKey(de
);
4777 addReplyBulk(c
,ele
);
4780 dictAdd(dstset
->ptr
,ele
,NULL
);
4784 dictReleaseIterator(di
);
4787 /* Store the resulting set into the target, if the intersection
4788 * is not an empty set. */
4789 deleteKey(c
->db
,dstkey
);
4790 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4791 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4792 incrRefCount(dstkey
);
4793 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4795 decrRefCount(dstset
);
4796 addReply(c
,shared
.czero
);
4800 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4805 static void sinterCommand(redisClient
*c
) {
4806 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4809 static void sinterstoreCommand(redisClient
*c
) {
4810 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4813 #define REDIS_OP_UNION 0
4814 #define REDIS_OP_DIFF 1
4815 #define REDIS_OP_INTER 2
4817 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4818 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4821 robj
*dstset
= NULL
;
4822 int j
, cardinality
= 0;
4824 for (j
= 0; j
< setsnum
; j
++) {
4828 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4829 lookupKeyRead(c
->db
,setskeys
[j
]);
4834 if (setobj
->type
!= REDIS_SET
) {
4836 addReply(c
,shared
.wrongtypeerr
);
4839 dv
[j
] = setobj
->ptr
;
4842 /* We need a temp set object to store our union. If the dstkey
4843 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4844 * this set object will be the resulting object to set into the target key*/
4845 dstset
= createSetObject();
4847 /* Iterate all the elements of all the sets, add every element a single
4848 * time to the result set */
4849 for (j
= 0; j
< setsnum
; j
++) {
4850 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4851 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4853 di
= dictGetIterator(dv
[j
]);
4855 while((de
= dictNext(di
)) != NULL
) {
4858 /* dictAdd will not add the same element multiple times */
4859 ele
= dictGetEntryKey(de
);
4860 if (op
== REDIS_OP_UNION
|| j
== 0) {
4861 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4865 } else if (op
== REDIS_OP_DIFF
) {
4866 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4871 dictReleaseIterator(di
);
4873 /* result set is empty? Exit asap. */
4874 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
4877 /* Output the content of the resulting set, if not in STORE mode */
4879 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4880 di
= dictGetIterator(dstset
->ptr
);
4881 while((de
= dictNext(di
)) != NULL
) {
4884 ele
= dictGetEntryKey(de
);
4885 addReplyBulk(c
,ele
);
4887 dictReleaseIterator(di
);
4888 decrRefCount(dstset
);
4890 /* If we have a target key where to store the resulting set
4891 * create this key with the result set inside */
4892 deleteKey(c
->db
,dstkey
);
4893 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4894 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4895 incrRefCount(dstkey
);
4896 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4898 decrRefCount(dstset
);
4899 addReply(c
,shared
.czero
);
4906 static void sunionCommand(redisClient
*c
) {
4907 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4910 static void sunionstoreCommand(redisClient
*c
) {
4911 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4914 static void sdiffCommand(redisClient
*c
) {
4915 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4918 static void sdiffstoreCommand(redisClient
*c
) {
4919 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4922 /* ==================================== ZSets =============================== */
4924 /* ZSETs are ordered sets using two data structures to hold the same elements
4925 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4928 * The elements are added to an hash table mapping Redis objects to scores.
4929 * At the same time the elements are added to a skip list mapping scores
4930 * to Redis objects (so objects are sorted by scores in this "view"). */
4932 /* This skiplist implementation is almost a C translation of the original
4933 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4934 * Alternative to Balanced Trees", modified in three ways:
4935 * a) this implementation allows for repeated values.
4936 * b) the comparison is not just by key (our 'score') but by satellite data.
4937 * c) there is a back pointer, so it's a doubly linked list with the back
4938 * pointers being only at "level 1". This allows to traverse the list
4939 * from tail to head, useful for ZREVRANGE. */
4941 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4942 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4944 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4946 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4952 static zskiplist
*zslCreate(void) {
4956 zsl
= zmalloc(sizeof(*zsl
));
4959 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4960 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4961 zsl
->header
->forward
[j
] = NULL
;
4963 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4964 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4965 zsl
->header
->span
[j
] = 0;
4967 zsl
->header
->backward
= NULL
;
4972 static void zslFreeNode(zskiplistNode
*node
) {
4973 decrRefCount(node
->obj
);
4974 zfree(node
->forward
);
4979 static void zslFree(zskiplist
*zsl
) {
4980 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4982 zfree(zsl
->header
->forward
);
4983 zfree(zsl
->header
->span
);
4986 next
= node
->forward
[0];
4993 static int zslRandomLevel(void) {
4995 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5000 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5001 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5002 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5006 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5007 /* store rank that is crossed to reach the insert position */
5008 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5010 while (x
->forward
[i
] &&
5011 (x
->forward
[i
]->score
< score
||
5012 (x
->forward
[i
]->score
== score
&&
5013 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5014 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5019 /* we assume the key is not already inside, since we allow duplicated
5020 * scores, and the re-insertion of score and redis object should never
5021 * happpen since the caller of zslInsert() should test in the hash table
5022 * if the element is already inside or not. */
5023 level
= zslRandomLevel();
5024 if (level
> zsl
->level
) {
5025 for (i
= zsl
->level
; i
< level
; i
++) {
5027 update
[i
] = zsl
->header
;
5028 update
[i
]->span
[i
-1] = zsl
->length
;
5032 x
= zslCreateNode(level
,score
,obj
);
5033 for (i
= 0; i
< level
; i
++) {
5034 x
->forward
[i
] = update
[i
]->forward
[i
];
5035 update
[i
]->forward
[i
] = x
;
5037 /* update span covered by update[i] as x is inserted here */
5039 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5040 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5044 /* increment span for untouched levels */
5045 for (i
= level
; i
< zsl
->level
; i
++) {
5046 update
[i
]->span
[i
-1]++;
5049 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5051 x
->forward
[0]->backward
= x
;
5057 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5058 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5060 for (i
= 0; i
< zsl
->level
; i
++) {
5061 if (update
[i
]->forward
[i
] == x
) {
5063 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5065 update
[i
]->forward
[i
] = x
->forward
[i
];
5067 /* invariant: i > 0, because update[0]->forward[0]
5068 * is always equal to x */
5069 update
[i
]->span
[i
-1] -= 1;
5072 if (x
->forward
[0]) {
5073 x
->forward
[0]->backward
= x
->backward
;
5075 zsl
->tail
= x
->backward
;
5077 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5082 /* Delete an element with matching score/object from the skiplist. */
5083 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5084 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5088 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5089 while (x
->forward
[i
] &&
5090 (x
->forward
[i
]->score
< score
||
5091 (x
->forward
[i
]->score
== score
&&
5092 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5096 /* We may have multiple elements with the same score, what we need
5097 * is to find the element with both the right score and object. */
5099 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5100 zslDeleteNode(zsl
, x
, update
);
5104 return 0; /* not found */
5106 return 0; /* not found */
5109 /* Delete all the elements with score between min and max from the skiplist.
5110 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5111 * Note that this function takes the reference to the hash table view of the
5112 * sorted set, in order to remove the elements from the hash table too. */
5113 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5114 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5115 unsigned long removed
= 0;
5119 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5120 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5124 /* We may have multiple elements with the same score, what we need
5125 * is to find the element with both the right score and object. */
5127 while (x
&& x
->score
<= max
) {
5128 zskiplistNode
*next
= x
->forward
[0];
5129 zslDeleteNode(zsl
, x
, update
);
5130 dictDelete(dict
,x
->obj
);
5135 return removed
; /* not found */
5138 /* Delete all the elements with rank between start and end from the skiplist.
5139 * Start and end are inclusive. Note that start and end need to be 1-based */
5140 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5141 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5142 unsigned long traversed
= 0, removed
= 0;
5146 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5147 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5148 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5156 while (x
&& traversed
<= end
) {
5157 zskiplistNode
*next
= x
->forward
[0];
5158 zslDeleteNode(zsl
, x
, update
);
5159 dictDelete(dict
,x
->obj
);
5168 /* Find the first node having a score equal or greater than the specified one.
5169 * Returns NULL if there is no match. */
5170 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5175 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5176 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5179 /* We may have multiple elements with the same score, what we need
5180 * is to find the element with both the right score and object. */
5181 return x
->forward
[0];
5184 /* Find the rank for an element by both score and key.
5185 * Returns 0 when the element cannot be found, rank otherwise.
5186 * Note that the rank is 1-based due to the span of zsl->header to the
5188 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5190 unsigned long rank
= 0;
5194 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5195 while (x
->forward
[i
] &&
5196 (x
->forward
[i
]->score
< score
||
5197 (x
->forward
[i
]->score
== score
&&
5198 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5199 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5203 /* x might be equal to zsl->header, so test if obj is non-NULL */
5204 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5211 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5212 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5214 unsigned long traversed
= 0;
5218 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5219 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5221 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5224 if (traversed
== rank
) {
5231 /* The actual Z-commands implementations */
5233 /* This generic command implements both ZADD and ZINCRBY.
5234 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5235 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5236 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5241 zsetobj
= lookupKeyWrite(c
->db
,key
);
5242 if (zsetobj
== NULL
) {
5243 zsetobj
= createZsetObject();
5244 dictAdd(c
->db
->dict
,key
,zsetobj
);
5247 if (zsetobj
->type
!= REDIS_ZSET
) {
5248 addReply(c
,shared
.wrongtypeerr
);
5254 /* Ok now since we implement both ZADD and ZINCRBY here the code
5255 * needs to handle the two different conditions. It's all about setting
5256 * '*score', that is, the new score to set, to the right value. */
5257 score
= zmalloc(sizeof(double));
5261 /* Read the old score. If the element was not present starts from 0 */
5262 de
= dictFind(zs
->dict
,ele
);
5264 double *oldscore
= dictGetEntryVal(de
);
5265 *score
= *oldscore
+ scoreval
;
5273 /* What follows is a simple remove and re-insert operation that is common
5274 * to both ZADD and ZINCRBY... */
5275 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5276 /* case 1: New element */
5277 incrRefCount(ele
); /* added to hash */
5278 zslInsert(zs
->zsl
,*score
,ele
);
5279 incrRefCount(ele
); /* added to skiplist */
5282 addReplyDouble(c
,*score
);
5284 addReply(c
,shared
.cone
);
5289 /* case 2: Score update operation */
5290 de
= dictFind(zs
->dict
,ele
);
5291 redisAssert(de
!= NULL
);
5292 oldscore
= dictGetEntryVal(de
);
5293 if (*score
!= *oldscore
) {
5296 /* Remove and insert the element in the skip list with new score */
5297 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5298 redisAssert(deleted
!= 0);
5299 zslInsert(zs
->zsl
,*score
,ele
);
5301 /* Update the score in the hash table */
5302 dictReplace(zs
->dict
,ele
,score
);
5308 addReplyDouble(c
,*score
);
5310 addReply(c
,shared
.czero
);
5314 static void zaddCommand(redisClient
*c
) {
5317 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5318 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5321 static void zincrbyCommand(redisClient
*c
) {
5324 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5325 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5328 static void zremCommand(redisClient
*c
) {
5335 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5336 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5339 de
= dictFind(zs
->dict
,c
->argv
[2]);
5341 addReply(c
,shared
.czero
);
5344 /* Delete from the skiplist */
5345 oldscore
= dictGetEntryVal(de
);
5346 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5347 redisAssert(deleted
!= 0);
5349 /* Delete from the hash table */
5350 dictDelete(zs
->dict
,c
->argv
[2]);
5351 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5352 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5354 addReply(c
,shared
.cone
);
5357 static void zremrangebyscoreCommand(redisClient
*c
) {
5358 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5359 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5364 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5365 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5368 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5369 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5370 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5371 server
.dirty
+= deleted
;
5372 addReplyLong(c
,deleted
);
5375 static void zremrangebyrankCommand(redisClient
*c
) {
5376 int start
= atoi(c
->argv
[2]->ptr
);
5377 int end
= atoi(c
->argv
[3]->ptr
);
5383 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5384 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5386 llen
= zs
->zsl
->length
;
5388 /* convert negative indexes */
5389 if (start
< 0) start
= llen
+start
;
5390 if (end
< 0) end
= llen
+end
;
5391 if (start
< 0) start
= 0;
5392 if (end
< 0) end
= 0;
5394 /* indexes sanity checks */
5395 if (start
> end
|| start
>= llen
) {
5396 addReply(c
,shared
.czero
);
5399 if (end
>= llen
) end
= llen
-1;
5401 /* increment start and end because zsl*Rank functions
5402 * use 1-based rank */
5403 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5404 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5405 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5406 server
.dirty
+= deleted
;
5407 addReplyLong(c
, deleted
);
5415 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5416 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5417 unsigned long size1
, size2
;
5418 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5419 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5420 return size1
- size2
;
5423 #define REDIS_AGGR_SUM 1
5424 #define REDIS_AGGR_MIN 2
5425 #define REDIS_AGGR_MAX 3
5427 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5428 if (aggregate
== REDIS_AGGR_SUM
) {
5429 *target
= *target
+ val
;
5430 } else if (aggregate
== REDIS_AGGR_MIN
) {
5431 *target
= val
< *target
? val
: *target
;
5432 } else if (aggregate
== REDIS_AGGR_MAX
) {
5433 *target
= val
> *target
? val
: *target
;
5436 redisAssert(0 != 0);
5440 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5442 int aggregate
= REDIS_AGGR_SUM
;
5449 /* expect zsetnum input keys to be given */
5450 zsetnum
= atoi(c
->argv
[2]->ptr
);
5452 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5456 /* test if the expected number of keys would overflow */
5457 if (3+zsetnum
> c
->argc
) {
5458 addReply(c
,shared
.syntaxerr
);
5462 /* read keys to be used for input */
5463 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5464 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5465 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5469 if (zsetobj
->type
!= REDIS_ZSET
) {
5471 addReply(c
,shared
.wrongtypeerr
);
5474 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5477 /* default all weights to 1 */
5478 src
[i
].weight
= 1.0;
5481 /* parse optional extra arguments */
5483 int remaining
= c
->argc
- j
;
5486 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5488 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5489 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5491 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5493 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5494 aggregate
= REDIS_AGGR_SUM
;
5495 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5496 aggregate
= REDIS_AGGR_MIN
;
5497 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5498 aggregate
= REDIS_AGGR_MAX
;
5501 addReply(c
,shared
.syntaxerr
);
5507 addReply(c
,shared
.syntaxerr
);
5513 /* sort sets from the smallest to largest, this will improve our
5514 * algorithm's performance */
5515 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5517 dstobj
= createZsetObject();
5518 dstzset
= dstobj
->ptr
;
5520 if (op
== REDIS_OP_INTER
) {
5521 /* skip going over all entries if the smallest zset is NULL or empty */
5522 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5523 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5524 * from small to large, all src[i > 0].dict are non-empty too */
5525 di
= dictGetIterator(src
[0].dict
);
5526 while((de
= dictNext(di
)) != NULL
) {
5527 double *score
= zmalloc(sizeof(double)), value
;
5528 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5530 for (j
= 1; j
< zsetnum
; j
++) {
5531 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5533 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5534 zunionInterAggregate(score
, value
, aggregate
);
5540 /* skip entry when not present in every source dict */
5544 robj
*o
= dictGetEntryKey(de
);
5545 dictAdd(dstzset
->dict
,o
,score
);
5546 incrRefCount(o
); /* added to dictionary */
5547 zslInsert(dstzset
->zsl
,*score
,o
);
5548 incrRefCount(o
); /* added to skiplist */
5551 dictReleaseIterator(di
);
5553 } else if (op
== REDIS_OP_UNION
) {
5554 for (i
= 0; i
< zsetnum
; i
++) {
5555 if (!src
[i
].dict
) continue;
5557 di
= dictGetIterator(src
[i
].dict
);
5558 while((de
= dictNext(di
)) != NULL
) {
5559 /* skip key when already processed */
5560 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5562 double *score
= zmalloc(sizeof(double)), value
;
5563 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5565 /* because the zsets are sorted by size, its only possible
5566 * for sets at larger indices to hold this entry */
5567 for (j
= (i
+1); j
< zsetnum
; j
++) {
5568 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5570 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5571 zunionInterAggregate(score
, value
, aggregate
);
5575 robj
*o
= dictGetEntryKey(de
);
5576 dictAdd(dstzset
->dict
,o
,score
);
5577 incrRefCount(o
); /* added to dictionary */
5578 zslInsert(dstzset
->zsl
,*score
,o
);
5579 incrRefCount(o
); /* added to skiplist */
5581 dictReleaseIterator(di
);
5584 /* unknown operator */
5585 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5588 deleteKey(c
->db
,dstkey
);
5589 if (dstzset
->zsl
->length
) {
5590 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5591 incrRefCount(dstkey
);
5592 addReplyLong(c
, dstzset
->zsl
->length
);
5595 decrRefCount(dstzset
);
5596 addReply(c
, shared
.czero
);
5601 static void zunionCommand(redisClient
*c
) {
5602 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5605 static void zinterCommand(redisClient
*c
) {
5606 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5609 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5611 int start
= atoi(c
->argv
[2]->ptr
);
5612 int end
= atoi(c
->argv
[3]->ptr
);
5621 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5623 } else if (c
->argc
>= 5) {
5624 addReply(c
,shared
.syntaxerr
);
5628 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5629 checkType(c
,o
,REDIS_ZSET
)) return;
5634 /* convert negative indexes */
5635 if (start
< 0) start
= llen
+start
;
5636 if (end
< 0) end
= llen
+end
;
5637 if (start
< 0) start
= 0;
5638 if (end
< 0) end
= 0;
5640 /* indexes sanity checks */
5641 if (start
> end
|| start
>= llen
) {
5642 /* Out of range start or start > end result in empty list */
5643 addReply(c
,shared
.emptymultibulk
);
5646 if (end
>= llen
) end
= llen
-1;
5647 rangelen
= (end
-start
)+1;
5649 /* check if starting point is trivial, before searching
5650 * the element in log(N) time */
5652 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5655 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5658 /* Return the result in form of a multi-bulk reply */
5659 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5660 withscores
? (rangelen
*2) : rangelen
));
5661 for (j
= 0; j
< rangelen
; j
++) {
5663 addReplyBulk(c
,ele
);
5665 addReplyDouble(c
,ln
->score
);
5666 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5670 static void zrangeCommand(redisClient
*c
) {
5671 zrangeGenericCommand(c
,0);
5674 static void zrevrangeCommand(redisClient
*c
) {
5675 zrangeGenericCommand(c
,1);
5678 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5679 * If justcount is non-zero, just the count is returned. */
5680 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5683 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5684 int offset
= 0, limit
= -1;
5688 /* Parse the min-max interval. If one of the values is prefixed
5689 * by the "(" character, it's considered "open". For instance
5690 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5691 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5692 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5693 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5696 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5698 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5699 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5702 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5705 /* Parse "WITHSCORES": note that if the command was called with
5706 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5707 * enter the following paths to parse WITHSCORES and LIMIT. */
5708 if (c
->argc
== 5 || c
->argc
== 8) {
5709 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5714 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5718 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5723 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5724 addReply(c
,shared
.syntaxerr
);
5726 } else if (c
->argc
== (7 + withscores
)) {
5727 offset
= atoi(c
->argv
[5]->ptr
);
5728 limit
= atoi(c
->argv
[6]->ptr
);
5729 if (offset
< 0) offset
= 0;
5732 /* Ok, lookup the key and get the range */
5733 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5735 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5737 if (o
->type
!= REDIS_ZSET
) {
5738 addReply(c
,shared
.wrongtypeerr
);
5740 zset
*zsetobj
= o
->ptr
;
5741 zskiplist
*zsl
= zsetobj
->zsl
;
5743 robj
*ele
, *lenobj
= NULL
;
5744 unsigned long rangelen
= 0;
5746 /* Get the first node with the score >= min, or with
5747 * score > min if 'minex' is true. */
5748 ln
= zslFirstWithScore(zsl
,min
);
5749 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5752 /* No element matching the speciifed interval */
5753 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5757 /* We don't know in advance how many matching elements there
5758 * are in the list, so we push this object that will represent
5759 * the multi-bulk length in the output buffer, and will "fix"
5762 lenobj
= createObject(REDIS_STRING
,NULL
);
5764 decrRefCount(lenobj
);
5767 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5770 ln
= ln
->forward
[0];
5773 if (limit
== 0) break;
5776 addReplyBulk(c
,ele
);
5778 addReplyDouble(c
,ln
->score
);
5780 ln
= ln
->forward
[0];
5782 if (limit
> 0) limit
--;
5785 addReplyLong(c
,(long)rangelen
);
5787 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5788 withscores
? (rangelen
*2) : rangelen
);
5794 static void zrangebyscoreCommand(redisClient
*c
) {
5795 genericZrangebyscoreCommand(c
,0);
5798 static void zcountCommand(redisClient
*c
) {
5799 genericZrangebyscoreCommand(c
,1);
5802 static void zcardCommand(redisClient
*c
) {
5806 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5807 checkType(c
,o
,REDIS_ZSET
)) return;
5810 addReplyUlong(c
,zs
->zsl
->length
);
5813 static void zscoreCommand(redisClient
*c
) {
5818 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5819 checkType(c
,o
,REDIS_ZSET
)) return;
5822 de
= dictFind(zs
->dict
,c
->argv
[2]);
5824 addReply(c
,shared
.nullbulk
);
5826 double *score
= dictGetEntryVal(de
);
5828 addReplyDouble(c
,*score
);
5832 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5840 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5841 checkType(c
,o
,REDIS_ZSET
)) return;
5845 de
= dictFind(zs
->dict
,c
->argv
[2]);
5847 addReply(c
,shared
.nullbulk
);
5851 score
= dictGetEntryVal(de
);
5852 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5855 addReplyLong(c
, zsl
->length
- rank
);
5857 addReplyLong(c
, rank
-1);
5860 addReply(c
,shared
.nullbulk
);
5864 static void zrankCommand(redisClient
*c
) {
5865 zrankGenericCommand(c
, 0);
5868 static void zrevrankCommand(redisClient
*c
) {
5869 zrankGenericCommand(c
, 1);
5872 /* =================================== Hashes =============================== */
5873 static void hsetCommand(redisClient
*c
) {
5875 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5878 o
= createHashObject();
5879 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5880 incrRefCount(c
->argv
[1]);
5882 if (o
->type
!= REDIS_HASH
) {
5883 addReply(c
,shared
.wrongtypeerr
);
5887 /* We want to convert the zipmap into an hash table right now if the
5888 * entry to be added is too big. Note that we check if the object
5889 * is integer encoded before to try fetching the length in the test below.
5890 * This is because integers are small, but currently stringObjectLen()
5891 * performs a slow conversion: not worth it. */
5892 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5893 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5894 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5895 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5896 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5898 convertToRealHash(o
);
5901 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5902 unsigned char *zm
= o
->ptr
;
5903 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5905 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5906 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
5907 decrRefCount(valobj
);
5910 /* And here there is the second check for hash conversion...
5911 * we want to do it only if the operation was not just an update as
5912 * zipmapLen() is O(N). */
5913 if (!update
&& zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
5914 convertToRealHash(o
);
5916 tryObjectEncoding(c
->argv
[2]);
5917 /* note that c->argv[3] is already encoded, as the latest arg
5918 * of a bulk command is always integer encoded if possible. */
5919 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
5920 incrRefCount(c
->argv
[2]);
5924 incrRefCount(c
->argv
[3]);
5927 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
5930 static void hgetCommand(redisClient
*c
) {
5933 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5934 checkType(c
,o
,REDIS_HASH
)) return;
5936 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5937 unsigned char *zm
= o
->ptr
;
5942 field
= getDecodedObject(c
->argv
[2]);
5943 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
5944 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
5945 addReplySds(c
,sdsnewlen(val
,vlen
));
5946 addReply(c
,shared
.crlf
);
5947 decrRefCount(field
);
5950 addReply(c
,shared
.nullbulk
);
5951 decrRefCount(field
);
5955 struct dictEntry
*de
;
5957 de
= dictFind(o
->ptr
,c
->argv
[2]);
5959 addReply(c
,shared
.nullbulk
);
5961 robj
*e
= dictGetEntryVal(de
);
5968 static void hdelCommand(redisClient
*c
) {
5972 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5973 checkType(c
,o
,REDIS_HASH
)) return;
5975 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5976 robj
*field
= getDecodedObject(c
->argv
[2]);
5978 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
5979 (unsigned char*) field
->ptr
,
5980 sdslen(field
->ptr
), &deleted
);
5981 decrRefCount(field
);
5982 if (zipmapLen((unsigned char*) o
->ptr
) == 0)
5983 deleteKey(c
->db
,c
->argv
[1]);
5985 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
5986 if (htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
5987 if (dictSize((dict
*)o
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5989 if (deleted
) server
.dirty
++;
5990 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
5993 static void hlenCommand(redisClient
*c
) {
5997 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5998 checkType(c
,o
,REDIS_HASH
)) return;
6000 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6001 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6002 addReplyUlong(c
,len
);
6005 #define REDIS_GETALL_KEYS 1
6006 #define REDIS_GETALL_VALS 2
6007 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6009 unsigned long count
= 0;
6011 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
6012 || checkType(c
,o
,REDIS_HASH
)) return;
6014 lenobj
= createObject(REDIS_STRING
,NULL
);
6016 decrRefCount(lenobj
);
6018 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6019 unsigned char *p
= zipmapRewind(o
->ptr
);
6020 unsigned char *field
, *val
;
6021 unsigned int flen
, vlen
;
6023 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
6026 if (flags
& REDIS_GETALL_KEYS
) {
6027 aux
= createStringObject((char*)field
,flen
);
6028 addReplyBulk(c
,aux
);
6032 if (flags
& REDIS_GETALL_VALS
) {
6033 aux
= createStringObject((char*)val
,vlen
);
6034 addReplyBulk(c
,aux
);
6040 dictIterator
*di
= dictGetIterator(o
->ptr
);
6043 while((de
= dictNext(di
)) != NULL
) {
6044 robj
*fieldobj
= dictGetEntryKey(de
);
6045 robj
*valobj
= dictGetEntryVal(de
);
6047 if (flags
& REDIS_GETALL_KEYS
) {
6048 addReplyBulk(c
,fieldobj
);
6051 if (flags
& REDIS_GETALL_VALS
) {
6052 addReplyBulk(c
,valobj
);
6056 dictReleaseIterator(di
);
6058 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6061 static void hkeysCommand(redisClient
*c
) {
6062 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6065 static void hvalsCommand(redisClient
*c
) {
6066 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6069 static void hgetallCommand(redisClient
*c
) {
6070 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6073 static void hexistsCommand(redisClient
*c
) {
6077 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6078 checkType(c
,o
,REDIS_HASH
)) return;
6080 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6082 unsigned char *zm
= o
->ptr
;
6084 field
= getDecodedObject(c
->argv
[2]);
6085 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6086 decrRefCount(field
);
6088 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6090 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6093 static void convertToRealHash(robj
*o
) {
6094 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6095 unsigned int klen
, vlen
;
6096 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6098 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6099 p
= zipmapRewind(zm
);
6100 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6101 robj
*keyobj
, *valobj
;
6103 keyobj
= createStringObject((char*)key
,klen
);
6104 valobj
= createStringObject((char*)val
,vlen
);
6105 tryObjectEncoding(keyobj
);
6106 tryObjectEncoding(valobj
);
6107 dictAdd(dict
,keyobj
,valobj
);
6109 o
->encoding
= REDIS_ENCODING_HT
;
6114 /* ========================= Non type-specific commands ==================== */
6116 static void flushdbCommand(redisClient
*c
) {
6117 server
.dirty
+= dictSize(c
->db
->dict
);
6118 dictEmpty(c
->db
->dict
);
6119 dictEmpty(c
->db
->expires
);
6120 addReply(c
,shared
.ok
);
6123 static void flushallCommand(redisClient
*c
) {
6124 server
.dirty
+= emptyDb();
6125 addReply(c
,shared
.ok
);
6126 rdbSave(server
.dbfilename
);
6130 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6131 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6133 so
->pattern
= pattern
;
6137 /* Return the value associated to the key with a name obtained
6138 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6139 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6143 int prefixlen
, sublen
, postfixlen
;
6144 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6148 char buf
[REDIS_SORTKEY_MAX
+1];
6151 /* If the pattern is "#" return the substitution object itself in order
6152 * to implement the "SORT ... GET #" feature. */
6153 spat
= pattern
->ptr
;
6154 if (spat
[0] == '#' && spat
[1] == '\0') {
6158 /* The substitution object may be specially encoded. If so we create
6159 * a decoded object on the fly. Otherwise getDecodedObject will just
6160 * increment the ref count, that we'll decrement later. */
6161 subst
= getDecodedObject(subst
);
6164 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6165 p
= strchr(spat
,'*');
6167 decrRefCount(subst
);
6172 sublen
= sdslen(ssub
);
6173 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6174 memcpy(keyname
.buf
,spat
,prefixlen
);
6175 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6176 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6177 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6178 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6180 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6181 decrRefCount(subst
);
6183 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6184 return lookupKeyRead(db
,&keyobj
);
6187 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6188 * the additional parameter is not standard but a BSD-specific we have to
6189 * pass sorting parameters via the global 'server' structure */
6190 static int sortCompare(const void *s1
, const void *s2
) {
6191 const redisSortObject
*so1
= s1
, *so2
= s2
;
6194 if (!server
.sort_alpha
) {
6195 /* Numeric sorting. Here it's trivial as we precomputed scores */
6196 if (so1
->u
.score
> so2
->u
.score
) {
6198 } else if (so1
->u
.score
< so2
->u
.score
) {
6204 /* Alphanumeric sorting */
6205 if (server
.sort_bypattern
) {
6206 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6207 /* At least one compare object is NULL */
6208 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6210 else if (so1
->u
.cmpobj
== NULL
)
6215 /* We have both the objects, use strcoll */
6216 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6219 /* Compare elements directly */
6222 dec1
= getDecodedObject(so1
->obj
);
6223 dec2
= getDecodedObject(so2
->obj
);
6224 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6229 return server
.sort_desc
? -cmp
: cmp
;
6232 /* The SORT command is the most complex command in Redis. Warning: this code
6233 * is optimized for speed and a bit less for readability */
6234 static void sortCommand(redisClient
*c
) {
6237 int desc
= 0, alpha
= 0;
6238 int limit_start
= 0, limit_count
= -1, start
, end
;
6239 int j
, dontsort
= 0, vectorlen
;
6240 int getop
= 0; /* GET operation counter */
6241 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6242 redisSortObject
*vector
; /* Resulting vector to sort */
6244 /* Lookup the key to sort. It must be of the right types */
6245 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6246 if (sortval
== NULL
) {
6247 addReply(c
,shared
.nullmultibulk
);
6250 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6251 sortval
->type
!= REDIS_ZSET
)
6253 addReply(c
,shared
.wrongtypeerr
);
6257 /* Create a list of operations to perform for every sorted element.
6258 * Operations can be GET/DEL/INCR/DECR */
6259 operations
= listCreate();
6260 listSetFreeMethod(operations
,zfree
);
6263 /* Now we need to protect sortval incrementing its count, in the future
6264 * SORT may have options able to overwrite/delete keys during the sorting
6265 * and the sorted key itself may get destroied */
6266 incrRefCount(sortval
);
6268 /* The SORT command has an SQL-alike syntax, parse it */
6269 while(j
< c
->argc
) {
6270 int leftargs
= c
->argc
-j
-1;
6271 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6273 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6275 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6277 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6278 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6279 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6281 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6282 storekey
= c
->argv
[j
+1];
6284 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6285 sortby
= c
->argv
[j
+1];
6286 /* If the BY pattern does not contain '*', i.e. it is constant,
6287 * we don't need to sort nor to lookup the weight keys. */
6288 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6290 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6291 listAddNodeTail(operations
,createSortOperation(
6292 REDIS_SORT_GET
,c
->argv
[j
+1]));
6296 decrRefCount(sortval
);
6297 listRelease(operations
);
6298 addReply(c
,shared
.syntaxerr
);
6304 /* Load the sorting vector with all the objects to sort */
6305 switch(sortval
->type
) {
6306 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6307 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6308 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6309 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6311 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6314 if (sortval
->type
== REDIS_LIST
) {
6315 list
*list
= sortval
->ptr
;
6319 listRewind(list
,&li
);
6320 while((ln
= listNext(&li
))) {
6321 robj
*ele
= ln
->value
;
6322 vector
[j
].obj
= ele
;
6323 vector
[j
].u
.score
= 0;
6324 vector
[j
].u
.cmpobj
= NULL
;
6332 if (sortval
->type
== REDIS_SET
) {
6335 zset
*zs
= sortval
->ptr
;
6339 di
= dictGetIterator(set
);
6340 while((setele
= dictNext(di
)) != NULL
) {
6341 vector
[j
].obj
= dictGetEntryKey(setele
);
6342 vector
[j
].u
.score
= 0;
6343 vector
[j
].u
.cmpobj
= NULL
;
6346 dictReleaseIterator(di
);
6348 redisAssert(j
== vectorlen
);
6350 /* Now it's time to load the right scores in the sorting vector */
6351 if (dontsort
== 0) {
6352 for (j
= 0; j
< vectorlen
; j
++) {
6356 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6357 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6359 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6361 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6362 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6364 /* Don't need to decode the object if it's
6365 * integer-encoded (the only encoding supported) so
6366 * far. We can just cast it */
6367 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6368 vector
[j
].u
.score
= (long)byval
->ptr
;
6370 redisAssert(1 != 1);
6375 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6376 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6378 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6379 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6381 redisAssert(1 != 1);
6388 /* We are ready to sort the vector... perform a bit of sanity check
6389 * on the LIMIT option too. We'll use a partial version of quicksort. */
6390 start
= (limit_start
< 0) ? 0 : limit_start
;
6391 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6392 if (start
>= vectorlen
) {
6393 start
= vectorlen
-1;
6396 if (end
>= vectorlen
) end
= vectorlen
-1;
6398 if (dontsort
== 0) {
6399 server
.sort_desc
= desc
;
6400 server
.sort_alpha
= alpha
;
6401 server
.sort_bypattern
= sortby
? 1 : 0;
6402 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6403 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6405 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6408 /* Send command output to the output buffer, performing the specified
6409 * GET/DEL/INCR/DECR operations if any. */
6410 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6411 if (storekey
== NULL
) {
6412 /* STORE option not specified, sent the sorting result to client */
6413 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6414 for (j
= start
; j
<= end
; j
++) {
6418 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6419 listRewind(operations
,&li
);
6420 while((ln
= listNext(&li
))) {
6421 redisSortOperation
*sop
= ln
->value
;
6422 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6425 if (sop
->type
== REDIS_SORT_GET
) {
6426 if (!val
|| val
->type
!= REDIS_STRING
) {
6427 addReply(c
,shared
.nullbulk
);
6429 addReplyBulk(c
,val
);
6432 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6437 robj
*listObject
= createListObject();
6438 list
*listPtr
= (list
*) listObject
->ptr
;
6440 /* STORE option specified, set the sorting result as a List object */
6441 for (j
= start
; j
<= end
; j
++) {
6446 listAddNodeTail(listPtr
,vector
[j
].obj
);
6447 incrRefCount(vector
[j
].obj
);
6449 listRewind(operations
,&li
);
6450 while((ln
= listNext(&li
))) {
6451 redisSortOperation
*sop
= ln
->value
;
6452 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6455 if (sop
->type
== REDIS_SORT_GET
) {
6456 if (!val
|| val
->type
!= REDIS_STRING
) {
6457 listAddNodeTail(listPtr
,createStringObject("",0));
6459 listAddNodeTail(listPtr
,val
);
6463 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6467 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6468 incrRefCount(storekey
);
6470 /* Note: we add 1 because the DB is dirty anyway since even if the
6471 * SORT result is empty a new key is set and maybe the old content
6473 server
.dirty
+= 1+outputlen
;
6474 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6478 decrRefCount(sortval
);
6479 listRelease(operations
);
6480 for (j
= 0; j
< vectorlen
; j
++) {
6481 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6482 decrRefCount(vector
[j
].u
.cmpobj
);
6487 /* Convert an amount of bytes into a human readable string in the form
6488 * of 100B, 2G, 100M, 4K, and so forth. */
6489 static void bytesToHuman(char *s
, unsigned long long n
) {
6494 sprintf(s
,"%lluB",n
);
6496 } else if (n
< (1024*1024)) {
6497 d
= (double)n
/(1024);
6498 sprintf(s
,"%.2fK",d
);
6499 } else if (n
< (1024LL*1024*1024)) {
6500 d
= (double)n
/(1024*1024);
6501 sprintf(s
,"%.2fM",d
);
6502 } else if (n
< (1024LL*1024*1024*1024)) {
6503 d
= (double)n
/(1024LL*1024*1024);
6504 sprintf(s
,"%.2fG",d
);
6508 /* Create the string returned by the INFO command. This is decoupled
6509 * by the INFO command itself as we need to report the same information
6510 * on memory corruption problems. */
6511 static sds
genRedisInfoString(void) {
6513 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6517 bytesToHuman(hmem
,zmalloc_used_memory());
6518 info
= sdscatprintf(sdsempty(),
6519 "redis_version:%s\r\n"
6521 "multiplexing_api:%s\r\n"
6522 "process_id:%ld\r\n"
6523 "uptime_in_seconds:%ld\r\n"
6524 "uptime_in_days:%ld\r\n"
6525 "connected_clients:%d\r\n"
6526 "connected_slaves:%d\r\n"
6527 "blocked_clients:%d\r\n"
6528 "used_memory:%zu\r\n"
6529 "used_memory_human:%s\r\n"
6530 "changes_since_last_save:%lld\r\n"
6531 "bgsave_in_progress:%d\r\n"
6532 "last_save_time:%ld\r\n"
6533 "bgrewriteaof_in_progress:%d\r\n"
6534 "total_connections_received:%lld\r\n"
6535 "total_commands_processed:%lld\r\n"
6536 "hash_max_zipmap_entries:%ld\r\n"
6537 "hash_max_zipmap_value:%ld\r\n"
6541 (sizeof(long) == 8) ? "64" : "32",
6546 listLength(server
.clients
)-listLength(server
.slaves
),
6547 listLength(server
.slaves
),
6548 server
.blpop_blocked_clients
,
6549 zmalloc_used_memory(),
6552 server
.bgsavechildpid
!= -1,
6554 server
.bgrewritechildpid
!= -1,
6555 server
.stat_numconnections
,
6556 server
.stat_numcommands
,
6557 server
.hash_max_zipmap_entries
,
6558 server
.hash_max_zipmap_value
,
6559 server
.vm_enabled
!= 0,
6560 server
.masterhost
== NULL
? "master" : "slave"
6562 if (server
.masterhost
) {
6563 info
= sdscatprintf(info
,
6564 "master_host:%s\r\n"
6565 "master_port:%d\r\n"
6566 "master_link_status:%s\r\n"
6567 "master_last_io_seconds_ago:%d\r\n"
6570 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6572 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6575 if (server
.vm_enabled
) {
6577 info
= sdscatprintf(info
,
6578 "vm_conf_max_memory:%llu\r\n"
6579 "vm_conf_page_size:%llu\r\n"
6580 "vm_conf_pages:%llu\r\n"
6581 "vm_stats_used_pages:%llu\r\n"
6582 "vm_stats_swapped_objects:%llu\r\n"
6583 "vm_stats_swappin_count:%llu\r\n"
6584 "vm_stats_swappout_count:%llu\r\n"
6585 "vm_stats_io_newjobs_len:%lu\r\n"
6586 "vm_stats_io_processing_len:%lu\r\n"
6587 "vm_stats_io_processed_len:%lu\r\n"
6588 "vm_stats_io_active_threads:%lu\r\n"
6589 "vm_stats_blocked_clients:%lu\r\n"
6590 ,(unsigned long long) server
.vm_max_memory
,
6591 (unsigned long long) server
.vm_page_size
,
6592 (unsigned long long) server
.vm_pages
,
6593 (unsigned long long) server
.vm_stats_used_pages
,
6594 (unsigned long long) server
.vm_stats_swapped_objects
,
6595 (unsigned long long) server
.vm_stats_swapins
,
6596 (unsigned long long) server
.vm_stats_swapouts
,
6597 (unsigned long) listLength(server
.io_newjobs
),
6598 (unsigned long) listLength(server
.io_processing
),
6599 (unsigned long) listLength(server
.io_processed
),
6600 (unsigned long) server
.io_active_threads
,
6601 (unsigned long) server
.vm_blocked_clients
6605 for (j
= 0; j
< server
.dbnum
; j
++) {
6606 long long keys
, vkeys
;
6608 keys
= dictSize(server
.db
[j
].dict
);
6609 vkeys
= dictSize(server
.db
[j
].expires
);
6610 if (keys
|| vkeys
) {
6611 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6618 static void infoCommand(redisClient
*c
) {
6619 sds info
= genRedisInfoString();
6620 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6621 (unsigned long)sdslen(info
)));
6622 addReplySds(c
,info
);
6623 addReply(c
,shared
.crlf
);
6626 static void monitorCommand(redisClient
*c
) {
6627 /* ignore MONITOR if aleady slave or in monitor mode */
6628 if (c
->flags
& REDIS_SLAVE
) return;
6630 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6632 listAddNodeTail(server
.monitors
,c
);
6633 addReply(c
,shared
.ok
);
6636 /* ================================= Expire ================================= */
6637 static int removeExpire(redisDb
*db
, robj
*key
) {
6638 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6645 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6646 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6654 /* Return the expire time of the specified key, or -1 if no expire
6655 * is associated with this key (i.e. the key is non volatile) */
6656 static time_t getExpire(redisDb
*db
, robj
*key
) {
6659 /* No expire? return ASAP */
6660 if (dictSize(db
->expires
) == 0 ||
6661 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6663 return (time_t) dictGetEntryVal(de
);
6666 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6670 /* No expire? return ASAP */
6671 if (dictSize(db
->expires
) == 0 ||
6672 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6674 /* Lookup the expire */
6675 when
= (time_t) dictGetEntryVal(de
);
6676 if (time(NULL
) <= when
) return 0;
6678 /* Delete the key */
6679 dictDelete(db
->expires
,key
);
6680 return dictDelete(db
->dict
,key
) == DICT_OK
;
6683 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6686 /* No expire? return ASAP */
6687 if (dictSize(db
->expires
) == 0 ||
6688 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6690 /* Delete the key */
6692 dictDelete(db
->expires
,key
);
6693 return dictDelete(db
->dict
,key
) == DICT_OK
;
6696 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6699 de
= dictFind(c
->db
->dict
,key
);
6701 addReply(c
,shared
.czero
);
6705 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6706 addReply(c
, shared
.cone
);
6709 time_t when
= time(NULL
)+seconds
;
6710 if (setExpire(c
->db
,key
,when
)) {
6711 addReply(c
,shared
.cone
);
6714 addReply(c
,shared
.czero
);
6720 static void expireCommand(redisClient
*c
) {
6721 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6724 static void expireatCommand(redisClient
*c
) {
6725 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6728 static void ttlCommand(redisClient
*c
) {
6732 expire
= getExpire(c
->db
,c
->argv
[1]);
6734 ttl
= (int) (expire
-time(NULL
));
6735 if (ttl
< 0) ttl
= -1;
6737 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6740 /* ================================ MULTI/EXEC ============================== */
6742 /* Client state initialization for MULTI/EXEC */
6743 static void initClientMultiState(redisClient
*c
) {
6744 c
->mstate
.commands
= NULL
;
6745 c
->mstate
.count
= 0;
6748 /* Release all the resources associated with MULTI/EXEC state */
6749 static void freeClientMultiState(redisClient
*c
) {
6752 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6754 multiCmd
*mc
= c
->mstate
.commands
+j
;
6756 for (i
= 0; i
< mc
->argc
; i
++)
6757 decrRefCount(mc
->argv
[i
]);
6760 zfree(c
->mstate
.commands
);
6763 /* Add a new command into the MULTI commands queue */
6764 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6768 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6769 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6770 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6773 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6774 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6775 for (j
= 0; j
< c
->argc
; j
++)
6776 incrRefCount(mc
->argv
[j
]);
6780 static void multiCommand(redisClient
*c
) {
6781 c
->flags
|= REDIS_MULTI
;
6782 addReply(c
,shared
.ok
);
6785 static void discardCommand(redisClient
*c
) {
6786 if (!(c
->flags
& REDIS_MULTI
)) {
6787 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6791 freeClientMultiState(c
);
6792 initClientMultiState(c
);
6793 c
->flags
&= (~REDIS_MULTI
);
6794 addReply(c
,shared
.ok
);
6797 static void execCommand(redisClient
*c
) {
6802 if (!(c
->flags
& REDIS_MULTI
)) {
6803 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6807 orig_argv
= c
->argv
;
6808 orig_argc
= c
->argc
;
6809 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6810 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6811 c
->argc
= c
->mstate
.commands
[j
].argc
;
6812 c
->argv
= c
->mstate
.commands
[j
].argv
;
6813 call(c
,c
->mstate
.commands
[j
].cmd
);
6815 c
->argv
= orig_argv
;
6816 c
->argc
= orig_argc
;
6817 freeClientMultiState(c
);
6818 initClientMultiState(c
);
6819 c
->flags
&= (~REDIS_MULTI
);
6822 /* =========================== Blocking Operations ========================= */
6824 /* Currently Redis blocking operations support is limited to list POP ops,
6825 * so the current implementation is not fully generic, but it is also not
6826 * completely specific so it will not require a rewrite to support new
6827 * kind of blocking operations in the future.
6829 * Still it's important to note that list blocking operations can be already
6830 * used as a notification mechanism in order to implement other blocking
6831 * operations at application level, so there must be a very strong evidence
6832 * of usefulness and generality before new blocking operations are implemented.
6834 * This is how the current blocking POP works, we use BLPOP as example:
6835 * - If the user calls BLPOP and the key exists and contains a non empty list
6836 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6837 * if there is not to block.
6838 * - If instead BLPOP is called and the key does not exists or the list is
6839 * empty we need to block. In order to do so we remove the notification for
6840 * new data to read in the client socket (so that we'll not serve new
6841 * requests if the blocking request is not served). Also we put the client
6842 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6843 * blocking for this keys.
6844 * - If a PUSH operation against a key with blocked clients waiting is
6845 * performed, we serve the first in the list: basically instead to push
6846 * the new element inside the list we return it to the (first / oldest)
6847 * blocking client, unblock the client, and remove it form the list.
6849 * The above comment and the source code should be enough in order to understand
6850 * the implementation and modify / fix it later.
6853 /* Set a client in blocking mode for the specified key, with the specified
6855 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6860 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6861 c
->blockingkeysnum
= numkeys
;
6862 c
->blockingto
= timeout
;
6863 for (j
= 0; j
< numkeys
; j
++) {
6864 /* Add the key in the client structure, to map clients -> keys */
6865 c
->blockingkeys
[j
] = keys
[j
];
6866 incrRefCount(keys
[j
]);
6868 /* And in the other "side", to map keys -> clients */
6869 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6873 /* For every key we take a list of clients blocked for it */
6875 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6876 incrRefCount(keys
[j
]);
6877 assert(retval
== DICT_OK
);
6879 l
= dictGetEntryVal(de
);
6881 listAddNodeTail(l
,c
);
6883 /* Mark the client as a blocked client */
6884 c
->flags
|= REDIS_BLOCKED
;
6885 server
.blpop_blocked_clients
++;
6888 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6889 static void unblockClientWaitingData(redisClient
*c
) {
6894 assert(c
->blockingkeys
!= NULL
);
6895 /* The client may wait for multiple keys, so unblock it for every key. */
6896 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6897 /* Remove this client from the list of clients waiting for this key. */
6898 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6900 l
= dictGetEntryVal(de
);
6901 listDelNode(l
,listSearchKey(l
,c
));
6902 /* If the list is empty we need to remove it to avoid wasting memory */
6903 if (listLength(l
) == 0)
6904 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6905 decrRefCount(c
->blockingkeys
[j
]);
6907 /* Cleanup the client structure */
6908 zfree(c
->blockingkeys
);
6909 c
->blockingkeys
= NULL
;
6910 c
->flags
&= (~REDIS_BLOCKED
);
6911 server
.blpop_blocked_clients
--;
6912 /* We want to process data if there is some command waiting
6913 * in the input buffer. Note that this is safe even if
6914 * unblockClientWaitingData() gets called from freeClient() because
6915 * freeClient() will be smart enough to call this function
6916 * *after* c->querybuf was set to NULL. */
6917 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6920 /* This should be called from any function PUSHing into lists.
6921 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6922 * 'ele' is the element pushed.
6924 * If the function returns 0 there was no client waiting for a list push
6927 * If the function returns 1 there was a client waiting for a list push
6928 * against this key, the element was passed to this client thus it's not
6929 * needed to actually add it to the list and the caller should return asap. */
6930 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6931 struct dictEntry
*de
;
6932 redisClient
*receiver
;
6936 de
= dictFind(c
->db
->blockingkeys
,key
);
6937 if (de
== NULL
) return 0;
6938 l
= dictGetEntryVal(de
);
6941 receiver
= ln
->value
;
6943 addReplySds(receiver
,sdsnew("*2\r\n"));
6944 addReplyBulk(receiver
,key
);
6945 addReplyBulk(receiver
,ele
);
6946 unblockClientWaitingData(receiver
);
6950 /* Blocking RPOP/LPOP */
6951 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6956 for (j
= 1; j
< c
->argc
-1; j
++) {
6957 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6959 if (o
->type
!= REDIS_LIST
) {
6960 addReply(c
,shared
.wrongtypeerr
);
6963 list
*list
= o
->ptr
;
6964 if (listLength(list
) != 0) {
6965 /* If the list contains elements fall back to the usual
6966 * non-blocking POP operation */
6967 robj
*argv
[2], **orig_argv
;
6970 /* We need to alter the command arguments before to call
6971 * popGenericCommand() as the command takes a single key. */
6972 orig_argv
= c
->argv
;
6973 orig_argc
= c
->argc
;
6974 argv
[1] = c
->argv
[j
];
6978 /* Also the return value is different, we need to output
6979 * the multi bulk reply header and the key name. The
6980 * "real" command will add the last element (the value)
6981 * for us. If this souds like an hack to you it's just
6982 * because it is... */
6983 addReplySds(c
,sdsnew("*2\r\n"));
6984 addReplyBulk(c
,argv
[1]);
6985 popGenericCommand(c
,where
);
6987 /* Fix the client structure with the original stuff */
6988 c
->argv
= orig_argv
;
6989 c
->argc
= orig_argc
;
6995 /* If the list is empty or the key does not exists we must block */
6996 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6997 if (timeout
> 0) timeout
+= time(NULL
);
6998 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7001 static void blpopCommand(redisClient
*c
) {
7002 blockingPopGenericCommand(c
,REDIS_HEAD
);
7005 static void brpopCommand(redisClient
*c
) {
7006 blockingPopGenericCommand(c
,REDIS_TAIL
);
7009 /* =============================== Replication ============================= */
7011 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7012 ssize_t nwritten
, ret
= size
;
7013 time_t start
= time(NULL
);
7017 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7018 nwritten
= write(fd
,ptr
,size
);
7019 if (nwritten
== -1) return -1;
7023 if ((time(NULL
)-start
) > timeout
) {
7031 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7032 ssize_t nread
, totread
= 0;
7033 time_t start
= time(NULL
);
7037 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7038 nread
= read(fd
,ptr
,size
);
7039 if (nread
== -1) return -1;
7044 if ((time(NULL
)-start
) > timeout
) {
7052 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7059 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7062 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7073 static void syncCommand(redisClient
*c
) {
7074 /* ignore SYNC if aleady slave or in monitor mode */
7075 if (c
->flags
& REDIS_SLAVE
) return;
7077 /* SYNC can't be issued when the server has pending data to send to
7078 * the client about already issued commands. We need a fresh reply
7079 * buffer registering the differences between the BGSAVE and the current
7080 * dataset, so that we can copy to other slaves if needed. */
7081 if (listLength(c
->reply
) != 0) {
7082 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7086 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7087 /* Here we need to check if there is a background saving operation
7088 * in progress, or if it is required to start one */
7089 if (server
.bgsavechildpid
!= -1) {
7090 /* Ok a background save is in progress. Let's check if it is a good
7091 * one for replication, i.e. if there is another slave that is
7092 * registering differences since the server forked to save */
7097 listRewind(server
.slaves
,&li
);
7098 while((ln
= listNext(&li
))) {
7100 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7103 /* Perfect, the server is already registering differences for
7104 * another slave. Set the right state, and copy the buffer. */
7105 listRelease(c
->reply
);
7106 c
->reply
= listDup(slave
->reply
);
7107 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7108 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7110 /* No way, we need to wait for the next BGSAVE in order to
7111 * register differences */
7112 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7113 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7116 /* Ok we don't have a BGSAVE in progress, let's start one */
7117 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7118 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7119 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7120 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7123 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7126 c
->flags
|= REDIS_SLAVE
;
7128 listAddNodeTail(server
.slaves
,c
);
7132 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7133 redisClient
*slave
= privdata
;
7135 REDIS_NOTUSED(mask
);
7136 char buf
[REDIS_IOBUF_LEN
];
7137 ssize_t nwritten
, buflen
;
7139 if (slave
->repldboff
== 0) {
7140 /* Write the bulk write count before to transfer the DB. In theory here
7141 * we don't know how much room there is in the output buffer of the
7142 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7143 * operations) will never be smaller than the few bytes we need. */
7146 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7148 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7156 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7157 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7159 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7160 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7164 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7165 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7170 slave
->repldboff
+= nwritten
;
7171 if (slave
->repldboff
== slave
->repldbsize
) {
7172 close(slave
->repldbfd
);
7173 slave
->repldbfd
= -1;
7174 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7175 slave
->replstate
= REDIS_REPL_ONLINE
;
7176 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7177 sendReplyToClient
, slave
) == AE_ERR
) {
7181 addReplySds(slave
,sdsempty());
7182 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7186 /* This function is called at the end of every backgrond saving.
7187 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7188 * otherwise REDIS_ERR is passed to the function.
7190 * The goal of this function is to handle slaves waiting for a successful
7191 * background saving in order to perform non-blocking synchronization. */
7192 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7194 int startbgsave
= 0;
7197 listRewind(server
.slaves
,&li
);
7198 while((ln
= listNext(&li
))) {
7199 redisClient
*slave
= ln
->value
;
7201 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7203 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7204 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7205 struct redis_stat buf
;
7207 if (bgsaveerr
!= REDIS_OK
) {
7209 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7212 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7213 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7215 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7218 slave
->repldboff
= 0;
7219 slave
->repldbsize
= buf
.st_size
;
7220 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7221 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7222 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7229 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7232 listRewind(server
.slaves
,&li
);
7233 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7234 while((ln
= listNext(&li
))) {
7235 redisClient
*slave
= ln
->value
;
7237 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7244 static int syncWithMaster(void) {
7245 char buf
[1024], tmpfile
[256], authcmd
[1024];
7247 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7248 int dfd
, maxtries
= 5;
7251 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7256 /* AUTH with the master if required. */
7257 if(server
.masterauth
) {
7258 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7259 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7261 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7265 /* Read the AUTH result. */
7266 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7268 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7272 if (buf
[0] != '+') {
7274 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7279 /* Issue the SYNC command */
7280 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7282 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7286 /* Read the bulk write count */
7287 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7289 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7293 if (buf
[0] != '$') {
7295 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7298 dumpsize
= strtol(buf
+1,NULL
,10);
7299 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7300 /* Read the bulk write data on a temp file */
7302 snprintf(tmpfile
,256,
7303 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7304 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7305 if (dfd
!= -1) break;
7310 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7314 int nread
, nwritten
;
7316 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7318 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7324 nwritten
= write(dfd
,buf
,nread
);
7325 if (nwritten
== -1) {
7326 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7334 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7335 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7341 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7342 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7346 server
.master
= createClient(fd
);
7347 server
.master
->flags
|= REDIS_MASTER
;
7348 server
.master
->authenticated
= 1;
7349 server
.replstate
= REDIS_REPL_CONNECTED
;
7353 static void slaveofCommand(redisClient
*c
) {
7354 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7355 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7356 if (server
.masterhost
) {
7357 sdsfree(server
.masterhost
);
7358 server
.masterhost
= NULL
;
7359 if (server
.master
) freeClient(server
.master
);
7360 server
.replstate
= REDIS_REPL_NONE
;
7361 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7364 sdsfree(server
.masterhost
);
7365 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7366 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7367 if (server
.master
) freeClient(server
.master
);
7368 server
.replstate
= REDIS_REPL_CONNECT
;
7369 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7370 server
.masterhost
, server
.masterport
);
7372 addReply(c
,shared
.ok
);
7375 /* ============================ Maxmemory directive ======================== */
7377 /* Try to free one object form the pre-allocated objects free list.
7378 * This is useful under low mem conditions as by default we take 1 million
7379 * free objects allocated. On success REDIS_OK is returned, otherwise
7381 static int tryFreeOneObjectFromFreelist(void) {
7384 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7385 if (listLength(server
.objfreelist
)) {
7386 listNode
*head
= listFirst(server
.objfreelist
);
7387 o
= listNodeValue(head
);
7388 listDelNode(server
.objfreelist
,head
);
7389 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7393 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7398 /* This function gets called when 'maxmemory' is set on the config file to limit
7399 * the max memory used by the server, and we are out of memory.
7400 * This function will try to, in order:
7402 * - Free objects from the free list
7403 * - Try to remove keys with an EXPIRE set
7405 * It is not possible to free enough memory to reach used-memory < maxmemory
7406 * the server will start refusing commands that will enlarge even more the
7409 static void freeMemoryIfNeeded(void) {
7410 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7411 int j
, k
, freed
= 0;
7413 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7414 for (j
= 0; j
< server
.dbnum
; j
++) {
7416 robj
*minkey
= NULL
;
7417 struct dictEntry
*de
;
7419 if (dictSize(server
.db
[j
].expires
)) {
7421 /* From a sample of three keys drop the one nearest to
7422 * the natural expire */
7423 for (k
= 0; k
< 3; k
++) {
7426 de
= dictGetRandomKey(server
.db
[j
].expires
);
7427 t
= (time_t) dictGetEntryVal(de
);
7428 if (minttl
== -1 || t
< minttl
) {
7429 minkey
= dictGetEntryKey(de
);
7433 deleteKey(server
.db
+j
,minkey
);
7436 if (!freed
) return; /* nothing to free... */
7440 /* ============================== Append Only file ========================== */
7442 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7443 sds buf
= sdsempty();
7449 /* The DB this command was targetting is not the same as the last command
7450 * we appendend. To issue a SELECT command is needed. */
7451 if (dictid
!= server
.appendseldb
) {
7454 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7455 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7456 (unsigned long)strlen(seldb
),seldb
);
7457 server
.appendseldb
= dictid
;
7460 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7461 * EXPIREs into EXPIREATs calls */
7462 if (cmd
->proc
== expireCommand
) {
7465 tmpargv
[0] = createStringObject("EXPIREAT",8);
7466 tmpargv
[1] = argv
[1];
7467 incrRefCount(argv
[1]);
7468 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7469 tmpargv
[2] = createObject(REDIS_STRING
,
7470 sdscatprintf(sdsempty(),"%ld",when
));
7474 /* Append the actual command */
7475 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7476 for (j
= 0; j
< argc
; j
++) {
7479 o
= getDecodedObject(o
);
7480 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7481 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7482 buf
= sdscatlen(buf
,"\r\n",2);
7486 /* Free the objects from the modified argv for EXPIREAT */
7487 if (cmd
->proc
== expireCommand
) {
7488 for (j
= 0; j
< 3; j
++)
7489 decrRefCount(argv
[j
]);
7492 /* We want to perform a single write. This should be guaranteed atomic
7493 * at least if the filesystem we are writing is a real physical one.
7494 * While this will save us against the server being killed I don't think
7495 * there is much to do about the whole server stopping for power problems
7497 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7498 if (nwritten
!= (signed)sdslen(buf
)) {
7499 /* Ooops, we are in troubles. The best thing to do for now is
7500 * to simply exit instead to give the illusion that everything is
7501 * working as expected. */
7502 if (nwritten
== -1) {
7503 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7505 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7509 /* If a background append only file rewriting is in progress we want to
7510 * accumulate the differences between the child DB and the current one
7511 * in a buffer, so that when the child process will do its work we
7512 * can append the differences to the new append only file. */
7513 if (server
.bgrewritechildpid
!= -1)
7514 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7518 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7519 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7520 now
-server
.lastfsync
> 1))
7522 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7523 server
.lastfsync
= now
;
7527 /* In Redis commands are always executed in the context of a client, so in
7528 * order to load the append only file we need to create a fake client. */
7529 static struct redisClient
*createFakeClient(void) {
7530 struct redisClient
*c
= zmalloc(sizeof(*c
));
7534 c
->querybuf
= sdsempty();
7538 /* We set the fake client as a slave waiting for the synchronization
7539 * so that Redis will not try to send replies to this client. */
7540 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7541 c
->reply
= listCreate();
7542 listSetFreeMethod(c
->reply
,decrRefCount
);
7543 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7547 static void freeFakeClient(struct redisClient
*c
) {
7548 sdsfree(c
->querybuf
);
7549 listRelease(c
->reply
);
7553 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7554 * error (the append only file is zero-length) REDIS_ERR is returned. On
7555 * fatal error an error message is logged and the program exists. */
7556 int loadAppendOnlyFile(char *filename
) {
7557 struct redisClient
*fakeClient
;
7558 FILE *fp
= fopen(filename
,"r");
7559 struct redis_stat sb
;
7560 unsigned long long loadedkeys
= 0;
7562 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7566 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7570 fakeClient
= createFakeClient();
7577 struct redisCommand
*cmd
;
7579 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7585 if (buf
[0] != '*') goto fmterr
;
7587 argv
= zmalloc(sizeof(robj
*)*argc
);
7588 for (j
= 0; j
< argc
; j
++) {
7589 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7590 if (buf
[0] != '$') goto fmterr
;
7591 len
= strtol(buf
+1,NULL
,10);
7592 argsds
= sdsnewlen(NULL
,len
);
7593 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7594 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7595 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7598 /* Command lookup */
7599 cmd
= lookupCommand(argv
[0]->ptr
);
7601 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7604 /* Try object sharing and encoding */
7605 if (server
.shareobjects
) {
7607 for(j
= 1; j
< argc
; j
++)
7608 argv
[j
] = tryObjectSharing(argv
[j
]);
7610 if (cmd
->flags
& REDIS_CMD_BULK
)
7611 tryObjectEncoding(argv
[argc
-1]);
7612 /* Run the command in the context of a fake client */
7613 fakeClient
->argc
= argc
;
7614 fakeClient
->argv
= argv
;
7615 cmd
->proc(fakeClient
);
7616 /* Discard the reply objects list from the fake client */
7617 while(listLength(fakeClient
->reply
))
7618 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7619 /* Clean up, ready for the next command */
7620 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7622 /* Handle swapping while loading big datasets when VM is on */
7624 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7625 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7626 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7631 freeFakeClient(fakeClient
);
7636 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7638 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7642 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7646 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7647 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7651 /* Avoid the incr/decr ref count business if possible to help
7652 * copy-on-write (we are often in a child process when this function
7654 * Also makes sure that key objects don't get incrRefCount-ed when VM
7656 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7657 obj
= getDecodedObject(obj
);
7660 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7661 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7662 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7664 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7665 if (decrrc
) decrRefCount(obj
);
7668 if (decrrc
) decrRefCount(obj
);
7672 /* Write binary-safe string into a file in the bulkformat
7673 * $<count>\r\n<payload>\r\n */
7674 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7677 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7678 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7679 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7680 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7684 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7685 static int fwriteBulkDouble(FILE *fp
, double d
) {
7686 char buf
[128], dbuf
[128];
7688 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7689 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7690 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7691 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7695 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7696 static int fwriteBulkLong(FILE *fp
, long l
) {
7697 char buf
[128], lbuf
[128];
7699 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7700 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7701 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7702 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7706 /* Write a sequence of commands able to fully rebuild the dataset into
7707 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7708 static int rewriteAppendOnlyFile(char *filename
) {
7709 dictIterator
*di
= NULL
;
7714 time_t now
= time(NULL
);
7716 /* Note that we have to use a different temp name here compared to the
7717 * one used by rewriteAppendOnlyFileBackground() function. */
7718 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7719 fp
= fopen(tmpfile
,"w");
7721 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7724 for (j
= 0; j
< server
.dbnum
; j
++) {
7725 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7726 redisDb
*db
= server
.db
+j
;
7728 if (dictSize(d
) == 0) continue;
7729 di
= dictGetIterator(d
);
7735 /* SELECT the new DB */
7736 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7737 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7739 /* Iterate this DB writing every entry */
7740 while((de
= dictNext(di
)) != NULL
) {
7745 key
= dictGetEntryKey(de
);
7746 /* If the value for this key is swapped, load a preview in memory.
7747 * We use a "swapped" flag to remember if we need to free the
7748 * value object instead to just increment the ref count anyway
7749 * in order to avoid copy-on-write of pages if we are forked() */
7750 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7751 key
->storage
== REDIS_VM_SWAPPING
) {
7752 o
= dictGetEntryVal(de
);
7755 o
= vmPreviewObject(key
);
7758 expiretime
= getExpire(db
,key
);
7760 /* Save the key and associated value */
7761 if (o
->type
== REDIS_STRING
) {
7762 /* Emit a SET command */
7763 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7764 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7766 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7767 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7768 } else if (o
->type
== REDIS_LIST
) {
7769 /* Emit the RPUSHes needed to rebuild the list */
7770 list
*list
= o
->ptr
;
7774 listRewind(list
,&li
);
7775 while((ln
= listNext(&li
))) {
7776 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7777 robj
*eleobj
= listNodeValue(ln
);
7779 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7780 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7781 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7783 } else if (o
->type
== REDIS_SET
) {
7784 /* Emit the SADDs needed to rebuild the set */
7786 dictIterator
*di
= dictGetIterator(set
);
7789 while((de
= dictNext(di
)) != NULL
) {
7790 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7791 robj
*eleobj
= dictGetEntryKey(de
);
7793 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7794 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7795 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7797 dictReleaseIterator(di
);
7798 } else if (o
->type
== REDIS_ZSET
) {
7799 /* Emit the ZADDs needed to rebuild the sorted set */
7801 dictIterator
*di
= dictGetIterator(zs
->dict
);
7804 while((de
= dictNext(di
)) != NULL
) {
7805 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7806 robj
*eleobj
= dictGetEntryKey(de
);
7807 double *score
= dictGetEntryVal(de
);
7809 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7810 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7811 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7812 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7814 dictReleaseIterator(di
);
7815 } else if (o
->type
== REDIS_HASH
) {
7816 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7818 /* Emit the HSETs needed to rebuild the hash */
7819 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7820 unsigned char *p
= zipmapRewind(o
->ptr
);
7821 unsigned char *field
, *val
;
7822 unsigned int flen
, vlen
;
7824 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
7825 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7826 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7827 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
7829 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
7833 dictIterator
*di
= dictGetIterator(o
->ptr
);
7836 while((de
= dictNext(di
)) != NULL
) {
7837 robj
*field
= dictGetEntryKey(de
);
7838 robj
*val
= dictGetEntryVal(de
);
7840 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7841 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7842 if (fwriteBulkObject(fp
,field
) == -1) return -1;
7843 if (fwriteBulkObject(fp
,val
) == -1) return -1;
7845 dictReleaseIterator(di
);
7850 /* Save the expire time */
7851 if (expiretime
!= -1) {
7852 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7853 /* If this key is already expired skip it */
7854 if (expiretime
< now
) continue;
7855 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7856 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7857 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7859 if (swapped
) decrRefCount(o
);
7861 dictReleaseIterator(di
);
7864 /* Make sure data will not remain on the OS's output buffers */
7869 /* Use RENAME to make sure the DB file is changed atomically only
7870 * if the generate DB file is ok. */
7871 if (rename(tmpfile
,filename
) == -1) {
7872 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7876 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7882 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7883 if (di
) dictReleaseIterator(di
);
7887 /* This is how rewriting of the append only file in background works:
7889 * 1) The user calls BGREWRITEAOF
7890 * 2) Redis calls this function, that forks():
7891 * 2a) the child rewrite the append only file in a temp file.
7892 * 2b) the parent accumulates differences in server.bgrewritebuf.
7893 * 3) When the child finished '2a' exists.
7894 * 4) The parent will trap the exit code, if it's OK, will append the
7895 * data accumulated into server.bgrewritebuf into the temp file, and
7896 * finally will rename(2) the temp file in the actual file name.
7897 * The the new file is reopened as the new append only file. Profit!
7899 static int rewriteAppendOnlyFileBackground(void) {
7902 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7903 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7904 if ((childpid
= fork()) == 0) {
7908 if (server
.vm_enabled
) vmReopenSwapFile();
7910 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7911 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7918 if (childpid
== -1) {
7919 redisLog(REDIS_WARNING
,
7920 "Can't rewrite append only file in background: fork: %s",
7924 redisLog(REDIS_NOTICE
,
7925 "Background append only file rewriting started by pid %d",childpid
);
7926 server
.bgrewritechildpid
= childpid
;
7927 /* We set appendseldb to -1 in order to force the next call to the
7928 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7929 * accumulated by the parent into server.bgrewritebuf will start
7930 * with a SELECT statement and it will be safe to merge. */
7931 server
.appendseldb
= -1;
7934 return REDIS_OK
; /* unreached */
7937 static void bgrewriteaofCommand(redisClient
*c
) {
7938 if (server
.bgrewritechildpid
!= -1) {
7939 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7942 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7943 char *status
= "+Background append only file rewriting started\r\n";
7944 addReplySds(c
,sdsnew(status
));
7946 addReply(c
,shared
.err
);
7950 static void aofRemoveTempFile(pid_t childpid
) {
7953 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7957 /* Virtual Memory is composed mainly of two subsystems:
7958 * - Blocking Virutal Memory
7959 * - Threaded Virtual Memory I/O
7960 * The two parts are not fully decoupled, but functions are split among two
7961 * different sections of the source code (delimited by comments) in order to
7962 * make more clear what functionality is about the blocking VM and what about
7963 * the threaded (not blocking) VM.
7967 * Redis VM is a blocking VM (one that blocks reading swapped values from
7968 * disk into memory when a value swapped out is needed in memory) that is made
7969 * unblocking by trying to examine the command argument vector in order to
7970 * load in background values that will likely be needed in order to exec
7971 * the command. The command is executed only once all the relevant keys
7972 * are loaded into memory.
7974 * This basically is almost as simple of a blocking VM, but almost as parallel
7975 * as a fully non-blocking VM.
7978 /* =================== Virtual Memory - Blocking Side ====================== */
7980 /* substitute the first occurrence of '%p' with the process pid in the
7981 * swap file name. */
7982 static void expandVmSwapFilename(void) {
7983 char *p
= strstr(server
.vm_swap_file
,"%p");
7989 new = sdscat(new,server
.vm_swap_file
);
7990 new = sdscatprintf(new,"%ld",(long) getpid());
7991 new = sdscat(new,p
+2);
7992 zfree(server
.vm_swap_file
);
7993 server
.vm_swap_file
= new;
7996 static void vmInit(void) {
8001 if (server
.vm_max_threads
!= 0)
8002 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8004 expandVmSwapFilename();
8005 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8006 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8007 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8009 if (server
.vm_fp
== NULL
) {
8010 redisLog(REDIS_WARNING
,
8011 "Impossible to open the swap file: %s. Exiting.",
8015 server
.vm_fd
= fileno(server
.vm_fp
);
8016 server
.vm_next_page
= 0;
8017 server
.vm_near_pages
= 0;
8018 server
.vm_stats_used_pages
= 0;
8019 server
.vm_stats_swapped_objects
= 0;
8020 server
.vm_stats_swapouts
= 0;
8021 server
.vm_stats_swapins
= 0;
8022 totsize
= server
.vm_pages
*server
.vm_page_size
;
8023 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8024 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8025 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8029 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8031 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8032 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8033 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8034 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8036 /* Initialize threaded I/O (used by Virtual Memory) */
8037 server
.io_newjobs
= listCreate();
8038 server
.io_processing
= listCreate();
8039 server
.io_processed
= listCreate();
8040 server
.io_ready_clients
= listCreate();
8041 pthread_mutex_init(&server
.io_mutex
,NULL
);
8042 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8043 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8044 server
.io_active_threads
= 0;
8045 if (pipe(pipefds
) == -1) {
8046 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8050 server
.io_ready_pipe_read
= pipefds
[0];
8051 server
.io_ready_pipe_write
= pipefds
[1];
8052 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8053 /* LZF requires a lot of stack */
8054 pthread_attr_init(&server
.io_threads_attr
);
8055 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8056 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8057 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8058 /* Listen for events in the threaded I/O pipe */
8059 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8060 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8061 oom("creating file event");
8064 /* Mark the page as used */
8065 static void vmMarkPageUsed(off_t page
) {
8066 off_t byte
= page
/8;
8068 redisAssert(vmFreePage(page
) == 1);
8069 server
.vm_bitmap
[byte
] |= 1<<bit
;
8072 /* Mark N contiguous pages as used, with 'page' being the first. */
8073 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8076 for (j
= 0; j
< count
; j
++)
8077 vmMarkPageUsed(page
+j
);
8078 server
.vm_stats_used_pages
+= count
;
8079 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8080 (long long)count
, (long long)page
);
8083 /* Mark the page as free */
8084 static void vmMarkPageFree(off_t page
) {
8085 off_t byte
= page
/8;
8087 redisAssert(vmFreePage(page
) == 0);
8088 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8091 /* Mark N contiguous pages as free, with 'page' being the first. */
8092 static void vmMarkPagesFree(off_t page
, off_t count
) {
8095 for (j
= 0; j
< count
; j
++)
8096 vmMarkPageFree(page
+j
);
8097 server
.vm_stats_used_pages
-= count
;
8098 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8099 (long long)count
, (long long)page
);
8102 /* Test if the page is free */
8103 static int vmFreePage(off_t page
) {
8104 off_t byte
= page
/8;
8106 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8109 /* Find N contiguous free pages storing the first page of the cluster in *first.
8110 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8111 * REDIS_ERR is returned.
8113 * This function uses a simple algorithm: we try to allocate
8114 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8115 * again from the start of the swap file searching for free spaces.
8117 * If it looks pretty clear that there are no free pages near our offset
8118 * we try to find less populated places doing a forward jump of
8119 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8120 * without hurry, and then we jump again and so forth...
8122 * This function can be improved using a free list to avoid to guess
8123 * too much, since we could collect data about freed pages.
8125 * note: I implemented this function just after watching an episode of
8126 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8128 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8129 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8131 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8132 server
.vm_near_pages
= 0;
8133 server
.vm_next_page
= 0;
8135 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8136 base
= server
.vm_next_page
;
8138 while(offset
< server
.vm_pages
) {
8139 off_t
this = base
+offset
;
8141 /* If we overflow, restart from page zero */
8142 if (this >= server
.vm_pages
) {
8143 this -= server
.vm_pages
;
8145 /* Just overflowed, what we found on tail is no longer
8146 * interesting, as it's no longer contiguous. */
8150 if (vmFreePage(this)) {
8151 /* This is a free page */
8153 /* Already got N free pages? Return to the caller, with success */
8155 *first
= this-(n
-1);
8156 server
.vm_next_page
= this+1;
8157 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8161 /* The current one is not a free page */
8165 /* Fast-forward if the current page is not free and we already
8166 * searched enough near this place. */
8168 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8169 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8171 /* Note that even if we rewind after the jump, we are don't need
8172 * to make sure numfree is set to zero as we only jump *if* it
8173 * is set to zero. */
8175 /* Otherwise just check the next page */
8182 /* Write the specified object at the specified page of the swap file */
8183 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8184 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8185 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8186 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8187 redisLog(REDIS_WARNING
,
8188 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8192 rdbSaveObject(server
.vm_fp
,o
);
8193 fflush(server
.vm_fp
);
8194 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8198 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8199 * needed to later retrieve the object into the key object.
8200 * If we can't find enough contiguous empty pages to swap the object on disk
8201 * REDIS_ERR is returned. */
8202 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8203 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8206 assert(key
->storage
== REDIS_VM_MEMORY
);
8207 assert(key
->refcount
== 1);
8208 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8209 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8210 key
->vm
.page
= page
;
8211 key
->vm
.usedpages
= pages
;
8212 key
->storage
= REDIS_VM_SWAPPED
;
8213 key
->vtype
= val
->type
;
8214 decrRefCount(val
); /* Deallocate the object from memory. */
8215 vmMarkPagesUsed(page
,pages
);
8216 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8217 (unsigned char*) key
->ptr
,
8218 (unsigned long long) page
, (unsigned long long) pages
);
8219 server
.vm_stats_swapped_objects
++;
8220 server
.vm_stats_swapouts
++;
8224 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8227 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8228 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8229 redisLog(REDIS_WARNING
,
8230 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8234 o
= rdbLoadObject(type
,server
.vm_fp
);
8236 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8239 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8243 /* Load the value object relative to the 'key' object from swap to memory.
8244 * The newly allocated object is returned.
8246 * If preview is true the unserialized object is returned to the caller but
8247 * no changes are made to the key object, nor the pages are marked as freed */
8248 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8251 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8252 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8254 key
->storage
= REDIS_VM_MEMORY
;
8255 key
->vm
.atime
= server
.unixtime
;
8256 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8257 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8258 (unsigned char*) key
->ptr
);
8259 server
.vm_stats_swapped_objects
--;
8261 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8262 (unsigned char*) key
->ptr
);
8264 server
.vm_stats_swapins
++;
8268 /* Plain object loading, from swap to memory */
8269 static robj
*vmLoadObject(robj
*key
) {
8270 /* If we are loading the object in background, stop it, we
8271 * need to load this object synchronously ASAP. */
8272 if (key
->storage
== REDIS_VM_LOADING
)
8273 vmCancelThreadedIOJob(key
);
8274 return vmGenericLoadObject(key
,0);
8277 /* Just load the value on disk, without to modify the key.
8278 * This is useful when we want to perform some operation on the value
8279 * without to really bring it from swap to memory, like while saving the
8280 * dataset or rewriting the append only log. */
8281 static robj
*vmPreviewObject(robj
*key
) {
8282 return vmGenericLoadObject(key
,1);
8285 /* How a good candidate is this object for swapping?
8286 * The better candidate it is, the greater the returned value.
8288 * Currently we try to perform a fast estimation of the object size in
8289 * memory, and combine it with aging informations.
8291 * Basically swappability = idle-time * log(estimated size)
8293 * Bigger objects are preferred over smaller objects, but not
8294 * proportionally, this is why we use the logarithm. This algorithm is
8295 * just a first try and will probably be tuned later. */
8296 static double computeObjectSwappability(robj
*o
) {
8297 time_t age
= server
.unixtime
- o
->vm
.atime
;
8301 struct dictEntry
*de
;
8304 if (age
<= 0) return 0;
8307 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8310 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8315 listNode
*ln
= listFirst(l
);
8317 asize
= sizeof(list
);
8319 robj
*ele
= ln
->value
;
8322 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8323 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8325 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8330 z
= (o
->type
== REDIS_ZSET
);
8331 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8333 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8334 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8339 de
= dictGetRandomKey(d
);
8340 ele
= dictGetEntryKey(de
);
8341 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8342 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8344 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8345 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8349 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8350 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8351 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8352 unsigned int klen
, vlen
;
8353 unsigned char *key
, *val
;
8355 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8359 asize
= len
*(klen
+vlen
+3);
8360 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8362 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8367 de
= dictGetRandomKey(d
);
8368 ele
= dictGetEntryKey(de
);
8369 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8370 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8372 ele
= dictGetEntryVal(de
);
8373 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8374 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8376 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8381 return (double)age
*log(1+asize
);
8384 /* Try to swap an object that's a good candidate for swapping.
8385 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8386 * to swap any object at all.
8388 * If 'usethreaded' is true, Redis will try to swap the object in background
8389 * using I/O threads. */
8390 static int vmSwapOneObject(int usethreads
) {
8392 struct dictEntry
*best
= NULL
;
8393 double best_swappability
= 0;
8394 redisDb
*best_db
= NULL
;
8397 for (j
= 0; j
< server
.dbnum
; j
++) {
8398 redisDb
*db
= server
.db
+j
;
8399 /* Why maxtries is set to 100?
8400 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8401 * are swappable objects */
8404 if (dictSize(db
->dict
) == 0) continue;
8405 for (i
= 0; i
< 5; i
++) {
8407 double swappability
;
8409 if (maxtries
) maxtries
--;
8410 de
= dictGetRandomKey(db
->dict
);
8411 key
= dictGetEntryKey(de
);
8412 val
= dictGetEntryVal(de
);
8413 /* Only swap objects that are currently in memory.
8415 * Also don't swap shared objects if threaded VM is on, as we
8416 * try to ensure that the main thread does not touch the
8417 * object while the I/O thread is using it, but we can't
8418 * control other keys without adding additional mutex. */
8419 if (key
->storage
!= REDIS_VM_MEMORY
||
8420 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8421 if (maxtries
) i
--; /* don't count this try */
8424 swappability
= computeObjectSwappability(val
);
8425 if (!best
|| swappability
> best_swappability
) {
8427 best_swappability
= swappability
;
8432 if (best
== NULL
) return REDIS_ERR
;
8433 key
= dictGetEntryKey(best
);
8434 val
= dictGetEntryVal(best
);
8436 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8437 key
->ptr
, best_swappability
);
8439 /* Unshare the key if needed */
8440 if (key
->refcount
> 1) {
8441 robj
*newkey
= dupStringObject(key
);
8443 key
= dictGetEntryKey(best
) = newkey
;
8447 vmSwapObjectThreaded(key
,val
,best_db
);
8450 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8451 dictGetEntryVal(best
) = NULL
;
8459 static int vmSwapOneObjectBlocking() {
8460 return vmSwapOneObject(0);
8463 static int vmSwapOneObjectThreaded() {
8464 return vmSwapOneObject(1);
8467 /* Return true if it's safe to swap out objects in a given moment.
8468 * Basically we don't want to swap objects out while there is a BGSAVE
8469 * or a BGAEOREWRITE running in backgroud. */
8470 static int vmCanSwapOut(void) {
8471 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8474 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8475 * and was deleted. Otherwise 0 is returned. */
8476 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8480 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8481 foundkey
= dictGetEntryKey(de
);
8482 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8487 /* =================== Virtual Memory - Threaded I/O ======================= */
8489 static void freeIOJob(iojob
*j
) {
8490 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8491 j
->type
== REDIS_IOJOB_DO_SWAP
||
8492 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8493 decrRefCount(j
->val
);
8494 decrRefCount(j
->key
);
8498 /* Every time a thread finished a Job, it writes a byte into the write side
8499 * of an unix pipe in order to "awake" the main thread, and this function
8501 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8505 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8507 REDIS_NOTUSED(mask
);
8508 REDIS_NOTUSED(privdata
);
8510 /* For every byte we read in the read side of the pipe, there is one
8511 * I/O job completed to process. */
8512 while((retval
= read(fd
,buf
,1)) == 1) {
8516 struct dictEntry
*de
;
8518 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8520 /* Get the processed element (the oldest one) */
8522 assert(listLength(server
.io_processed
) != 0);
8523 if (toprocess
== -1) {
8524 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8525 if (toprocess
<= 0) toprocess
= 1;
8527 ln
= listFirst(server
.io_processed
);
8529 listDelNode(server
.io_processed
,ln
);
8531 /* If this job is marked as canceled, just ignore it */
8536 /* Post process it in the main thread, as there are things we
8537 * can do just here to avoid race conditions and/or invasive locks */
8538 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
);
8539 de
= dictFind(j
->db
->dict
,j
->key
);
8541 key
= dictGetEntryKey(de
);
8542 if (j
->type
== REDIS_IOJOB_LOAD
) {
8545 /* Key loaded, bring it at home */
8546 key
->storage
= REDIS_VM_MEMORY
;
8547 key
->vm
.atime
= server
.unixtime
;
8548 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8549 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8550 (unsigned char*) key
->ptr
);
8551 server
.vm_stats_swapped_objects
--;
8552 server
.vm_stats_swapins
++;
8553 dictGetEntryVal(de
) = j
->val
;
8554 incrRefCount(j
->val
);
8557 /* Handle clients waiting for this key to be loaded. */
8558 handleClientsBlockedOnSwappedKey(db
,key
);
8559 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8560 /* Now we know the amount of pages required to swap this object.
8561 * Let's find some space for it, and queue this task again
8562 * rebranded as REDIS_IOJOB_DO_SWAP. */
8563 if (!vmCanSwapOut() ||
8564 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8566 /* Ooops... no space or we can't swap as there is
8567 * a fork()ed Redis trying to save stuff on disk. */
8569 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8571 /* Note that we need to mark this pages as used now,
8572 * if the job will be canceled, we'll mark them as freed
8574 vmMarkPagesUsed(j
->page
,j
->pages
);
8575 j
->type
= REDIS_IOJOB_DO_SWAP
;
8580 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8583 /* Key swapped. We can finally free some memory. */
8584 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8585 printf("key->storage: %d\n",key
->storage
);
8586 printf("key->name: %s\n",(char*)key
->ptr
);
8587 printf("key->refcount: %d\n",key
->refcount
);
8588 printf("val: %p\n",(void*)j
->val
);
8589 printf("val->type: %d\n",j
->val
->type
);
8590 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8592 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8593 val
= dictGetEntryVal(de
);
8594 key
->vm
.page
= j
->page
;
8595 key
->vm
.usedpages
= j
->pages
;
8596 key
->storage
= REDIS_VM_SWAPPED
;
8597 key
->vtype
= j
->val
->type
;
8598 decrRefCount(val
); /* Deallocate the object from memory. */
8599 dictGetEntryVal(de
) = NULL
;
8600 redisLog(REDIS_DEBUG
,
8601 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8602 (unsigned char*) key
->ptr
,
8603 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8604 server
.vm_stats_swapped_objects
++;
8605 server
.vm_stats_swapouts
++;
8607 /* Put a few more swap requests in queue if we are still
8609 if (trytoswap
&& vmCanSwapOut() &&
8610 zmalloc_used_memory() > server
.vm_max_memory
)
8615 more
= listLength(server
.io_newjobs
) <
8616 (unsigned) server
.vm_max_threads
;
8618 /* Don't waste CPU time if swappable objects are rare. */
8619 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8627 if (processed
== toprocess
) return;
8629 if (retval
< 0 && errno
!= EAGAIN
) {
8630 redisLog(REDIS_WARNING
,
8631 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8636 static void lockThreadedIO(void) {
8637 pthread_mutex_lock(&server
.io_mutex
);
8640 static void unlockThreadedIO(void) {
8641 pthread_mutex_unlock(&server
.io_mutex
);
8644 /* Remove the specified object from the threaded I/O queue if still not
8645 * processed, otherwise make sure to flag it as canceled. */
8646 static void vmCancelThreadedIOJob(robj
*o
) {
8648 server
.io_newjobs
, /* 0 */
8649 server
.io_processing
, /* 1 */
8650 server
.io_processed
/* 2 */
8654 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8657 /* Search for a matching key in one of the queues */
8658 for (i
= 0; i
< 3; i
++) {
8662 listRewind(lists
[i
],&li
);
8663 while ((ln
= listNext(&li
)) != NULL
) {
8664 iojob
*job
= ln
->value
;
8666 if (job
->canceled
) continue; /* Skip this, already canceled. */
8667 if (compareStringObjects(job
->key
,o
) == 0) {
8668 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8669 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8670 /* Mark the pages as free since the swap didn't happened
8671 * or happened but is now discarded. */
8672 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8673 vmMarkPagesFree(job
->page
,job
->pages
);
8674 /* Cancel the job. It depends on the list the job is
8677 case 0: /* io_newjobs */
8678 /* If the job was yet not processed the best thing to do
8679 * is to remove it from the queue at all */
8681 listDelNode(lists
[i
],ln
);
8683 case 1: /* io_processing */
8684 /* Oh Shi- the thread is messing with the Job:
8686 * Probably it's accessing the object if this is a
8687 * PREPARE_SWAP or DO_SWAP job.
8688 * If it's a LOAD job it may be reading from disk and
8689 * if we don't wait for the job to terminate before to
8690 * cancel it, maybe in a few microseconds data can be
8691 * corrupted in this pages. So the short story is:
8693 * Better to wait for the job to move into the
8694 * next queue (processed)... */
8696 /* We try again and again until the job is completed. */
8698 /* But let's wait some time for the I/O thread
8699 * to finish with this job. After all this condition
8700 * should be very rare. */
8703 case 2: /* io_processed */
8704 /* The job was already processed, that's easy...
8705 * just mark it as canceled so that we'll ignore it
8706 * when processing completed jobs. */
8710 /* Finally we have to adjust the storage type of the object
8711 * in order to "UNDO" the operaiton. */
8712 if (o
->storage
== REDIS_VM_LOADING
)
8713 o
->storage
= REDIS_VM_SWAPPED
;
8714 else if (o
->storage
== REDIS_VM_SWAPPING
)
8715 o
->storage
= REDIS_VM_MEMORY
;
8722 assert(1 != 1); /* We should never reach this */
8725 static void *IOThreadEntryPoint(void *arg
) {
8730 pthread_detach(pthread_self());
8732 /* Get a new job to process */
8734 if (listLength(server
.io_newjobs
) == 0) {
8735 /* No new jobs in queue, exit. */
8736 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8737 (long) pthread_self());
8738 server
.io_active_threads
--;
8742 ln
= listFirst(server
.io_newjobs
);
8744 listDelNode(server
.io_newjobs
,ln
);
8745 /* Add the job in the processing queue */
8746 j
->thread
= pthread_self();
8747 listAddNodeTail(server
.io_processing
,j
);
8748 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8750 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8751 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8753 /* Process the Job */
8754 if (j
->type
== REDIS_IOJOB_LOAD
) {
8755 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8756 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8757 FILE *fp
= fopen("/dev/null","w+");
8758 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8760 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8761 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8765 /* Done: insert the job into the processed queue */
8766 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8767 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8769 listDelNode(server
.io_processing
,ln
);
8770 listAddNodeTail(server
.io_processed
,j
);
8773 /* Signal the main thread there is new stuff to process */
8774 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8776 return NULL
; /* never reached */
8779 static void spawnIOThread(void) {
8781 sigset_t mask
, omask
;
8785 sigaddset(&mask
,SIGCHLD
);
8786 sigaddset(&mask
,SIGHUP
);
8787 sigaddset(&mask
,SIGPIPE
);
8788 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8789 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
8790 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
8794 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8795 server
.io_active_threads
++;
8798 /* We need to wait for the last thread to exit before we are able to
8799 * fork() in order to BGSAVE or BGREWRITEAOF. */
8800 static void waitEmptyIOJobsQueue(void) {
8802 int io_processed_len
;
8805 if (listLength(server
.io_newjobs
) == 0 &&
8806 listLength(server
.io_processing
) == 0 &&
8807 server
.io_active_threads
== 0)
8812 /* While waiting for empty jobs queue condition we post-process some
8813 * finshed job, as I/O threads may be hanging trying to write against
8814 * the io_ready_pipe_write FD but there are so much pending jobs that
8816 io_processed_len
= listLength(server
.io_processed
);
8818 if (io_processed_len
) {
8819 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8820 usleep(1000); /* 1 millisecond */
8822 usleep(10000); /* 10 milliseconds */
8827 static void vmReopenSwapFile(void) {
8828 /* Note: we don't close the old one as we are in the child process
8829 * and don't want to mess at all with the original file object. */
8830 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8831 if (server
.vm_fp
== NULL
) {
8832 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8833 server
.vm_swap_file
);
8836 server
.vm_fd
= fileno(server
.vm_fp
);
8839 /* This function must be called while with threaded IO locked */
8840 static void queueIOJob(iojob
*j
) {
8841 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8842 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8843 listAddNodeTail(server
.io_newjobs
,j
);
8844 if (server
.io_active_threads
< server
.vm_max_threads
)
8848 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8851 assert(key
->storage
== REDIS_VM_MEMORY
);
8852 assert(key
->refcount
== 1);
8854 j
= zmalloc(sizeof(*j
));
8855 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8857 j
->key
= dupStringObject(key
);
8861 j
->thread
= (pthread_t
) -1;
8862 key
->storage
= REDIS_VM_SWAPPING
;
8870 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8872 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8873 * If there is not already a job loading the key, it is craeted.
8874 * The key is added to the io_keys list in the client structure, and also
8875 * in the hash table mapping swapped keys to waiting clients, that is,
8876 * server.io_waited_keys. */
8877 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8878 struct dictEntry
*de
;
8882 /* If the key does not exist or is already in RAM we don't need to
8883 * block the client at all. */
8884 de
= dictFind(c
->db
->dict
,key
);
8885 if (de
== NULL
) return 0;
8886 o
= dictGetEntryKey(de
);
8887 if (o
->storage
== REDIS_VM_MEMORY
) {
8889 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8890 /* We were swapping the key, undo it! */
8891 vmCancelThreadedIOJob(o
);
8895 /* OK: the key is either swapped, or being loaded just now. */
8897 /* Add the key to the list of keys this client is waiting for.
8898 * This maps clients to keys they are waiting for. */
8899 listAddNodeTail(c
->io_keys
,key
);
8902 /* Add the client to the swapped keys => clients waiting map. */
8903 de
= dictFind(c
->db
->io_keys
,key
);
8907 /* For every key we take a list of clients blocked for it */
8909 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8911 assert(retval
== DICT_OK
);
8913 l
= dictGetEntryVal(de
);
8915 listAddNodeTail(l
,c
);
8917 /* Are we already loading the key from disk? If not create a job */
8918 if (o
->storage
== REDIS_VM_SWAPPED
) {
8921 o
->storage
= REDIS_VM_LOADING
;
8922 j
= zmalloc(sizeof(*j
));
8923 j
->type
= REDIS_IOJOB_LOAD
;
8925 j
->key
= dupStringObject(key
);
8926 j
->key
->vtype
= o
->vtype
;
8927 j
->page
= o
->vm
.page
;
8930 j
->thread
= (pthread_t
) -1;
8938 /* Preload keys needed for the ZUNION and ZINTER commands. */
8939 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
8941 num
= atoi(c
->argv
[2]->ptr
);
8942 for (i
= 0; i
< num
; i
++) {
8943 waitForSwappedKey(c
,c
->argv
[3+i
]);
8947 /* Is this client attempting to run a command against swapped keys?
8948 * If so, block it ASAP, load the keys in background, then resume it.
8950 * The important idea about this function is that it can fail! If keys will
8951 * still be swapped when the client is resumed, this key lookups will
8952 * just block loading keys from disk. In practical terms this should only
8953 * happen with SORT BY command or if there is a bug in this function.
8955 * Return 1 if the client is marked as blocked, 0 if the client can
8956 * continue as the keys it is going to access appear to be in memory. */
8957 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8960 if (cmd
->vm_preload_proc
!= NULL
) {
8961 cmd
->vm_preload_proc(c
);
8963 if (cmd
->vm_firstkey
== 0) return 0;
8964 last
= cmd
->vm_lastkey
;
8965 if (last
< 0) last
= c
->argc
+last
;
8966 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8967 waitForSwappedKey(c
,c
->argv
[j
]);
8970 /* If the client was blocked for at least one key, mark it as blocked. */
8971 if (listLength(c
->io_keys
)) {
8972 c
->flags
|= REDIS_IO_WAIT
;
8973 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8974 server
.vm_blocked_clients
++;
8981 /* Remove the 'key' from the list of blocked keys for a given client.
8983 * The function returns 1 when there are no longer blocking keys after
8984 * the current one was removed (and the client can be unblocked). */
8985 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8989 struct dictEntry
*de
;
8991 /* Remove the key from the list of keys this client is waiting for. */
8992 listRewind(c
->io_keys
,&li
);
8993 while ((ln
= listNext(&li
)) != NULL
) {
8994 if (compareStringObjects(ln
->value
,key
) == 0) {
8995 listDelNode(c
->io_keys
,ln
);
9001 /* Remove the client form the key => waiting clients map. */
9002 de
= dictFind(c
->db
->io_keys
,key
);
9004 l
= dictGetEntryVal(de
);
9005 ln
= listSearchKey(l
,c
);
9008 if (listLength(l
) == 0)
9009 dictDelete(c
->db
->io_keys
,key
);
9011 return listLength(c
->io_keys
) == 0;
9014 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9015 struct dictEntry
*de
;
9020 de
= dictFind(db
->io_keys
,key
);
9023 l
= dictGetEntryVal(de
);
9024 len
= listLength(l
);
9025 /* Note: we can't use something like while(listLength(l)) as the list
9026 * can be freed by the calling function when we remove the last element. */
9029 redisClient
*c
= ln
->value
;
9031 if (dontWaitForSwappedKey(c
,key
)) {
9032 /* Put the client in the list of clients ready to go as we
9033 * loaded all the keys about it. */
9034 listAddNodeTail(server
.io_ready_clients
,c
);
9039 /* ================================= Debugging ============================== */
9041 static void debugCommand(redisClient
*c
) {
9042 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9044 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9045 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9046 addReply(c
,shared
.err
);
9050 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9051 addReply(c
,shared
.err
);
9054 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9055 addReply(c
,shared
.ok
);
9056 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9058 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9059 addReply(c
,shared
.err
);
9062 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9063 addReply(c
,shared
.ok
);
9064 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9065 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9069 addReply(c
,shared
.nokeyerr
);
9072 key
= dictGetEntryKey(de
);
9073 val
= dictGetEntryVal(de
);
9074 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9075 key
->storage
== REDIS_VM_SWAPPING
)) {
9079 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9080 strenc
= strencoding
[val
->encoding
];
9082 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9085 addReplySds(c
,sdscatprintf(sdsempty(),
9086 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9087 "encoding:%s serializedlength:%lld\r\n",
9088 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9089 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9091 addReplySds(c
,sdscatprintf(sdsempty(),
9092 "+Key at:%p refcount:%d, value swapped at: page %llu "
9093 "using %llu pages\r\n",
9094 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9095 (unsigned long long) key
->vm
.usedpages
));
9097 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9098 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9101 if (!server
.vm_enabled
) {
9102 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9106 addReply(c
,shared
.nokeyerr
);
9109 key
= dictGetEntryKey(de
);
9110 val
= dictGetEntryVal(de
);
9111 /* If the key is shared we want to create a copy */
9112 if (key
->refcount
> 1) {
9113 robj
*newkey
= dupStringObject(key
);
9115 key
= dictGetEntryKey(de
) = newkey
;
9118 if (key
->storage
!= REDIS_VM_MEMORY
) {
9119 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9120 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9121 dictGetEntryVal(de
) = NULL
;
9122 addReply(c
,shared
.ok
);
9124 addReply(c
,shared
.err
);
9127 addReplySds(c
,sdsnew(
9128 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9132 static void _redisAssert(char *estr
, char *file
, int line
) {
9133 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9134 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9135 #ifdef HAVE_BACKTRACE
9136 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9141 /* =================================== Main! ================================ */
9144 int linuxOvercommitMemoryValue(void) {
9145 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9149 if (fgets(buf
,64,fp
) == NULL
) {
9158 void linuxOvercommitMemoryWarning(void) {
9159 if (linuxOvercommitMemoryValue() == 0) {
9160 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.");
9163 #endif /* __linux__ */
9165 static void daemonize(void) {
9169 if (fork() != 0) exit(0); /* parent exits */
9170 setsid(); /* create a new session */
9172 /* Every output goes to /dev/null. If Redis is daemonized but
9173 * the 'logfile' is set to 'stdout' in the configuration file
9174 * it will not log at all. */
9175 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9176 dup2(fd
, STDIN_FILENO
);
9177 dup2(fd
, STDOUT_FILENO
);
9178 dup2(fd
, STDERR_FILENO
);
9179 if (fd
> STDERR_FILENO
) close(fd
);
9181 /* Try to write the pid file */
9182 fp
= fopen(server
.pidfile
,"w");
9184 fprintf(fp
,"%d\n",getpid());
9189 static void version() {
9190 printf("Redis server version %s\n", REDIS_VERSION
);
9194 static void usage() {
9195 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9199 int main(int argc
, char **argv
) {
9204 if (strcmp(argv
[1], "-v") == 0 ||
9205 strcmp(argv
[1], "--version") == 0) version();
9206 if (strcmp(argv
[1], "--help") == 0) usage();
9207 resetServerSaveParams();
9208 loadServerConfig(argv
[1]);
9209 } else if ((argc
> 2)) {
9212 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'");
9214 if (server
.daemonize
) daemonize();
9216 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9218 linuxOvercommitMemoryWarning();
9221 if (server
.appendonly
) {
9222 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9223 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9225 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9226 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9228 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9229 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9231 aeDeleteEventLoop(server
.el
);
9235 /* ============================= Backtrace support ========================= */
9237 #ifdef HAVE_BACKTRACE
9238 static char *findFuncName(void *pointer
, unsigned long *offset
);
9240 static void *getMcontextEip(ucontext_t
*uc
) {
9241 #if defined(__FreeBSD__)
9242 return (void*) uc
->uc_mcontext
.mc_eip
;
9243 #elif defined(__dietlibc__)
9244 return (void*) uc
->uc_mcontext
.eip
;
9245 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9247 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9249 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9251 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9252 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9253 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9255 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9257 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9258 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9259 #elif defined(__ia64__) /* Linux IA64 */
9260 return (void*) uc
->uc_mcontext
.sc_ip
;
9266 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9268 char **messages
= NULL
;
9269 int i
, trace_size
= 0;
9270 unsigned long offset
=0;
9271 ucontext_t
*uc
= (ucontext_t
*) secret
;
9273 REDIS_NOTUSED(info
);
9275 redisLog(REDIS_WARNING
,
9276 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9277 infostring
= genRedisInfoString();
9278 redisLog(REDIS_WARNING
, "%s",infostring
);
9279 /* It's not safe to sdsfree() the returned string under memory
9280 * corruption conditions. Let it leak as we are going to abort */
9282 trace_size
= backtrace(trace
, 100);
9283 /* overwrite sigaction with caller's address */
9284 if (getMcontextEip(uc
) != NULL
) {
9285 trace
[1] = getMcontextEip(uc
);
9287 messages
= backtrace_symbols(trace
, trace_size
);
9289 for (i
=1; i
<trace_size
; ++i
) {
9290 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9292 p
= strchr(messages
[i
],'+');
9293 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9294 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9296 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9299 /* free(messages); Don't call free() with possibly corrupted memory. */
9303 static void setupSigSegvAction(void) {
9304 struct sigaction act
;
9306 sigemptyset (&act
.sa_mask
);
9307 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9308 * is used. Otherwise, sa_handler is used */
9309 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9310 act
.sa_sigaction
= segvHandler
;
9311 sigaction (SIGSEGV
, &act
, NULL
);
9312 sigaction (SIGBUS
, &act
, NULL
);
9313 sigaction (SIGFPE
, &act
, NULL
);
9314 sigaction (SIGILL
, &act
, NULL
);
9315 sigaction (SIGBUS
, &act
, NULL
);
9319 #include "staticsymbols.h"
9320 /* This function try to convert a pointer into a function name. It's used in
9321 * oreder to provide a backtrace under segmentation fault that's able to
9322 * display functions declared as static (otherwise the backtrace is useless). */
9323 static char *findFuncName(void *pointer
, unsigned long *offset
){
9325 unsigned long off
, minoff
= 0;
9327 /* Try to match against the Symbol with the smallest offset */
9328 for (i
=0; symsTable
[i
].pointer
; i
++) {
9329 unsigned long lp
= (unsigned long) pointer
;
9331 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9332 off
=lp
-symsTable
[i
].pointer
;
9333 if (ret
< 0 || off
< minoff
) {
9339 if (ret
== -1) return NULL
;
9341 return symsTable
[ret
].name
;
9343 #else /* HAVE_BACKTRACE */
9344 static void setupSigSegvAction(void) {
9346 #endif /* HAVE_BACKTRACE */