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.6"
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}
802 /*============================ Utility functions ============================ */
804 /* Glob-style pattern matching. */
805 int stringmatchlen(const char *pattern
, int patternLen
,
806 const char *string
, int stringLen
, int nocase
)
811 while (pattern
[1] == '*') {
816 return 1; /* match */
818 if (stringmatchlen(pattern
+1, patternLen
-1,
819 string
, stringLen
, nocase
))
820 return 1; /* match */
824 return 0; /* no match */
828 return 0; /* no match */
838 not = pattern
[0] == '^';
845 if (pattern
[0] == '\\') {
848 if (pattern
[0] == string
[0])
850 } else if (pattern
[0] == ']') {
852 } else if (patternLen
== 0) {
856 } else if (pattern
[1] == '-' && patternLen
>= 3) {
857 int start
= pattern
[0];
858 int end
= pattern
[2];
866 start
= tolower(start
);
872 if (c
>= start
&& c
<= end
)
876 if (pattern
[0] == string
[0])
879 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
889 return 0; /* no match */
895 if (patternLen
>= 2) {
902 if (pattern
[0] != string
[0])
903 return 0; /* no match */
905 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
906 return 0; /* no match */
914 if (stringLen
== 0) {
915 while(*pattern
== '*') {
922 if (patternLen
== 0 && stringLen
== 0)
927 static void redisLog(int level
, const char *fmt
, ...) {
931 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
935 if (level
>= server
.verbosity
) {
941 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
942 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
943 vfprintf(fp
, fmt
, ap
);
949 if (server
.logfile
) fclose(fp
);
952 /*====================== Hash table type implementation ==================== */
954 /* This is an hash table type that uses the SDS dynamic strings libary as
955 * keys and radis objects as values (objects can hold SDS strings,
958 static void dictVanillaFree(void *privdata
, void *val
)
960 DICT_NOTUSED(privdata
);
964 static void dictListDestructor(void *privdata
, void *val
)
966 DICT_NOTUSED(privdata
);
967 listRelease((list
*)val
);
970 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
974 DICT_NOTUSED(privdata
);
976 l1
= sdslen((sds
)key1
);
977 l2
= sdslen((sds
)key2
);
978 if (l1
!= l2
) return 0;
979 return memcmp(key1
, key2
, l1
) == 0;
982 static void dictRedisObjectDestructor(void *privdata
, void *val
)
984 DICT_NOTUSED(privdata
);
986 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
990 static int dictObjKeyCompare(void *privdata
, const void *key1
,
993 const robj
*o1
= key1
, *o2
= key2
;
994 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
997 static unsigned int dictObjHash(const void *key
) {
999 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1002 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1005 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1008 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1009 o2
->encoding
== REDIS_ENCODING_INT
&&
1010 o1
->ptr
== o2
->ptr
) return 1;
1012 o1
= getDecodedObject(o1
);
1013 o2
= getDecodedObject(o2
);
1014 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1020 static unsigned int dictEncObjHash(const void *key
) {
1021 robj
*o
= (robj
*) key
;
1023 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1024 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1026 if (o
->encoding
== REDIS_ENCODING_INT
) {
1030 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1031 return dictGenHashFunction((unsigned char*)buf
, len
);
1035 o
= getDecodedObject(o
);
1036 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1043 /* Sets type and expires */
1044 static dictType setDictType
= {
1045 dictEncObjHash
, /* hash function */
1048 dictEncObjKeyCompare
, /* key compare */
1049 dictRedisObjectDestructor
, /* key destructor */
1050 NULL
/* val destructor */
1053 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1054 static dictType zsetDictType
= {
1055 dictEncObjHash
, /* hash function */
1058 dictEncObjKeyCompare
, /* key compare */
1059 dictRedisObjectDestructor
, /* key destructor */
1060 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1064 static dictType dbDictType
= {
1065 dictObjHash
, /* hash function */
1068 dictObjKeyCompare
, /* key compare */
1069 dictRedisObjectDestructor
, /* key destructor */
1070 dictRedisObjectDestructor
/* val destructor */
1074 static dictType keyptrDictType
= {
1075 dictObjHash
, /* hash function */
1078 dictObjKeyCompare
, /* key compare */
1079 dictRedisObjectDestructor
, /* key destructor */
1080 NULL
/* val destructor */
1083 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1084 static dictType hashDictType
= {
1085 dictEncObjHash
, /* hash function */
1088 dictEncObjKeyCompare
, /* key compare */
1089 dictRedisObjectDestructor
, /* key destructor */
1090 dictRedisObjectDestructor
/* val destructor */
1093 /* Keylist hash table type has unencoded redis objects as keys and
1094 * lists as values. It's used for blocking operations (BLPOP) and to
1095 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1096 static dictType keylistDictType
= {
1097 dictObjHash
, /* hash function */
1100 dictObjKeyCompare
, /* key compare */
1101 dictRedisObjectDestructor
, /* key destructor */
1102 dictListDestructor
/* val destructor */
1105 /* ========================= Random utility functions ======================= */
1107 /* Redis generally does not try to recover from out of memory conditions
1108 * when allocating objects or strings, it is not clear if it will be possible
1109 * to report this condition to the client since the networking layer itself
1110 * is based on heap allocation for send buffers, so we simply abort.
1111 * At least the code will be simpler to read... */
1112 static void oom(const char *msg
) {
1113 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1118 /* ====================== Redis server networking stuff ===================== */
1119 static void closeTimedoutClients(void) {
1122 time_t now
= time(NULL
);
1125 listRewind(server
.clients
,&li
);
1126 while ((ln
= listNext(&li
)) != NULL
) {
1127 c
= listNodeValue(ln
);
1128 if (server
.maxidletime
&&
1129 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1130 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1131 (now
- c
->lastinteraction
> server
.maxidletime
))
1133 redisLog(REDIS_VERBOSE
,"Closing idle client");
1135 } else if (c
->flags
& REDIS_BLOCKED
) {
1136 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1137 addReply(c
,shared
.nullmultibulk
);
1138 unblockClientWaitingData(c
);
1144 static int htNeedsResize(dict
*dict
) {
1145 long long size
, used
;
1147 size
= dictSlots(dict
);
1148 used
= dictSize(dict
);
1149 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1150 (used
*100/size
< REDIS_HT_MINFILL
));
1153 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1154 * we resize the hash table to save memory */
1155 static void tryResizeHashTables(void) {
1158 for (j
= 0; j
< server
.dbnum
; j
++) {
1159 if (htNeedsResize(server
.db
[j
].dict
)) {
1160 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1161 dictResize(server
.db
[j
].dict
);
1162 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1164 if (htNeedsResize(server
.db
[j
].expires
))
1165 dictResize(server
.db
[j
].expires
);
1169 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1170 void backgroundSaveDoneHandler(int statloc
) {
1171 int exitcode
= WEXITSTATUS(statloc
);
1172 int bysignal
= WIFSIGNALED(statloc
);
1174 if (!bysignal
&& exitcode
== 0) {
1175 redisLog(REDIS_NOTICE
,
1176 "Background saving terminated with success");
1178 server
.lastsave
= time(NULL
);
1179 } else if (!bysignal
&& exitcode
!= 0) {
1180 redisLog(REDIS_WARNING
, "Background saving error");
1182 redisLog(REDIS_WARNING
,
1183 "Background saving terminated by signal");
1184 rdbRemoveTempFile(server
.bgsavechildpid
);
1186 server
.bgsavechildpid
= -1;
1187 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1188 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1189 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1192 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1194 void backgroundRewriteDoneHandler(int statloc
) {
1195 int exitcode
= WEXITSTATUS(statloc
);
1196 int bysignal
= WIFSIGNALED(statloc
);
1198 if (!bysignal
&& exitcode
== 0) {
1202 redisLog(REDIS_NOTICE
,
1203 "Background append only file rewriting terminated with success");
1204 /* Now it's time to flush the differences accumulated by the parent */
1205 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1206 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1208 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1211 /* Flush our data... */
1212 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1213 (signed) sdslen(server
.bgrewritebuf
)) {
1214 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
));
1218 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1219 /* Now our work is to rename the temp file into the stable file. And
1220 * switch the file descriptor used by the server for append only. */
1221 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1222 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1226 /* Mission completed... almost */
1227 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1228 if (server
.appendfd
!= -1) {
1229 /* If append only is actually enabled... */
1230 close(server
.appendfd
);
1231 server
.appendfd
= fd
;
1233 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1234 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1236 /* If append only is disabled we just generate a dump in this
1237 * format. Why not? */
1240 } else if (!bysignal
&& exitcode
!= 0) {
1241 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1243 redisLog(REDIS_WARNING
,
1244 "Background append only file rewriting terminated by signal");
1247 sdsfree(server
.bgrewritebuf
);
1248 server
.bgrewritebuf
= sdsempty();
1249 aofRemoveTempFile(server
.bgrewritechildpid
);
1250 server
.bgrewritechildpid
= -1;
1253 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1254 int j
, loops
= server
.cronloops
++;
1255 REDIS_NOTUSED(eventLoop
);
1257 REDIS_NOTUSED(clientData
);
1259 /* We take a cached value of the unix time in the global state because
1260 * with virtual memory and aging there is to store the current time
1261 * in objects at every object access, and accuracy is not needed.
1262 * To access a global var is faster than calling time(NULL) */
1263 server
.unixtime
= time(NULL
);
1265 /* Show some info about non-empty databases */
1266 for (j
= 0; j
< server
.dbnum
; j
++) {
1267 long long size
, used
, vkeys
;
1269 size
= dictSlots(server
.db
[j
].dict
);
1270 used
= dictSize(server
.db
[j
].dict
);
1271 vkeys
= dictSize(server
.db
[j
].expires
);
1272 if (!(loops
% 5) && (used
|| vkeys
)) {
1273 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1274 /* dictPrintStats(server.dict); */
1278 /* We don't want to resize the hash tables while a bacground saving
1279 * is in progress: the saving child is created using fork() that is
1280 * implemented with a copy-on-write semantic in most modern systems, so
1281 * if we resize the HT while there is the saving child at work actually
1282 * a lot of memory movements in the parent will cause a lot of pages
1284 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1286 /* Show information about connected clients */
1288 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1289 listLength(server
.clients
)-listLength(server
.slaves
),
1290 listLength(server
.slaves
),
1291 zmalloc_used_memory(),
1292 dictSize(server
.sharingpool
));
1295 /* Close connections of timedout clients */
1296 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1297 closeTimedoutClients();
1299 /* Check if a background saving or AOF rewrite in progress terminated */
1300 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1304 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1305 if (pid
== server
.bgsavechildpid
) {
1306 backgroundSaveDoneHandler(statloc
);
1308 backgroundRewriteDoneHandler(statloc
);
1312 /* If there is not a background saving in progress check if
1313 * we have to save now */
1314 time_t now
= time(NULL
);
1315 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1316 struct saveparam
*sp
= server
.saveparams
+j
;
1318 if (server
.dirty
>= sp
->changes
&&
1319 now
-server
.lastsave
> sp
->seconds
) {
1320 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1321 sp
->changes
, sp
->seconds
);
1322 rdbSaveBackground(server
.dbfilename
);
1328 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1329 * will use few CPU cycles if there are few expiring keys, otherwise
1330 * it will get more aggressive to avoid that too much memory is used by
1331 * keys that can be removed from the keyspace. */
1332 for (j
= 0; j
< server
.dbnum
; j
++) {
1334 redisDb
*db
= server
.db
+j
;
1336 /* Continue to expire if at the end of the cycle more than 25%
1337 * of the keys were expired. */
1339 long num
= dictSize(db
->expires
);
1340 time_t now
= time(NULL
);
1343 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1344 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1349 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1350 t
= (time_t) dictGetEntryVal(de
);
1352 deleteKey(db
,dictGetEntryKey(de
));
1356 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1359 /* Swap a few keys on disk if we are over the memory limit and VM
1360 * is enbled. Try to free objects from the free list first. */
1361 if (vmCanSwapOut()) {
1362 while (server
.vm_enabled
&& zmalloc_used_memory() >
1363 server
.vm_max_memory
)
1367 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1368 retval
= (server
.vm_max_threads
== 0) ?
1369 vmSwapOneObjectBlocking() :
1370 vmSwapOneObjectThreaded();
1371 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1372 zmalloc_used_memory() >
1373 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1375 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1377 /* Note that when using threade I/O we free just one object,
1378 * because anyway when the I/O thread in charge to swap this
1379 * object out will finish, the handler of completed jobs
1380 * will try to swap more objects if we are still out of memory. */
1381 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1385 /* Check if we should connect to a MASTER */
1386 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1387 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1388 if (syncWithMaster() == REDIS_OK
) {
1389 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1395 /* This function gets called every time Redis is entering the
1396 * main loop of the event driven library, that is, before to sleep
1397 * for ready file descriptors. */
1398 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1399 REDIS_NOTUSED(eventLoop
);
1401 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1405 listRewind(server
.io_ready_clients
,&li
);
1406 while((ln
= listNext(&li
))) {
1407 redisClient
*c
= ln
->value
;
1408 struct redisCommand
*cmd
;
1410 /* Resume the client. */
1411 listDelNode(server
.io_ready_clients
,ln
);
1412 c
->flags
&= (~REDIS_IO_WAIT
);
1413 server
.vm_blocked_clients
--;
1414 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1415 readQueryFromClient
, c
);
1416 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1417 assert(cmd
!= NULL
);
1420 /* There may be more data to process in the input buffer. */
1421 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1422 processInputBuffer(c
);
1427 static void createSharedObjects(void) {
1428 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1429 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1430 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1431 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1432 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1433 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1434 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1435 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1436 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1437 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1438 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1439 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1440 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1441 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1442 "-ERR no such key\r\n"));
1443 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1444 "-ERR syntax error\r\n"));
1445 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1446 "-ERR source and destination objects are the same\r\n"));
1447 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1448 "-ERR index out of range\r\n"));
1449 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1450 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1451 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1452 shared
.select0
= createStringObject("select 0\r\n",10);
1453 shared
.select1
= createStringObject("select 1\r\n",10);
1454 shared
.select2
= createStringObject("select 2\r\n",10);
1455 shared
.select3
= createStringObject("select 3\r\n",10);
1456 shared
.select4
= createStringObject("select 4\r\n",10);
1457 shared
.select5
= createStringObject("select 5\r\n",10);
1458 shared
.select6
= createStringObject("select 6\r\n",10);
1459 shared
.select7
= createStringObject("select 7\r\n",10);
1460 shared
.select8
= createStringObject("select 8\r\n",10);
1461 shared
.select9
= createStringObject("select 9\r\n",10);
1464 static void appendServerSaveParams(time_t seconds
, int changes
) {
1465 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1466 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1467 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1468 server
.saveparamslen
++;
1471 static void resetServerSaveParams() {
1472 zfree(server
.saveparams
);
1473 server
.saveparams
= NULL
;
1474 server
.saveparamslen
= 0;
1477 static void initServerConfig() {
1478 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1479 server
.port
= REDIS_SERVERPORT
;
1480 server
.verbosity
= REDIS_VERBOSE
;
1481 server
.maxidletime
= REDIS_MAXIDLETIME
;
1482 server
.saveparams
= NULL
;
1483 server
.logfile
= NULL
; /* NULL = log on standard output */
1484 server
.bindaddr
= NULL
;
1485 server
.glueoutputbuf
= 1;
1486 server
.daemonize
= 0;
1487 server
.appendonly
= 0;
1488 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1489 server
.lastfsync
= time(NULL
);
1490 server
.appendfd
= -1;
1491 server
.appendseldb
= -1; /* Make sure the first time will not match */
1492 server
.pidfile
= "/var/run/redis.pid";
1493 server
.dbfilename
= "dump.rdb";
1494 server
.appendfilename
= "appendonly.aof";
1495 server
.requirepass
= NULL
;
1496 server
.shareobjects
= 0;
1497 server
.rdbcompression
= 1;
1498 server
.sharingpoolsize
= 1024;
1499 server
.maxclients
= 0;
1500 server
.blpop_blocked_clients
= 0;
1501 server
.maxmemory
= 0;
1502 server
.vm_enabled
= 0;
1503 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1504 server
.vm_page_size
= 256; /* 256 bytes per page */
1505 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1506 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1507 server
.vm_max_threads
= 4;
1508 server
.vm_blocked_clients
= 0;
1509 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1510 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1512 resetServerSaveParams();
1514 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1515 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1516 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1517 /* Replication related */
1519 server
.masterauth
= NULL
;
1520 server
.masterhost
= NULL
;
1521 server
.masterport
= 6379;
1522 server
.master
= NULL
;
1523 server
.replstate
= REDIS_REPL_NONE
;
1525 /* Double constants initialization */
1527 R_PosInf
= 1.0/R_Zero
;
1528 R_NegInf
= -1.0/R_Zero
;
1529 R_Nan
= R_Zero
/R_Zero
;
1532 static void initServer() {
1535 signal(SIGHUP
, SIG_IGN
);
1536 signal(SIGPIPE
, SIG_IGN
);
1537 setupSigSegvAction();
1539 server
.devnull
= fopen("/dev/null","w");
1540 if (server
.devnull
== NULL
) {
1541 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1544 server
.clients
= listCreate();
1545 server
.slaves
= listCreate();
1546 server
.monitors
= listCreate();
1547 server
.objfreelist
= listCreate();
1548 createSharedObjects();
1549 server
.el
= aeCreateEventLoop();
1550 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1551 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1552 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1553 if (server
.fd
== -1) {
1554 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1557 for (j
= 0; j
< server
.dbnum
; j
++) {
1558 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1559 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1560 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1561 if (server
.vm_enabled
)
1562 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1563 server
.db
[j
].id
= j
;
1565 server
.cronloops
= 0;
1566 server
.bgsavechildpid
= -1;
1567 server
.bgrewritechildpid
= -1;
1568 server
.bgrewritebuf
= sdsempty();
1569 server
.lastsave
= time(NULL
);
1571 server
.stat_numcommands
= 0;
1572 server
.stat_numconnections
= 0;
1573 server
.stat_starttime
= time(NULL
);
1574 server
.unixtime
= time(NULL
);
1575 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1576 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1577 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1579 if (server
.appendonly
) {
1580 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1581 if (server
.appendfd
== -1) {
1582 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1588 if (server
.vm_enabled
) vmInit();
1591 /* Empty the whole database */
1592 static long long emptyDb() {
1594 long long removed
= 0;
1596 for (j
= 0; j
< server
.dbnum
; j
++) {
1597 removed
+= dictSize(server
.db
[j
].dict
);
1598 dictEmpty(server
.db
[j
].dict
);
1599 dictEmpty(server
.db
[j
].expires
);
1604 static int yesnotoi(char *s
) {
1605 if (!strcasecmp(s
,"yes")) return 1;
1606 else if (!strcasecmp(s
,"no")) return 0;
1610 /* I agree, this is a very rudimental way to load a configuration...
1611 will improve later if the config gets more complex */
1612 static void loadServerConfig(char *filename
) {
1614 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1618 if (filename
[0] == '-' && filename
[1] == '\0')
1621 if ((fp
= fopen(filename
,"r")) == NULL
) {
1622 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1627 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1633 line
= sdstrim(line
," \t\r\n");
1635 /* Skip comments and blank lines*/
1636 if (line
[0] == '#' || line
[0] == '\0') {
1641 /* Split into arguments */
1642 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1643 sdstolower(argv
[0]);
1645 /* Execute config directives */
1646 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1647 server
.maxidletime
= atoi(argv
[1]);
1648 if (server
.maxidletime
< 0) {
1649 err
= "Invalid timeout value"; goto loaderr
;
1651 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1652 server
.port
= atoi(argv
[1]);
1653 if (server
.port
< 1 || server
.port
> 65535) {
1654 err
= "Invalid port"; goto loaderr
;
1656 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1657 server
.bindaddr
= zstrdup(argv
[1]);
1658 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1659 int seconds
= atoi(argv
[1]);
1660 int changes
= atoi(argv
[2]);
1661 if (seconds
< 1 || changes
< 0) {
1662 err
= "Invalid save parameters"; goto loaderr
;
1664 appendServerSaveParams(seconds
,changes
);
1665 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1666 if (chdir(argv
[1]) == -1) {
1667 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1668 argv
[1], strerror(errno
));
1671 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1672 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1673 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1674 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1675 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1677 err
= "Invalid log level. Must be one of debug, notice, warning";
1680 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1683 server
.logfile
= zstrdup(argv
[1]);
1684 if (!strcasecmp(server
.logfile
,"stdout")) {
1685 zfree(server
.logfile
);
1686 server
.logfile
= NULL
;
1688 if (server
.logfile
) {
1689 /* Test if we are able to open the file. The server will not
1690 * be able to abort just for this problem later... */
1691 logfp
= fopen(server
.logfile
,"a");
1692 if (logfp
== NULL
) {
1693 err
= sdscatprintf(sdsempty(),
1694 "Can't open the log file: %s", strerror(errno
));
1699 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1700 server
.dbnum
= atoi(argv
[1]);
1701 if (server
.dbnum
< 1) {
1702 err
= "Invalid number of databases"; goto loaderr
;
1704 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1705 server
.maxclients
= atoi(argv
[1]);
1706 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1707 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1708 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1709 server
.masterhost
= sdsnew(argv
[1]);
1710 server
.masterport
= atoi(argv
[2]);
1711 server
.replstate
= REDIS_REPL_CONNECT
;
1712 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1713 server
.masterauth
= zstrdup(argv
[1]);
1714 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1715 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1716 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1718 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1719 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1720 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1722 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1723 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1724 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1726 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1727 server
.sharingpoolsize
= atoi(argv
[1]);
1728 if (server
.sharingpoolsize
< 1) {
1729 err
= "invalid object sharing pool size"; goto loaderr
;
1731 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1732 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1733 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1735 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1736 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1737 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1739 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1740 if (!strcasecmp(argv
[1],"no")) {
1741 server
.appendfsync
= APPENDFSYNC_NO
;
1742 } else if (!strcasecmp(argv
[1],"always")) {
1743 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1744 } else if (!strcasecmp(argv
[1],"everysec")) {
1745 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1747 err
= "argument must be 'no', 'always' or 'everysec'";
1750 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1751 server
.requirepass
= zstrdup(argv
[1]);
1752 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1753 server
.pidfile
= zstrdup(argv
[1]);
1754 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1755 server
.dbfilename
= zstrdup(argv
[1]);
1756 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1757 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1758 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1760 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1761 zfree(server
.vm_swap_file
);
1762 server
.vm_swap_file
= zstrdup(argv
[1]);
1763 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1764 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1765 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1766 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1767 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1768 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1769 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1770 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1771 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1772 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1773 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1774 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1775 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1776 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1778 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1780 for (j
= 0; j
< argc
; j
++)
1785 if (fp
!= stdin
) fclose(fp
);
1789 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1790 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1791 fprintf(stderr
, ">>> '%s'\n", line
);
1792 fprintf(stderr
, "%s\n", err
);
1796 static void freeClientArgv(redisClient
*c
) {
1799 for (j
= 0; j
< c
->argc
; j
++)
1800 decrRefCount(c
->argv
[j
]);
1801 for (j
= 0; j
< c
->mbargc
; j
++)
1802 decrRefCount(c
->mbargv
[j
]);
1807 static void freeClient(redisClient
*c
) {
1810 /* Note that if the client we are freeing is blocked into a blocking
1811 * call, we have to set querybuf to NULL *before* to call
1812 * unblockClientWaitingData() to avoid processInputBuffer() will get
1813 * called. Also it is important to remove the file events after
1814 * this, because this call adds the READABLE event. */
1815 sdsfree(c
->querybuf
);
1817 if (c
->flags
& REDIS_BLOCKED
)
1818 unblockClientWaitingData(c
);
1820 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1821 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1822 listRelease(c
->reply
);
1825 /* Remove from the list of clients */
1826 ln
= listSearchKey(server
.clients
,c
);
1827 redisAssert(ln
!= NULL
);
1828 listDelNode(server
.clients
,ln
);
1829 /* Remove from the list of clients waiting for swapped keys */
1830 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1831 ln
= listSearchKey(server
.io_ready_clients
,c
);
1833 listDelNode(server
.io_ready_clients
,ln
);
1834 server
.vm_blocked_clients
--;
1837 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1838 ln
= listFirst(c
->io_keys
);
1839 dontWaitForSwappedKey(c
,ln
->value
);
1841 listRelease(c
->io_keys
);
1843 if (c
->flags
& REDIS_SLAVE
) {
1844 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1846 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1847 ln
= listSearchKey(l
,c
);
1848 redisAssert(ln
!= NULL
);
1851 if (c
->flags
& REDIS_MASTER
) {
1852 server
.master
= NULL
;
1853 server
.replstate
= REDIS_REPL_CONNECT
;
1857 freeClientMultiState(c
);
1861 #define GLUEREPLY_UP_TO (1024)
1862 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1864 char buf
[GLUEREPLY_UP_TO
];
1869 listRewind(c
->reply
,&li
);
1870 while((ln
= listNext(&li
))) {
1874 objlen
= sdslen(o
->ptr
);
1875 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1876 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1878 listDelNode(c
->reply
,ln
);
1880 if (copylen
== 0) return;
1884 /* Now the output buffer is empty, add the new single element */
1885 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1886 listAddNodeHead(c
->reply
,o
);
1889 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1890 redisClient
*c
= privdata
;
1891 int nwritten
= 0, totwritten
= 0, objlen
;
1894 REDIS_NOTUSED(mask
);
1896 /* Use writev() if we have enough buffers to send */
1897 if (!server
.glueoutputbuf
&&
1898 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1899 !(c
->flags
& REDIS_MASTER
))
1901 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1905 while(listLength(c
->reply
)) {
1906 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1907 glueReplyBuffersIfNeeded(c
);
1909 o
= listNodeValue(listFirst(c
->reply
));
1910 objlen
= sdslen(o
->ptr
);
1913 listDelNode(c
->reply
,listFirst(c
->reply
));
1917 if (c
->flags
& REDIS_MASTER
) {
1918 /* Don't reply to a master */
1919 nwritten
= objlen
- c
->sentlen
;
1921 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1922 if (nwritten
<= 0) break;
1924 c
->sentlen
+= nwritten
;
1925 totwritten
+= nwritten
;
1926 /* If we fully sent the object on head go to the next one */
1927 if (c
->sentlen
== objlen
) {
1928 listDelNode(c
->reply
,listFirst(c
->reply
));
1931 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1932 * bytes, in a single threaded server it's a good idea to serve
1933 * other clients as well, even if a very large request comes from
1934 * super fast link that is always able to accept data (in real world
1935 * scenario think about 'KEYS *' against the loopback interfae) */
1936 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1938 if (nwritten
== -1) {
1939 if (errno
== EAGAIN
) {
1942 redisLog(REDIS_VERBOSE
,
1943 "Error writing to client: %s", strerror(errno
));
1948 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1949 if (listLength(c
->reply
) == 0) {
1951 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1955 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1957 redisClient
*c
= privdata
;
1958 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1960 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1961 int offset
, ion
= 0;
1963 REDIS_NOTUSED(mask
);
1966 while (listLength(c
->reply
)) {
1967 offset
= c
->sentlen
;
1971 /* fill-in the iov[] array */
1972 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1973 o
= listNodeValue(node
);
1974 objlen
= sdslen(o
->ptr
);
1976 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1979 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1980 break; /* no more iovecs */
1982 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1983 iov
[ion
].iov_len
= objlen
- offset
;
1984 willwrite
+= objlen
- offset
;
1985 offset
= 0; /* just for the first item */
1992 /* write all collected blocks at once */
1993 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1994 if (errno
!= EAGAIN
) {
1995 redisLog(REDIS_VERBOSE
,
1996 "Error writing to client: %s", strerror(errno
));
2003 totwritten
+= nwritten
;
2004 offset
= c
->sentlen
;
2006 /* remove written robjs from c->reply */
2007 while (nwritten
&& listLength(c
->reply
)) {
2008 o
= listNodeValue(listFirst(c
->reply
));
2009 objlen
= sdslen(o
->ptr
);
2011 if(nwritten
>= objlen
- offset
) {
2012 listDelNode(c
->reply
, listFirst(c
->reply
));
2013 nwritten
-= objlen
- offset
;
2017 c
->sentlen
+= nwritten
;
2025 c
->lastinteraction
= time(NULL
);
2027 if (listLength(c
->reply
) == 0) {
2029 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2033 static struct redisCommand
*lookupCommand(char *name
) {
2035 while(cmdTable
[j
].name
!= NULL
) {
2036 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2042 /* resetClient prepare the client to process the next command */
2043 static void resetClient(redisClient
*c
) {
2049 /* Call() is the core of Redis execution of a command */
2050 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2053 dirty
= server
.dirty
;
2055 if (server
.appendonly
&& server
.dirty
-dirty
)
2056 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2057 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2058 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2059 if (listLength(server
.monitors
))
2060 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2061 server
.stat_numcommands
++;
2064 /* If this function gets called we already read a whole
2065 * command, argments are in the client argv/argc fields.
2066 * processCommand() execute the command or prepare the
2067 * server for a bulk read from the client.
2069 * If 1 is returned the client is still alive and valid and
2070 * and other operations can be performed by the caller. Otherwise
2071 * if 0 is returned the client was destroied (i.e. after QUIT). */
2072 static int processCommand(redisClient
*c
) {
2073 struct redisCommand
*cmd
;
2075 /* Free some memory if needed (maxmemory setting) */
2076 if (server
.maxmemory
) freeMemoryIfNeeded();
2078 /* Handle the multi bulk command type. This is an alternative protocol
2079 * supported by Redis in order to receive commands that are composed of
2080 * multiple binary-safe "bulk" arguments. The latency of processing is
2081 * a bit higher but this allows things like multi-sets, so if this
2082 * protocol is used only for MSET and similar commands this is a big win. */
2083 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2084 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2085 if (c
->multibulk
<= 0) {
2089 decrRefCount(c
->argv
[c
->argc
-1]);
2093 } else if (c
->multibulk
) {
2094 if (c
->bulklen
== -1) {
2095 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2096 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2100 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2101 decrRefCount(c
->argv
[0]);
2102 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2104 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2109 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2113 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2114 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2118 if (c
->multibulk
== 0) {
2122 /* Here we need to swap the multi-bulk argc/argv with the
2123 * normal argc/argv of the client structure. */
2125 c
->argv
= c
->mbargv
;
2126 c
->mbargv
= auxargv
;
2129 c
->argc
= c
->mbargc
;
2130 c
->mbargc
= auxargc
;
2132 /* We need to set bulklen to something different than -1
2133 * in order for the code below to process the command without
2134 * to try to read the last argument of a bulk command as
2135 * a special argument. */
2137 /* continue below and process the command */
2144 /* -- end of multi bulk commands processing -- */
2146 /* The QUIT command is handled as a special case. Normal command
2147 * procs are unable to close the client connection safely */
2148 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2153 /* Now lookup the command and check ASAP about trivial error conditions
2154 * such wrong arity, bad command name and so forth. */
2155 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2158 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2159 (char*)c
->argv
[0]->ptr
));
2162 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2163 (c
->argc
< -cmd
->arity
)) {
2165 sdscatprintf(sdsempty(),
2166 "-ERR wrong number of arguments for '%s' command\r\n",
2170 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2171 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2174 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2175 /* This is a bulk command, we have to read the last argument yet. */
2176 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2178 decrRefCount(c
->argv
[c
->argc
-1]);
2179 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2181 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2186 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2187 /* It is possible that the bulk read is already in the
2188 * buffer. Check this condition and handle it accordingly.
2189 * This is just a fast path, alternative to call processInputBuffer().
2190 * It's a good idea since the code is small and this condition
2191 * happens most of the times. */
2192 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2193 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2195 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2197 /* Otherwise return... there is to read the last argument
2198 * from the socket. */
2202 /* Let's try to share objects on the command arguments vector */
2203 if (server
.shareobjects
) {
2205 for(j
= 1; j
< c
->argc
; j
++)
2206 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2208 /* Let's try to encode the bulk object to save space. */
2209 if (cmd
->flags
& REDIS_CMD_BULK
)
2210 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2212 /* Check if the user is authenticated */
2213 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2214 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2219 /* Exec the command */
2220 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2221 queueMultiCommand(c
,cmd
);
2222 addReply(c
,shared
.queued
);
2224 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2225 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2229 /* Prepare the client for the next command */
2234 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2239 /* (args*2)+1 is enough room for args, spaces, newlines */
2240 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2242 if (argc
<= REDIS_STATIC_ARGS
) {
2245 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2248 for (j
= 0; j
< argc
; j
++) {
2249 if (j
!= 0) outv
[outc
++] = shared
.space
;
2250 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2253 lenobj
= createObject(REDIS_STRING
,
2254 sdscatprintf(sdsempty(),"%lu\r\n",
2255 (unsigned long) stringObjectLen(argv
[j
])));
2256 lenobj
->refcount
= 0;
2257 outv
[outc
++] = lenobj
;
2259 outv
[outc
++] = argv
[j
];
2261 outv
[outc
++] = shared
.crlf
;
2263 /* Increment all the refcounts at start and decrement at end in order to
2264 * be sure to free objects if there is no slave in a replication state
2265 * able to be feed with commands */
2266 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2267 listRewind(slaves
,&li
);
2268 while((ln
= listNext(&li
))) {
2269 redisClient
*slave
= ln
->value
;
2271 /* Don't feed slaves that are still waiting for BGSAVE to start */
2272 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2274 /* Feed all the other slaves, MONITORs and so on */
2275 if (slave
->slaveseldb
!= dictid
) {
2279 case 0: selectcmd
= shared
.select0
; break;
2280 case 1: selectcmd
= shared
.select1
; break;
2281 case 2: selectcmd
= shared
.select2
; break;
2282 case 3: selectcmd
= shared
.select3
; break;
2283 case 4: selectcmd
= shared
.select4
; break;
2284 case 5: selectcmd
= shared
.select5
; break;
2285 case 6: selectcmd
= shared
.select6
; break;
2286 case 7: selectcmd
= shared
.select7
; break;
2287 case 8: selectcmd
= shared
.select8
; break;
2288 case 9: selectcmd
= shared
.select9
; break;
2290 selectcmd
= createObject(REDIS_STRING
,
2291 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2292 selectcmd
->refcount
= 0;
2295 addReply(slave
,selectcmd
);
2296 slave
->slaveseldb
= dictid
;
2298 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2300 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2301 if (outv
!= static_outv
) zfree(outv
);
2304 static void processInputBuffer(redisClient
*c
) {
2306 /* Before to process the input buffer, make sure the client is not
2307 * waitig for a blocking operation such as BLPOP. Note that the first
2308 * iteration the client is never blocked, otherwise the processInputBuffer
2309 * would not be called at all, but after the execution of the first commands
2310 * in the input buffer the client may be blocked, and the "goto again"
2311 * will try to reiterate. The following line will make it return asap. */
2312 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2313 if (c
->bulklen
== -1) {
2314 /* Read the first line of the query */
2315 char *p
= strchr(c
->querybuf
,'\n');
2322 query
= c
->querybuf
;
2323 c
->querybuf
= sdsempty();
2324 querylen
= 1+(p
-(query
));
2325 if (sdslen(query
) > querylen
) {
2326 /* leave data after the first line of the query in the buffer */
2327 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2329 *p
= '\0'; /* remove "\n" */
2330 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2331 sdsupdatelen(query
);
2333 /* Now we can split the query in arguments */
2334 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2337 if (c
->argv
) zfree(c
->argv
);
2338 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2340 for (j
= 0; j
< argc
; j
++) {
2341 if (sdslen(argv
[j
])) {
2342 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2350 /* Execute the command. If the client is still valid
2351 * after processCommand() return and there is something
2352 * on the query buffer try to process the next command. */
2353 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2355 /* Nothing to process, argc == 0. Just process the query
2356 * buffer if it's not empty or return to the caller */
2357 if (sdslen(c
->querybuf
)) goto again
;
2360 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2361 redisLog(REDIS_VERBOSE
, "Client protocol error");
2366 /* Bulk read handling. Note that if we are at this point
2367 the client already sent a command terminated with a newline,
2368 we are reading the bulk data that is actually the last
2369 argument of the command. */
2370 int qbl
= sdslen(c
->querybuf
);
2372 if (c
->bulklen
<= qbl
) {
2373 /* Copy everything but the final CRLF as final argument */
2374 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2376 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2377 /* Process the command. If the client is still valid after
2378 * the processing and there is more data in the buffer
2379 * try to parse it. */
2380 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2386 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2387 redisClient
*c
= (redisClient
*) privdata
;
2388 char buf
[REDIS_IOBUF_LEN
];
2391 REDIS_NOTUSED(mask
);
2393 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2395 if (errno
== EAGAIN
) {
2398 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2402 } else if (nread
== 0) {
2403 redisLog(REDIS_VERBOSE
, "Client closed connection");
2408 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2409 c
->lastinteraction
= time(NULL
);
2413 if (!(c
->flags
& REDIS_BLOCKED
))
2414 processInputBuffer(c
);
2417 static int selectDb(redisClient
*c
, int id
) {
2418 if (id
< 0 || id
>= server
.dbnum
)
2420 c
->db
= &server
.db
[id
];
2424 static void *dupClientReplyValue(void *o
) {
2425 incrRefCount((robj
*)o
);
2429 static redisClient
*createClient(int fd
) {
2430 redisClient
*c
= zmalloc(sizeof(*c
));
2432 anetNonBlock(NULL
,fd
);
2433 anetTcpNoDelay(NULL
,fd
);
2434 if (!c
) return NULL
;
2437 c
->querybuf
= sdsempty();
2446 c
->lastinteraction
= time(NULL
);
2447 c
->authenticated
= 0;
2448 c
->replstate
= REDIS_REPL_NONE
;
2449 c
->reply
= listCreate();
2450 listSetFreeMethod(c
->reply
,decrRefCount
);
2451 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2452 c
->blockingkeys
= NULL
;
2453 c
->blockingkeysnum
= 0;
2454 c
->io_keys
= listCreate();
2455 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2456 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2457 readQueryFromClient
, c
) == AE_ERR
) {
2461 listAddNodeTail(server
.clients
,c
);
2462 initClientMultiState(c
);
2466 static void addReply(redisClient
*c
, robj
*obj
) {
2467 if (listLength(c
->reply
) == 0 &&
2468 (c
->replstate
== REDIS_REPL_NONE
||
2469 c
->replstate
== REDIS_REPL_ONLINE
) &&
2470 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2471 sendReplyToClient
, c
) == AE_ERR
) return;
2473 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2474 obj
= dupStringObject(obj
);
2475 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2477 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2480 static void addReplySds(redisClient
*c
, sds s
) {
2481 robj
*o
= createObject(REDIS_STRING
,s
);
2486 static void addReplyDouble(redisClient
*c
, double d
) {
2489 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2490 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2491 (unsigned long) strlen(buf
),buf
));
2494 static void addReplyLong(redisClient
*c
, long l
) {
2499 addReply(c
,shared
.czero
);
2501 } else if (l
== 1) {
2502 addReply(c
,shared
.cone
);
2505 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2506 addReplySds(c
,sdsnewlen(buf
,len
));
2509 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2514 addReply(c
,shared
.czero
);
2516 } else if (ul
== 1) {
2517 addReply(c
,shared
.cone
);
2520 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2521 addReplySds(c
,sdsnewlen(buf
,len
));
2524 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2527 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2528 len
= sdslen(obj
->ptr
);
2530 long n
= (long)obj
->ptr
;
2532 /* Compute how many bytes will take this integer as a radix 10 string */
2538 while((n
= n
/10) != 0) {
2542 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2545 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2546 addReplyBulkLen(c
,obj
);
2548 addReply(c
,shared
.crlf
);
2551 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2556 REDIS_NOTUSED(mask
);
2557 REDIS_NOTUSED(privdata
);
2559 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2560 if (cfd
== AE_ERR
) {
2561 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2564 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2565 if ((c
= createClient(cfd
)) == NULL
) {
2566 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2567 close(cfd
); /* May be already closed, just ingore errors */
2570 /* If maxclient directive is set and this is one client more... close the
2571 * connection. Note that we create the client instead to check before
2572 * for this condition, since now the socket is already set in nonblocking
2573 * mode and we can send an error for free using the Kernel I/O */
2574 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2575 char *err
= "-ERR max number of clients reached\r\n";
2577 /* That's a best effort error message, don't check write errors */
2578 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2579 /* Nothing to do, Just to avoid the warning... */
2584 server
.stat_numconnections
++;
2587 /* ======================= Redis objects implementation ===================== */
2589 static robj
*createObject(int type
, void *ptr
) {
2592 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2593 if (listLength(server
.objfreelist
)) {
2594 listNode
*head
= listFirst(server
.objfreelist
);
2595 o
= listNodeValue(head
);
2596 listDelNode(server
.objfreelist
,head
);
2597 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2599 if (server
.vm_enabled
) {
2600 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2601 o
= zmalloc(sizeof(*o
));
2603 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2607 o
->encoding
= REDIS_ENCODING_RAW
;
2610 if (server
.vm_enabled
) {
2611 /* Note that this code may run in the context of an I/O thread
2612 * and accessing to server.unixtime in theory is an error
2613 * (no locks). But in practice this is safe, and even if we read
2614 * garbage Redis will not fail, as it's just a statistical info */
2615 o
->vm
.atime
= server
.unixtime
;
2616 o
->storage
= REDIS_VM_MEMORY
;
2621 static robj
*createStringObject(char *ptr
, size_t len
) {
2622 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2625 static robj
*dupStringObject(robj
*o
) {
2626 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2627 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2630 static robj
*createListObject(void) {
2631 list
*l
= listCreate();
2633 listSetFreeMethod(l
,decrRefCount
);
2634 return createObject(REDIS_LIST
,l
);
2637 static robj
*createSetObject(void) {
2638 dict
*d
= dictCreate(&setDictType
,NULL
);
2639 return createObject(REDIS_SET
,d
);
2642 static robj
*createHashObject(void) {
2643 /* All the Hashes start as zipmaps. Will be automatically converted
2644 * into hash tables if there are enough elements or big elements
2646 unsigned char *zm
= zipmapNew();
2647 robj
*o
= createObject(REDIS_HASH
,zm
);
2648 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2652 static robj
*createZsetObject(void) {
2653 zset
*zs
= zmalloc(sizeof(*zs
));
2655 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2656 zs
->zsl
= zslCreate();
2657 return createObject(REDIS_ZSET
,zs
);
2660 static void freeStringObject(robj
*o
) {
2661 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2666 static void freeListObject(robj
*o
) {
2667 listRelease((list
*) o
->ptr
);
2670 static void freeSetObject(robj
*o
) {
2671 dictRelease((dict
*) o
->ptr
);
2674 static void freeZsetObject(robj
*o
) {
2677 dictRelease(zs
->dict
);
2682 static void freeHashObject(robj
*o
) {
2683 switch (o
->encoding
) {
2684 case REDIS_ENCODING_HT
:
2685 dictRelease((dict
*) o
->ptr
);
2687 case REDIS_ENCODING_ZIPMAP
:
2696 static void incrRefCount(robj
*o
) {
2697 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2701 static void decrRefCount(void *obj
) {
2704 /* Object is a key of a swapped out value, or in the process of being
2706 if (server
.vm_enabled
&&
2707 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2709 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2710 redisAssert(o
->refcount
== 1);
2712 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2713 redisAssert(o
->type
== REDIS_STRING
);
2714 freeStringObject(o
);
2715 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2716 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2717 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2718 !listAddNodeHead(server
.objfreelist
,o
))
2720 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2721 server
.vm_stats_swapped_objects
--;
2724 /* Object is in memory, or in the process of being swapped out. */
2725 if (--(o
->refcount
) == 0) {
2726 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2727 vmCancelThreadedIOJob(obj
);
2729 case REDIS_STRING
: freeStringObject(o
); break;
2730 case REDIS_LIST
: freeListObject(o
); break;
2731 case REDIS_SET
: freeSetObject(o
); break;
2732 case REDIS_ZSET
: freeZsetObject(o
); break;
2733 case REDIS_HASH
: freeHashObject(o
); break;
2734 default: redisAssert(0); break;
2736 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2737 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2738 !listAddNodeHead(server
.objfreelist
,o
))
2740 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2744 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2745 dictEntry
*de
= dictFind(db
->dict
,key
);
2747 robj
*key
= dictGetEntryKey(de
);
2748 robj
*val
= dictGetEntryVal(de
);
2750 if (server
.vm_enabled
) {
2751 if (key
->storage
== REDIS_VM_MEMORY
||
2752 key
->storage
== REDIS_VM_SWAPPING
)
2754 /* If we were swapping the object out, stop it, this key
2756 if (key
->storage
== REDIS_VM_SWAPPING
)
2757 vmCancelThreadedIOJob(key
);
2758 /* Update the access time of the key for the aging algorithm. */
2759 key
->vm
.atime
= server
.unixtime
;
2761 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2763 /* Our value was swapped on disk. Bring it at home. */
2764 redisAssert(val
== NULL
);
2765 val
= vmLoadObject(key
);
2766 dictGetEntryVal(de
) = val
;
2768 /* Clients blocked by the VM subsystem may be waiting for
2770 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2779 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2780 expireIfNeeded(db
,key
);
2781 return lookupKey(db
,key
);
2784 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2785 deleteIfVolatile(db
,key
);
2786 return lookupKey(db
,key
);
2789 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2790 robj
*o
= lookupKeyRead(c
->db
, key
);
2791 if (!o
) addReply(c
,reply
);
2795 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2796 robj
*o
= lookupKeyWrite(c
->db
, key
);
2797 if (!o
) addReply(c
,reply
);
2801 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2802 if (o
->type
!= type
) {
2803 addReply(c
,shared
.wrongtypeerr
);
2809 static int deleteKey(redisDb
*db
, robj
*key
) {
2812 /* We need to protect key from destruction: after the first dictDelete()
2813 * it may happen that 'key' is no longer valid if we don't increment
2814 * it's count. This may happen when we get the object reference directly
2815 * from the hash table with dictRandomKey() or dict iterators */
2817 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2818 retval
= dictDelete(db
->dict
,key
);
2821 return retval
== DICT_OK
;
2824 /* Try to share an object against the shared objects pool */
2825 static robj
*tryObjectSharing(robj
*o
) {
2826 struct dictEntry
*de
;
2829 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2831 redisAssert(o
->type
== REDIS_STRING
);
2832 de
= dictFind(server
.sharingpool
,o
);
2834 robj
*shared
= dictGetEntryKey(de
);
2836 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2837 dictGetEntryVal(de
) = (void*) c
;
2838 incrRefCount(shared
);
2842 /* Here we are using a stream algorihtm: Every time an object is
2843 * shared we increment its count, everytime there is a miss we
2844 * recrement the counter of a random object. If this object reaches
2845 * zero we remove the object and put the current object instead. */
2846 if (dictSize(server
.sharingpool
) >=
2847 server
.sharingpoolsize
) {
2848 de
= dictGetRandomKey(server
.sharingpool
);
2849 redisAssert(de
!= NULL
);
2850 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2851 dictGetEntryVal(de
) = (void*) c
;
2853 dictDelete(server
.sharingpool
,de
->key
);
2856 c
= 0; /* If the pool is empty we want to add this object */
2861 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2862 redisAssert(retval
== DICT_OK
);
2869 /* Check if the nul-terminated string 's' can be represented by a long
2870 * (that is, is a number that fits into long without any other space or
2871 * character before or after the digits).
2873 * If so, the function returns REDIS_OK and *longval is set to the value
2874 * of the number. Otherwise REDIS_ERR is returned */
2875 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2876 char buf
[32], *endptr
;
2880 value
= strtol(s
, &endptr
, 10);
2881 if (endptr
[0] != '\0') return REDIS_ERR
;
2882 slen
= snprintf(buf
,32,"%ld",value
);
2884 /* If the number converted back into a string is not identical
2885 * then it's not possible to encode the string as integer */
2886 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2887 if (longval
) *longval
= value
;
2891 /* Try to encode a string object in order to save space */
2892 static int tryObjectEncoding(robj
*o
) {
2896 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2897 return REDIS_ERR
; /* Already encoded */
2899 /* It's not save to encode shared objects: shared objects can be shared
2900 * everywhere in the "object space" of Redis. Encoded objects can only
2901 * appear as "values" (and not, for instance, as keys) */
2902 if (o
->refcount
> 1) return REDIS_ERR
;
2904 /* Currently we try to encode only strings */
2905 redisAssert(o
->type
== REDIS_STRING
);
2907 /* Check if we can represent this string as a long integer */
2908 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2910 /* Ok, this object can be encoded */
2911 o
->encoding
= REDIS_ENCODING_INT
;
2913 o
->ptr
= (void*) value
;
2917 /* Get a decoded version of an encoded object (returned as a new object).
2918 * If the object is already raw-encoded just increment the ref count. */
2919 static robj
*getDecodedObject(robj
*o
) {
2922 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2926 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2929 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2930 dec
= createStringObject(buf
,strlen(buf
));
2933 redisAssert(1 != 1);
2937 /* Compare two string objects via strcmp() or alike.
2938 * Note that the objects may be integer-encoded. In such a case we
2939 * use snprintf() to get a string representation of the numbers on the stack
2940 * and compare the strings, it's much faster than calling getDecodedObject().
2942 * Important note: if objects are not integer encoded, but binary-safe strings,
2943 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2945 static int compareStringObjects(robj
*a
, robj
*b
) {
2946 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2947 char bufa
[128], bufb
[128], *astr
, *bstr
;
2950 if (a
== b
) return 0;
2951 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2952 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2958 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2959 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2965 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2968 static size_t stringObjectLen(robj
*o
) {
2969 redisAssert(o
->type
== REDIS_STRING
);
2970 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2971 return sdslen(o
->ptr
);
2975 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2979 /*============================ RDB saving/loading =========================== */
2981 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2982 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2986 static int rdbSaveTime(FILE *fp
, time_t t
) {
2987 int32_t t32
= (int32_t) t
;
2988 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2992 /* check rdbLoadLen() comments for more info */
2993 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2994 unsigned char buf
[2];
2997 /* Save a 6 bit len */
2998 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2999 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3000 } else if (len
< (1<<14)) {
3001 /* Save a 14 bit len */
3002 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3004 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3006 /* Save a 32 bit len */
3007 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3008 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3010 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3015 /* String objects in the form "2391" "-100" without any space and with a
3016 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3017 * encoded as integers to save space */
3018 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3020 char *endptr
, buf
[32];
3022 /* Check if it's possible to encode this value as a number */
3023 value
= strtoll(s
, &endptr
, 10);
3024 if (endptr
[0] != '\0') return 0;
3025 snprintf(buf
,32,"%lld",value
);
3027 /* If the number converted back into a string is not identical
3028 * then it's not possible to encode the string as integer */
3029 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3031 /* Finally check if it fits in our ranges */
3032 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3033 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3034 enc
[1] = value
&0xFF;
3036 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3037 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3038 enc
[1] = value
&0xFF;
3039 enc
[2] = (value
>>8)&0xFF;
3041 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3042 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3043 enc
[1] = value
&0xFF;
3044 enc
[2] = (value
>>8)&0xFF;
3045 enc
[3] = (value
>>16)&0xFF;
3046 enc
[4] = (value
>>24)&0xFF;
3053 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3054 size_t comprlen
, outlen
;
3058 /* We require at least four bytes compression for this to be worth it */
3059 if (len
<= 4) return 0;
3061 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3062 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3063 if (comprlen
== 0) {
3067 /* Data compressed! Let's save it on disk */
3068 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3069 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3070 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3071 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3072 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3081 /* Save a string objet as [len][data] on disk. If the object is a string
3082 * representation of an integer value we try to safe it in a special form */
3083 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3086 /* Try integer encoding */
3088 unsigned char buf
[5];
3089 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3090 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3095 /* Try LZF compression - under 20 bytes it's unable to compress even
3096 * aaaaaaaaaaaaaaaaaa so skip it */
3097 if (server
.rdbcompression
&& len
> 20) {
3100 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3101 if (retval
== -1) return -1;
3102 if (retval
> 0) return 0;
3103 /* retval == 0 means data can't be compressed, save the old way */
3106 /* Store verbatim */
3107 if (rdbSaveLen(fp
,len
) == -1) return -1;
3108 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3112 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3113 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3116 /* Avoid incr/decr ref count business when possible.
3117 * This plays well with copy-on-write given that we are probably
3118 * in a child process (BGSAVE). Also this makes sure key objects
3119 * of swapped objects are not incRefCount-ed (an assert does not allow
3120 * this in order to avoid bugs) */
3121 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3122 obj
= getDecodedObject(obj
);
3123 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3126 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3131 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3132 * 8 bit integer specifing the length of the representation.
3133 * This 8 bit integer has special values in order to specify the following
3139 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3140 unsigned char buf
[128];
3146 } else if (!isfinite(val
)) {
3148 buf
[0] = (val
< 0) ? 255 : 254;
3150 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3151 buf
[0] = strlen((char*)buf
+1);
3154 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3158 /* Save a Redis object. */
3159 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3160 if (o
->type
== REDIS_STRING
) {
3161 /* Save a string value */
3162 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3163 } else if (o
->type
== REDIS_LIST
) {
3164 /* Save a list value */
3165 list
*list
= o
->ptr
;
3169 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3170 listRewind(list
,&li
);
3171 while((ln
= listNext(&li
))) {
3172 robj
*eleobj
= listNodeValue(ln
);
3174 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3176 } else if (o
->type
== REDIS_SET
) {
3177 /* Save a set value */
3179 dictIterator
*di
= dictGetIterator(set
);
3182 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3183 while((de
= dictNext(di
)) != NULL
) {
3184 robj
*eleobj
= dictGetEntryKey(de
);
3186 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3188 dictReleaseIterator(di
);
3189 } else if (o
->type
== REDIS_ZSET
) {
3190 /* Save a set value */
3192 dictIterator
*di
= dictGetIterator(zs
->dict
);
3195 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3196 while((de
= dictNext(di
)) != NULL
) {
3197 robj
*eleobj
= dictGetEntryKey(de
);
3198 double *score
= dictGetEntryVal(de
);
3200 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3201 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3203 dictReleaseIterator(di
);
3204 } else if (o
->type
== REDIS_HASH
) {
3205 /* Save a hash value */
3206 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3207 unsigned char *p
= zipmapRewind(o
->ptr
);
3208 unsigned int count
= zipmapLen(o
->ptr
);
3209 unsigned char *key
, *val
;
3210 unsigned int klen
, vlen
;
3212 if (rdbSaveLen(fp
,count
) == -1) return -1;
3213 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3214 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3215 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3218 dictIterator
*di
= dictGetIterator(o
->ptr
);
3221 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3222 while((de
= dictNext(di
)) != NULL
) {
3223 robj
*key
= dictGetEntryKey(de
);
3224 robj
*val
= dictGetEntryVal(de
);
3226 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3227 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3229 dictReleaseIterator(di
);
3237 /* Return the length the object will have on disk if saved with
3238 * the rdbSaveObject() function. Currently we use a trick to get
3239 * this length with very little changes to the code. In the future
3240 * we could switch to a faster solution. */
3241 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3242 if (fp
== NULL
) fp
= server
.devnull
;
3244 assert(rdbSaveObject(fp
,o
) != 1);
3248 /* Return the number of pages required to save this object in the swap file */
3249 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3250 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3252 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3255 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3256 static int rdbSave(char *filename
) {
3257 dictIterator
*di
= NULL
;
3262 time_t now
= time(NULL
);
3264 /* Wait for I/O therads to terminate, just in case this is a
3265 * foreground-saving, to avoid seeking the swap file descriptor at the
3267 if (server
.vm_enabled
)
3268 waitEmptyIOJobsQueue();
3270 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3271 fp
= fopen(tmpfile
,"w");
3273 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3276 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3277 for (j
= 0; j
< server
.dbnum
; j
++) {
3278 redisDb
*db
= server
.db
+j
;
3280 if (dictSize(d
) == 0) continue;
3281 di
= dictGetIterator(d
);
3287 /* Write the SELECT DB opcode */
3288 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3289 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3291 /* Iterate this DB writing every entry */
3292 while((de
= dictNext(di
)) != NULL
) {
3293 robj
*key
= dictGetEntryKey(de
);
3294 robj
*o
= dictGetEntryVal(de
);
3295 time_t expiretime
= getExpire(db
,key
);
3297 /* Save the expire time */
3298 if (expiretime
!= -1) {
3299 /* If this key is already expired skip it */
3300 if (expiretime
< now
) continue;
3301 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3302 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3304 /* Save the key and associated value. This requires special
3305 * handling if the value is swapped out. */
3306 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3307 key
->storage
== REDIS_VM_SWAPPING
) {
3308 /* Save type, key, value */
3309 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3310 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3311 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3313 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3315 /* Get a preview of the object in memory */
3316 po
= vmPreviewObject(key
);
3317 /* Save type, key, value */
3318 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3319 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3320 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3321 /* Remove the loaded object from memory */
3325 dictReleaseIterator(di
);
3328 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3330 /* Make sure data will not remain on the OS's output buffers */
3335 /* Use RENAME to make sure the DB file is changed atomically only
3336 * if the generate DB file is ok. */
3337 if (rename(tmpfile
,filename
) == -1) {
3338 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3342 redisLog(REDIS_NOTICE
,"DB saved on disk");
3344 server
.lastsave
= time(NULL
);
3350 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3351 if (di
) dictReleaseIterator(di
);
3355 static int rdbSaveBackground(char *filename
) {
3358 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3359 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3360 if ((childpid
= fork()) == 0) {
3362 if (server
.vm_enabled
) vmReopenSwapFile();
3364 if (rdbSave(filename
) == REDIS_OK
) {
3371 if (childpid
== -1) {
3372 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3376 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3377 server
.bgsavechildpid
= childpid
;
3380 return REDIS_OK
; /* unreached */
3383 static void rdbRemoveTempFile(pid_t childpid
) {
3386 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3390 static int rdbLoadType(FILE *fp
) {
3392 if (fread(&type
,1,1,fp
) == 0) return -1;
3396 static time_t rdbLoadTime(FILE *fp
) {
3398 if (fread(&t32
,4,1,fp
) == 0) return -1;
3399 return (time_t) t32
;
3402 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3403 * of this file for a description of how this are stored on disk.
3405 * isencoded is set to 1 if the readed length is not actually a length but
3406 * an "encoding type", check the above comments for more info */
3407 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3408 unsigned char buf
[2];
3412 if (isencoded
) *isencoded
= 0;
3413 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3414 type
= (buf
[0]&0xC0)>>6;
3415 if (type
== REDIS_RDB_6BITLEN
) {
3416 /* Read a 6 bit len */
3418 } else if (type
== REDIS_RDB_ENCVAL
) {
3419 /* Read a 6 bit len encoding type */
3420 if (isencoded
) *isencoded
= 1;
3422 } else if (type
== REDIS_RDB_14BITLEN
) {
3423 /* Read a 14 bit len */
3424 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3425 return ((buf
[0]&0x3F)<<8)|buf
[1];
3427 /* Read a 32 bit len */
3428 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3433 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3434 unsigned char enc
[4];
3437 if (enctype
== REDIS_RDB_ENC_INT8
) {
3438 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3439 val
= (signed char)enc
[0];
3440 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3442 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3443 v
= enc
[0]|(enc
[1]<<8);
3445 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3447 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3448 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3451 val
= 0; /* anti-warning */
3454 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3457 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3458 unsigned int len
, clen
;
3459 unsigned char *c
= NULL
;
3462 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3463 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3464 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3465 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3466 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3467 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3469 return createObject(REDIS_STRING
,val
);
3476 static robj
*rdbLoadStringObject(FILE*fp
) {
3481 len
= rdbLoadLen(fp
,&isencoded
);
3484 case REDIS_RDB_ENC_INT8
:
3485 case REDIS_RDB_ENC_INT16
:
3486 case REDIS_RDB_ENC_INT32
:
3487 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3488 case REDIS_RDB_ENC_LZF
:
3489 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3495 if (len
== REDIS_RDB_LENERR
) return NULL
;
3496 val
= sdsnewlen(NULL
,len
);
3497 if (len
&& fread(val
,len
,1,fp
) == 0) {
3501 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3504 /* For information about double serialization check rdbSaveDoubleValue() */
3505 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3509 if (fread(&len
,1,1,fp
) == 0) return -1;
3511 case 255: *val
= R_NegInf
; return 0;
3512 case 254: *val
= R_PosInf
; return 0;
3513 case 253: *val
= R_Nan
; return 0;
3515 if (fread(buf
,len
,1,fp
) == 0) return -1;
3517 sscanf(buf
, "%lg", val
);
3522 /* Load a Redis object of the specified type from the specified file.
3523 * On success a newly allocated object is returned, otherwise NULL. */
3524 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3527 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3528 if (type
== REDIS_STRING
) {
3529 /* Read string value */
3530 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3531 tryObjectEncoding(o
);
3532 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3533 /* Read list/set value */
3536 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3537 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3538 /* It's faster to expand the dict to the right size asap in order
3539 * to avoid rehashing */
3540 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3541 dictExpand(o
->ptr
,listlen
);
3542 /* Load every single element of the list/set */
3546 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3547 tryObjectEncoding(ele
);
3548 if (type
== REDIS_LIST
) {
3549 listAddNodeTail((list
*)o
->ptr
,ele
);
3551 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3554 } else if (type
== REDIS_ZSET
) {
3555 /* Read list/set value */
3559 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3560 o
= createZsetObject();
3562 /* Load every single element of the list/set */
3565 double *score
= zmalloc(sizeof(double));
3567 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3568 tryObjectEncoding(ele
);
3569 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3570 dictAdd(zs
->dict
,ele
,score
);
3571 zslInsert(zs
->zsl
,*score
,ele
);
3572 incrRefCount(ele
); /* added to skiplist */
3574 } else if (type
== REDIS_HASH
) {
3577 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3578 o
= createHashObject();
3579 /* Too many entries? Use an hash table. */
3580 if (hashlen
> server
.hash_max_zipmap_entries
)
3581 convertToRealHash(o
);
3582 /* Load every key/value, then set it into the zipmap or hash
3583 * table, as needed. */
3587 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3588 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3589 /* If we are using a zipmap and there are too big values
3590 * the object is converted to real hash table encoding. */
3591 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3592 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3593 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3595 convertToRealHash(o
);
3598 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3599 unsigned char *zm
= o
->ptr
;
3601 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3602 val
->ptr
,sdslen(val
->ptr
),NULL
);
3607 tryObjectEncoding(key
);
3608 tryObjectEncoding(val
);
3609 dictAdd((dict
*)o
->ptr
,key
,val
);
3618 static int rdbLoad(char *filename
) {
3620 robj
*keyobj
= NULL
;
3622 int type
, retval
, rdbver
;
3623 dict
*d
= server
.db
[0].dict
;
3624 redisDb
*db
= server
.db
+0;
3626 time_t expiretime
= -1, now
= time(NULL
);
3627 long long loadedkeys
= 0;
3629 fp
= fopen(filename
,"r");
3630 if (!fp
) return REDIS_ERR
;
3631 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3633 if (memcmp(buf
,"REDIS",5) != 0) {
3635 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3638 rdbver
= atoi(buf
+5);
3641 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3648 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3649 if (type
== REDIS_EXPIRETIME
) {
3650 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3651 /* We read the time so we need to read the object type again */
3652 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3654 if (type
== REDIS_EOF
) break;
3655 /* Handle SELECT DB opcode as a special case */
3656 if (type
== REDIS_SELECTDB
) {
3657 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3659 if (dbid
>= (unsigned)server
.dbnum
) {
3660 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3663 db
= server
.db
+dbid
;
3668 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3670 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3671 /* Add the new object in the hash table */
3672 retval
= dictAdd(d
,keyobj
,o
);
3673 if (retval
== DICT_ERR
) {
3674 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3677 /* Set the expire time if needed */
3678 if (expiretime
!= -1) {
3679 setExpire(db
,keyobj
,expiretime
);
3680 /* Delete this key if already expired */
3681 if (expiretime
< now
) deleteKey(db
,keyobj
);
3685 /* Handle swapping while loading big datasets when VM is on */
3687 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3688 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3689 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3696 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3697 if (keyobj
) decrRefCount(keyobj
);
3698 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3700 return REDIS_ERR
; /* Just to avoid warning */
3703 /*================================== Commands =============================== */
3705 static void authCommand(redisClient
*c
) {
3706 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3707 c
->authenticated
= 1;
3708 addReply(c
,shared
.ok
);
3710 c
->authenticated
= 0;
3711 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3715 static void pingCommand(redisClient
*c
) {
3716 addReply(c
,shared
.pong
);
3719 static void echoCommand(redisClient
*c
) {
3720 addReplyBulk(c
,c
->argv
[1]);
3723 /*=================================== Strings =============================== */
3725 static void setGenericCommand(redisClient
*c
, int nx
) {
3728 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3729 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3730 if (retval
== DICT_ERR
) {
3732 /* If the key is about a swapped value, we want a new key object
3733 * to overwrite the old. So we delete the old key in the database.
3734 * This will also make sure that swap pages about the old object
3735 * will be marked as free. */
3736 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3737 incrRefCount(c
->argv
[1]);
3738 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3739 incrRefCount(c
->argv
[2]);
3741 addReply(c
,shared
.czero
);
3745 incrRefCount(c
->argv
[1]);
3746 incrRefCount(c
->argv
[2]);
3749 removeExpire(c
->db
,c
->argv
[1]);
3750 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3753 static void setCommand(redisClient
*c
) {
3754 setGenericCommand(c
,0);
3757 static void setnxCommand(redisClient
*c
) {
3758 setGenericCommand(c
,1);
3761 static int getGenericCommand(redisClient
*c
) {
3764 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3767 if (o
->type
!= REDIS_STRING
) {
3768 addReply(c
,shared
.wrongtypeerr
);
3776 static void getCommand(redisClient
*c
) {
3777 getGenericCommand(c
);
3780 static void getsetCommand(redisClient
*c
) {
3781 if (getGenericCommand(c
) == REDIS_ERR
) return;
3782 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3783 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3785 incrRefCount(c
->argv
[1]);
3787 incrRefCount(c
->argv
[2]);
3789 removeExpire(c
->db
,c
->argv
[1]);
3792 static void mgetCommand(redisClient
*c
) {
3795 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3796 for (j
= 1; j
< c
->argc
; j
++) {
3797 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3799 addReply(c
,shared
.nullbulk
);
3801 if (o
->type
!= REDIS_STRING
) {
3802 addReply(c
,shared
.nullbulk
);
3810 static void msetGenericCommand(redisClient
*c
, int nx
) {
3811 int j
, busykeys
= 0;
3813 if ((c
->argc
% 2) == 0) {
3814 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3817 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3818 * set nothing at all if at least one already key exists. */
3820 for (j
= 1; j
< c
->argc
; j
+= 2) {
3821 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3827 addReply(c
, shared
.czero
);
3831 for (j
= 1; j
< c
->argc
; j
+= 2) {
3834 tryObjectEncoding(c
->argv
[j
+1]);
3835 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3836 if (retval
== DICT_ERR
) {
3837 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3838 incrRefCount(c
->argv
[j
+1]);
3840 incrRefCount(c
->argv
[j
]);
3841 incrRefCount(c
->argv
[j
+1]);
3843 removeExpire(c
->db
,c
->argv
[j
]);
3845 server
.dirty
+= (c
->argc
-1)/2;
3846 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3849 static void msetCommand(redisClient
*c
) {
3850 msetGenericCommand(c
,0);
3853 static void msetnxCommand(redisClient
*c
) {
3854 msetGenericCommand(c
,1);
3857 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3862 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3866 if (o
->type
!= REDIS_STRING
) {
3871 if (o
->encoding
== REDIS_ENCODING_RAW
)
3872 value
= strtoll(o
->ptr
, &eptr
, 10);
3873 else if (o
->encoding
== REDIS_ENCODING_INT
)
3874 value
= (long)o
->ptr
;
3876 redisAssert(1 != 1);
3881 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3882 tryObjectEncoding(o
);
3883 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3884 if (retval
== DICT_ERR
) {
3885 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3886 removeExpire(c
->db
,c
->argv
[1]);
3888 incrRefCount(c
->argv
[1]);
3891 addReply(c
,shared
.colon
);
3893 addReply(c
,shared
.crlf
);
3896 static void incrCommand(redisClient
*c
) {
3897 incrDecrCommand(c
,1);
3900 static void decrCommand(redisClient
*c
) {
3901 incrDecrCommand(c
,-1);
3904 static void incrbyCommand(redisClient
*c
) {
3905 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3906 incrDecrCommand(c
,incr
);
3909 static void decrbyCommand(redisClient
*c
) {
3910 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3911 incrDecrCommand(c
,-incr
);
3914 static void appendCommand(redisClient
*c
) {
3919 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3921 /* Create the key */
3922 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3923 incrRefCount(c
->argv
[1]);
3924 incrRefCount(c
->argv
[2]);
3925 totlen
= stringObjectLen(c
->argv
[2]);
3929 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3932 o
= dictGetEntryVal(de
);
3933 if (o
->type
!= REDIS_STRING
) {
3934 addReply(c
,shared
.wrongtypeerr
);
3937 /* If the object is specially encoded or shared we have to make
3939 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3940 robj
*decoded
= getDecodedObject(o
);
3942 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3943 decrRefCount(decoded
);
3944 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3947 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3948 o
->ptr
= sdscatlen(o
->ptr
,
3949 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3951 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3952 (unsigned long) c
->argv
[2]->ptr
);
3954 totlen
= sdslen(o
->ptr
);
3957 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3960 static void substrCommand(redisClient
*c
) {
3962 long start
= atoi(c
->argv
[2]->ptr
);
3963 long end
= atoi(c
->argv
[3]->ptr
);
3964 size_t rangelen
, strlen
;
3967 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
3968 checkType(c
,o
,REDIS_STRING
)) return;
3970 o
= getDecodedObject(o
);
3971 strlen
= sdslen(o
->ptr
);
3973 /* convert negative indexes */
3974 if (start
< 0) start
= strlen
+start
;
3975 if (end
< 0) end
= strlen
+end
;
3976 if (start
< 0) start
= 0;
3977 if (end
< 0) end
= 0;
3979 /* indexes sanity checks */
3980 if (start
> end
|| (size_t)start
>= strlen
) {
3981 /* Out of range start or start > end result in null reply */
3982 addReply(c
,shared
.nullbulk
);
3986 if ((size_t)end
>= strlen
) end
= strlen
-1;
3987 rangelen
= (end
-start
)+1;
3989 /* Return the result */
3990 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
3991 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
3992 addReplySds(c
,range
);
3993 addReply(c
,shared
.crlf
);
3997 /* ========================= Type agnostic commands ========================= */
3999 static void delCommand(redisClient
*c
) {
4002 for (j
= 1; j
< c
->argc
; j
++) {
4003 if (deleteKey(c
->db
,c
->argv
[j
])) {
4008 addReplyLong(c
,deleted
);
4011 static void existsCommand(redisClient
*c
) {
4012 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4015 static void selectCommand(redisClient
*c
) {
4016 int id
= atoi(c
->argv
[1]->ptr
);
4018 if (selectDb(c
,id
) == REDIS_ERR
) {
4019 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4021 addReply(c
,shared
.ok
);
4025 static void randomkeyCommand(redisClient
*c
) {
4029 de
= dictGetRandomKey(c
->db
->dict
);
4030 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4033 addReply(c
,shared
.plus
);
4034 addReply(c
,shared
.crlf
);
4036 addReply(c
,shared
.plus
);
4037 addReply(c
,dictGetEntryKey(de
));
4038 addReply(c
,shared
.crlf
);
4042 static void keysCommand(redisClient
*c
) {
4045 sds pattern
= c
->argv
[1]->ptr
;
4046 int plen
= sdslen(pattern
);
4047 unsigned long numkeys
= 0;
4048 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4050 di
= dictGetIterator(c
->db
->dict
);
4052 decrRefCount(lenobj
);
4053 while((de
= dictNext(di
)) != NULL
) {
4054 robj
*keyobj
= dictGetEntryKey(de
);
4056 sds key
= keyobj
->ptr
;
4057 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4058 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4059 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4060 addReplyBulk(c
,keyobj
);
4065 dictReleaseIterator(di
);
4066 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4069 static void dbsizeCommand(redisClient
*c
) {
4071 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4074 static void lastsaveCommand(redisClient
*c
) {
4076 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4079 static void typeCommand(redisClient
*c
) {
4083 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4088 case REDIS_STRING
: type
= "+string"; break;
4089 case REDIS_LIST
: type
= "+list"; break;
4090 case REDIS_SET
: type
= "+set"; break;
4091 case REDIS_ZSET
: type
= "+zset"; break;
4092 case REDIS_HASH
: type
= "+hash"; break;
4093 default: type
= "+unknown"; break;
4096 addReplySds(c
,sdsnew(type
));
4097 addReply(c
,shared
.crlf
);
4100 static void saveCommand(redisClient
*c
) {
4101 if (server
.bgsavechildpid
!= -1) {
4102 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4105 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4106 addReply(c
,shared
.ok
);
4108 addReply(c
,shared
.err
);
4112 static void bgsaveCommand(redisClient
*c
) {
4113 if (server
.bgsavechildpid
!= -1) {
4114 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4117 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4118 char *status
= "+Background saving started\r\n";
4119 addReplySds(c
,sdsnew(status
));
4121 addReply(c
,shared
.err
);
4125 static void shutdownCommand(redisClient
*c
) {
4126 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4127 /* Kill the saving child if there is a background saving in progress.
4128 We want to avoid race conditions, for instance our saving child may
4129 overwrite the synchronous saving did by SHUTDOWN. */
4130 if (server
.bgsavechildpid
!= -1) {
4131 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4132 kill(server
.bgsavechildpid
,SIGKILL
);
4133 rdbRemoveTempFile(server
.bgsavechildpid
);
4135 if (server
.appendonly
) {
4136 /* Append only file: fsync() the AOF and exit */
4137 fsync(server
.appendfd
);
4138 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4141 /* Snapshotting. Perform a SYNC SAVE and exit */
4142 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4143 if (server
.daemonize
)
4144 unlink(server
.pidfile
);
4145 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4146 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4147 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4150 /* Ooops.. error saving! The best we can do is to continue
4151 * operating. Note that if there was a background saving process,
4152 * in the next cron() Redis will be notified that the background
4153 * saving aborted, handling special stuff like slaves pending for
4154 * synchronization... */
4155 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4157 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4162 static void renameGenericCommand(redisClient
*c
, int nx
) {
4165 /* To use the same key as src and dst is probably an error */
4166 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4167 addReply(c
,shared
.sameobjecterr
);
4171 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4175 deleteIfVolatile(c
->db
,c
->argv
[2]);
4176 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4179 addReply(c
,shared
.czero
);
4182 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4184 incrRefCount(c
->argv
[2]);
4186 deleteKey(c
->db
,c
->argv
[1]);
4188 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4191 static void renameCommand(redisClient
*c
) {
4192 renameGenericCommand(c
,0);
4195 static void renamenxCommand(redisClient
*c
) {
4196 renameGenericCommand(c
,1);
4199 static void moveCommand(redisClient
*c
) {
4204 /* Obtain source and target DB pointers */
4207 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4208 addReply(c
,shared
.outofrangeerr
);
4212 selectDb(c
,srcid
); /* Back to the source DB */
4214 /* If the user is moving using as target the same
4215 * DB as the source DB it is probably an error. */
4217 addReply(c
,shared
.sameobjecterr
);
4221 /* Check if the element exists and get a reference */
4222 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4224 addReply(c
,shared
.czero
);
4228 /* Try to add the element to the target DB */
4229 deleteIfVolatile(dst
,c
->argv
[1]);
4230 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4231 addReply(c
,shared
.czero
);
4234 incrRefCount(c
->argv
[1]);
4237 /* OK! key moved, free the entry in the source DB */
4238 deleteKey(src
,c
->argv
[1]);
4240 addReply(c
,shared
.cone
);
4243 /* =================================== Lists ================================ */
4244 static void pushGenericCommand(redisClient
*c
, int where
) {
4248 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4250 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4251 addReply(c
,shared
.cone
);
4254 lobj
= createListObject();
4256 if (where
== REDIS_HEAD
) {
4257 listAddNodeHead(list
,c
->argv
[2]);
4259 listAddNodeTail(list
,c
->argv
[2]);
4261 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4262 incrRefCount(c
->argv
[1]);
4263 incrRefCount(c
->argv
[2]);
4265 if (lobj
->type
!= REDIS_LIST
) {
4266 addReply(c
,shared
.wrongtypeerr
);
4269 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4270 addReply(c
,shared
.cone
);
4274 if (where
== REDIS_HEAD
) {
4275 listAddNodeHead(list
,c
->argv
[2]);
4277 listAddNodeTail(list
,c
->argv
[2]);
4279 incrRefCount(c
->argv
[2]);
4282 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4285 static void lpushCommand(redisClient
*c
) {
4286 pushGenericCommand(c
,REDIS_HEAD
);
4289 static void rpushCommand(redisClient
*c
) {
4290 pushGenericCommand(c
,REDIS_TAIL
);
4293 static void llenCommand(redisClient
*c
) {
4297 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4298 checkType(c
,o
,REDIS_LIST
)) return;
4301 addReplyUlong(c
,listLength(l
));
4304 static void lindexCommand(redisClient
*c
) {
4306 int index
= atoi(c
->argv
[2]->ptr
);
4310 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4311 checkType(c
,o
,REDIS_LIST
)) return;
4314 ln
= listIndex(list
, index
);
4316 addReply(c
,shared
.nullbulk
);
4318 robj
*ele
= listNodeValue(ln
);
4319 addReplyBulk(c
,ele
);
4323 static void lsetCommand(redisClient
*c
) {
4325 int index
= atoi(c
->argv
[2]->ptr
);
4329 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4330 checkType(c
,o
,REDIS_LIST
)) return;
4333 ln
= listIndex(list
, index
);
4335 addReply(c
,shared
.outofrangeerr
);
4337 robj
*ele
= listNodeValue(ln
);
4340 listNodeValue(ln
) = c
->argv
[3];
4341 incrRefCount(c
->argv
[3]);
4342 addReply(c
,shared
.ok
);
4347 static void popGenericCommand(redisClient
*c
, int where
) {
4352 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4353 checkType(c
,o
,REDIS_LIST
)) return;
4356 if (where
== REDIS_HEAD
)
4357 ln
= listFirst(list
);
4359 ln
= listLast(list
);
4362 addReply(c
,shared
.nullbulk
);
4364 robj
*ele
= listNodeValue(ln
);
4365 addReplyBulk(c
,ele
);
4366 listDelNode(list
,ln
);
4371 static void lpopCommand(redisClient
*c
) {
4372 popGenericCommand(c
,REDIS_HEAD
);
4375 static void rpopCommand(redisClient
*c
) {
4376 popGenericCommand(c
,REDIS_TAIL
);
4379 static void lrangeCommand(redisClient
*c
) {
4381 int start
= atoi(c
->argv
[2]->ptr
);
4382 int end
= atoi(c
->argv
[3]->ptr
);
4389 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4390 checkType(c
,o
,REDIS_LIST
)) return;
4392 llen
= listLength(list
);
4394 /* convert negative indexes */
4395 if (start
< 0) start
= llen
+start
;
4396 if (end
< 0) end
= llen
+end
;
4397 if (start
< 0) start
= 0;
4398 if (end
< 0) end
= 0;
4400 /* indexes sanity checks */
4401 if (start
> end
|| start
>= llen
) {
4402 /* Out of range start or start > end result in empty list */
4403 addReply(c
,shared
.emptymultibulk
);
4406 if (end
>= llen
) end
= llen
-1;
4407 rangelen
= (end
-start
)+1;
4409 /* Return the result in form of a multi-bulk reply */
4410 ln
= listIndex(list
, start
);
4411 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4412 for (j
= 0; j
< rangelen
; j
++) {
4413 ele
= listNodeValue(ln
);
4414 addReplyBulk(c
,ele
);
4419 static void ltrimCommand(redisClient
*c
) {
4421 int start
= atoi(c
->argv
[2]->ptr
);
4422 int end
= atoi(c
->argv
[3]->ptr
);
4424 int j
, ltrim
, rtrim
;
4428 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4429 checkType(c
,o
,REDIS_LIST
)) return;
4431 llen
= listLength(list
);
4433 /* convert negative indexes */
4434 if (start
< 0) start
= llen
+start
;
4435 if (end
< 0) end
= llen
+end
;
4436 if (start
< 0) start
= 0;
4437 if (end
< 0) end
= 0;
4439 /* indexes sanity checks */
4440 if (start
> end
|| start
>= llen
) {
4441 /* Out of range start or start > end result in empty list */
4445 if (end
>= llen
) end
= llen
-1;
4450 /* Remove list elements to perform the trim */
4451 for (j
= 0; j
< ltrim
; j
++) {
4452 ln
= listFirst(list
);
4453 listDelNode(list
,ln
);
4455 for (j
= 0; j
< rtrim
; j
++) {
4456 ln
= listLast(list
);
4457 listDelNode(list
,ln
);
4460 addReply(c
,shared
.ok
);
4463 static void lremCommand(redisClient
*c
) {
4466 listNode
*ln
, *next
;
4467 int toremove
= atoi(c
->argv
[2]->ptr
);
4471 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4472 checkType(c
,o
,REDIS_LIST
)) return;
4476 toremove
= -toremove
;
4479 ln
= fromtail
? list
->tail
: list
->head
;
4481 robj
*ele
= listNodeValue(ln
);
4483 next
= fromtail
? ln
->prev
: ln
->next
;
4484 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4485 listDelNode(list
,ln
);
4488 if (toremove
&& removed
== toremove
) break;
4492 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4495 /* This is the semantic of this command:
4496 * RPOPLPUSH srclist dstlist:
4497 * IF LLEN(srclist) > 0
4498 * element = RPOP srclist
4499 * LPUSH dstlist element
4506 * The idea is to be able to get an element from a list in a reliable way
4507 * since the element is not just returned but pushed against another list
4508 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4510 static void rpoplpushcommand(redisClient
*c
) {
4515 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4516 checkType(c
,sobj
,REDIS_LIST
)) return;
4517 srclist
= sobj
->ptr
;
4518 ln
= listLast(srclist
);
4521 addReply(c
,shared
.nullbulk
);
4523 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4524 robj
*ele
= listNodeValue(ln
);
4527 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4528 addReply(c
,shared
.wrongtypeerr
);
4532 /* Add the element to the target list (unless it's directly
4533 * passed to some BLPOP-ing client */
4534 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4536 /* Create the list if the key does not exist */
4537 dobj
= createListObject();
4538 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4539 incrRefCount(c
->argv
[2]);
4541 dstlist
= dobj
->ptr
;
4542 listAddNodeHead(dstlist
,ele
);
4546 /* Send the element to the client as reply as well */
4547 addReplyBulk(c
,ele
);
4549 /* Finally remove the element from the source list */
4550 listDelNode(srclist
,ln
);
4555 /* ==================================== Sets ================================ */
4557 static void saddCommand(redisClient
*c
) {
4560 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4562 set
= createSetObject();
4563 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4564 incrRefCount(c
->argv
[1]);
4566 if (set
->type
!= REDIS_SET
) {
4567 addReply(c
,shared
.wrongtypeerr
);
4571 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4572 incrRefCount(c
->argv
[2]);
4574 addReply(c
,shared
.cone
);
4576 addReply(c
,shared
.czero
);
4580 static void sremCommand(redisClient
*c
) {
4583 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4584 checkType(c
,set
,REDIS_SET
)) return;
4586 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4588 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4589 addReply(c
,shared
.cone
);
4591 addReply(c
,shared
.czero
);
4595 static void smoveCommand(redisClient
*c
) {
4596 robj
*srcset
, *dstset
;
4598 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4599 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4601 /* If the source key does not exist return 0, if it's of the wrong type
4603 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4604 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4607 /* Error if the destination key is not a set as well */
4608 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4609 addReply(c
,shared
.wrongtypeerr
);
4612 /* Remove the element from the source set */
4613 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4614 /* Key not found in the src set! return zero */
4615 addReply(c
,shared
.czero
);
4619 /* Add the element to the destination set */
4621 dstset
= createSetObject();
4622 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4623 incrRefCount(c
->argv
[2]);
4625 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4626 incrRefCount(c
->argv
[3]);
4627 addReply(c
,shared
.cone
);
4630 static void sismemberCommand(redisClient
*c
) {
4633 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4634 checkType(c
,set
,REDIS_SET
)) return;
4636 if (dictFind(set
->ptr
,c
->argv
[2]))
4637 addReply(c
,shared
.cone
);
4639 addReply(c
,shared
.czero
);
4642 static void scardCommand(redisClient
*c
) {
4646 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4647 checkType(c
,o
,REDIS_SET
)) return;
4650 addReplyUlong(c
,dictSize(s
));
4653 static void spopCommand(redisClient
*c
) {
4657 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4658 checkType(c
,set
,REDIS_SET
)) return;
4660 de
= dictGetRandomKey(set
->ptr
);
4662 addReply(c
,shared
.nullbulk
);
4664 robj
*ele
= dictGetEntryKey(de
);
4666 addReplyBulk(c
,ele
);
4667 dictDelete(set
->ptr
,ele
);
4668 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4673 static void srandmemberCommand(redisClient
*c
) {
4677 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4678 checkType(c
,set
,REDIS_SET
)) return;
4680 de
= dictGetRandomKey(set
->ptr
);
4682 addReply(c
,shared
.nullbulk
);
4684 robj
*ele
= dictGetEntryKey(de
);
4686 addReplyBulk(c
,ele
);
4690 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4691 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4693 return dictSize(*d1
)-dictSize(*d2
);
4696 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4697 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4700 robj
*lenobj
= NULL
, *dstset
= NULL
;
4701 unsigned long j
, cardinality
= 0;
4703 for (j
= 0; j
< setsnum
; j
++) {
4707 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4708 lookupKeyRead(c
->db
,setskeys
[j
]);
4712 if (deleteKey(c
->db
,dstkey
))
4714 addReply(c
,shared
.czero
);
4716 addReply(c
,shared
.nullmultibulk
);
4720 if (setobj
->type
!= REDIS_SET
) {
4722 addReply(c
,shared
.wrongtypeerr
);
4725 dv
[j
] = setobj
->ptr
;
4727 /* Sort sets from the smallest to largest, this will improve our
4728 * algorithm's performace */
4729 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4731 /* The first thing we should output is the total number of elements...
4732 * since this is a multi-bulk write, but at this stage we don't know
4733 * the intersection set size, so we use a trick, append an empty object
4734 * to the output list and save the pointer to later modify it with the
4737 lenobj
= createObject(REDIS_STRING
,NULL
);
4739 decrRefCount(lenobj
);
4741 /* If we have a target key where to store the resulting set
4742 * create this key with an empty set inside */
4743 dstset
= createSetObject();
4746 /* Iterate all the elements of the first (smallest) set, and test
4747 * the element against all the other sets, if at least one set does
4748 * not include the element it is discarded */
4749 di
= dictGetIterator(dv
[0]);
4751 while((de
= dictNext(di
)) != NULL
) {
4754 for (j
= 1; j
< setsnum
; j
++)
4755 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4757 continue; /* at least one set does not contain the member */
4758 ele
= dictGetEntryKey(de
);
4760 addReplyBulk(c
,ele
);
4763 dictAdd(dstset
->ptr
,ele
,NULL
);
4767 dictReleaseIterator(di
);
4770 /* Store the resulting set into the target */
4771 deleteKey(c
->db
,dstkey
);
4772 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4773 incrRefCount(dstkey
);
4777 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4779 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4780 dictSize((dict
*)dstset
->ptr
)));
4786 static void sinterCommand(redisClient
*c
) {
4787 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4790 static void sinterstoreCommand(redisClient
*c
) {
4791 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4794 #define REDIS_OP_UNION 0
4795 #define REDIS_OP_DIFF 1
4796 #define REDIS_OP_INTER 2
4798 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4799 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4802 robj
*dstset
= NULL
;
4803 int j
, cardinality
= 0;
4805 for (j
= 0; j
< setsnum
; j
++) {
4809 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4810 lookupKeyRead(c
->db
,setskeys
[j
]);
4815 if (setobj
->type
!= REDIS_SET
) {
4817 addReply(c
,shared
.wrongtypeerr
);
4820 dv
[j
] = setobj
->ptr
;
4823 /* We need a temp set object to store our union. If the dstkey
4824 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4825 * this set object will be the resulting object to set into the target key*/
4826 dstset
= createSetObject();
4828 /* Iterate all the elements of all the sets, add every element a single
4829 * time to the result set */
4830 for (j
= 0; j
< setsnum
; j
++) {
4831 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4832 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4834 di
= dictGetIterator(dv
[j
]);
4836 while((de
= dictNext(di
)) != NULL
) {
4839 /* dictAdd will not add the same element multiple times */
4840 ele
= dictGetEntryKey(de
);
4841 if (op
== REDIS_OP_UNION
|| j
== 0) {
4842 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4846 } else if (op
== REDIS_OP_DIFF
) {
4847 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4852 dictReleaseIterator(di
);
4854 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4857 /* Output the content of the resulting set, if not in STORE mode */
4859 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4860 di
= dictGetIterator(dstset
->ptr
);
4861 while((de
= dictNext(di
)) != NULL
) {
4864 ele
= dictGetEntryKey(de
);
4865 addReplyBulk(c
,ele
);
4867 dictReleaseIterator(di
);
4869 /* If we have a target key where to store the resulting set
4870 * create this key with the result set inside */
4871 deleteKey(c
->db
,dstkey
);
4872 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4873 incrRefCount(dstkey
);
4878 decrRefCount(dstset
);
4880 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4881 dictSize((dict
*)dstset
->ptr
)));
4887 static void sunionCommand(redisClient
*c
) {
4888 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4891 static void sunionstoreCommand(redisClient
*c
) {
4892 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4895 static void sdiffCommand(redisClient
*c
) {
4896 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4899 static void sdiffstoreCommand(redisClient
*c
) {
4900 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4903 /* ==================================== ZSets =============================== */
4905 /* ZSETs are ordered sets using two data structures to hold the same elements
4906 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4909 * The elements are added to an hash table mapping Redis objects to scores.
4910 * At the same time the elements are added to a skip list mapping scores
4911 * to Redis objects (so objects are sorted by scores in this "view"). */
4913 /* This skiplist implementation is almost a C translation of the original
4914 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4915 * Alternative to Balanced Trees", modified in three ways:
4916 * a) this implementation allows for repeated values.
4917 * b) the comparison is not just by key (our 'score') but by satellite data.
4918 * c) there is a back pointer, so it's a doubly linked list with the back
4919 * pointers being only at "level 1". This allows to traverse the list
4920 * from tail to head, useful for ZREVRANGE. */
4922 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4923 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4925 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4927 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4933 static zskiplist
*zslCreate(void) {
4937 zsl
= zmalloc(sizeof(*zsl
));
4940 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4941 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4942 zsl
->header
->forward
[j
] = NULL
;
4944 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4945 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4946 zsl
->header
->span
[j
] = 0;
4948 zsl
->header
->backward
= NULL
;
4953 static void zslFreeNode(zskiplistNode
*node
) {
4954 decrRefCount(node
->obj
);
4955 zfree(node
->forward
);
4960 static void zslFree(zskiplist
*zsl
) {
4961 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4963 zfree(zsl
->header
->forward
);
4964 zfree(zsl
->header
->span
);
4967 next
= node
->forward
[0];
4974 static int zslRandomLevel(void) {
4976 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4981 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4982 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4983 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
4987 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4988 /* store rank that is crossed to reach the insert position */
4989 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
4991 while (x
->forward
[i
] &&
4992 (x
->forward
[i
]->score
< score
||
4993 (x
->forward
[i
]->score
== score
&&
4994 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
4995 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5000 /* we assume the key is not already inside, since we allow duplicated
5001 * scores, and the re-insertion of score and redis object should never
5002 * happpen since the caller of zslInsert() should test in the hash table
5003 * if the element is already inside or not. */
5004 level
= zslRandomLevel();
5005 if (level
> zsl
->level
) {
5006 for (i
= zsl
->level
; i
< level
; i
++) {
5008 update
[i
] = zsl
->header
;
5009 update
[i
]->span
[i
-1] = zsl
->length
;
5013 x
= zslCreateNode(level
,score
,obj
);
5014 for (i
= 0; i
< level
; i
++) {
5015 x
->forward
[i
] = update
[i
]->forward
[i
];
5016 update
[i
]->forward
[i
] = x
;
5018 /* update span covered by update[i] as x is inserted here */
5020 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5021 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5025 /* increment span for untouched levels */
5026 for (i
= level
; i
< zsl
->level
; i
++) {
5027 update
[i
]->span
[i
-1]++;
5030 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5032 x
->forward
[0]->backward
= x
;
5038 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5039 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5041 for (i
= 0; i
< zsl
->level
; i
++) {
5042 if (update
[i
]->forward
[i
] == x
) {
5044 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5046 update
[i
]->forward
[i
] = x
->forward
[i
];
5048 /* invariant: i > 0, because update[0]->forward[0]
5049 * is always equal to x */
5050 update
[i
]->span
[i
-1] -= 1;
5053 if (x
->forward
[0]) {
5054 x
->forward
[0]->backward
= x
->backward
;
5056 zsl
->tail
= x
->backward
;
5058 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5063 /* Delete an element with matching score/object from the skiplist. */
5064 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5065 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5069 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5070 while (x
->forward
[i
] &&
5071 (x
->forward
[i
]->score
< score
||
5072 (x
->forward
[i
]->score
== score
&&
5073 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5077 /* We may have multiple elements with the same score, what we need
5078 * is to find the element with both the right score and object. */
5080 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5081 zslDeleteNode(zsl
, x
, update
);
5085 return 0; /* not found */
5087 return 0; /* not found */
5090 /* Delete all the elements with score between min and max from the skiplist.
5091 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5092 * Note that this function takes the reference to the hash table view of the
5093 * sorted set, in order to remove the elements from the hash table too. */
5094 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5095 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5096 unsigned long removed
= 0;
5100 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5101 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5105 /* We may have multiple elements with the same score, what we need
5106 * is to find the element with both the right score and object. */
5108 while (x
&& x
->score
<= max
) {
5109 zskiplistNode
*next
= x
->forward
[0];
5110 zslDeleteNode(zsl
, x
, update
);
5111 dictDelete(dict
,x
->obj
);
5116 return removed
; /* not found */
5119 /* Delete all the elements with rank between start and end from the skiplist.
5120 * Start and end are inclusive. Note that start and end need to be 1-based */
5121 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5122 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5123 unsigned long traversed
= 0, removed
= 0;
5127 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5128 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5129 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5137 while (x
&& traversed
<= end
) {
5138 zskiplistNode
*next
= x
->forward
[0];
5139 zslDeleteNode(zsl
, x
, update
);
5140 dictDelete(dict
,x
->obj
);
5149 /* Find the first node having a score equal or greater than the specified one.
5150 * Returns NULL if there is no match. */
5151 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5156 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5157 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5160 /* We may have multiple elements with the same score, what we need
5161 * is to find the element with both the right score and object. */
5162 return x
->forward
[0];
5165 /* Find the rank for an element by both score and key.
5166 * Returns 0 when the element cannot be found, rank otherwise.
5167 * Note that the rank is 1-based due to the span of zsl->header to the
5169 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5171 unsigned long rank
= 0;
5175 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5176 while (x
->forward
[i
] &&
5177 (x
->forward
[i
]->score
< score
||
5178 (x
->forward
[i
]->score
== score
&&
5179 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5180 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5184 /* x might be equal to zsl->header, so test if obj is non-NULL */
5185 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5192 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5193 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5195 unsigned long traversed
= 0;
5199 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5200 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5202 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5205 if (traversed
== rank
) {
5212 /* The actual Z-commands implementations */
5214 /* This generic command implements both ZADD and ZINCRBY.
5215 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5216 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5217 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5222 zsetobj
= lookupKeyWrite(c
->db
,key
);
5223 if (zsetobj
== NULL
) {
5224 zsetobj
= createZsetObject();
5225 dictAdd(c
->db
->dict
,key
,zsetobj
);
5228 if (zsetobj
->type
!= REDIS_ZSET
) {
5229 addReply(c
,shared
.wrongtypeerr
);
5235 /* Ok now since we implement both ZADD and ZINCRBY here the code
5236 * needs to handle the two different conditions. It's all about setting
5237 * '*score', that is, the new score to set, to the right value. */
5238 score
= zmalloc(sizeof(double));
5242 /* Read the old score. If the element was not present starts from 0 */
5243 de
= dictFind(zs
->dict
,ele
);
5245 double *oldscore
= dictGetEntryVal(de
);
5246 *score
= *oldscore
+ scoreval
;
5254 /* What follows is a simple remove and re-insert operation that is common
5255 * to both ZADD and ZINCRBY... */
5256 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5257 /* case 1: New element */
5258 incrRefCount(ele
); /* added to hash */
5259 zslInsert(zs
->zsl
,*score
,ele
);
5260 incrRefCount(ele
); /* added to skiplist */
5263 addReplyDouble(c
,*score
);
5265 addReply(c
,shared
.cone
);
5270 /* case 2: Score update operation */
5271 de
= dictFind(zs
->dict
,ele
);
5272 redisAssert(de
!= NULL
);
5273 oldscore
= dictGetEntryVal(de
);
5274 if (*score
!= *oldscore
) {
5277 /* Remove and insert the element in the skip list with new score */
5278 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5279 redisAssert(deleted
!= 0);
5280 zslInsert(zs
->zsl
,*score
,ele
);
5282 /* Update the score in the hash table */
5283 dictReplace(zs
->dict
,ele
,score
);
5289 addReplyDouble(c
,*score
);
5291 addReply(c
,shared
.czero
);
5295 static void zaddCommand(redisClient
*c
) {
5298 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5299 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5302 static void zincrbyCommand(redisClient
*c
) {
5305 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5306 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5309 static void zremCommand(redisClient
*c
) {
5316 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5317 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5320 de
= dictFind(zs
->dict
,c
->argv
[2]);
5322 addReply(c
,shared
.czero
);
5325 /* Delete from the skiplist */
5326 oldscore
= dictGetEntryVal(de
);
5327 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5328 redisAssert(deleted
!= 0);
5330 /* Delete from the hash table */
5331 dictDelete(zs
->dict
,c
->argv
[2]);
5332 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5334 addReply(c
,shared
.cone
);
5337 static void zremrangebyscoreCommand(redisClient
*c
) {
5338 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5339 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5344 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5345 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5348 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5349 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5350 server
.dirty
+= deleted
;
5351 addReplyLong(c
,deleted
);
5354 static void zremrangebyrankCommand(redisClient
*c
) {
5355 int start
= atoi(c
->argv
[2]->ptr
);
5356 int end
= atoi(c
->argv
[3]->ptr
);
5362 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5363 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5365 llen
= zs
->zsl
->length
;
5367 /* convert negative indexes */
5368 if (start
< 0) start
= llen
+start
;
5369 if (end
< 0) end
= llen
+end
;
5370 if (start
< 0) start
= 0;
5371 if (end
< 0) end
= 0;
5373 /* indexes sanity checks */
5374 if (start
> end
|| start
>= llen
) {
5375 addReply(c
,shared
.czero
);
5378 if (end
>= llen
) end
= llen
-1;
5380 /* increment start and end because zsl*Rank functions
5381 * use 1-based rank */
5382 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5383 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5384 server
.dirty
+= deleted
;
5385 addReplyLong(c
, deleted
);
5393 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5394 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5395 unsigned long size1
, size2
;
5396 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5397 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5398 return size1
- size2
;
5401 #define REDIS_AGGR_SUM 1
5402 #define REDIS_AGGR_MIN 2
5403 #define REDIS_AGGR_MAX 3
5405 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5406 if (aggregate
== REDIS_AGGR_SUM
) {
5407 *target
= *target
+ val
;
5408 } else if (aggregate
== REDIS_AGGR_MIN
) {
5409 *target
= val
< *target
? val
: *target
;
5410 } else if (aggregate
== REDIS_AGGR_MAX
) {
5411 *target
= val
> *target
? val
: *target
;
5414 redisAssert(0 != 0);
5418 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5420 int aggregate
= REDIS_AGGR_SUM
;
5427 /* expect zsetnum input keys to be given */
5428 zsetnum
= atoi(c
->argv
[2]->ptr
);
5430 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5434 /* test if the expected number of keys would overflow */
5435 if (3+zsetnum
> c
->argc
) {
5436 addReply(c
,shared
.syntaxerr
);
5440 /* read keys to be used for input */
5441 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5442 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5443 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5447 if (zsetobj
->type
!= REDIS_ZSET
) {
5449 addReply(c
,shared
.wrongtypeerr
);
5452 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5455 /* default all weights to 1 */
5456 src
[i
].weight
= 1.0;
5459 /* parse optional extra arguments */
5461 int remaining
= c
->argc
- j
;
5464 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5466 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5467 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5469 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5471 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5472 aggregate
= REDIS_AGGR_SUM
;
5473 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5474 aggregate
= REDIS_AGGR_MIN
;
5475 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5476 aggregate
= REDIS_AGGR_MAX
;
5479 addReply(c
,shared
.syntaxerr
);
5485 addReply(c
,shared
.syntaxerr
);
5491 /* sort sets from the smallest to largest, this will improve our
5492 * algorithm's performance */
5493 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5495 dstobj
= createZsetObject();
5496 dstzset
= dstobj
->ptr
;
5498 if (op
== REDIS_OP_INTER
) {
5499 /* skip going over all entries if the smallest zset is NULL or empty */
5500 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5501 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5502 * from small to large, all src[i > 0].dict are non-empty too */
5503 di
= dictGetIterator(src
[0].dict
);
5504 while((de
= dictNext(di
)) != NULL
) {
5505 double *score
= zmalloc(sizeof(double)), value
;
5506 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5508 for (j
= 1; j
< zsetnum
; j
++) {
5509 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5511 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5512 zunionInterAggregate(score
, value
, aggregate
);
5518 /* skip entry when not present in every source dict */
5522 robj
*o
= dictGetEntryKey(de
);
5523 dictAdd(dstzset
->dict
,o
,score
);
5524 incrRefCount(o
); /* added to dictionary */
5525 zslInsert(dstzset
->zsl
,*score
,o
);
5526 incrRefCount(o
); /* added to skiplist */
5529 dictReleaseIterator(di
);
5531 } else if (op
== REDIS_OP_UNION
) {
5532 for (i
= 0; i
< zsetnum
; i
++) {
5533 if (!src
[i
].dict
) continue;
5535 di
= dictGetIterator(src
[i
].dict
);
5536 while((de
= dictNext(di
)) != NULL
) {
5537 /* skip key when already processed */
5538 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5540 double *score
= zmalloc(sizeof(double)), value
;
5541 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5543 /* because the zsets are sorted by size, its only possible
5544 * for sets at larger indices to hold this entry */
5545 for (j
= (i
+1); j
< zsetnum
; j
++) {
5546 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5548 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5549 zunionInterAggregate(score
, value
, aggregate
);
5553 robj
*o
= dictGetEntryKey(de
);
5554 dictAdd(dstzset
->dict
,o
,score
);
5555 incrRefCount(o
); /* added to dictionary */
5556 zslInsert(dstzset
->zsl
,*score
,o
);
5557 incrRefCount(o
); /* added to skiplist */
5559 dictReleaseIterator(di
);
5562 /* unknown operator */
5563 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5566 deleteKey(c
->db
,dstkey
);
5567 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5568 incrRefCount(dstkey
);
5570 addReplyLong(c
, dstzset
->zsl
->length
);
5575 static void zunionCommand(redisClient
*c
) {
5576 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5579 static void zinterCommand(redisClient
*c
) {
5580 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5583 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5585 int start
= atoi(c
->argv
[2]->ptr
);
5586 int end
= atoi(c
->argv
[3]->ptr
);
5595 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5597 } else if (c
->argc
>= 5) {
5598 addReply(c
,shared
.syntaxerr
);
5602 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5603 checkType(c
,o
,REDIS_ZSET
)) return;
5608 /* convert negative indexes */
5609 if (start
< 0) start
= llen
+start
;
5610 if (end
< 0) end
= llen
+end
;
5611 if (start
< 0) start
= 0;
5612 if (end
< 0) end
= 0;
5614 /* indexes sanity checks */
5615 if (start
> end
|| start
>= llen
) {
5616 /* Out of range start or start > end result in empty list */
5617 addReply(c
,shared
.emptymultibulk
);
5620 if (end
>= llen
) end
= llen
-1;
5621 rangelen
= (end
-start
)+1;
5623 /* check if starting point is trivial, before searching
5624 * the element in log(N) time */
5626 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5629 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5632 /* Return the result in form of a multi-bulk reply */
5633 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5634 withscores
? (rangelen
*2) : rangelen
));
5635 for (j
= 0; j
< rangelen
; j
++) {
5637 addReplyBulk(c
,ele
);
5639 addReplyDouble(c
,ln
->score
);
5640 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5644 static void zrangeCommand(redisClient
*c
) {
5645 zrangeGenericCommand(c
,0);
5648 static void zrevrangeCommand(redisClient
*c
) {
5649 zrangeGenericCommand(c
,1);
5652 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5653 * If justcount is non-zero, just the count is returned. */
5654 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5657 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5658 int offset
= 0, limit
= -1;
5662 /* Parse the min-max interval. If one of the values is prefixed
5663 * by the "(" character, it's considered "open". For instance
5664 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5665 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5666 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5667 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5670 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5672 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5673 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5676 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5679 /* Parse "WITHSCORES": note that if the command was called with
5680 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5681 * enter the following paths to parse WITHSCORES and LIMIT. */
5682 if (c
->argc
== 5 || c
->argc
== 8) {
5683 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5688 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5692 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5697 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5698 addReply(c
,shared
.syntaxerr
);
5700 } else if (c
->argc
== (7 + withscores
)) {
5701 offset
= atoi(c
->argv
[5]->ptr
);
5702 limit
= atoi(c
->argv
[6]->ptr
);
5703 if (offset
< 0) offset
= 0;
5706 /* Ok, lookup the key and get the range */
5707 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5709 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5711 if (o
->type
!= REDIS_ZSET
) {
5712 addReply(c
,shared
.wrongtypeerr
);
5714 zset
*zsetobj
= o
->ptr
;
5715 zskiplist
*zsl
= zsetobj
->zsl
;
5717 robj
*ele
, *lenobj
= NULL
;
5718 unsigned long rangelen
= 0;
5720 /* Get the first node with the score >= min, or with
5721 * score > min if 'minex' is true. */
5722 ln
= zslFirstWithScore(zsl
,min
);
5723 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5726 /* No element matching the speciifed interval */
5727 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5731 /* We don't know in advance how many matching elements there
5732 * are in the list, so we push this object that will represent
5733 * the multi-bulk length in the output buffer, and will "fix"
5736 lenobj
= createObject(REDIS_STRING
,NULL
);
5738 decrRefCount(lenobj
);
5741 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5744 ln
= ln
->forward
[0];
5747 if (limit
== 0) break;
5750 addReplyBulk(c
,ele
);
5752 addReplyDouble(c
,ln
->score
);
5754 ln
= ln
->forward
[0];
5756 if (limit
> 0) limit
--;
5759 addReplyLong(c
,(long)rangelen
);
5761 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5762 withscores
? (rangelen
*2) : rangelen
);
5768 static void zrangebyscoreCommand(redisClient
*c
) {
5769 genericZrangebyscoreCommand(c
,0);
5772 static void zcountCommand(redisClient
*c
) {
5773 genericZrangebyscoreCommand(c
,1);
5776 static void zcardCommand(redisClient
*c
) {
5780 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5781 checkType(c
,o
,REDIS_ZSET
)) return;
5784 addReplyUlong(c
,zs
->zsl
->length
);
5787 static void zscoreCommand(redisClient
*c
) {
5792 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5793 checkType(c
,o
,REDIS_ZSET
)) return;
5796 de
= dictFind(zs
->dict
,c
->argv
[2]);
5798 addReply(c
,shared
.nullbulk
);
5800 double *score
= dictGetEntryVal(de
);
5802 addReplyDouble(c
,*score
);
5806 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5814 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5815 checkType(c
,o
,REDIS_ZSET
)) return;
5819 de
= dictFind(zs
->dict
,c
->argv
[2]);
5821 addReply(c
,shared
.nullbulk
);
5825 score
= dictGetEntryVal(de
);
5826 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5829 addReplyLong(c
, zsl
->length
- rank
);
5831 addReplyLong(c
, rank
-1);
5834 addReply(c
,shared
.nullbulk
);
5838 static void zrankCommand(redisClient
*c
) {
5839 zrankGenericCommand(c
, 0);
5842 static void zrevrankCommand(redisClient
*c
) {
5843 zrankGenericCommand(c
, 1);
5846 /* =================================== Hashes =============================== */
5847 static void hsetCommand(redisClient
*c
) {
5849 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5852 o
= createHashObject();
5853 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5854 incrRefCount(c
->argv
[1]);
5856 if (o
->type
!= REDIS_HASH
) {
5857 addReply(c
,shared
.wrongtypeerr
);
5861 /* We want to convert the zipmap into an hash table right now if the
5862 * entry to be added is too big. Note that we check if the object
5863 * is integer encoded before to try fetching the length in the test below.
5864 * This is because integers are small, but currently stringObjectLen()
5865 * performs a slow conversion: not worth it. */
5866 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5867 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5868 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5869 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5870 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5872 convertToRealHash(o
);
5875 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5876 unsigned char *zm
= o
->ptr
;
5877 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5879 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5880 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
5881 decrRefCount(valobj
);
5884 /* And here there is the second check for hash conversion...
5885 * we want to do it only if the operation was not just an update as
5886 * zipmapLen() is O(N). */
5887 if (!update
&& zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
5888 convertToRealHash(o
);
5890 tryObjectEncoding(c
->argv
[2]);
5891 /* note that c->argv[3] is already encoded, as the latest arg
5892 * of a bulk command is always integer encoded if possible. */
5893 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
5894 incrRefCount(c
->argv
[2]);
5898 incrRefCount(c
->argv
[3]);
5901 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
5904 static void hgetCommand(redisClient
*c
) {
5907 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5908 checkType(c
,o
,REDIS_HASH
)) return;
5910 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5911 unsigned char *zm
= o
->ptr
;
5916 field
= getDecodedObject(c
->argv
[2]);
5917 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
5918 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
5919 addReplySds(c
,sdsnewlen(val
,vlen
));
5920 addReply(c
,shared
.crlf
);
5921 decrRefCount(field
);
5924 addReply(c
,shared
.nullbulk
);
5925 decrRefCount(field
);
5929 struct dictEntry
*de
;
5931 de
= dictFind(o
->ptr
,c
->argv
[2]);
5933 addReply(c
,shared
.nullbulk
);
5935 robj
*e
= dictGetEntryVal(de
);
5942 static void hdelCommand(redisClient
*c
) {
5946 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5947 checkType(c
,o
,REDIS_HASH
)) return;
5949 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5950 robj
*field
= getDecodedObject(c
->argv
[2]);
5952 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
5953 (unsigned char*) field
->ptr
,
5954 sdslen(field
->ptr
), &deleted
);
5955 decrRefCount(field
);
5957 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
5959 if (deleted
) server
.dirty
++;
5960 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
5963 static void hlenCommand(redisClient
*c
) {
5967 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5968 checkType(c
,o
,REDIS_HASH
)) return;
5970 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
5971 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
5972 addReplyUlong(c
,len
);
5975 #define REDIS_GETALL_KEYS 1
5976 #define REDIS_GETALL_VALS 2
5977 static void genericHgetallCommand(redisClient
*c
, int flags
) {
5979 unsigned long count
= 0;
5981 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
5982 || checkType(c
,o
,REDIS_HASH
)) return;
5984 lenobj
= createObject(REDIS_STRING
,NULL
);
5986 decrRefCount(lenobj
);
5988 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5989 unsigned char *p
= zipmapRewind(o
->ptr
);
5990 unsigned char *field
, *val
;
5991 unsigned int flen
, vlen
;
5993 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
5996 if (flags
& REDIS_GETALL_KEYS
) {
5997 aux
= createStringObject((char*)field
,flen
);
5998 addReplyBulk(c
,aux
);
6002 if (flags
& REDIS_GETALL_VALS
) {
6003 aux
= createStringObject((char*)val
,vlen
);
6004 addReplyBulk(c
,aux
);
6010 dictIterator
*di
= dictGetIterator(o
->ptr
);
6013 while((de
= dictNext(di
)) != NULL
) {
6014 robj
*fieldobj
= dictGetEntryKey(de
);
6015 robj
*valobj
= dictGetEntryVal(de
);
6017 if (flags
& REDIS_GETALL_KEYS
) {
6018 addReplyBulk(c
,fieldobj
);
6021 if (flags
& REDIS_GETALL_VALS
) {
6022 addReplyBulk(c
,valobj
);
6026 dictReleaseIterator(di
);
6028 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6031 static void hkeysCommand(redisClient
*c
) {
6032 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6035 static void hvalsCommand(redisClient
*c
) {
6036 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6039 static void hgetallCommand(redisClient
*c
) {
6040 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6043 static void hexistsCommand(redisClient
*c
) {
6047 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6048 checkType(c
,o
,REDIS_HASH
)) return;
6050 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6052 unsigned char *zm
= o
->ptr
;
6054 field
= getDecodedObject(c
->argv
[2]);
6055 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6056 decrRefCount(field
);
6058 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6060 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6063 static void convertToRealHash(robj
*o
) {
6064 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6065 unsigned int klen
, vlen
;
6066 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6068 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6069 p
= zipmapRewind(zm
);
6070 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6071 robj
*keyobj
, *valobj
;
6073 keyobj
= createStringObject((char*)key
,klen
);
6074 valobj
= createStringObject((char*)val
,vlen
);
6075 tryObjectEncoding(keyobj
);
6076 tryObjectEncoding(valobj
);
6077 dictAdd(dict
,keyobj
,valobj
);
6079 o
->encoding
= REDIS_ENCODING_HT
;
6084 /* ========================= Non type-specific commands ==================== */
6086 static void flushdbCommand(redisClient
*c
) {
6087 server
.dirty
+= dictSize(c
->db
->dict
);
6088 dictEmpty(c
->db
->dict
);
6089 dictEmpty(c
->db
->expires
);
6090 addReply(c
,shared
.ok
);
6093 static void flushallCommand(redisClient
*c
) {
6094 server
.dirty
+= emptyDb();
6095 addReply(c
,shared
.ok
);
6096 rdbSave(server
.dbfilename
);
6100 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6101 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6103 so
->pattern
= pattern
;
6107 /* Return the value associated to the key with a name obtained
6108 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6109 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6113 int prefixlen
, sublen
, postfixlen
;
6114 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6118 char buf
[REDIS_SORTKEY_MAX
+1];
6121 /* If the pattern is "#" return the substitution object itself in order
6122 * to implement the "SORT ... GET #" feature. */
6123 spat
= pattern
->ptr
;
6124 if (spat
[0] == '#' && spat
[1] == '\0') {
6128 /* The substitution object may be specially encoded. If so we create
6129 * a decoded object on the fly. Otherwise getDecodedObject will just
6130 * increment the ref count, that we'll decrement later. */
6131 subst
= getDecodedObject(subst
);
6134 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6135 p
= strchr(spat
,'*');
6137 decrRefCount(subst
);
6142 sublen
= sdslen(ssub
);
6143 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6144 memcpy(keyname
.buf
,spat
,prefixlen
);
6145 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6146 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6147 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6148 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6150 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6151 decrRefCount(subst
);
6153 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6154 return lookupKeyRead(db
,&keyobj
);
6157 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6158 * the additional parameter is not standard but a BSD-specific we have to
6159 * pass sorting parameters via the global 'server' structure */
6160 static int sortCompare(const void *s1
, const void *s2
) {
6161 const redisSortObject
*so1
= s1
, *so2
= s2
;
6164 if (!server
.sort_alpha
) {
6165 /* Numeric sorting. Here it's trivial as we precomputed scores */
6166 if (so1
->u
.score
> so2
->u
.score
) {
6168 } else if (so1
->u
.score
< so2
->u
.score
) {
6174 /* Alphanumeric sorting */
6175 if (server
.sort_bypattern
) {
6176 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6177 /* At least one compare object is NULL */
6178 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6180 else if (so1
->u
.cmpobj
== NULL
)
6185 /* We have both the objects, use strcoll */
6186 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6189 /* Compare elements directly */
6192 dec1
= getDecodedObject(so1
->obj
);
6193 dec2
= getDecodedObject(so2
->obj
);
6194 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6199 return server
.sort_desc
? -cmp
: cmp
;
6202 /* The SORT command is the most complex command in Redis. Warning: this code
6203 * is optimized for speed and a bit less for readability */
6204 static void sortCommand(redisClient
*c
) {
6207 int desc
= 0, alpha
= 0;
6208 int limit_start
= 0, limit_count
= -1, start
, end
;
6209 int j
, dontsort
= 0, vectorlen
;
6210 int getop
= 0; /* GET operation counter */
6211 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6212 redisSortObject
*vector
; /* Resulting vector to sort */
6214 /* Lookup the key to sort. It must be of the right types */
6215 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6216 if (sortval
== NULL
) {
6217 addReply(c
,shared
.nullmultibulk
);
6220 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6221 sortval
->type
!= REDIS_ZSET
)
6223 addReply(c
,shared
.wrongtypeerr
);
6227 /* Create a list of operations to perform for every sorted element.
6228 * Operations can be GET/DEL/INCR/DECR */
6229 operations
= listCreate();
6230 listSetFreeMethod(operations
,zfree
);
6233 /* Now we need to protect sortval incrementing its count, in the future
6234 * SORT may have options able to overwrite/delete keys during the sorting
6235 * and the sorted key itself may get destroied */
6236 incrRefCount(sortval
);
6238 /* The SORT command has an SQL-alike syntax, parse it */
6239 while(j
< c
->argc
) {
6240 int leftargs
= c
->argc
-j
-1;
6241 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6243 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6245 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6247 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6248 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6249 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6251 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6252 storekey
= c
->argv
[j
+1];
6254 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6255 sortby
= c
->argv
[j
+1];
6256 /* If the BY pattern does not contain '*', i.e. it is constant,
6257 * we don't need to sort nor to lookup the weight keys. */
6258 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6260 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6261 listAddNodeTail(operations
,createSortOperation(
6262 REDIS_SORT_GET
,c
->argv
[j
+1]));
6266 decrRefCount(sortval
);
6267 listRelease(operations
);
6268 addReply(c
,shared
.syntaxerr
);
6274 /* Load the sorting vector with all the objects to sort */
6275 switch(sortval
->type
) {
6276 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6277 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6278 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6279 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6281 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6284 if (sortval
->type
== REDIS_LIST
) {
6285 list
*list
= sortval
->ptr
;
6289 listRewind(list
,&li
);
6290 while((ln
= listNext(&li
))) {
6291 robj
*ele
= ln
->value
;
6292 vector
[j
].obj
= ele
;
6293 vector
[j
].u
.score
= 0;
6294 vector
[j
].u
.cmpobj
= NULL
;
6302 if (sortval
->type
== REDIS_SET
) {
6305 zset
*zs
= sortval
->ptr
;
6309 di
= dictGetIterator(set
);
6310 while((setele
= dictNext(di
)) != NULL
) {
6311 vector
[j
].obj
= dictGetEntryKey(setele
);
6312 vector
[j
].u
.score
= 0;
6313 vector
[j
].u
.cmpobj
= NULL
;
6316 dictReleaseIterator(di
);
6318 redisAssert(j
== vectorlen
);
6320 /* Now it's time to load the right scores in the sorting vector */
6321 if (dontsort
== 0) {
6322 for (j
= 0; j
< vectorlen
; j
++) {
6326 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6327 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6329 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6331 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6332 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6334 /* Don't need to decode the object if it's
6335 * integer-encoded (the only encoding supported) so
6336 * far. We can just cast it */
6337 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6338 vector
[j
].u
.score
= (long)byval
->ptr
;
6340 redisAssert(1 != 1);
6345 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6346 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6348 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6349 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6351 redisAssert(1 != 1);
6358 /* We are ready to sort the vector... perform a bit of sanity check
6359 * on the LIMIT option too. We'll use a partial version of quicksort. */
6360 start
= (limit_start
< 0) ? 0 : limit_start
;
6361 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6362 if (start
>= vectorlen
) {
6363 start
= vectorlen
-1;
6366 if (end
>= vectorlen
) end
= vectorlen
-1;
6368 if (dontsort
== 0) {
6369 server
.sort_desc
= desc
;
6370 server
.sort_alpha
= alpha
;
6371 server
.sort_bypattern
= sortby
? 1 : 0;
6372 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6373 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6375 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6378 /* Send command output to the output buffer, performing the specified
6379 * GET/DEL/INCR/DECR operations if any. */
6380 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6381 if (storekey
== NULL
) {
6382 /* STORE option not specified, sent the sorting result to client */
6383 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6384 for (j
= start
; j
<= end
; j
++) {
6388 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6389 listRewind(operations
,&li
);
6390 while((ln
= listNext(&li
))) {
6391 redisSortOperation
*sop
= ln
->value
;
6392 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6395 if (sop
->type
== REDIS_SORT_GET
) {
6396 if (!val
|| val
->type
!= REDIS_STRING
) {
6397 addReply(c
,shared
.nullbulk
);
6399 addReplyBulk(c
,val
);
6402 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6407 robj
*listObject
= createListObject();
6408 list
*listPtr
= (list
*) listObject
->ptr
;
6410 /* STORE option specified, set the sorting result as a List object */
6411 for (j
= start
; j
<= end
; j
++) {
6416 listAddNodeTail(listPtr
,vector
[j
].obj
);
6417 incrRefCount(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 listAddNodeTail(listPtr
,createStringObject("",0));
6429 listAddNodeTail(listPtr
,val
);
6433 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6437 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6438 incrRefCount(storekey
);
6440 /* Note: we add 1 because the DB is dirty anyway since even if the
6441 * SORT result is empty a new key is set and maybe the old content
6443 server
.dirty
+= 1+outputlen
;
6444 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6448 decrRefCount(sortval
);
6449 listRelease(operations
);
6450 for (j
= 0; j
< vectorlen
; j
++) {
6451 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6452 decrRefCount(vector
[j
].u
.cmpobj
);
6457 /* Convert an amount of bytes into a human readable string in the form
6458 * of 100B, 2G, 100M, 4K, and so forth. */
6459 static void bytesToHuman(char *s
, unsigned long long n
) {
6464 sprintf(s
,"%lluB",n
);
6466 } else if (n
< (1024*1024)) {
6467 d
= (double)n
/(1024);
6468 sprintf(s
,"%.2fK",d
);
6469 } else if (n
< (1024LL*1024*1024)) {
6470 d
= (double)n
/(1024*1024);
6471 sprintf(s
,"%.2fM",d
);
6472 } else if (n
< (1024LL*1024*1024*1024)) {
6473 d
= (double)n
/(1024LL*1024*1024);
6474 sprintf(s
,"%.2fG",d
);
6478 /* Create the string returned by the INFO command. This is decoupled
6479 * by the INFO command itself as we need to report the same information
6480 * on memory corruption problems. */
6481 static sds
genRedisInfoString(void) {
6483 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6487 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
6488 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
6490 bytesToHuman(hmem
,zmalloc_used_memory());
6491 info
= sdscatprintf(sdsempty(),
6492 "redis_version:%s\r\n"
6494 "multiplexing_api:%s\r\n"
6495 "process_id:%ld\r\n"
6496 "uptime_in_seconds:%ld\r\n"
6497 "uptime_in_days:%ld\r\n"
6498 "connected_clients:%d\r\n"
6499 "connected_slaves:%d\r\n"
6500 "blocked_clients:%d\r\n"
6501 "used_memory:%zu\r\n"
6502 "used_memory_human:%s\r\n"
6503 "changes_since_last_save:%lld\r\n"
6504 "bgsave_in_progress:%d\r\n"
6505 "last_save_time:%ld\r\n"
6506 "bgrewriteaof_in_progress:%d\r\n"
6507 "total_connections_received:%lld\r\n"
6508 "total_commands_processed:%lld\r\n"
6509 "hash_max_zipmap_entries:%ld\r\n"
6510 "hash_max_zipmap_value:%ld\r\n"
6514 (sizeof(long) == 8) ? "64" : "32",
6519 listLength(server
.clients
)-listLength(server
.slaves
),
6520 listLength(server
.slaves
),
6521 server
.blpop_blocked_clients
,
6522 zmalloc_used_memory(),
6525 server
.bgsavechildpid
!= -1,
6527 server
.bgrewritechildpid
!= -1,
6528 server
.stat_numconnections
,
6529 server
.stat_numcommands
,
6530 server
.hash_max_zipmap_entries
,
6531 server
.hash_max_zipmap_value
,
6532 server
.vm_enabled
!= 0,
6533 server
.masterhost
== NULL
? "master" : "slave"
6535 if (server
.masterhost
) {
6536 info
= sdscatprintf(info
,
6537 "master_host:%s\r\n"
6538 "master_port:%d\r\n"
6539 "master_link_status:%s\r\n"
6540 "master_last_io_seconds_ago:%d\r\n"
6543 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6545 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6548 if (server
.vm_enabled
) {
6550 info
= sdscatprintf(info
,
6551 "vm_conf_max_memory:%llu\r\n"
6552 "vm_conf_page_size:%llu\r\n"
6553 "vm_conf_pages:%llu\r\n"
6554 "vm_stats_used_pages:%llu\r\n"
6555 "vm_stats_swapped_objects:%llu\r\n"
6556 "vm_stats_swappin_count:%llu\r\n"
6557 "vm_stats_swappout_count:%llu\r\n"
6558 "vm_stats_io_newjobs_len:%lu\r\n"
6559 "vm_stats_io_processing_len:%lu\r\n"
6560 "vm_stats_io_processed_len:%lu\r\n"
6561 "vm_stats_io_active_threads:%lu\r\n"
6562 "vm_stats_blocked_clients:%lu\r\n"
6563 ,(unsigned long long) server
.vm_max_memory
,
6564 (unsigned long long) server
.vm_page_size
,
6565 (unsigned long long) server
.vm_pages
,
6566 (unsigned long long) server
.vm_stats_used_pages
,
6567 (unsigned long long) server
.vm_stats_swapped_objects
,
6568 (unsigned long long) server
.vm_stats_swapins
,
6569 (unsigned long long) server
.vm_stats_swapouts
,
6570 (unsigned long) listLength(server
.io_newjobs
),
6571 (unsigned long) listLength(server
.io_processing
),
6572 (unsigned long) listLength(server
.io_processed
),
6573 (unsigned long) server
.io_active_threads
,
6574 (unsigned long) server
.vm_blocked_clients
6578 for (j
= 0; j
< server
.dbnum
; j
++) {
6579 long long keys
, vkeys
;
6581 keys
= dictSize(server
.db
[j
].dict
);
6582 vkeys
= dictSize(server
.db
[j
].expires
);
6583 if (keys
|| vkeys
) {
6584 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6591 static void infoCommand(redisClient
*c
) {
6592 sds info
= genRedisInfoString();
6593 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6594 (unsigned long)sdslen(info
)));
6595 addReplySds(c
,info
);
6596 addReply(c
,shared
.crlf
);
6599 static void monitorCommand(redisClient
*c
) {
6600 /* ignore MONITOR if aleady slave or in monitor mode */
6601 if (c
->flags
& REDIS_SLAVE
) return;
6603 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6605 listAddNodeTail(server
.monitors
,c
);
6606 addReply(c
,shared
.ok
);
6609 /* ================================= Expire ================================= */
6610 static int removeExpire(redisDb
*db
, robj
*key
) {
6611 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6618 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6619 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6627 /* Return the expire time of the specified key, or -1 if no expire
6628 * is associated with this key (i.e. the key is non volatile) */
6629 static time_t getExpire(redisDb
*db
, robj
*key
) {
6632 /* No expire? return ASAP */
6633 if (dictSize(db
->expires
) == 0 ||
6634 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6636 return (time_t) dictGetEntryVal(de
);
6639 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6643 /* No expire? return ASAP */
6644 if (dictSize(db
->expires
) == 0 ||
6645 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6647 /* Lookup the expire */
6648 when
= (time_t) dictGetEntryVal(de
);
6649 if (time(NULL
) <= when
) return 0;
6651 /* Delete the key */
6652 dictDelete(db
->expires
,key
);
6653 return dictDelete(db
->dict
,key
) == DICT_OK
;
6656 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6659 /* No expire? return ASAP */
6660 if (dictSize(db
->expires
) == 0 ||
6661 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6663 /* Delete the key */
6665 dictDelete(db
->expires
,key
);
6666 return dictDelete(db
->dict
,key
) == DICT_OK
;
6669 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6672 de
= dictFind(c
->db
->dict
,key
);
6674 addReply(c
,shared
.czero
);
6678 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6679 addReply(c
, shared
.cone
);
6682 time_t when
= time(NULL
)+seconds
;
6683 if (setExpire(c
->db
,key
,when
)) {
6684 addReply(c
,shared
.cone
);
6687 addReply(c
,shared
.czero
);
6693 static void expireCommand(redisClient
*c
) {
6694 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6697 static void expireatCommand(redisClient
*c
) {
6698 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6701 static void ttlCommand(redisClient
*c
) {
6705 expire
= getExpire(c
->db
,c
->argv
[1]);
6707 ttl
= (int) (expire
-time(NULL
));
6708 if (ttl
< 0) ttl
= -1;
6710 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6713 /* ================================ MULTI/EXEC ============================== */
6715 /* Client state initialization for MULTI/EXEC */
6716 static void initClientMultiState(redisClient
*c
) {
6717 c
->mstate
.commands
= NULL
;
6718 c
->mstate
.count
= 0;
6721 /* Release all the resources associated with MULTI/EXEC state */
6722 static void freeClientMultiState(redisClient
*c
) {
6725 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6727 multiCmd
*mc
= c
->mstate
.commands
+j
;
6729 for (i
= 0; i
< mc
->argc
; i
++)
6730 decrRefCount(mc
->argv
[i
]);
6733 zfree(c
->mstate
.commands
);
6736 /* Add a new command into the MULTI commands queue */
6737 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6741 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6742 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6743 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6746 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6747 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6748 for (j
= 0; j
< c
->argc
; j
++)
6749 incrRefCount(mc
->argv
[j
]);
6753 static void multiCommand(redisClient
*c
) {
6754 c
->flags
|= REDIS_MULTI
;
6755 addReply(c
,shared
.ok
);
6758 static void discardCommand(redisClient
*c
) {
6759 if (!(c
->flags
& REDIS_MULTI
)) {
6760 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6764 freeClientMultiState(c
);
6765 initClientMultiState(c
);
6766 c
->flags
&= (~REDIS_MULTI
);
6767 addReply(c
,shared
.ok
);
6770 static void execCommand(redisClient
*c
) {
6775 if (!(c
->flags
& REDIS_MULTI
)) {
6776 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6780 orig_argv
= c
->argv
;
6781 orig_argc
= c
->argc
;
6782 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6783 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6784 c
->argc
= c
->mstate
.commands
[j
].argc
;
6785 c
->argv
= c
->mstate
.commands
[j
].argv
;
6786 call(c
,c
->mstate
.commands
[j
].cmd
);
6788 c
->argv
= orig_argv
;
6789 c
->argc
= orig_argc
;
6790 freeClientMultiState(c
);
6791 initClientMultiState(c
);
6792 c
->flags
&= (~REDIS_MULTI
);
6795 /* =========================== Blocking Operations ========================= */
6797 /* Currently Redis blocking operations support is limited to list POP ops,
6798 * so the current implementation is not fully generic, but it is also not
6799 * completely specific so it will not require a rewrite to support new
6800 * kind of blocking operations in the future.
6802 * Still it's important to note that list blocking operations can be already
6803 * used as a notification mechanism in order to implement other blocking
6804 * operations at application level, so there must be a very strong evidence
6805 * of usefulness and generality before new blocking operations are implemented.
6807 * This is how the current blocking POP works, we use BLPOP as example:
6808 * - If the user calls BLPOP and the key exists and contains a non empty list
6809 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6810 * if there is not to block.
6811 * - If instead BLPOP is called and the key does not exists or the list is
6812 * empty we need to block. In order to do so we remove the notification for
6813 * new data to read in the client socket (so that we'll not serve new
6814 * requests if the blocking request is not served). Also we put the client
6815 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6816 * blocking for this keys.
6817 * - If a PUSH operation against a key with blocked clients waiting is
6818 * performed, we serve the first in the list: basically instead to push
6819 * the new element inside the list we return it to the (first / oldest)
6820 * blocking client, unblock the client, and remove it form the list.
6822 * The above comment and the source code should be enough in order to understand
6823 * the implementation and modify / fix it later.
6826 /* Set a client in blocking mode for the specified key, with the specified
6828 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6833 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6834 c
->blockingkeysnum
= numkeys
;
6835 c
->blockingto
= timeout
;
6836 for (j
= 0; j
< numkeys
; j
++) {
6837 /* Add the key in the client structure, to map clients -> keys */
6838 c
->blockingkeys
[j
] = keys
[j
];
6839 incrRefCount(keys
[j
]);
6841 /* And in the other "side", to map keys -> clients */
6842 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6846 /* For every key we take a list of clients blocked for it */
6848 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6849 incrRefCount(keys
[j
]);
6850 assert(retval
== DICT_OK
);
6852 l
= dictGetEntryVal(de
);
6854 listAddNodeTail(l
,c
);
6856 /* Mark the client as a blocked client */
6857 c
->flags
|= REDIS_BLOCKED
;
6858 server
.blpop_blocked_clients
++;
6861 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6862 static void unblockClientWaitingData(redisClient
*c
) {
6867 assert(c
->blockingkeys
!= NULL
);
6868 /* The client may wait for multiple keys, so unblock it for every key. */
6869 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6870 /* Remove this client from the list of clients waiting for this key. */
6871 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6873 l
= dictGetEntryVal(de
);
6874 listDelNode(l
,listSearchKey(l
,c
));
6875 /* If the list is empty we need to remove it to avoid wasting memory */
6876 if (listLength(l
) == 0)
6877 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6878 decrRefCount(c
->blockingkeys
[j
]);
6880 /* Cleanup the client structure */
6881 zfree(c
->blockingkeys
);
6882 c
->blockingkeys
= NULL
;
6883 c
->flags
&= (~REDIS_BLOCKED
);
6884 server
.blpop_blocked_clients
--;
6885 /* We want to process data if there is some command waiting
6886 * in the input buffer. Note that this is safe even if
6887 * unblockClientWaitingData() gets called from freeClient() because
6888 * freeClient() will be smart enough to call this function
6889 * *after* c->querybuf was set to NULL. */
6890 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6893 /* This should be called from any function PUSHing into lists.
6894 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6895 * 'ele' is the element pushed.
6897 * If the function returns 0 there was no client waiting for a list push
6900 * If the function returns 1 there was a client waiting for a list push
6901 * against this key, the element was passed to this client thus it's not
6902 * needed to actually add it to the list and the caller should return asap. */
6903 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6904 struct dictEntry
*de
;
6905 redisClient
*receiver
;
6909 de
= dictFind(c
->db
->blockingkeys
,key
);
6910 if (de
== NULL
) return 0;
6911 l
= dictGetEntryVal(de
);
6914 receiver
= ln
->value
;
6916 addReplySds(receiver
,sdsnew("*2\r\n"));
6917 addReplyBulk(receiver
,key
);
6918 addReplyBulk(receiver
,ele
);
6919 unblockClientWaitingData(receiver
);
6923 /* Blocking RPOP/LPOP */
6924 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6929 for (j
= 1; j
< c
->argc
-1; j
++) {
6930 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6932 if (o
->type
!= REDIS_LIST
) {
6933 addReply(c
,shared
.wrongtypeerr
);
6936 list
*list
= o
->ptr
;
6937 if (listLength(list
) != 0) {
6938 /* If the list contains elements fall back to the usual
6939 * non-blocking POP operation */
6940 robj
*argv
[2], **orig_argv
;
6943 /* We need to alter the command arguments before to call
6944 * popGenericCommand() as the command takes a single key. */
6945 orig_argv
= c
->argv
;
6946 orig_argc
= c
->argc
;
6947 argv
[1] = c
->argv
[j
];
6951 /* Also the return value is different, we need to output
6952 * the multi bulk reply header and the key name. The
6953 * "real" command will add the last element (the value)
6954 * for us. If this souds like an hack to you it's just
6955 * because it is... */
6956 addReplySds(c
,sdsnew("*2\r\n"));
6957 addReplyBulk(c
,argv
[1]);
6958 popGenericCommand(c
,where
);
6960 /* Fix the client structure with the original stuff */
6961 c
->argv
= orig_argv
;
6962 c
->argc
= orig_argc
;
6968 /* If the list is empty or the key does not exists we must block */
6969 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6970 if (timeout
> 0) timeout
+= time(NULL
);
6971 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6974 static void blpopCommand(redisClient
*c
) {
6975 blockingPopGenericCommand(c
,REDIS_HEAD
);
6978 static void brpopCommand(redisClient
*c
) {
6979 blockingPopGenericCommand(c
,REDIS_TAIL
);
6982 /* =============================== Replication ============================= */
6984 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6985 ssize_t nwritten
, ret
= size
;
6986 time_t start
= time(NULL
);
6990 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6991 nwritten
= write(fd
,ptr
,size
);
6992 if (nwritten
== -1) return -1;
6996 if ((time(NULL
)-start
) > timeout
) {
7004 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7005 ssize_t nread
, totread
= 0;
7006 time_t start
= time(NULL
);
7010 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7011 nread
= read(fd
,ptr
,size
);
7012 if (nread
== -1) return -1;
7017 if ((time(NULL
)-start
) > timeout
) {
7025 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7032 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7035 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7046 static void syncCommand(redisClient
*c
) {
7047 /* ignore SYNC if aleady slave or in monitor mode */
7048 if (c
->flags
& REDIS_SLAVE
) return;
7050 /* SYNC can't be issued when the server has pending data to send to
7051 * the client about already issued commands. We need a fresh reply
7052 * buffer registering the differences between the BGSAVE and the current
7053 * dataset, so that we can copy to other slaves if needed. */
7054 if (listLength(c
->reply
) != 0) {
7055 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7059 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7060 /* Here we need to check if there is a background saving operation
7061 * in progress, or if it is required to start one */
7062 if (server
.bgsavechildpid
!= -1) {
7063 /* Ok a background save is in progress. Let's check if it is a good
7064 * one for replication, i.e. if there is another slave that is
7065 * registering differences since the server forked to save */
7070 listRewind(server
.slaves
,&li
);
7071 while((ln
= listNext(&li
))) {
7073 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7076 /* Perfect, the server is already registering differences for
7077 * another slave. Set the right state, and copy the buffer. */
7078 listRelease(c
->reply
);
7079 c
->reply
= listDup(slave
->reply
);
7080 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7081 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7083 /* No way, we need to wait for the next BGSAVE in order to
7084 * register differences */
7085 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7086 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7089 /* Ok we don't have a BGSAVE in progress, let's start one */
7090 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7091 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7092 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7093 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7096 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7099 c
->flags
|= REDIS_SLAVE
;
7101 listAddNodeTail(server
.slaves
,c
);
7105 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7106 redisClient
*slave
= privdata
;
7108 REDIS_NOTUSED(mask
);
7109 char buf
[REDIS_IOBUF_LEN
];
7110 ssize_t nwritten
, buflen
;
7112 if (slave
->repldboff
== 0) {
7113 /* Write the bulk write count before to transfer the DB. In theory here
7114 * we don't know how much room there is in the output buffer of the
7115 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7116 * operations) will never be smaller than the few bytes we need. */
7119 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7121 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7129 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7130 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7132 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7133 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7137 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7138 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7143 slave
->repldboff
+= nwritten
;
7144 if (slave
->repldboff
== slave
->repldbsize
) {
7145 close(slave
->repldbfd
);
7146 slave
->repldbfd
= -1;
7147 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7148 slave
->replstate
= REDIS_REPL_ONLINE
;
7149 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7150 sendReplyToClient
, slave
) == AE_ERR
) {
7154 addReplySds(slave
,sdsempty());
7155 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7159 /* This function is called at the end of every backgrond saving.
7160 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7161 * otherwise REDIS_ERR is passed to the function.
7163 * The goal of this function is to handle slaves waiting for a successful
7164 * background saving in order to perform non-blocking synchronization. */
7165 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7167 int startbgsave
= 0;
7170 listRewind(server
.slaves
,&li
);
7171 while((ln
= listNext(&li
))) {
7172 redisClient
*slave
= ln
->value
;
7174 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7176 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7177 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7178 struct redis_stat buf
;
7180 if (bgsaveerr
!= REDIS_OK
) {
7182 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7185 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7186 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7188 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7191 slave
->repldboff
= 0;
7192 slave
->repldbsize
= buf
.st_size
;
7193 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7194 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7195 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7202 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7205 listRewind(server
.slaves
,&li
);
7206 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7207 while((ln
= listNext(&li
))) {
7208 redisClient
*slave
= ln
->value
;
7210 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7217 static int syncWithMaster(void) {
7218 char buf
[1024], tmpfile
[256], authcmd
[1024];
7220 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7221 int dfd
, maxtries
= 5;
7224 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7229 /* AUTH with the master if required. */
7230 if(server
.masterauth
) {
7231 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7232 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7234 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7238 /* Read the AUTH result. */
7239 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7241 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7245 if (buf
[0] != '+') {
7247 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7252 /* Issue the SYNC command */
7253 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7255 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7259 /* Read the bulk write count */
7260 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7262 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7266 if (buf
[0] != '$') {
7268 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7271 dumpsize
= strtol(buf
+1,NULL
,10);
7272 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7273 /* Read the bulk write data on a temp file */
7275 snprintf(tmpfile
,256,
7276 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7277 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7278 if (dfd
!= -1) break;
7283 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7287 int nread
, nwritten
;
7289 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7291 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7297 nwritten
= write(dfd
,buf
,nread
);
7298 if (nwritten
== -1) {
7299 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7307 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7308 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7314 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7315 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7319 server
.master
= createClient(fd
);
7320 server
.master
->flags
|= REDIS_MASTER
;
7321 server
.master
->authenticated
= 1;
7322 server
.replstate
= REDIS_REPL_CONNECTED
;
7326 static void slaveofCommand(redisClient
*c
) {
7327 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7328 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7329 if (server
.masterhost
) {
7330 sdsfree(server
.masterhost
);
7331 server
.masterhost
= NULL
;
7332 if (server
.master
) freeClient(server
.master
);
7333 server
.replstate
= REDIS_REPL_NONE
;
7334 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7337 sdsfree(server
.masterhost
);
7338 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7339 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7340 if (server
.master
) freeClient(server
.master
);
7341 server
.replstate
= REDIS_REPL_CONNECT
;
7342 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7343 server
.masterhost
, server
.masterport
);
7345 addReply(c
,shared
.ok
);
7348 /* ============================ Maxmemory directive ======================== */
7350 /* Try to free one object form the pre-allocated objects free list.
7351 * This is useful under low mem conditions as by default we take 1 million
7352 * free objects allocated. On success REDIS_OK is returned, otherwise
7354 static int tryFreeOneObjectFromFreelist(void) {
7357 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7358 if (listLength(server
.objfreelist
)) {
7359 listNode
*head
= listFirst(server
.objfreelist
);
7360 o
= listNodeValue(head
);
7361 listDelNode(server
.objfreelist
,head
);
7362 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7366 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7371 /* This function gets called when 'maxmemory' is set on the config file to limit
7372 * the max memory used by the server, and we are out of memory.
7373 * This function will try to, in order:
7375 * - Free objects from the free list
7376 * - Try to remove keys with an EXPIRE set
7378 * It is not possible to free enough memory to reach used-memory < maxmemory
7379 * the server will start refusing commands that will enlarge even more the
7382 static void freeMemoryIfNeeded(void) {
7383 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7384 int j
, k
, freed
= 0;
7386 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7387 for (j
= 0; j
< server
.dbnum
; j
++) {
7389 robj
*minkey
= NULL
;
7390 struct dictEntry
*de
;
7392 if (dictSize(server
.db
[j
].expires
)) {
7394 /* From a sample of three keys drop the one nearest to
7395 * the natural expire */
7396 for (k
= 0; k
< 3; k
++) {
7399 de
= dictGetRandomKey(server
.db
[j
].expires
);
7400 t
= (time_t) dictGetEntryVal(de
);
7401 if (minttl
== -1 || t
< minttl
) {
7402 minkey
= dictGetEntryKey(de
);
7406 deleteKey(server
.db
+j
,minkey
);
7409 if (!freed
) return; /* nothing to free... */
7413 /* ============================== Append Only file ========================== */
7415 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7416 sds buf
= sdsempty();
7422 /* The DB this command was targetting is not the same as the last command
7423 * we appendend. To issue a SELECT command is needed. */
7424 if (dictid
!= server
.appendseldb
) {
7427 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7428 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7429 (unsigned long)strlen(seldb
),seldb
);
7430 server
.appendseldb
= dictid
;
7433 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7434 * EXPIREs into EXPIREATs calls */
7435 if (cmd
->proc
== expireCommand
) {
7438 tmpargv
[0] = createStringObject("EXPIREAT",8);
7439 tmpargv
[1] = argv
[1];
7440 incrRefCount(argv
[1]);
7441 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7442 tmpargv
[2] = createObject(REDIS_STRING
,
7443 sdscatprintf(sdsempty(),"%ld",when
));
7447 /* Append the actual command */
7448 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7449 for (j
= 0; j
< argc
; j
++) {
7452 o
= getDecodedObject(o
);
7453 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7454 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7455 buf
= sdscatlen(buf
,"\r\n",2);
7459 /* Free the objects from the modified argv for EXPIREAT */
7460 if (cmd
->proc
== expireCommand
) {
7461 for (j
= 0; j
< 3; j
++)
7462 decrRefCount(argv
[j
]);
7465 /* We want to perform a single write. This should be guaranteed atomic
7466 * at least if the filesystem we are writing is a real physical one.
7467 * While this will save us against the server being killed I don't think
7468 * there is much to do about the whole server stopping for power problems
7470 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7471 if (nwritten
!= (signed)sdslen(buf
)) {
7472 /* Ooops, we are in troubles. The best thing to do for now is
7473 * to simply exit instead to give the illusion that everything is
7474 * working as expected. */
7475 if (nwritten
== -1) {
7476 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7478 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7482 /* If a background append only file rewriting is in progress we want to
7483 * accumulate the differences between the child DB and the current one
7484 * in a buffer, so that when the child process will do its work we
7485 * can append the differences to the new append only file. */
7486 if (server
.bgrewritechildpid
!= -1)
7487 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7491 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7492 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7493 now
-server
.lastfsync
> 1))
7495 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7496 server
.lastfsync
= now
;
7500 /* In Redis commands are always executed in the context of a client, so in
7501 * order to load the append only file we need to create a fake client. */
7502 static struct redisClient
*createFakeClient(void) {
7503 struct redisClient
*c
= zmalloc(sizeof(*c
));
7507 c
->querybuf
= sdsempty();
7511 /* We set the fake client as a slave waiting for the synchronization
7512 * so that Redis will not try to send replies to this client. */
7513 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7514 c
->reply
= listCreate();
7515 listSetFreeMethod(c
->reply
,decrRefCount
);
7516 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7520 static void freeFakeClient(struct redisClient
*c
) {
7521 sdsfree(c
->querybuf
);
7522 listRelease(c
->reply
);
7526 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7527 * error (the append only file is zero-length) REDIS_ERR is returned. On
7528 * fatal error an error message is logged and the program exists. */
7529 int loadAppendOnlyFile(char *filename
) {
7530 struct redisClient
*fakeClient
;
7531 FILE *fp
= fopen(filename
,"r");
7532 struct redis_stat sb
;
7533 unsigned long long loadedkeys
= 0;
7535 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7539 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7543 fakeClient
= createFakeClient();
7550 struct redisCommand
*cmd
;
7552 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7558 if (buf
[0] != '*') goto fmterr
;
7560 argv
= zmalloc(sizeof(robj
*)*argc
);
7561 for (j
= 0; j
< argc
; j
++) {
7562 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7563 if (buf
[0] != '$') goto fmterr
;
7564 len
= strtol(buf
+1,NULL
,10);
7565 argsds
= sdsnewlen(NULL
,len
);
7566 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7567 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7568 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7571 /* Command lookup */
7572 cmd
= lookupCommand(argv
[0]->ptr
);
7574 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7577 /* Try object sharing and encoding */
7578 if (server
.shareobjects
) {
7580 for(j
= 1; j
< argc
; j
++)
7581 argv
[j
] = tryObjectSharing(argv
[j
]);
7583 if (cmd
->flags
& REDIS_CMD_BULK
)
7584 tryObjectEncoding(argv
[argc
-1]);
7585 /* Run the command in the context of a fake client */
7586 fakeClient
->argc
= argc
;
7587 fakeClient
->argv
= argv
;
7588 cmd
->proc(fakeClient
);
7589 /* Discard the reply objects list from the fake client */
7590 while(listLength(fakeClient
->reply
))
7591 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7592 /* Clean up, ready for the next command */
7593 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7595 /* Handle swapping while loading big datasets when VM is on */
7597 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7598 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7599 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7604 freeFakeClient(fakeClient
);
7609 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7611 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7615 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7619 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7620 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7624 /* Avoid the incr/decr ref count business if possible to help
7625 * copy-on-write (we are often in a child process when this function
7627 * Also makes sure that key objects don't get incrRefCount-ed when VM
7629 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7630 obj
= getDecodedObject(obj
);
7633 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7634 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7635 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7637 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7638 if (decrrc
) decrRefCount(obj
);
7641 if (decrrc
) decrRefCount(obj
);
7645 /* Write binary-safe string into a file in the bulkformat
7646 * $<count>\r\n<payload>\r\n */
7647 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7650 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7651 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7652 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7653 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7657 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7658 static int fwriteBulkDouble(FILE *fp
, double d
) {
7659 char buf
[128], dbuf
[128];
7661 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7662 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7663 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7664 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7668 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7669 static int fwriteBulkLong(FILE *fp
, long l
) {
7670 char buf
[128], lbuf
[128];
7672 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7673 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7674 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7675 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7679 /* Write a sequence of commands able to fully rebuild the dataset into
7680 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7681 static int rewriteAppendOnlyFile(char *filename
) {
7682 dictIterator
*di
= NULL
;
7687 time_t now
= time(NULL
);
7689 /* Note that we have to use a different temp name here compared to the
7690 * one used by rewriteAppendOnlyFileBackground() function. */
7691 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7692 fp
= fopen(tmpfile
,"w");
7694 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7697 for (j
= 0; j
< server
.dbnum
; j
++) {
7698 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7699 redisDb
*db
= server
.db
+j
;
7701 if (dictSize(d
) == 0) continue;
7702 di
= dictGetIterator(d
);
7708 /* SELECT the new DB */
7709 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7710 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7712 /* Iterate this DB writing every entry */
7713 while((de
= dictNext(di
)) != NULL
) {
7718 key
= dictGetEntryKey(de
);
7719 /* If the value for this key is swapped, load a preview in memory.
7720 * We use a "swapped" flag to remember if we need to free the
7721 * value object instead to just increment the ref count anyway
7722 * in order to avoid copy-on-write of pages if we are forked() */
7723 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7724 key
->storage
== REDIS_VM_SWAPPING
) {
7725 o
= dictGetEntryVal(de
);
7728 o
= vmPreviewObject(key
);
7731 expiretime
= getExpire(db
,key
);
7733 /* Save the key and associated value */
7734 if (o
->type
== REDIS_STRING
) {
7735 /* Emit a SET command */
7736 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7737 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7739 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7740 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7741 } else if (o
->type
== REDIS_LIST
) {
7742 /* Emit the RPUSHes needed to rebuild the list */
7743 list
*list
= o
->ptr
;
7747 listRewind(list
,&li
);
7748 while((ln
= listNext(&li
))) {
7749 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7750 robj
*eleobj
= listNodeValue(ln
);
7752 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7753 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7754 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7756 } else if (o
->type
== REDIS_SET
) {
7757 /* Emit the SADDs needed to rebuild the set */
7759 dictIterator
*di
= dictGetIterator(set
);
7762 while((de
= dictNext(di
)) != NULL
) {
7763 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7764 robj
*eleobj
= dictGetEntryKey(de
);
7766 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7767 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7768 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7770 dictReleaseIterator(di
);
7771 } else if (o
->type
== REDIS_ZSET
) {
7772 /* Emit the ZADDs needed to rebuild the sorted set */
7774 dictIterator
*di
= dictGetIterator(zs
->dict
);
7777 while((de
= dictNext(di
)) != NULL
) {
7778 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7779 robj
*eleobj
= dictGetEntryKey(de
);
7780 double *score
= dictGetEntryVal(de
);
7782 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7783 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7784 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7785 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7787 dictReleaseIterator(di
);
7788 } else if (o
->type
== REDIS_HASH
) {
7789 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7791 /* Emit the HSETs needed to rebuild the hash */
7792 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7793 unsigned char *p
= zipmapRewind(o
->ptr
);
7794 unsigned char *field
, *val
;
7795 unsigned int flen
, vlen
;
7797 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
7798 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7799 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7800 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
7802 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
7806 dictIterator
*di
= dictGetIterator(o
->ptr
);
7809 while((de
= dictNext(di
)) != NULL
) {
7810 robj
*field
= dictGetEntryKey(de
);
7811 robj
*val
= dictGetEntryVal(de
);
7813 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7814 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7815 if (fwriteBulkObject(fp
,field
) == -1) return -1;
7816 if (fwriteBulkObject(fp
,val
) == -1) return -1;
7818 dictReleaseIterator(di
);
7823 /* Save the expire time */
7824 if (expiretime
!= -1) {
7825 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7826 /* If this key is already expired skip it */
7827 if (expiretime
< now
) continue;
7828 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7829 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7830 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7832 if (swapped
) decrRefCount(o
);
7834 dictReleaseIterator(di
);
7837 /* Make sure data will not remain on the OS's output buffers */
7842 /* Use RENAME to make sure the DB file is changed atomically only
7843 * if the generate DB file is ok. */
7844 if (rename(tmpfile
,filename
) == -1) {
7845 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7849 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7855 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7856 if (di
) dictReleaseIterator(di
);
7860 /* This is how rewriting of the append only file in background works:
7862 * 1) The user calls BGREWRITEAOF
7863 * 2) Redis calls this function, that forks():
7864 * 2a) the child rewrite the append only file in a temp file.
7865 * 2b) the parent accumulates differences in server.bgrewritebuf.
7866 * 3) When the child finished '2a' exists.
7867 * 4) The parent will trap the exit code, if it's OK, will append the
7868 * data accumulated into server.bgrewritebuf into the temp file, and
7869 * finally will rename(2) the temp file in the actual file name.
7870 * The the new file is reopened as the new append only file. Profit!
7872 static int rewriteAppendOnlyFileBackground(void) {
7875 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7876 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7877 if ((childpid
= fork()) == 0) {
7881 if (server
.vm_enabled
) vmReopenSwapFile();
7883 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7884 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7891 if (childpid
== -1) {
7892 redisLog(REDIS_WARNING
,
7893 "Can't rewrite append only file in background: fork: %s",
7897 redisLog(REDIS_NOTICE
,
7898 "Background append only file rewriting started by pid %d",childpid
);
7899 server
.bgrewritechildpid
= childpid
;
7900 /* We set appendseldb to -1 in order to force the next call to the
7901 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7902 * accumulated by the parent into server.bgrewritebuf will start
7903 * with a SELECT statement and it will be safe to merge. */
7904 server
.appendseldb
= -1;
7907 return REDIS_OK
; /* unreached */
7910 static void bgrewriteaofCommand(redisClient
*c
) {
7911 if (server
.bgrewritechildpid
!= -1) {
7912 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7915 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7916 char *status
= "+Background append only file rewriting started\r\n";
7917 addReplySds(c
,sdsnew(status
));
7919 addReply(c
,shared
.err
);
7923 static void aofRemoveTempFile(pid_t childpid
) {
7926 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7930 /* Virtual Memory is composed mainly of two subsystems:
7931 * - Blocking Virutal Memory
7932 * - Threaded Virtual Memory I/O
7933 * The two parts are not fully decoupled, but functions are split among two
7934 * different sections of the source code (delimited by comments) in order to
7935 * make more clear what functionality is about the blocking VM and what about
7936 * the threaded (not blocking) VM.
7940 * Redis VM is a blocking VM (one that blocks reading swapped values from
7941 * disk into memory when a value swapped out is needed in memory) that is made
7942 * unblocking by trying to examine the command argument vector in order to
7943 * load in background values that will likely be needed in order to exec
7944 * the command. The command is executed only once all the relevant keys
7945 * are loaded into memory.
7947 * This basically is almost as simple of a blocking VM, but almost as parallel
7948 * as a fully non-blocking VM.
7951 /* =================== Virtual Memory - Blocking Side ====================== */
7953 /* substitute the first occurrence of '%p' with the process pid in the
7954 * swap file name. */
7955 static void expandVmSwapFilename(void) {
7956 char *p
= strstr(server
.vm_swap_file
,"%p");
7962 new = sdscat(new,server
.vm_swap_file
);
7963 new = sdscatprintf(new,"%ld",(long) getpid());
7964 new = sdscat(new,p
+2);
7965 zfree(server
.vm_swap_file
);
7966 server
.vm_swap_file
= new;
7969 static void vmInit(void) {
7974 if (server
.vm_max_threads
!= 0)
7975 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7977 expandVmSwapFilename();
7978 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7979 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7980 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7982 if (server
.vm_fp
== NULL
) {
7983 redisLog(REDIS_WARNING
,
7984 "Impossible to open the swap file: %s. Exiting.",
7988 server
.vm_fd
= fileno(server
.vm_fp
);
7989 server
.vm_next_page
= 0;
7990 server
.vm_near_pages
= 0;
7991 server
.vm_stats_used_pages
= 0;
7992 server
.vm_stats_swapped_objects
= 0;
7993 server
.vm_stats_swapouts
= 0;
7994 server
.vm_stats_swapins
= 0;
7995 totsize
= server
.vm_pages
*server
.vm_page_size
;
7996 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7997 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7998 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8002 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8004 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8005 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8006 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8007 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8009 /* Initialize threaded I/O (used by Virtual Memory) */
8010 server
.io_newjobs
= listCreate();
8011 server
.io_processing
= listCreate();
8012 server
.io_processed
= listCreate();
8013 server
.io_ready_clients
= listCreate();
8014 pthread_mutex_init(&server
.io_mutex
,NULL
);
8015 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8016 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8017 server
.io_active_threads
= 0;
8018 if (pipe(pipefds
) == -1) {
8019 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8023 server
.io_ready_pipe_read
= pipefds
[0];
8024 server
.io_ready_pipe_write
= pipefds
[1];
8025 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8026 /* LZF requires a lot of stack */
8027 pthread_attr_init(&server
.io_threads_attr
);
8028 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8029 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8030 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8031 /* Listen for events in the threaded I/O pipe */
8032 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8033 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8034 oom("creating file event");
8037 /* Mark the page as used */
8038 static void vmMarkPageUsed(off_t page
) {
8039 off_t byte
= page
/8;
8041 redisAssert(vmFreePage(page
) == 1);
8042 server
.vm_bitmap
[byte
] |= 1<<bit
;
8045 /* Mark N contiguous pages as used, with 'page' being the first. */
8046 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8049 for (j
= 0; j
< count
; j
++)
8050 vmMarkPageUsed(page
+j
);
8051 server
.vm_stats_used_pages
+= count
;
8052 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8053 (long long)count
, (long long)page
);
8056 /* Mark the page as free */
8057 static void vmMarkPageFree(off_t page
) {
8058 off_t byte
= page
/8;
8060 redisAssert(vmFreePage(page
) == 0);
8061 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8064 /* Mark N contiguous pages as free, with 'page' being the first. */
8065 static void vmMarkPagesFree(off_t page
, off_t count
) {
8068 for (j
= 0; j
< count
; j
++)
8069 vmMarkPageFree(page
+j
);
8070 server
.vm_stats_used_pages
-= count
;
8071 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8072 (long long)count
, (long long)page
);
8075 /* Test if the page is free */
8076 static int vmFreePage(off_t page
) {
8077 off_t byte
= page
/8;
8079 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8082 /* Find N contiguous free pages storing the first page of the cluster in *first.
8083 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8084 * REDIS_ERR is returned.
8086 * This function uses a simple algorithm: we try to allocate
8087 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8088 * again from the start of the swap file searching for free spaces.
8090 * If it looks pretty clear that there are no free pages near our offset
8091 * we try to find less populated places doing a forward jump of
8092 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8093 * without hurry, and then we jump again and so forth...
8095 * This function can be improved using a free list to avoid to guess
8096 * too much, since we could collect data about freed pages.
8098 * note: I implemented this function just after watching an episode of
8099 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8101 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8102 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8104 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8105 server
.vm_near_pages
= 0;
8106 server
.vm_next_page
= 0;
8108 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8109 base
= server
.vm_next_page
;
8111 while(offset
< server
.vm_pages
) {
8112 off_t
this = base
+offset
;
8114 /* If we overflow, restart from page zero */
8115 if (this >= server
.vm_pages
) {
8116 this -= server
.vm_pages
;
8118 /* Just overflowed, what we found on tail is no longer
8119 * interesting, as it's no longer contiguous. */
8123 if (vmFreePage(this)) {
8124 /* This is a free page */
8126 /* Already got N free pages? Return to the caller, with success */
8128 *first
= this-(n
-1);
8129 server
.vm_next_page
= this+1;
8130 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8134 /* The current one is not a free page */
8138 /* Fast-forward if the current page is not free and we already
8139 * searched enough near this place. */
8141 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8142 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8144 /* Note that even if we rewind after the jump, we are don't need
8145 * to make sure numfree is set to zero as we only jump *if* it
8146 * is set to zero. */
8148 /* Otherwise just check the next page */
8155 /* Write the specified object at the specified page of the swap file */
8156 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8157 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8158 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8159 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8160 redisLog(REDIS_WARNING
,
8161 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8165 rdbSaveObject(server
.vm_fp
,o
);
8166 fflush(server
.vm_fp
);
8167 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8171 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8172 * needed to later retrieve the object into the key object.
8173 * If we can't find enough contiguous empty pages to swap the object on disk
8174 * REDIS_ERR is returned. */
8175 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8176 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8179 assert(key
->storage
== REDIS_VM_MEMORY
);
8180 assert(key
->refcount
== 1);
8181 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8182 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8183 key
->vm
.page
= page
;
8184 key
->vm
.usedpages
= pages
;
8185 key
->storage
= REDIS_VM_SWAPPED
;
8186 key
->vtype
= val
->type
;
8187 decrRefCount(val
); /* Deallocate the object from memory. */
8188 vmMarkPagesUsed(page
,pages
);
8189 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8190 (unsigned char*) key
->ptr
,
8191 (unsigned long long) page
, (unsigned long long) pages
);
8192 server
.vm_stats_swapped_objects
++;
8193 server
.vm_stats_swapouts
++;
8197 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8200 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8201 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8202 redisLog(REDIS_WARNING
,
8203 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8207 o
= rdbLoadObject(type
,server
.vm_fp
);
8209 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8212 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8216 /* Load the value object relative to the 'key' object from swap to memory.
8217 * The newly allocated object is returned.
8219 * If preview is true the unserialized object is returned to the caller but
8220 * no changes are made to the key object, nor the pages are marked as freed */
8221 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8224 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8225 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8227 key
->storage
= REDIS_VM_MEMORY
;
8228 key
->vm
.atime
= server
.unixtime
;
8229 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8230 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8231 (unsigned char*) key
->ptr
);
8232 server
.vm_stats_swapped_objects
--;
8234 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8235 (unsigned char*) key
->ptr
);
8237 server
.vm_stats_swapins
++;
8241 /* Plain object loading, from swap to memory */
8242 static robj
*vmLoadObject(robj
*key
) {
8243 /* If we are loading the object in background, stop it, we
8244 * need to load this object synchronously ASAP. */
8245 if (key
->storage
== REDIS_VM_LOADING
)
8246 vmCancelThreadedIOJob(key
);
8247 return vmGenericLoadObject(key
,0);
8250 /* Just load the value on disk, without to modify the key.
8251 * This is useful when we want to perform some operation on the value
8252 * without to really bring it from swap to memory, like while saving the
8253 * dataset or rewriting the append only log. */
8254 static robj
*vmPreviewObject(robj
*key
) {
8255 return vmGenericLoadObject(key
,1);
8258 /* How a good candidate is this object for swapping?
8259 * The better candidate it is, the greater the returned value.
8261 * Currently we try to perform a fast estimation of the object size in
8262 * memory, and combine it with aging informations.
8264 * Basically swappability = idle-time * log(estimated size)
8266 * Bigger objects are preferred over smaller objects, but not
8267 * proportionally, this is why we use the logarithm. This algorithm is
8268 * just a first try and will probably be tuned later. */
8269 static double computeObjectSwappability(robj
*o
) {
8270 time_t age
= server
.unixtime
- o
->vm
.atime
;
8274 struct dictEntry
*de
;
8277 if (age
<= 0) return 0;
8280 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8283 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8288 listNode
*ln
= listFirst(l
);
8290 asize
= sizeof(list
);
8292 robj
*ele
= ln
->value
;
8295 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8296 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8298 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8303 z
= (o
->type
== REDIS_ZSET
);
8304 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8306 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8307 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8312 de
= dictGetRandomKey(d
);
8313 ele
= dictGetEntryKey(de
);
8314 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8315 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8317 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8318 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8322 return (double)age
*log(1+asize
);
8325 /* Try to swap an object that's a good candidate for swapping.
8326 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8327 * to swap any object at all.
8329 * If 'usethreaded' is true, Redis will try to swap the object in background
8330 * using I/O threads. */
8331 static int vmSwapOneObject(int usethreads
) {
8333 struct dictEntry
*best
= NULL
;
8334 double best_swappability
= 0;
8335 redisDb
*best_db
= NULL
;
8338 for (j
= 0; j
< server
.dbnum
; j
++) {
8339 redisDb
*db
= server
.db
+j
;
8340 /* Why maxtries is set to 100?
8341 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8342 * are swappable objects */
8345 if (dictSize(db
->dict
) == 0) continue;
8346 for (i
= 0; i
< 5; i
++) {
8348 double swappability
;
8350 if (maxtries
) maxtries
--;
8351 de
= dictGetRandomKey(db
->dict
);
8352 key
= dictGetEntryKey(de
);
8353 val
= dictGetEntryVal(de
);
8354 /* Only swap objects that are currently in memory.
8356 * Also don't swap shared objects if threaded VM is on, as we
8357 * try to ensure that the main thread does not touch the
8358 * object while the I/O thread is using it, but we can't
8359 * control other keys without adding additional mutex. */
8360 if (key
->storage
!= REDIS_VM_MEMORY
||
8361 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8362 if (maxtries
) i
--; /* don't count this try */
8365 swappability
= computeObjectSwappability(val
);
8366 if (!best
|| swappability
> best_swappability
) {
8368 best_swappability
= swappability
;
8373 if (best
== NULL
) return REDIS_ERR
;
8374 key
= dictGetEntryKey(best
);
8375 val
= dictGetEntryVal(best
);
8377 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8378 key
->ptr
, best_swappability
);
8380 /* Unshare the key if needed */
8381 if (key
->refcount
> 1) {
8382 robj
*newkey
= dupStringObject(key
);
8384 key
= dictGetEntryKey(best
) = newkey
;
8388 vmSwapObjectThreaded(key
,val
,best_db
);
8391 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8392 dictGetEntryVal(best
) = NULL
;
8400 static int vmSwapOneObjectBlocking() {
8401 return vmSwapOneObject(0);
8404 static int vmSwapOneObjectThreaded() {
8405 return vmSwapOneObject(1);
8408 /* Return true if it's safe to swap out objects in a given moment.
8409 * Basically we don't want to swap objects out while there is a BGSAVE
8410 * or a BGAEOREWRITE running in backgroud. */
8411 static int vmCanSwapOut(void) {
8412 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8415 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8416 * and was deleted. Otherwise 0 is returned. */
8417 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8421 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8422 foundkey
= dictGetEntryKey(de
);
8423 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8428 /* =================== Virtual Memory - Threaded I/O ======================= */
8430 static void freeIOJob(iojob
*j
) {
8431 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8432 j
->type
== REDIS_IOJOB_DO_SWAP
||
8433 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8434 decrRefCount(j
->val
);
8435 decrRefCount(j
->key
);
8439 /* Every time a thread finished a Job, it writes a byte into the write side
8440 * of an unix pipe in order to "awake" the main thread, and this function
8442 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8446 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8448 REDIS_NOTUSED(mask
);
8449 REDIS_NOTUSED(privdata
);
8451 /* For every byte we read in the read side of the pipe, there is one
8452 * I/O job completed to process. */
8453 while((retval
= read(fd
,buf
,1)) == 1) {
8457 struct dictEntry
*de
;
8459 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8461 /* Get the processed element (the oldest one) */
8463 assert(listLength(server
.io_processed
) != 0);
8464 if (toprocess
== -1) {
8465 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8466 if (toprocess
<= 0) toprocess
= 1;
8468 ln
= listFirst(server
.io_processed
);
8470 listDelNode(server
.io_processed
,ln
);
8472 /* If this job is marked as canceled, just ignore it */
8477 /* Post process it in the main thread, as there are things we
8478 * can do just here to avoid race conditions and/or invasive locks */
8479 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
);
8480 de
= dictFind(j
->db
->dict
,j
->key
);
8482 key
= dictGetEntryKey(de
);
8483 if (j
->type
== REDIS_IOJOB_LOAD
) {
8486 /* Key loaded, bring it at home */
8487 key
->storage
= REDIS_VM_MEMORY
;
8488 key
->vm
.atime
= server
.unixtime
;
8489 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8490 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8491 (unsigned char*) key
->ptr
);
8492 server
.vm_stats_swapped_objects
--;
8493 server
.vm_stats_swapins
++;
8494 dictGetEntryVal(de
) = j
->val
;
8495 incrRefCount(j
->val
);
8498 /* Handle clients waiting for this key to be loaded. */
8499 handleClientsBlockedOnSwappedKey(db
,key
);
8500 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8501 /* Now we know the amount of pages required to swap this object.
8502 * Let's find some space for it, and queue this task again
8503 * rebranded as REDIS_IOJOB_DO_SWAP. */
8504 if (!vmCanSwapOut() ||
8505 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8507 /* Ooops... no space or we can't swap as there is
8508 * a fork()ed Redis trying to save stuff on disk. */
8510 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8512 /* Note that we need to mark this pages as used now,
8513 * if the job will be canceled, we'll mark them as freed
8515 vmMarkPagesUsed(j
->page
,j
->pages
);
8516 j
->type
= REDIS_IOJOB_DO_SWAP
;
8521 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8524 /* Key swapped. We can finally free some memory. */
8525 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8526 printf("key->storage: %d\n",key
->storage
);
8527 printf("key->name: %s\n",(char*)key
->ptr
);
8528 printf("key->refcount: %d\n",key
->refcount
);
8529 printf("val: %p\n",(void*)j
->val
);
8530 printf("val->type: %d\n",j
->val
->type
);
8531 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8533 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8534 val
= dictGetEntryVal(de
);
8535 key
->vm
.page
= j
->page
;
8536 key
->vm
.usedpages
= j
->pages
;
8537 key
->storage
= REDIS_VM_SWAPPED
;
8538 key
->vtype
= j
->val
->type
;
8539 decrRefCount(val
); /* Deallocate the object from memory. */
8540 dictGetEntryVal(de
) = NULL
;
8541 redisLog(REDIS_DEBUG
,
8542 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8543 (unsigned char*) key
->ptr
,
8544 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8545 server
.vm_stats_swapped_objects
++;
8546 server
.vm_stats_swapouts
++;
8548 /* Put a few more swap requests in queue if we are still
8550 if (trytoswap
&& vmCanSwapOut() &&
8551 zmalloc_used_memory() > server
.vm_max_memory
)
8556 more
= listLength(server
.io_newjobs
) <
8557 (unsigned) server
.vm_max_threads
;
8559 /* Don't waste CPU time if swappable objects are rare. */
8560 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8568 if (processed
== toprocess
) return;
8570 if (retval
< 0 && errno
!= EAGAIN
) {
8571 redisLog(REDIS_WARNING
,
8572 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8577 static void lockThreadedIO(void) {
8578 pthread_mutex_lock(&server
.io_mutex
);
8581 static void unlockThreadedIO(void) {
8582 pthread_mutex_unlock(&server
.io_mutex
);
8585 /* Remove the specified object from the threaded I/O queue if still not
8586 * processed, otherwise make sure to flag it as canceled. */
8587 static void vmCancelThreadedIOJob(robj
*o
) {
8589 server
.io_newjobs
, /* 0 */
8590 server
.io_processing
, /* 1 */
8591 server
.io_processed
/* 2 */
8595 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8598 /* Search for a matching key in one of the queues */
8599 for (i
= 0; i
< 3; i
++) {
8603 listRewind(lists
[i
],&li
);
8604 while ((ln
= listNext(&li
)) != NULL
) {
8605 iojob
*job
= ln
->value
;
8607 if (job
->canceled
) continue; /* Skip this, already canceled. */
8608 if (compareStringObjects(job
->key
,o
) == 0) {
8609 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8610 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8611 /* Mark the pages as free since the swap didn't happened
8612 * or happened but is now discarded. */
8613 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8614 vmMarkPagesFree(job
->page
,job
->pages
);
8615 /* Cancel the job. It depends on the list the job is
8618 case 0: /* io_newjobs */
8619 /* If the job was yet not processed the best thing to do
8620 * is to remove it from the queue at all */
8622 listDelNode(lists
[i
],ln
);
8624 case 1: /* io_processing */
8625 /* Oh Shi- the thread is messing with the Job:
8627 * Probably it's accessing the object if this is a
8628 * PREPARE_SWAP or DO_SWAP job.
8629 * If it's a LOAD job it may be reading from disk and
8630 * if we don't wait for the job to terminate before to
8631 * cancel it, maybe in a few microseconds data can be
8632 * corrupted in this pages. So the short story is:
8634 * Better to wait for the job to move into the
8635 * next queue (processed)... */
8637 /* We try again and again until the job is completed. */
8639 /* But let's wait some time for the I/O thread
8640 * to finish with this job. After all this condition
8641 * should be very rare. */
8644 case 2: /* io_processed */
8645 /* The job was already processed, that's easy...
8646 * just mark it as canceled so that we'll ignore it
8647 * when processing completed jobs. */
8651 /* Finally we have to adjust the storage type of the object
8652 * in order to "UNDO" the operaiton. */
8653 if (o
->storage
== REDIS_VM_LOADING
)
8654 o
->storage
= REDIS_VM_SWAPPED
;
8655 else if (o
->storage
== REDIS_VM_SWAPPING
)
8656 o
->storage
= REDIS_VM_MEMORY
;
8663 assert(1 != 1); /* We should never reach this */
8666 static void *IOThreadEntryPoint(void *arg
) {
8671 pthread_detach(pthread_self());
8673 /* Get a new job to process */
8675 if (listLength(server
.io_newjobs
) == 0) {
8676 /* No new jobs in queue, exit. */
8677 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8678 (long) pthread_self());
8679 server
.io_active_threads
--;
8683 ln
= listFirst(server
.io_newjobs
);
8685 listDelNode(server
.io_newjobs
,ln
);
8686 /* Add the job in the processing queue */
8687 j
->thread
= pthread_self();
8688 listAddNodeTail(server
.io_processing
,j
);
8689 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8691 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8692 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8694 /* Process the Job */
8695 if (j
->type
== REDIS_IOJOB_LOAD
) {
8696 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8697 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8698 FILE *fp
= fopen("/dev/null","w+");
8699 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8701 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8702 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8706 /* Done: insert the job into the processed queue */
8707 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8708 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8710 listDelNode(server
.io_processing
,ln
);
8711 listAddNodeTail(server
.io_processed
,j
);
8714 /* Signal the main thread there is new stuff to process */
8715 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8717 return NULL
; /* never reached */
8720 static void spawnIOThread(void) {
8722 sigset_t mask
, omask
;
8725 sigaddset(&mask
,SIGCHLD
);
8726 sigaddset(&mask
,SIGHUP
);
8727 sigaddset(&mask
,SIGPIPE
);
8728 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8729 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
8730 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8731 server
.io_active_threads
++;
8734 /* We need to wait for the last thread to exit before we are able to
8735 * fork() in order to BGSAVE or BGREWRITEAOF. */
8736 static void waitEmptyIOJobsQueue(void) {
8738 int io_processed_len
;
8741 if (listLength(server
.io_newjobs
) == 0 &&
8742 listLength(server
.io_processing
) == 0 &&
8743 server
.io_active_threads
== 0)
8748 /* While waiting for empty jobs queue condition we post-process some
8749 * finshed job, as I/O threads may be hanging trying to write against
8750 * the io_ready_pipe_write FD but there are so much pending jobs that
8752 io_processed_len
= listLength(server
.io_processed
);
8754 if (io_processed_len
) {
8755 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8756 usleep(1000); /* 1 millisecond */
8758 usleep(10000); /* 10 milliseconds */
8763 static void vmReopenSwapFile(void) {
8764 /* Note: we don't close the old one as we are in the child process
8765 * and don't want to mess at all with the original file object. */
8766 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8767 if (server
.vm_fp
== NULL
) {
8768 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8769 server
.vm_swap_file
);
8772 server
.vm_fd
= fileno(server
.vm_fp
);
8775 /* This function must be called while with threaded IO locked */
8776 static void queueIOJob(iojob
*j
) {
8777 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8778 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8779 listAddNodeTail(server
.io_newjobs
,j
);
8780 if (server
.io_active_threads
< server
.vm_max_threads
)
8784 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8787 assert(key
->storage
== REDIS_VM_MEMORY
);
8788 assert(key
->refcount
== 1);
8790 j
= zmalloc(sizeof(*j
));
8791 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8793 j
->key
= dupStringObject(key
);
8797 j
->thread
= (pthread_t
) -1;
8798 key
->storage
= REDIS_VM_SWAPPING
;
8806 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8808 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8809 * If there is not already a job loading the key, it is craeted.
8810 * The key is added to the io_keys list in the client structure, and also
8811 * in the hash table mapping swapped keys to waiting clients, that is,
8812 * server.io_waited_keys. */
8813 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8814 struct dictEntry
*de
;
8818 /* If the key does not exist or is already in RAM we don't need to
8819 * block the client at all. */
8820 de
= dictFind(c
->db
->dict
,key
);
8821 if (de
== NULL
) return 0;
8822 o
= dictGetEntryKey(de
);
8823 if (o
->storage
== REDIS_VM_MEMORY
) {
8825 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8826 /* We were swapping the key, undo it! */
8827 vmCancelThreadedIOJob(o
);
8831 /* OK: the key is either swapped, or being loaded just now. */
8833 /* Add the key to the list of keys this client is waiting for.
8834 * This maps clients to keys they are waiting for. */
8835 listAddNodeTail(c
->io_keys
,key
);
8838 /* Add the client to the swapped keys => clients waiting map. */
8839 de
= dictFind(c
->db
->io_keys
,key
);
8843 /* For every key we take a list of clients blocked for it */
8845 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8847 assert(retval
== DICT_OK
);
8849 l
= dictGetEntryVal(de
);
8851 listAddNodeTail(l
,c
);
8853 /* Are we already loading the key from disk? If not create a job */
8854 if (o
->storage
== REDIS_VM_SWAPPED
) {
8857 o
->storage
= REDIS_VM_LOADING
;
8858 j
= zmalloc(sizeof(*j
));
8859 j
->type
= REDIS_IOJOB_LOAD
;
8861 j
->key
= dupStringObject(key
);
8862 j
->key
->vtype
= o
->vtype
;
8863 j
->page
= o
->vm
.page
;
8866 j
->thread
= (pthread_t
) -1;
8874 /* Preload keys needed for the ZUNION and ZINTER commands. */
8875 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
8877 num
= atoi(c
->argv
[2]->ptr
);
8878 for (i
= 0; i
< num
; i
++) {
8879 waitForSwappedKey(c
,c
->argv
[3+i
]);
8883 /* Is this client attempting to run a command against swapped keys?
8884 * If so, block it ASAP, load the keys in background, then resume it.
8886 * The important idea about this function is that it can fail! If keys will
8887 * still be swapped when the client is resumed, this key lookups will
8888 * just block loading keys from disk. In practical terms this should only
8889 * happen with SORT BY command or if there is a bug in this function.
8891 * Return 1 if the client is marked as blocked, 0 if the client can
8892 * continue as the keys it is going to access appear to be in memory. */
8893 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8896 if (cmd
->vm_preload_proc
!= NULL
) {
8897 cmd
->vm_preload_proc(c
);
8899 if (cmd
->vm_firstkey
== 0) return 0;
8900 last
= cmd
->vm_lastkey
;
8901 if (last
< 0) last
= c
->argc
+last
;
8902 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8903 waitForSwappedKey(c
,c
->argv
[j
]);
8906 /* If the client was blocked for at least one key, mark it as blocked. */
8907 if (listLength(c
->io_keys
)) {
8908 c
->flags
|= REDIS_IO_WAIT
;
8909 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8910 server
.vm_blocked_clients
++;
8917 /* Remove the 'key' from the list of blocked keys for a given client.
8919 * The function returns 1 when there are no longer blocking keys after
8920 * the current one was removed (and the client can be unblocked). */
8921 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8925 struct dictEntry
*de
;
8927 /* Remove the key from the list of keys this client is waiting for. */
8928 listRewind(c
->io_keys
,&li
);
8929 while ((ln
= listNext(&li
)) != NULL
) {
8930 if (compareStringObjects(ln
->value
,key
) == 0) {
8931 listDelNode(c
->io_keys
,ln
);
8937 /* Remove the client form the key => waiting clients map. */
8938 de
= dictFind(c
->db
->io_keys
,key
);
8940 l
= dictGetEntryVal(de
);
8941 ln
= listSearchKey(l
,c
);
8944 if (listLength(l
) == 0)
8945 dictDelete(c
->db
->io_keys
,key
);
8947 return listLength(c
->io_keys
) == 0;
8950 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8951 struct dictEntry
*de
;
8956 de
= dictFind(db
->io_keys
,key
);
8959 l
= dictGetEntryVal(de
);
8960 len
= listLength(l
);
8961 /* Note: we can't use something like while(listLength(l)) as the list
8962 * can be freed by the calling function when we remove the last element. */
8965 redisClient
*c
= ln
->value
;
8967 if (dontWaitForSwappedKey(c
,key
)) {
8968 /* Put the client in the list of clients ready to go as we
8969 * loaded all the keys about it. */
8970 listAddNodeTail(server
.io_ready_clients
,c
);
8975 /* ================================= Debugging ============================== */
8977 static void debugCommand(redisClient
*c
) {
8978 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8980 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8981 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8982 addReply(c
,shared
.err
);
8986 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8987 addReply(c
,shared
.err
);
8990 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8991 addReply(c
,shared
.ok
);
8992 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8994 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8995 addReply(c
,shared
.err
);
8998 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8999 addReply(c
,shared
.ok
);
9000 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9001 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9005 addReply(c
,shared
.nokeyerr
);
9008 key
= dictGetEntryKey(de
);
9009 val
= dictGetEntryVal(de
);
9010 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9011 key
->storage
== REDIS_VM_SWAPPING
)) {
9015 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9016 strenc
= strencoding
[val
->encoding
];
9018 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9021 addReplySds(c
,sdscatprintf(sdsempty(),
9022 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9023 "encoding:%s serializedlength:%lld\r\n",
9024 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9025 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9027 addReplySds(c
,sdscatprintf(sdsempty(),
9028 "+Key at:%p refcount:%d, value swapped at: page %llu "
9029 "using %llu pages\r\n",
9030 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9031 (unsigned long long) key
->vm
.usedpages
));
9033 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9034 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9037 if (!server
.vm_enabled
) {
9038 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9042 addReply(c
,shared
.nokeyerr
);
9045 key
= dictGetEntryKey(de
);
9046 val
= dictGetEntryVal(de
);
9047 /* If the key is shared we want to create a copy */
9048 if (key
->refcount
> 1) {
9049 robj
*newkey
= dupStringObject(key
);
9051 key
= dictGetEntryKey(de
) = newkey
;
9054 if (key
->storage
!= REDIS_VM_MEMORY
) {
9055 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9056 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9057 dictGetEntryVal(de
) = NULL
;
9058 addReply(c
,shared
.ok
);
9060 addReply(c
,shared
.err
);
9063 addReplySds(c
,sdsnew(
9064 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9068 static void _redisAssert(char *estr
, char *file
, int line
) {
9069 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9070 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9071 #ifdef HAVE_BACKTRACE
9072 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9077 /* =================================== Main! ================================ */
9080 int linuxOvercommitMemoryValue(void) {
9081 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9085 if (fgets(buf
,64,fp
) == NULL
) {
9094 void linuxOvercommitMemoryWarning(void) {
9095 if (linuxOvercommitMemoryValue() == 0) {
9096 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.");
9099 #endif /* __linux__ */
9101 static void daemonize(void) {
9105 if (fork() != 0) exit(0); /* parent exits */
9106 setsid(); /* create a new session */
9108 /* Every output goes to /dev/null. If Redis is daemonized but
9109 * the 'logfile' is set to 'stdout' in the configuration file
9110 * it will not log at all. */
9111 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9112 dup2(fd
, STDIN_FILENO
);
9113 dup2(fd
, STDOUT_FILENO
);
9114 dup2(fd
, STDERR_FILENO
);
9115 if (fd
> STDERR_FILENO
) close(fd
);
9117 /* Try to write the pid file */
9118 fp
= fopen(server
.pidfile
,"w");
9120 fprintf(fp
,"%d\n",getpid());
9125 int main(int argc
, char **argv
) {
9130 resetServerSaveParams();
9131 loadServerConfig(argv
[1]);
9132 } else if (argc
> 2) {
9133 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9136 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'");
9138 if (server
.daemonize
) daemonize();
9140 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9142 linuxOvercommitMemoryWarning();
9145 if (server
.appendonly
) {
9146 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9147 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9149 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9150 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9152 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9153 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9155 aeDeleteEventLoop(server
.el
);
9159 /* ============================= Backtrace support ========================= */
9161 #ifdef HAVE_BACKTRACE
9162 static char *findFuncName(void *pointer
, unsigned long *offset
);
9164 static void *getMcontextEip(ucontext_t
*uc
) {
9165 #if defined(__FreeBSD__)
9166 return (void*) uc
->uc_mcontext
.mc_eip
;
9167 #elif defined(__dietlibc__)
9168 return (void*) uc
->uc_mcontext
.eip
;
9169 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9171 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9173 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9175 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9176 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9177 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9179 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9181 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9182 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9183 #elif defined(__ia64__) /* Linux IA64 */
9184 return (void*) uc
->uc_mcontext
.sc_ip
;
9190 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9192 char **messages
= NULL
;
9193 int i
, trace_size
= 0;
9194 unsigned long offset
=0;
9195 ucontext_t
*uc
= (ucontext_t
*) secret
;
9197 REDIS_NOTUSED(info
);
9199 redisLog(REDIS_WARNING
,
9200 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9201 infostring
= genRedisInfoString();
9202 redisLog(REDIS_WARNING
, "%s",infostring
);
9203 /* It's not safe to sdsfree() the returned string under memory
9204 * corruption conditions. Let it leak as we are going to abort */
9206 trace_size
= backtrace(trace
, 100);
9207 /* overwrite sigaction with caller's address */
9208 if (getMcontextEip(uc
) != NULL
) {
9209 trace
[1] = getMcontextEip(uc
);
9211 messages
= backtrace_symbols(trace
, trace_size
);
9213 for (i
=1; i
<trace_size
; ++i
) {
9214 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9216 p
= strchr(messages
[i
],'+');
9217 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9218 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9220 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9223 /* free(messages); Don't call free() with possibly corrupted memory. */
9227 static void setupSigSegvAction(void) {
9228 struct sigaction act
;
9230 sigemptyset (&act
.sa_mask
);
9231 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9232 * is used. Otherwise, sa_handler is used */
9233 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9234 act
.sa_sigaction
= segvHandler
;
9235 sigaction (SIGSEGV
, &act
, NULL
);
9236 sigaction (SIGBUS
, &act
, NULL
);
9237 sigaction (SIGFPE
, &act
, NULL
);
9238 sigaction (SIGILL
, &act
, NULL
);
9239 sigaction (SIGBUS
, &act
, NULL
);
9243 #include "staticsymbols.h"
9244 /* This function try to convert a pointer into a function name. It's used in
9245 * oreder to provide a backtrace under segmentation fault that's able to
9246 * display functions declared as static (otherwise the backtrace is useless). */
9247 static char *findFuncName(void *pointer
, unsigned long *offset
){
9249 unsigned long off
, minoff
= 0;
9251 /* Try to match against the Symbol with the smallest offset */
9252 for (i
=0; symsTable
[i
].pointer
; i
++) {
9253 unsigned long lp
= (unsigned long) pointer
;
9255 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9256 off
=lp
-symsTable
[i
].pointer
;
9257 if (ret
< 0 || off
< minoff
) {
9263 if (ret
== -1) return NULL
;
9265 return symsTable
[ret
].name
;
9267 #else /* HAVE_BACKTRACE */
9268 static void setupSigSegvAction(void) {
9270 #endif /* HAVE_BACKTRACE */