2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.7"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 4
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_STRING 0
122 /* Objects encoding. Some kind of objects like Strings and Hashes can be
123 * internally represented in multiple ways. The 'encoding' field of the object
124 * is set to one of this fields for this object. */
125 #define REDIS_ENCODING_RAW 0 /* Raw representation */
126 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
127 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
128 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
130 static char* strencoding
[] = {
131 "raw", "int", "zipmap", "hashtable"
134 /* Object types only used for dumping to disk */
135 #define REDIS_EXPIRETIME 253
136 #define REDIS_SELECTDB 254
137 #define REDIS_EOF 255
139 /* Defines related to the dump file format. To store 32 bits lengths for short
140 * keys requires a lot of space, so we check the most significant 2 bits of
141 * the first byte to interpreter the length:
143 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
144 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
145 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
146 * 11|000000 this means: specially encoded object will follow. The six bits
147 * number specify the kind of object that follows.
148 * See the REDIS_RDB_ENC_* defines.
150 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
151 * values, will fit inside. */
152 #define REDIS_RDB_6BITLEN 0
153 #define REDIS_RDB_14BITLEN 1
154 #define REDIS_RDB_32BITLEN 2
155 #define REDIS_RDB_ENCVAL 3
156 #define REDIS_RDB_LENERR UINT_MAX
158 /* When a length of a string object stored on disk has the first two bits
159 * set, the remaining two bits specify a special encoding for the object
160 * accordingly to the following defines: */
161 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
162 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
163 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
164 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
166 /* Virtual memory object->where field. */
167 #define REDIS_VM_MEMORY 0 /* The object is on memory */
168 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
169 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
170 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
172 /* Virtual memory static configuration stuff.
173 * Check vmFindContiguousPages() to know more about this magic numbers. */
174 #define REDIS_VM_MAX_NEAR_PAGES 65536
175 #define REDIS_VM_MAX_RANDOM_JUMP 4096
176 #define REDIS_VM_MAX_THREADS 32
177 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
178 /* The following is the *percentage* of completed I/O jobs to process when the
179 * handelr is called. While Virtual Memory I/O operations are performed by
180 * threads, this operations must be processed by the main thread when completed
181 * in order to take effect. */
182 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
185 #define REDIS_SLAVE 1 /* This client is a slave server */
186 #define REDIS_MASTER 2 /* This client is a master server */
187 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
188 #define REDIS_MULTI 8 /* This client is in a MULTI context */
189 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
190 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
192 /* Slave replication state - slave side */
193 #define REDIS_REPL_NONE 0 /* No active replication */
194 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
195 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
197 /* Slave replication state - from the point of view of master
198 * Note that in SEND_BULK and ONLINE state the slave receives new updates
199 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
200 * to start the next background saving in order to send updates to it. */
201 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
202 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
203 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
204 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
206 /* List related stuff */
210 /* Sort operations */
211 #define REDIS_SORT_GET 0
212 #define REDIS_SORT_ASC 1
213 #define REDIS_SORT_DESC 2
214 #define REDIS_SORTKEY_MAX 1024
217 #define REDIS_DEBUG 0
218 #define REDIS_VERBOSE 1
219 #define REDIS_NOTICE 2
220 #define REDIS_WARNING 3
222 /* Anti-warning macro... */
223 #define REDIS_NOTUSED(V) ((void) V)
225 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
226 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
228 /* Append only defines */
229 #define APPENDFSYNC_NO 0
230 #define APPENDFSYNC_ALWAYS 1
231 #define APPENDFSYNC_EVERYSEC 2
233 /* Hashes related defaults */
234 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
235 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
237 /* We can print the stacktrace, so our assert is defined this way: */
238 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
239 static void _redisAssert(char *estr
, char *file
, int line
);
241 /*================================= Data types ============================== */
243 /* A redis object, that is a type able to hold a string / list / set */
245 /* The VM object structure */
246 struct redisObjectVM
{
247 off_t page
; /* the page at witch the object is stored on disk */
248 off_t usedpages
; /* number of pages used on disk */
249 time_t atime
; /* Last access time */
252 /* The actual Redis Object */
253 typedef struct redisObject
{
256 unsigned char encoding
;
257 unsigned char storage
; /* If this object is a key, where is the value?
258 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
259 unsigned char vtype
; /* If this object is a key, and value is swapped out,
260 * this is the type of the swapped out object. */
262 /* VM fields, this are only allocated if VM is active, otherwise the
263 * object allocation function will just allocate
264 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
265 * Redis without VM active will not have any overhead. */
266 struct redisObjectVM vm
;
269 /* Macro used to initalize a Redis object allocated on the stack.
270 * Note that this macro is taken near the structure definition to make sure
271 * we'll update it when the structure is changed, to avoid bugs like
272 * bug #85 introduced exactly in this way. */
273 #define initStaticStringObject(_var,_ptr) do { \
275 _var.type = REDIS_STRING; \
276 _var.encoding = REDIS_ENCODING_RAW; \
278 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
281 typedef struct redisDb
{
282 dict
*dict
; /* The keyspace for this DB */
283 dict
*expires
; /* Timeout of keys with a timeout set */
284 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
285 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
289 /* Client MULTI/EXEC state */
290 typedef struct multiCmd
{
293 struct redisCommand
*cmd
;
296 typedef struct multiState
{
297 multiCmd
*commands
; /* Array of MULTI commands */
298 int count
; /* Total number of MULTI commands */
301 /* With multiplexing we need to take per-clinet state.
302 * Clients are taken in a liked list. */
303 typedef struct redisClient
{
308 robj
**argv
, **mbargv
;
310 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
311 int multibulk
; /* multi bulk command format active */
314 time_t lastinteraction
; /* time of the last interaction, used for timeout */
315 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
316 int slaveseldb
; /* slave selected db, if this client is a slave */
317 int authenticated
; /* when requirepass is non-NULL */
318 int replstate
; /* replication state if this is a slave */
319 int repldbfd
; /* replication DB file descriptor */
320 long repldboff
; /* replication DB file offset */
321 off_t repldbsize
; /* replication DB file size */
322 multiState mstate
; /* MULTI/EXEC state */
323 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
324 * operation such as BLPOP. Otherwise NULL. */
325 int blockingkeysnum
; /* Number of blocking keys */
326 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
327 * is >= blockingto then the operation timed out. */
328 list
*io_keys
; /* Keys this client is waiting to be loaded from the
329 * swap file in order to continue. */
337 /* Global server state structure */
342 dict
*sharingpool
; /* Poll used for object sharing */
343 unsigned int sharingpoolsize
;
344 long long dirty
; /* changes to DB from the last save */
346 list
*slaves
, *monitors
;
347 char neterr
[ANET_ERR_LEN
];
349 int cronloops
; /* number of times the cron function run */
350 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
351 time_t lastsave
; /* Unix time of last save succeeede */
352 /* Fields used only for stats */
353 time_t stat_starttime
; /* server start time */
354 long long stat_numcommands
; /* number of processed commands */
355 long long stat_numconnections
; /* number of connections received */
368 pid_t bgsavechildpid
;
369 pid_t bgrewritechildpid
;
370 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
371 struct saveparam
*saveparams
;
376 char *appendfilename
;
380 /* Replication related */
385 redisClient
*master
; /* client that is master for this slave */
387 unsigned int maxclients
;
388 unsigned long long maxmemory
;
389 unsigned int blpop_blocked_clients
;
390 unsigned int vm_blocked_clients
;
391 /* Sort parameters - qsort_r() is only available under BSD so we
392 * have to take this state global, in order to pass it to sortCompare() */
396 /* Virtual memory configuration */
401 unsigned long long vm_max_memory
;
403 size_t hash_max_zipmap_entries
;
404 size_t hash_max_zipmap_value
;
405 /* Virtual memory state */
408 off_t vm_next_page
; /* Next probably empty page */
409 off_t vm_near_pages
; /* Number of pages allocated sequentially */
410 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
411 time_t unixtime
; /* Unix time sampled every second. */
412 /* Virtual memory I/O threads stuff */
413 /* An I/O thread process an element taken from the io_jobs queue and
414 * put the result of the operation in the io_done list. While the
415 * job is being processed, it's put on io_processing queue. */
416 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
417 list
*io_processing
; /* List of VM I/O jobs being processed */
418 list
*io_processed
; /* List of VM I/O jobs already processed */
419 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
420 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
421 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
422 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
423 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
424 int io_active_threads
; /* Number of running I/O threads */
425 int vm_max_threads
; /* Max number of I/O threads running at the same time */
426 /* Our main thread is blocked on the event loop, locking for sockets ready
427 * to be read or written, so when a threaded I/O operation is ready to be
428 * processed by the main thread, the I/O thread will use a unix pipe to
429 * awake the main thread. The followings are the two pipe FDs. */
430 int io_ready_pipe_read
;
431 int io_ready_pipe_write
;
432 /* Virtual memory stats */
433 unsigned long long vm_stats_used_pages
;
434 unsigned long long vm_stats_swapped_objects
;
435 unsigned long long vm_stats_swapouts
;
436 unsigned long long vm_stats_swapins
;
440 typedef void redisCommandProc(redisClient
*c
);
441 struct redisCommand
{
443 redisCommandProc
*proc
;
446 /* Use a function to determine which keys need to be loaded
447 * in the background prior to executing this command. Takes precedence
448 * over vm_firstkey and others, ignored when NULL */
449 redisCommandProc
*vm_preload_proc
;
450 /* What keys should be loaded in background when calling this command? */
451 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
452 int vm_lastkey
; /* THe last argument that's a key */
453 int vm_keystep
; /* The step between first and last key */
456 struct redisFunctionSym
{
458 unsigned long pointer
;
461 typedef struct _redisSortObject
{
469 typedef struct _redisSortOperation
{
472 } redisSortOperation
;
474 /* ZSETs use a specialized version of Skiplists */
476 typedef struct zskiplistNode
{
477 struct zskiplistNode
**forward
;
478 struct zskiplistNode
*backward
;
484 typedef struct zskiplist
{
485 struct zskiplistNode
*header
, *tail
;
486 unsigned long length
;
490 typedef struct zset
{
495 /* Our shared "common" objects */
497 struct sharedObjectsStruct
{
498 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
499 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
500 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
501 *outofrangeerr
, *plus
,
502 *select0
, *select1
, *select2
, *select3
, *select4
,
503 *select5
, *select6
, *select7
, *select8
, *select9
;
506 /* Global vars that are actally used as constants. The following double
507 * values are used for double on-disk serialization, and are initialized
508 * at runtime to avoid strange compiler optimizations. */
510 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
512 /* VM threaded I/O request message */
513 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
514 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
515 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
516 typedef struct iojob
{
517 int type
; /* Request type, REDIS_IOJOB_* */
518 redisDb
*db
;/* Redis database */
519 robj
*key
; /* This I/O request is about swapping this key */
520 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
521 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
522 off_t page
; /* Swap page where to read/write the object */
523 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
524 int canceled
; /* True if this command was canceled by blocking side of VM */
525 pthread_t thread
; /* ID of the thread processing this entry */
528 /*================================ Prototypes =============================== */
530 static void freeStringObject(robj
*o
);
531 static void freeListObject(robj
*o
);
532 static void freeSetObject(robj
*o
);
533 static void decrRefCount(void *o
);
534 static robj
*createObject(int type
, void *ptr
);
535 static void freeClient(redisClient
*c
);
536 static int rdbLoad(char *filename
);
537 static void addReply(redisClient
*c
, robj
*obj
);
538 static void addReplySds(redisClient
*c
, sds s
);
539 static void incrRefCount(robj
*o
);
540 static int rdbSaveBackground(char *filename
);
541 static robj
*createStringObject(char *ptr
, size_t len
);
542 static robj
*dupStringObject(robj
*o
);
543 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
544 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
545 static int syncWithMaster(void);
546 static robj
*tryObjectSharing(robj
*o
);
547 static int tryObjectEncoding(robj
*o
);
548 static robj
*getDecodedObject(robj
*o
);
549 static int removeExpire(redisDb
*db
, robj
*key
);
550 static int expireIfNeeded(redisDb
*db
, robj
*key
);
551 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
552 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
553 static int deleteKey(redisDb
*db
, robj
*key
);
554 static time_t getExpire(redisDb
*db
, robj
*key
);
555 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
556 static void updateSlavesWaitingBgsave(int bgsaveerr
);
557 static void freeMemoryIfNeeded(void);
558 static int processCommand(redisClient
*c
);
559 static void setupSigSegvAction(void);
560 static void rdbRemoveTempFile(pid_t childpid
);
561 static void aofRemoveTempFile(pid_t childpid
);
562 static size_t stringObjectLen(robj
*o
);
563 static void processInputBuffer(redisClient
*c
);
564 static zskiplist
*zslCreate(void);
565 static void zslFree(zskiplist
*zsl
);
566 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
567 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
568 static void initClientMultiState(redisClient
*c
);
569 static void freeClientMultiState(redisClient
*c
);
570 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
571 static void unblockClientWaitingData(redisClient
*c
);
572 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
573 static void vmInit(void);
574 static void vmMarkPagesFree(off_t page
, off_t count
);
575 static robj
*vmLoadObject(robj
*key
);
576 static robj
*vmPreviewObject(robj
*key
);
577 static int vmSwapOneObjectBlocking(void);
578 static int vmSwapOneObjectThreaded(void);
579 static int vmCanSwapOut(void);
580 static int tryFreeOneObjectFromFreelist(void);
581 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
582 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
583 static void vmCancelThreadedIOJob(robj
*o
);
584 static void lockThreadedIO(void);
585 static void unlockThreadedIO(void);
586 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
587 static void freeIOJob(iojob
*j
);
588 static void queueIOJob(iojob
*j
);
589 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
590 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
591 static void waitEmptyIOJobsQueue(void);
592 static void vmReopenSwapFile(void);
593 static int vmFreePage(off_t page
);
594 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
595 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
596 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
597 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
598 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static struct redisCommand
*lookupCommand(char *name
);
600 static void call(redisClient
*c
, struct redisCommand
*cmd
);
601 static void resetClient(redisClient
*c
);
602 static void convertToRealHash(robj
*o
);
604 static void authCommand(redisClient
*c
);
605 static void pingCommand(redisClient
*c
);
606 static void echoCommand(redisClient
*c
);
607 static void setCommand(redisClient
*c
);
608 static void setnxCommand(redisClient
*c
);
609 static void getCommand(redisClient
*c
);
610 static void delCommand(redisClient
*c
);
611 static void existsCommand(redisClient
*c
);
612 static void incrCommand(redisClient
*c
);
613 static void decrCommand(redisClient
*c
);
614 static void incrbyCommand(redisClient
*c
);
615 static void decrbyCommand(redisClient
*c
);
616 static void selectCommand(redisClient
*c
);
617 static void randomkeyCommand(redisClient
*c
);
618 static void keysCommand(redisClient
*c
);
619 static void dbsizeCommand(redisClient
*c
);
620 static void lastsaveCommand(redisClient
*c
);
621 static void saveCommand(redisClient
*c
);
622 static void bgsaveCommand(redisClient
*c
);
623 static void bgrewriteaofCommand(redisClient
*c
);
624 static void shutdownCommand(redisClient
*c
);
625 static void moveCommand(redisClient
*c
);
626 static void renameCommand(redisClient
*c
);
627 static void renamenxCommand(redisClient
*c
);
628 static void lpushCommand(redisClient
*c
);
629 static void rpushCommand(redisClient
*c
);
630 static void lpopCommand(redisClient
*c
);
631 static void rpopCommand(redisClient
*c
);
632 static void llenCommand(redisClient
*c
);
633 static void lindexCommand(redisClient
*c
);
634 static void lrangeCommand(redisClient
*c
);
635 static void ltrimCommand(redisClient
*c
);
636 static void typeCommand(redisClient
*c
);
637 static void lsetCommand(redisClient
*c
);
638 static void saddCommand(redisClient
*c
);
639 static void sremCommand(redisClient
*c
);
640 static void smoveCommand(redisClient
*c
);
641 static void sismemberCommand(redisClient
*c
);
642 static void scardCommand(redisClient
*c
);
643 static void spopCommand(redisClient
*c
);
644 static void srandmemberCommand(redisClient
*c
);
645 static void sinterCommand(redisClient
*c
);
646 static void sinterstoreCommand(redisClient
*c
);
647 static void sunionCommand(redisClient
*c
);
648 static void sunionstoreCommand(redisClient
*c
);
649 static void sdiffCommand(redisClient
*c
);
650 static void sdiffstoreCommand(redisClient
*c
);
651 static void syncCommand(redisClient
*c
);
652 static void flushdbCommand(redisClient
*c
);
653 static void flushallCommand(redisClient
*c
);
654 static void sortCommand(redisClient
*c
);
655 static void lremCommand(redisClient
*c
);
656 static void rpoplpushcommand(redisClient
*c
);
657 static void infoCommand(redisClient
*c
);
658 static void mgetCommand(redisClient
*c
);
659 static void monitorCommand(redisClient
*c
);
660 static void expireCommand(redisClient
*c
);
661 static void expireatCommand(redisClient
*c
);
662 static void getsetCommand(redisClient
*c
);
663 static void ttlCommand(redisClient
*c
);
664 static void slaveofCommand(redisClient
*c
);
665 static void debugCommand(redisClient
*c
);
666 static void msetCommand(redisClient
*c
);
667 static void msetnxCommand(redisClient
*c
);
668 static void zaddCommand(redisClient
*c
);
669 static void zincrbyCommand(redisClient
*c
);
670 static void zrangeCommand(redisClient
*c
);
671 static void zrangebyscoreCommand(redisClient
*c
);
672 static void zcountCommand(redisClient
*c
);
673 static void zrevrangeCommand(redisClient
*c
);
674 static void zcardCommand(redisClient
*c
);
675 static void zremCommand(redisClient
*c
);
676 static void zscoreCommand(redisClient
*c
);
677 static void zremrangebyscoreCommand(redisClient
*c
);
678 static void multiCommand(redisClient
*c
);
679 static void execCommand(redisClient
*c
);
680 static void discardCommand(redisClient
*c
);
681 static void blpopCommand(redisClient
*c
);
682 static void brpopCommand(redisClient
*c
);
683 static void appendCommand(redisClient
*c
);
684 static void substrCommand(redisClient
*c
);
685 static void zrankCommand(redisClient
*c
);
686 static void zrevrankCommand(redisClient
*c
);
687 static void hsetCommand(redisClient
*c
);
688 static void hgetCommand(redisClient
*c
);
689 static void hdelCommand(redisClient
*c
);
690 static void hlenCommand(redisClient
*c
);
691 static void zremrangebyrankCommand(redisClient
*c
);
692 static void zunionCommand(redisClient
*c
);
693 static void zinterCommand(redisClient
*c
);
694 static void hkeysCommand(redisClient
*c
);
695 static void hvalsCommand(redisClient
*c
);
696 static void hgetallCommand(redisClient
*c
);
697 static void hexistsCommand(redisClient
*c
);
699 /*================================= Globals ================================= */
702 static struct redisServer server
; /* server global state */
703 static struct redisCommand cmdTable
[] = {
704 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
705 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
706 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
707 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
708 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
709 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
710 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
711 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
712 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
713 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
714 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
715 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
716 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
717 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
718 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
719 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
720 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
721 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
722 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
723 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
724 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
725 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
726 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
727 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
728 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
729 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
730 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
731 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
732 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
733 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
734 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
735 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
736 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
737 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
738 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
739 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
740 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
742 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
743 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
744 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
747 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
748 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
754 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
755 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
756 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
757 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
759 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
764 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
766 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
767 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
768 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
769 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
770 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
771 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
772 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
775 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
776 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
777 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
778 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
779 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
780 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
781 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
782 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
783 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
784 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
785 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
786 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
788 {"exec",execCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
789 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
790 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
791 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
792 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
793 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
795 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
796 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
797 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
798 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
799 {NULL
,NULL
,0,0,NULL
,0,0,0}
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 static void version();
1107 /* ========================= Random utility functions ======================= */
1109 /* Redis generally does not try to recover from out of memory conditions
1110 * when allocating objects or strings, it is not clear if it will be possible
1111 * to report this condition to the client since the networking layer itself
1112 * is based on heap allocation for send buffers, so we simply abort.
1113 * At least the code will be simpler to read... */
1114 static void oom(const char *msg
) {
1115 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1120 /* ====================== Redis server networking stuff ===================== */
1121 static void closeTimedoutClients(void) {
1124 time_t now
= time(NULL
);
1127 listRewind(server
.clients
,&li
);
1128 while ((ln
= listNext(&li
)) != NULL
) {
1129 c
= listNodeValue(ln
);
1130 if (server
.maxidletime
&&
1131 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1132 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1133 (now
- c
->lastinteraction
> server
.maxidletime
))
1135 redisLog(REDIS_VERBOSE
,"Closing idle client");
1137 } else if (c
->flags
& REDIS_BLOCKED
) {
1138 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1139 addReply(c
,shared
.nullmultibulk
);
1140 unblockClientWaitingData(c
);
1146 static int htNeedsResize(dict
*dict
) {
1147 long long size
, used
;
1149 size
= dictSlots(dict
);
1150 used
= dictSize(dict
);
1151 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1152 (used
*100/size
< REDIS_HT_MINFILL
));
1155 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1156 * we resize the hash table to save memory */
1157 static void tryResizeHashTables(void) {
1160 for (j
= 0; j
< server
.dbnum
; j
++) {
1161 if (htNeedsResize(server
.db
[j
].dict
)) {
1162 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1163 dictResize(server
.db
[j
].dict
);
1164 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1166 if (htNeedsResize(server
.db
[j
].expires
))
1167 dictResize(server
.db
[j
].expires
);
1171 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1172 void backgroundSaveDoneHandler(int statloc
) {
1173 int exitcode
= WEXITSTATUS(statloc
);
1174 int bysignal
= WIFSIGNALED(statloc
);
1176 if (!bysignal
&& exitcode
== 0) {
1177 redisLog(REDIS_NOTICE
,
1178 "Background saving terminated with success");
1180 server
.lastsave
= time(NULL
);
1181 } else if (!bysignal
&& exitcode
!= 0) {
1182 redisLog(REDIS_WARNING
, "Background saving error");
1184 redisLog(REDIS_WARNING
,
1185 "Background saving terminated by signal");
1186 rdbRemoveTempFile(server
.bgsavechildpid
);
1188 server
.bgsavechildpid
= -1;
1189 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1190 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1191 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1194 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1196 void backgroundRewriteDoneHandler(int statloc
) {
1197 int exitcode
= WEXITSTATUS(statloc
);
1198 int bysignal
= WIFSIGNALED(statloc
);
1200 if (!bysignal
&& exitcode
== 0) {
1204 redisLog(REDIS_NOTICE
,
1205 "Background append only file rewriting terminated with success");
1206 /* Now it's time to flush the differences accumulated by the parent */
1207 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1208 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1210 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1213 /* Flush our data... */
1214 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1215 (signed) sdslen(server
.bgrewritebuf
)) {
1216 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
));
1220 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1221 /* Now our work is to rename the temp file into the stable file. And
1222 * switch the file descriptor used by the server for append only. */
1223 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1224 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1228 /* Mission completed... almost */
1229 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1230 if (server
.appendfd
!= -1) {
1231 /* If append only is actually enabled... */
1232 close(server
.appendfd
);
1233 server
.appendfd
= fd
;
1235 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1236 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1238 /* If append only is disabled we just generate a dump in this
1239 * format. Why not? */
1242 } else if (!bysignal
&& exitcode
!= 0) {
1243 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1245 redisLog(REDIS_WARNING
,
1246 "Background append only file rewriting terminated by signal");
1249 sdsfree(server
.bgrewritebuf
);
1250 server
.bgrewritebuf
= sdsempty();
1251 aofRemoveTempFile(server
.bgrewritechildpid
);
1252 server
.bgrewritechildpid
= -1;
1255 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1256 int j
, loops
= server
.cronloops
++;
1257 REDIS_NOTUSED(eventLoop
);
1259 REDIS_NOTUSED(clientData
);
1261 /* We take a cached value of the unix time in the global state because
1262 * with virtual memory and aging there is to store the current time
1263 * in objects at every object access, and accuracy is not needed.
1264 * To access a global var is faster than calling time(NULL) */
1265 server
.unixtime
= time(NULL
);
1267 /* Show some info about non-empty databases */
1268 for (j
= 0; j
< server
.dbnum
; j
++) {
1269 long long size
, used
, vkeys
;
1271 size
= dictSlots(server
.db
[j
].dict
);
1272 used
= dictSize(server
.db
[j
].dict
);
1273 vkeys
= dictSize(server
.db
[j
].expires
);
1274 if (!(loops
% 5) && (used
|| vkeys
)) {
1275 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1276 /* dictPrintStats(server.dict); */
1280 /* We don't want to resize the hash tables while a bacground saving
1281 * is in progress: the saving child is created using fork() that is
1282 * implemented with a copy-on-write semantic in most modern systems, so
1283 * if we resize the HT while there is the saving child at work actually
1284 * a lot of memory movements in the parent will cause a lot of pages
1286 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1288 /* Show information about connected clients */
1290 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1291 listLength(server
.clients
)-listLength(server
.slaves
),
1292 listLength(server
.slaves
),
1293 zmalloc_used_memory(),
1294 dictSize(server
.sharingpool
));
1297 /* Close connections of timedout clients */
1298 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1299 closeTimedoutClients();
1301 /* Check if a background saving or AOF rewrite in progress terminated */
1302 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1306 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1307 if (pid
== server
.bgsavechildpid
) {
1308 backgroundSaveDoneHandler(statloc
);
1310 backgroundRewriteDoneHandler(statloc
);
1314 /* If there is not a background saving in progress check if
1315 * we have to save now */
1316 time_t now
= time(NULL
);
1317 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1318 struct saveparam
*sp
= server
.saveparams
+j
;
1320 if (server
.dirty
>= sp
->changes
&&
1321 now
-server
.lastsave
> sp
->seconds
) {
1322 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1323 sp
->changes
, sp
->seconds
);
1324 rdbSaveBackground(server
.dbfilename
);
1330 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1331 * will use few CPU cycles if there are few expiring keys, otherwise
1332 * it will get more aggressive to avoid that too much memory is used by
1333 * keys that can be removed from the keyspace. */
1334 for (j
= 0; j
< server
.dbnum
; j
++) {
1336 redisDb
*db
= server
.db
+j
;
1338 /* Continue to expire if at the end of the cycle more than 25%
1339 * of the keys were expired. */
1341 long num
= dictSize(db
->expires
);
1342 time_t now
= time(NULL
);
1345 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1346 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1351 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1352 t
= (time_t) dictGetEntryVal(de
);
1354 deleteKey(db
,dictGetEntryKey(de
));
1358 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1361 /* Swap a few keys on disk if we are over the memory limit and VM
1362 * is enbled. Try to free objects from the free list first. */
1363 if (vmCanSwapOut()) {
1364 while (server
.vm_enabled
&& zmalloc_used_memory() >
1365 server
.vm_max_memory
)
1369 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1370 retval
= (server
.vm_max_threads
== 0) ?
1371 vmSwapOneObjectBlocking() :
1372 vmSwapOneObjectThreaded();
1373 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1374 zmalloc_used_memory() >
1375 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1377 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1379 /* Note that when using threade I/O we free just one object,
1380 * because anyway when the I/O thread in charge to swap this
1381 * object out will finish, the handler of completed jobs
1382 * will try to swap more objects if we are still out of memory. */
1383 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1387 /* Check if we should connect to a MASTER */
1388 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1389 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1390 if (syncWithMaster() == REDIS_OK
) {
1391 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1397 /* This function gets called every time Redis is entering the
1398 * main loop of the event driven library, that is, before to sleep
1399 * for ready file descriptors. */
1400 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1401 REDIS_NOTUSED(eventLoop
);
1403 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1407 listRewind(server
.io_ready_clients
,&li
);
1408 while((ln
= listNext(&li
))) {
1409 redisClient
*c
= ln
->value
;
1410 struct redisCommand
*cmd
;
1412 /* Resume the client. */
1413 listDelNode(server
.io_ready_clients
,ln
);
1414 c
->flags
&= (~REDIS_IO_WAIT
);
1415 server
.vm_blocked_clients
--;
1416 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1417 readQueryFromClient
, c
);
1418 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1419 assert(cmd
!= NULL
);
1422 /* There may be more data to process in the input buffer. */
1423 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1424 processInputBuffer(c
);
1429 static void createSharedObjects(void) {
1430 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1431 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1432 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1433 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1434 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1435 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1436 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1437 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1438 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1439 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1440 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1441 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1442 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1443 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1444 "-ERR no such key\r\n"));
1445 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1446 "-ERR syntax error\r\n"));
1447 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1448 "-ERR source and destination objects are the same\r\n"));
1449 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1450 "-ERR index out of range\r\n"));
1451 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1452 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1453 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1454 shared
.select0
= createStringObject("select 0\r\n",10);
1455 shared
.select1
= createStringObject("select 1\r\n",10);
1456 shared
.select2
= createStringObject("select 2\r\n",10);
1457 shared
.select3
= createStringObject("select 3\r\n",10);
1458 shared
.select4
= createStringObject("select 4\r\n",10);
1459 shared
.select5
= createStringObject("select 5\r\n",10);
1460 shared
.select6
= createStringObject("select 6\r\n",10);
1461 shared
.select7
= createStringObject("select 7\r\n",10);
1462 shared
.select8
= createStringObject("select 8\r\n",10);
1463 shared
.select9
= createStringObject("select 9\r\n",10);
1466 static void appendServerSaveParams(time_t seconds
, int changes
) {
1467 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1468 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1469 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1470 server
.saveparamslen
++;
1473 static void resetServerSaveParams() {
1474 zfree(server
.saveparams
);
1475 server
.saveparams
= NULL
;
1476 server
.saveparamslen
= 0;
1479 static void initServerConfig() {
1480 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1481 server
.port
= REDIS_SERVERPORT
;
1482 server
.verbosity
= REDIS_VERBOSE
;
1483 server
.maxidletime
= REDIS_MAXIDLETIME
;
1484 server
.saveparams
= NULL
;
1485 server
.logfile
= NULL
; /* NULL = log on standard output */
1486 server
.bindaddr
= NULL
;
1487 server
.glueoutputbuf
= 1;
1488 server
.daemonize
= 0;
1489 server
.appendonly
= 0;
1490 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1491 server
.lastfsync
= time(NULL
);
1492 server
.appendfd
= -1;
1493 server
.appendseldb
= -1; /* Make sure the first time will not match */
1494 server
.pidfile
= "/var/run/redis.pid";
1495 server
.dbfilename
= "dump.rdb";
1496 server
.appendfilename
= "appendonly.aof";
1497 server
.requirepass
= NULL
;
1498 server
.shareobjects
= 0;
1499 server
.rdbcompression
= 1;
1500 server
.sharingpoolsize
= 1024;
1501 server
.maxclients
= 0;
1502 server
.blpop_blocked_clients
= 0;
1503 server
.maxmemory
= 0;
1504 server
.vm_enabled
= 0;
1505 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1506 server
.vm_page_size
= 256; /* 256 bytes per page */
1507 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1508 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1509 server
.vm_max_threads
= 4;
1510 server
.vm_blocked_clients
= 0;
1511 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1512 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1514 resetServerSaveParams();
1516 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1517 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1518 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1519 /* Replication related */
1521 server
.masterauth
= NULL
;
1522 server
.masterhost
= NULL
;
1523 server
.masterport
= 6379;
1524 server
.master
= NULL
;
1525 server
.replstate
= REDIS_REPL_NONE
;
1527 /* Double constants initialization */
1529 R_PosInf
= 1.0/R_Zero
;
1530 R_NegInf
= -1.0/R_Zero
;
1531 R_Nan
= R_Zero
/R_Zero
;
1534 static void initServer() {
1537 signal(SIGHUP
, SIG_IGN
);
1538 signal(SIGPIPE
, SIG_IGN
);
1539 setupSigSegvAction();
1541 server
.devnull
= fopen("/dev/null","w");
1542 if (server
.devnull
== NULL
) {
1543 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1546 server
.clients
= listCreate();
1547 server
.slaves
= listCreate();
1548 server
.monitors
= listCreate();
1549 server
.objfreelist
= listCreate();
1550 createSharedObjects();
1551 server
.el
= aeCreateEventLoop();
1552 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1553 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1554 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1555 if (server
.fd
== -1) {
1556 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1559 for (j
= 0; j
< server
.dbnum
; j
++) {
1560 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1561 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1562 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1563 if (server
.vm_enabled
)
1564 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1565 server
.db
[j
].id
= j
;
1567 server
.cronloops
= 0;
1568 server
.bgsavechildpid
= -1;
1569 server
.bgrewritechildpid
= -1;
1570 server
.bgrewritebuf
= sdsempty();
1571 server
.lastsave
= time(NULL
);
1573 server
.stat_numcommands
= 0;
1574 server
.stat_numconnections
= 0;
1575 server
.stat_starttime
= time(NULL
);
1576 server
.unixtime
= time(NULL
);
1577 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1578 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1579 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1581 if (server
.appendonly
) {
1582 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1583 if (server
.appendfd
== -1) {
1584 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1590 if (server
.vm_enabled
) vmInit();
1593 /* Empty the whole database */
1594 static long long emptyDb() {
1596 long long removed
= 0;
1598 for (j
= 0; j
< server
.dbnum
; j
++) {
1599 removed
+= dictSize(server
.db
[j
].dict
);
1600 dictEmpty(server
.db
[j
].dict
);
1601 dictEmpty(server
.db
[j
].expires
);
1606 static int yesnotoi(char *s
) {
1607 if (!strcasecmp(s
,"yes")) return 1;
1608 else if (!strcasecmp(s
,"no")) return 0;
1612 /* I agree, this is a very rudimental way to load a configuration...
1613 will improve later if the config gets more complex */
1614 static void loadServerConfig(char *filename
) {
1616 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1620 if (filename
[0] == '-' && filename
[1] == '\0')
1623 if ((fp
= fopen(filename
,"r")) == NULL
) {
1624 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1629 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1635 line
= sdstrim(line
," \t\r\n");
1637 /* Skip comments and blank lines*/
1638 if (line
[0] == '#' || line
[0] == '\0') {
1643 /* Split into arguments */
1644 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1645 sdstolower(argv
[0]);
1647 /* Execute config directives */
1648 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1649 server
.maxidletime
= atoi(argv
[1]);
1650 if (server
.maxidletime
< 0) {
1651 err
= "Invalid timeout value"; goto loaderr
;
1653 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1654 server
.port
= atoi(argv
[1]);
1655 if (server
.port
< 1 || server
.port
> 65535) {
1656 err
= "Invalid port"; goto loaderr
;
1658 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1659 server
.bindaddr
= zstrdup(argv
[1]);
1660 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1661 int seconds
= atoi(argv
[1]);
1662 int changes
= atoi(argv
[2]);
1663 if (seconds
< 1 || changes
< 0) {
1664 err
= "Invalid save parameters"; goto loaderr
;
1666 appendServerSaveParams(seconds
,changes
);
1667 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1668 if (chdir(argv
[1]) == -1) {
1669 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1670 argv
[1], strerror(errno
));
1673 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1674 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1675 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1676 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1677 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1679 err
= "Invalid log level. Must be one of debug, notice, warning";
1682 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1685 server
.logfile
= zstrdup(argv
[1]);
1686 if (!strcasecmp(server
.logfile
,"stdout")) {
1687 zfree(server
.logfile
);
1688 server
.logfile
= NULL
;
1690 if (server
.logfile
) {
1691 /* Test if we are able to open the file. The server will not
1692 * be able to abort just for this problem later... */
1693 logfp
= fopen(server
.logfile
,"a");
1694 if (logfp
== NULL
) {
1695 err
= sdscatprintf(sdsempty(),
1696 "Can't open the log file: %s", strerror(errno
));
1701 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1702 server
.dbnum
= atoi(argv
[1]);
1703 if (server
.dbnum
< 1) {
1704 err
= "Invalid number of databases"; goto loaderr
;
1706 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1707 loadServerConfig(argv
[1]);
1708 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1709 server
.maxclients
= atoi(argv
[1]);
1710 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1711 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1712 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1713 server
.masterhost
= sdsnew(argv
[1]);
1714 server
.masterport
= atoi(argv
[2]);
1715 server
.replstate
= REDIS_REPL_CONNECT
;
1716 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1717 server
.masterauth
= zstrdup(argv
[1]);
1718 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1719 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1720 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1722 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1723 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1724 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1726 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1727 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1728 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1730 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1731 server
.sharingpoolsize
= atoi(argv
[1]);
1732 if (server
.sharingpoolsize
< 1) {
1733 err
= "invalid object sharing pool size"; goto loaderr
;
1735 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1736 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1737 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1739 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1740 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1741 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1743 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1744 if (!strcasecmp(argv
[1],"no")) {
1745 server
.appendfsync
= APPENDFSYNC_NO
;
1746 } else if (!strcasecmp(argv
[1],"always")) {
1747 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1748 } else if (!strcasecmp(argv
[1],"everysec")) {
1749 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1751 err
= "argument must be 'no', 'always' or 'everysec'";
1754 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1755 server
.requirepass
= zstrdup(argv
[1]);
1756 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1757 server
.pidfile
= zstrdup(argv
[1]);
1758 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1759 server
.dbfilename
= zstrdup(argv
[1]);
1760 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1761 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1762 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1764 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1765 zfree(server
.vm_swap_file
);
1766 server
.vm_swap_file
= zstrdup(argv
[1]);
1767 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1768 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1769 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1770 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1771 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1772 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1773 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1774 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1775 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1776 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1777 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1778 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1779 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1780 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1782 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1784 for (j
= 0; j
< argc
; j
++)
1789 if (fp
!= stdin
) fclose(fp
);
1793 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1794 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1795 fprintf(stderr
, ">>> '%s'\n", line
);
1796 fprintf(stderr
, "%s\n", err
);
1800 static void freeClientArgv(redisClient
*c
) {
1803 for (j
= 0; j
< c
->argc
; j
++)
1804 decrRefCount(c
->argv
[j
]);
1805 for (j
= 0; j
< c
->mbargc
; j
++)
1806 decrRefCount(c
->mbargv
[j
]);
1811 static void freeClient(redisClient
*c
) {
1814 /* Note that if the client we are freeing is blocked into a blocking
1815 * call, we have to set querybuf to NULL *before* to call
1816 * unblockClientWaitingData() to avoid processInputBuffer() will get
1817 * called. Also it is important to remove the file events after
1818 * this, because this call adds the READABLE event. */
1819 sdsfree(c
->querybuf
);
1821 if (c
->flags
& REDIS_BLOCKED
)
1822 unblockClientWaitingData(c
);
1824 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1825 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1826 listRelease(c
->reply
);
1829 /* Remove from the list of clients */
1830 ln
= listSearchKey(server
.clients
,c
);
1831 redisAssert(ln
!= NULL
);
1832 listDelNode(server
.clients
,ln
);
1833 /* Remove from the list of clients waiting for swapped keys */
1834 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1835 ln
= listSearchKey(server
.io_ready_clients
,c
);
1837 listDelNode(server
.io_ready_clients
,ln
);
1838 server
.vm_blocked_clients
--;
1841 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1842 ln
= listFirst(c
->io_keys
);
1843 dontWaitForSwappedKey(c
,ln
->value
);
1845 listRelease(c
->io_keys
);
1847 if (c
->flags
& REDIS_SLAVE
) {
1848 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1850 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1851 ln
= listSearchKey(l
,c
);
1852 redisAssert(ln
!= NULL
);
1855 if (c
->flags
& REDIS_MASTER
) {
1856 server
.master
= NULL
;
1857 server
.replstate
= REDIS_REPL_CONNECT
;
1861 freeClientMultiState(c
);
1865 #define GLUEREPLY_UP_TO (1024)
1866 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1868 char buf
[GLUEREPLY_UP_TO
];
1873 listRewind(c
->reply
,&li
);
1874 while((ln
= listNext(&li
))) {
1878 objlen
= sdslen(o
->ptr
);
1879 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1880 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1882 listDelNode(c
->reply
,ln
);
1884 if (copylen
== 0) return;
1888 /* Now the output buffer is empty, add the new single element */
1889 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1890 listAddNodeHead(c
->reply
,o
);
1893 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1894 redisClient
*c
= privdata
;
1895 int nwritten
= 0, totwritten
= 0, objlen
;
1898 REDIS_NOTUSED(mask
);
1900 /* Use writev() if we have enough buffers to send */
1901 if (!server
.glueoutputbuf
&&
1902 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1903 !(c
->flags
& REDIS_MASTER
))
1905 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1909 while(listLength(c
->reply
)) {
1910 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1911 glueReplyBuffersIfNeeded(c
);
1913 o
= listNodeValue(listFirst(c
->reply
));
1914 objlen
= sdslen(o
->ptr
);
1917 listDelNode(c
->reply
,listFirst(c
->reply
));
1921 if (c
->flags
& REDIS_MASTER
) {
1922 /* Don't reply to a master */
1923 nwritten
= objlen
- c
->sentlen
;
1925 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1926 if (nwritten
<= 0) break;
1928 c
->sentlen
+= nwritten
;
1929 totwritten
+= nwritten
;
1930 /* If we fully sent the object on head go to the next one */
1931 if (c
->sentlen
== objlen
) {
1932 listDelNode(c
->reply
,listFirst(c
->reply
));
1935 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1936 * bytes, in a single threaded server it's a good idea to serve
1937 * other clients as well, even if a very large request comes from
1938 * super fast link that is always able to accept data (in real world
1939 * scenario think about 'KEYS *' against the loopback interfae) */
1940 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1942 if (nwritten
== -1) {
1943 if (errno
== EAGAIN
) {
1946 redisLog(REDIS_VERBOSE
,
1947 "Error writing to client: %s", strerror(errno
));
1952 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1953 if (listLength(c
->reply
) == 0) {
1955 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1959 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1961 redisClient
*c
= privdata
;
1962 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1964 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1965 int offset
, ion
= 0;
1967 REDIS_NOTUSED(mask
);
1970 while (listLength(c
->reply
)) {
1971 offset
= c
->sentlen
;
1975 /* fill-in the iov[] array */
1976 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1977 o
= listNodeValue(node
);
1978 objlen
= sdslen(o
->ptr
);
1980 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1983 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1984 break; /* no more iovecs */
1986 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1987 iov
[ion
].iov_len
= objlen
- offset
;
1988 willwrite
+= objlen
- offset
;
1989 offset
= 0; /* just for the first item */
1996 /* write all collected blocks at once */
1997 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1998 if (errno
!= EAGAIN
) {
1999 redisLog(REDIS_VERBOSE
,
2000 "Error writing to client: %s", strerror(errno
));
2007 totwritten
+= nwritten
;
2008 offset
= c
->sentlen
;
2010 /* remove written robjs from c->reply */
2011 while (nwritten
&& listLength(c
->reply
)) {
2012 o
= listNodeValue(listFirst(c
->reply
));
2013 objlen
= sdslen(o
->ptr
);
2015 if(nwritten
>= objlen
- offset
) {
2016 listDelNode(c
->reply
, listFirst(c
->reply
));
2017 nwritten
-= objlen
- offset
;
2021 c
->sentlen
+= nwritten
;
2029 c
->lastinteraction
= time(NULL
);
2031 if (listLength(c
->reply
) == 0) {
2033 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2037 static struct redisCommand
*lookupCommand(char *name
) {
2039 while(cmdTable
[j
].name
!= NULL
) {
2040 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2046 /* resetClient prepare the client to process the next command */
2047 static void resetClient(redisClient
*c
) {
2053 /* Call() is the core of Redis execution of a command */
2054 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2057 dirty
= server
.dirty
;
2059 if (server
.appendonly
&& server
.dirty
-dirty
)
2060 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2061 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2062 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2063 if (listLength(server
.monitors
))
2064 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2065 server
.stat_numcommands
++;
2068 /* If this function gets called we already read a whole
2069 * command, argments are in the client argv/argc fields.
2070 * processCommand() execute the command or prepare the
2071 * server for a bulk read from the client.
2073 * If 1 is returned the client is still alive and valid and
2074 * and other operations can be performed by the caller. Otherwise
2075 * if 0 is returned the client was destroied (i.e. after QUIT). */
2076 static int processCommand(redisClient
*c
) {
2077 struct redisCommand
*cmd
;
2079 /* Free some memory if needed (maxmemory setting) */
2080 if (server
.maxmemory
) freeMemoryIfNeeded();
2082 /* Handle the multi bulk command type. This is an alternative protocol
2083 * supported by Redis in order to receive commands that are composed of
2084 * multiple binary-safe "bulk" arguments. The latency of processing is
2085 * a bit higher but this allows things like multi-sets, so if this
2086 * protocol is used only for MSET and similar commands this is a big win. */
2087 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2088 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2089 if (c
->multibulk
<= 0) {
2093 decrRefCount(c
->argv
[c
->argc
-1]);
2097 } else if (c
->multibulk
) {
2098 if (c
->bulklen
== -1) {
2099 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2100 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2104 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2105 decrRefCount(c
->argv
[0]);
2106 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2108 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2113 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2117 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2118 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2122 if (c
->multibulk
== 0) {
2126 /* Here we need to swap the multi-bulk argc/argv with the
2127 * normal argc/argv of the client structure. */
2129 c
->argv
= c
->mbargv
;
2130 c
->mbargv
= auxargv
;
2133 c
->argc
= c
->mbargc
;
2134 c
->mbargc
= auxargc
;
2136 /* We need to set bulklen to something different than -1
2137 * in order for the code below to process the command without
2138 * to try to read the last argument of a bulk command as
2139 * a special argument. */
2141 /* continue below and process the command */
2148 /* -- end of multi bulk commands processing -- */
2150 /* The QUIT command is handled as a special case. Normal command
2151 * procs are unable to close the client connection safely */
2152 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2157 /* Now lookup the command and check ASAP about trivial error conditions
2158 * such wrong arity, bad command name and so forth. */
2159 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2162 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2163 (char*)c
->argv
[0]->ptr
));
2166 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2167 (c
->argc
< -cmd
->arity
)) {
2169 sdscatprintf(sdsempty(),
2170 "-ERR wrong number of arguments for '%s' command\r\n",
2174 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2175 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2178 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2179 /* This is a bulk command, we have to read the last argument yet. */
2180 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2182 decrRefCount(c
->argv
[c
->argc
-1]);
2183 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2185 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2190 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2191 /* It is possible that the bulk read is already in the
2192 * buffer. Check this condition and handle it accordingly.
2193 * This is just a fast path, alternative to call processInputBuffer().
2194 * It's a good idea since the code is small and this condition
2195 * happens most of the times. */
2196 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2197 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2199 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2201 /* Otherwise return... there is to read the last argument
2202 * from the socket. */
2206 /* Let's try to share objects on the command arguments vector */
2207 if (server
.shareobjects
) {
2209 for(j
= 1; j
< c
->argc
; j
++)
2210 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2212 /* Let's try to encode the bulk object to save space. */
2213 if (cmd
->flags
& REDIS_CMD_BULK
)
2214 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2216 /* Check if the user is authenticated */
2217 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2218 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2223 /* Exec the command */
2224 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2225 queueMultiCommand(c
,cmd
);
2226 addReply(c
,shared
.queued
);
2228 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2229 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2233 /* Prepare the client for the next command */
2238 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2243 /* (args*2)+1 is enough room for args, spaces, newlines */
2244 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2246 if (argc
<= REDIS_STATIC_ARGS
) {
2249 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2252 for (j
= 0; j
< argc
; j
++) {
2253 if (j
!= 0) outv
[outc
++] = shared
.space
;
2254 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2257 lenobj
= createObject(REDIS_STRING
,
2258 sdscatprintf(sdsempty(),"%lu\r\n",
2259 (unsigned long) stringObjectLen(argv
[j
])));
2260 lenobj
->refcount
= 0;
2261 outv
[outc
++] = lenobj
;
2263 outv
[outc
++] = argv
[j
];
2265 outv
[outc
++] = shared
.crlf
;
2267 /* Increment all the refcounts at start and decrement at end in order to
2268 * be sure to free objects if there is no slave in a replication state
2269 * able to be feed with commands */
2270 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2271 listRewind(slaves
,&li
);
2272 while((ln
= listNext(&li
))) {
2273 redisClient
*slave
= ln
->value
;
2275 /* Don't feed slaves that are still waiting for BGSAVE to start */
2276 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2278 /* Feed all the other slaves, MONITORs and so on */
2279 if (slave
->slaveseldb
!= dictid
) {
2283 case 0: selectcmd
= shared
.select0
; break;
2284 case 1: selectcmd
= shared
.select1
; break;
2285 case 2: selectcmd
= shared
.select2
; break;
2286 case 3: selectcmd
= shared
.select3
; break;
2287 case 4: selectcmd
= shared
.select4
; break;
2288 case 5: selectcmd
= shared
.select5
; break;
2289 case 6: selectcmd
= shared
.select6
; break;
2290 case 7: selectcmd
= shared
.select7
; break;
2291 case 8: selectcmd
= shared
.select8
; break;
2292 case 9: selectcmd
= shared
.select9
; break;
2294 selectcmd
= createObject(REDIS_STRING
,
2295 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2296 selectcmd
->refcount
= 0;
2299 addReply(slave
,selectcmd
);
2300 slave
->slaveseldb
= dictid
;
2302 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2304 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2305 if (outv
!= static_outv
) zfree(outv
);
2308 static void processInputBuffer(redisClient
*c
) {
2310 /* Before to process the input buffer, make sure the client is not
2311 * waitig for a blocking operation such as BLPOP. Note that the first
2312 * iteration the client is never blocked, otherwise the processInputBuffer
2313 * would not be called at all, but after the execution of the first commands
2314 * in the input buffer the client may be blocked, and the "goto again"
2315 * will try to reiterate. The following line will make it return asap. */
2316 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2317 if (c
->bulklen
== -1) {
2318 /* Read the first line of the query */
2319 char *p
= strchr(c
->querybuf
,'\n');
2326 query
= c
->querybuf
;
2327 c
->querybuf
= sdsempty();
2328 querylen
= 1+(p
-(query
));
2329 if (sdslen(query
) > querylen
) {
2330 /* leave data after the first line of the query in the buffer */
2331 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2333 *p
= '\0'; /* remove "\n" */
2334 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2335 sdsupdatelen(query
);
2337 /* Now we can split the query in arguments */
2338 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2341 if (c
->argv
) zfree(c
->argv
);
2342 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2344 for (j
= 0; j
< argc
; j
++) {
2345 if (sdslen(argv
[j
])) {
2346 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2354 /* Execute the command. If the client is still valid
2355 * after processCommand() return and there is something
2356 * on the query buffer try to process the next command. */
2357 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2359 /* Nothing to process, argc == 0. Just process the query
2360 * buffer if it's not empty or return to the caller */
2361 if (sdslen(c
->querybuf
)) goto again
;
2364 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2365 redisLog(REDIS_VERBOSE
, "Client protocol error");
2370 /* Bulk read handling. Note that if we are at this point
2371 the client already sent a command terminated with a newline,
2372 we are reading the bulk data that is actually the last
2373 argument of the command. */
2374 int qbl
= sdslen(c
->querybuf
);
2376 if (c
->bulklen
<= qbl
) {
2377 /* Copy everything but the final CRLF as final argument */
2378 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2380 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2381 /* Process the command. If the client is still valid after
2382 * the processing and there is more data in the buffer
2383 * try to parse it. */
2384 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2390 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2391 redisClient
*c
= (redisClient
*) privdata
;
2392 char buf
[REDIS_IOBUF_LEN
];
2395 REDIS_NOTUSED(mask
);
2397 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2399 if (errno
== EAGAIN
) {
2402 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2406 } else if (nread
== 0) {
2407 redisLog(REDIS_VERBOSE
, "Client closed connection");
2412 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2413 c
->lastinteraction
= time(NULL
);
2417 if (!(c
->flags
& REDIS_BLOCKED
))
2418 processInputBuffer(c
);
2421 static int selectDb(redisClient
*c
, int id
) {
2422 if (id
< 0 || id
>= server
.dbnum
)
2424 c
->db
= &server
.db
[id
];
2428 static void *dupClientReplyValue(void *o
) {
2429 incrRefCount((robj
*)o
);
2433 static redisClient
*createClient(int fd
) {
2434 redisClient
*c
= zmalloc(sizeof(*c
));
2436 anetNonBlock(NULL
,fd
);
2437 anetTcpNoDelay(NULL
,fd
);
2438 if (!c
) return NULL
;
2441 c
->querybuf
= sdsempty();
2450 c
->lastinteraction
= time(NULL
);
2451 c
->authenticated
= 0;
2452 c
->replstate
= REDIS_REPL_NONE
;
2453 c
->reply
= listCreate();
2454 listSetFreeMethod(c
->reply
,decrRefCount
);
2455 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2456 c
->blockingkeys
= NULL
;
2457 c
->blockingkeysnum
= 0;
2458 c
->io_keys
= listCreate();
2459 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2460 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2461 readQueryFromClient
, c
) == AE_ERR
) {
2465 listAddNodeTail(server
.clients
,c
);
2466 initClientMultiState(c
);
2470 static void addReply(redisClient
*c
, robj
*obj
) {
2471 if (listLength(c
->reply
) == 0 &&
2472 (c
->replstate
== REDIS_REPL_NONE
||
2473 c
->replstate
== REDIS_REPL_ONLINE
) &&
2474 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2475 sendReplyToClient
, c
) == AE_ERR
) return;
2477 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2478 obj
= dupStringObject(obj
);
2479 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2481 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2484 static void addReplySds(redisClient
*c
, sds s
) {
2485 robj
*o
= createObject(REDIS_STRING
,s
);
2490 static void addReplyDouble(redisClient
*c
, double d
) {
2493 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2494 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2495 (unsigned long) strlen(buf
),buf
));
2498 static void addReplyLong(redisClient
*c
, long l
) {
2503 addReply(c
,shared
.czero
);
2505 } else if (l
== 1) {
2506 addReply(c
,shared
.cone
);
2509 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2510 addReplySds(c
,sdsnewlen(buf
,len
));
2513 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2518 addReply(c
,shared
.czero
);
2520 } else if (ul
== 1) {
2521 addReply(c
,shared
.cone
);
2524 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2525 addReplySds(c
,sdsnewlen(buf
,len
));
2528 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2531 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2532 len
= sdslen(obj
->ptr
);
2534 long n
= (long)obj
->ptr
;
2536 /* Compute how many bytes will take this integer as a radix 10 string */
2542 while((n
= n
/10) != 0) {
2546 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2549 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2550 addReplyBulkLen(c
,obj
);
2552 addReply(c
,shared
.crlf
);
2555 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2560 REDIS_NOTUSED(mask
);
2561 REDIS_NOTUSED(privdata
);
2563 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2564 if (cfd
== AE_ERR
) {
2565 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2568 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2569 if ((c
= createClient(cfd
)) == NULL
) {
2570 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2571 close(cfd
); /* May be already closed, just ingore errors */
2574 /* If maxclient directive is set and this is one client more... close the
2575 * connection. Note that we create the client instead to check before
2576 * for this condition, since now the socket is already set in nonblocking
2577 * mode and we can send an error for free using the Kernel I/O */
2578 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2579 char *err
= "-ERR max number of clients reached\r\n";
2581 /* That's a best effort error message, don't check write errors */
2582 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2583 /* Nothing to do, Just to avoid the warning... */
2588 server
.stat_numconnections
++;
2591 /* ======================= Redis objects implementation ===================== */
2593 static robj
*createObject(int type
, void *ptr
) {
2596 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2597 if (listLength(server
.objfreelist
)) {
2598 listNode
*head
= listFirst(server
.objfreelist
);
2599 o
= listNodeValue(head
);
2600 listDelNode(server
.objfreelist
,head
);
2601 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2603 if (server
.vm_enabled
) {
2604 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2605 o
= zmalloc(sizeof(*o
));
2607 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2611 o
->encoding
= REDIS_ENCODING_RAW
;
2614 if (server
.vm_enabled
) {
2615 /* Note that this code may run in the context of an I/O thread
2616 * and accessing to server.unixtime in theory is an error
2617 * (no locks). But in practice this is safe, and even if we read
2618 * garbage Redis will not fail, as it's just a statistical info */
2619 o
->vm
.atime
= server
.unixtime
;
2620 o
->storage
= REDIS_VM_MEMORY
;
2625 static robj
*createStringObject(char *ptr
, size_t len
) {
2626 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2629 static robj
*dupStringObject(robj
*o
) {
2630 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2631 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2634 static robj
*createListObject(void) {
2635 list
*l
= listCreate();
2637 listSetFreeMethod(l
,decrRefCount
);
2638 return createObject(REDIS_LIST
,l
);
2641 static robj
*createSetObject(void) {
2642 dict
*d
= dictCreate(&setDictType
,NULL
);
2643 return createObject(REDIS_SET
,d
);
2646 static robj
*createHashObject(void) {
2647 /* All the Hashes start as zipmaps. Will be automatically converted
2648 * into hash tables if there are enough elements or big elements
2650 unsigned char *zm
= zipmapNew();
2651 robj
*o
= createObject(REDIS_HASH
,zm
);
2652 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2656 static robj
*createZsetObject(void) {
2657 zset
*zs
= zmalloc(sizeof(*zs
));
2659 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2660 zs
->zsl
= zslCreate();
2661 return createObject(REDIS_ZSET
,zs
);
2664 static void freeStringObject(robj
*o
) {
2665 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2670 static void freeListObject(robj
*o
) {
2671 listRelease((list
*) o
->ptr
);
2674 static void freeSetObject(robj
*o
) {
2675 dictRelease((dict
*) o
->ptr
);
2678 static void freeZsetObject(robj
*o
) {
2681 dictRelease(zs
->dict
);
2686 static void freeHashObject(robj
*o
) {
2687 switch (o
->encoding
) {
2688 case REDIS_ENCODING_HT
:
2689 dictRelease((dict
*) o
->ptr
);
2691 case REDIS_ENCODING_ZIPMAP
:
2700 static void incrRefCount(robj
*o
) {
2701 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2705 static void decrRefCount(void *obj
) {
2708 /* Object is a key of a swapped out value, or in the process of being
2710 if (server
.vm_enabled
&&
2711 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2713 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2714 redisAssert(o
->refcount
== 1);
2716 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2717 redisAssert(o
->type
== REDIS_STRING
);
2718 freeStringObject(o
);
2719 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2720 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2721 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2722 !listAddNodeHead(server
.objfreelist
,o
))
2724 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2725 server
.vm_stats_swapped_objects
--;
2728 /* Object is in memory, or in the process of being swapped out. */
2729 if (--(o
->refcount
) == 0) {
2730 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2731 vmCancelThreadedIOJob(obj
);
2733 case REDIS_STRING
: freeStringObject(o
); break;
2734 case REDIS_LIST
: freeListObject(o
); break;
2735 case REDIS_SET
: freeSetObject(o
); break;
2736 case REDIS_ZSET
: freeZsetObject(o
); break;
2737 case REDIS_HASH
: freeHashObject(o
); break;
2738 default: redisAssert(0); break;
2740 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2741 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2742 !listAddNodeHead(server
.objfreelist
,o
))
2744 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2748 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2749 dictEntry
*de
= dictFind(db
->dict
,key
);
2751 robj
*key
= dictGetEntryKey(de
);
2752 robj
*val
= dictGetEntryVal(de
);
2754 if (server
.vm_enabled
) {
2755 if (key
->storage
== REDIS_VM_MEMORY
||
2756 key
->storage
== REDIS_VM_SWAPPING
)
2758 /* If we were swapping the object out, stop it, this key
2760 if (key
->storage
== REDIS_VM_SWAPPING
)
2761 vmCancelThreadedIOJob(key
);
2762 /* Update the access time of the key for the aging algorithm. */
2763 key
->vm
.atime
= server
.unixtime
;
2765 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2767 /* Our value was swapped on disk. Bring it at home. */
2768 redisAssert(val
== NULL
);
2769 val
= vmLoadObject(key
);
2770 dictGetEntryVal(de
) = val
;
2772 /* Clients blocked by the VM subsystem may be waiting for
2774 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2783 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2784 expireIfNeeded(db
,key
);
2785 return lookupKey(db
,key
);
2788 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2789 deleteIfVolatile(db
,key
);
2790 return lookupKey(db
,key
);
2793 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2794 robj
*o
= lookupKeyRead(c
->db
, key
);
2795 if (!o
) addReply(c
,reply
);
2799 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2800 robj
*o
= lookupKeyWrite(c
->db
, key
);
2801 if (!o
) addReply(c
,reply
);
2805 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2806 if (o
->type
!= type
) {
2807 addReply(c
,shared
.wrongtypeerr
);
2813 static int deleteKey(redisDb
*db
, robj
*key
) {
2816 /* We need to protect key from destruction: after the first dictDelete()
2817 * it may happen that 'key' is no longer valid if we don't increment
2818 * it's count. This may happen when we get the object reference directly
2819 * from the hash table with dictRandomKey() or dict iterators */
2821 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2822 retval
= dictDelete(db
->dict
,key
);
2825 return retval
== DICT_OK
;
2828 /* Try to share an object against the shared objects pool */
2829 static robj
*tryObjectSharing(robj
*o
) {
2830 struct dictEntry
*de
;
2833 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2835 redisAssert(o
->type
== REDIS_STRING
);
2836 de
= dictFind(server
.sharingpool
,o
);
2838 robj
*shared
= dictGetEntryKey(de
);
2840 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2841 dictGetEntryVal(de
) = (void*) c
;
2842 incrRefCount(shared
);
2846 /* Here we are using a stream algorihtm: Every time an object is
2847 * shared we increment its count, everytime there is a miss we
2848 * recrement the counter of a random object. If this object reaches
2849 * zero we remove the object and put the current object instead. */
2850 if (dictSize(server
.sharingpool
) >=
2851 server
.sharingpoolsize
) {
2852 de
= dictGetRandomKey(server
.sharingpool
);
2853 redisAssert(de
!= NULL
);
2854 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2855 dictGetEntryVal(de
) = (void*) c
;
2857 dictDelete(server
.sharingpool
,de
->key
);
2860 c
= 0; /* If the pool is empty we want to add this object */
2865 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2866 redisAssert(retval
== DICT_OK
);
2873 /* Check if the nul-terminated string 's' can be represented by a long
2874 * (that is, is a number that fits into long without any other space or
2875 * character before or after the digits).
2877 * If so, the function returns REDIS_OK and *longval is set to the value
2878 * of the number. Otherwise REDIS_ERR is returned */
2879 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2880 char buf
[32], *endptr
;
2884 value
= strtol(s
, &endptr
, 10);
2885 if (endptr
[0] != '\0') return REDIS_ERR
;
2886 slen
= snprintf(buf
,32,"%ld",value
);
2888 /* If the number converted back into a string is not identical
2889 * then it's not possible to encode the string as integer */
2890 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2891 if (longval
) *longval
= value
;
2895 /* Try to encode a string object in order to save space */
2896 static int tryObjectEncoding(robj
*o
) {
2900 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2901 return REDIS_ERR
; /* Already encoded */
2903 /* It's not save to encode shared objects: shared objects can be shared
2904 * everywhere in the "object space" of Redis. Encoded objects can only
2905 * appear as "values" (and not, for instance, as keys) */
2906 if (o
->refcount
> 1) return REDIS_ERR
;
2908 /* Currently we try to encode only strings */
2909 redisAssert(o
->type
== REDIS_STRING
);
2911 /* Check if we can represent this string as a long integer */
2912 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2914 /* Ok, this object can be encoded */
2915 o
->encoding
= REDIS_ENCODING_INT
;
2917 o
->ptr
= (void*) value
;
2921 /* Get a decoded version of an encoded object (returned as a new object).
2922 * If the object is already raw-encoded just increment the ref count. */
2923 static robj
*getDecodedObject(robj
*o
) {
2926 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2930 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2933 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2934 dec
= createStringObject(buf
,strlen(buf
));
2937 redisAssert(1 != 1);
2941 /* Compare two string objects via strcmp() or alike.
2942 * Note that the objects may be integer-encoded. In such a case we
2943 * use snprintf() to get a string representation of the numbers on the stack
2944 * and compare the strings, it's much faster than calling getDecodedObject().
2946 * Important note: if objects are not integer encoded, but binary-safe strings,
2947 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2949 static int compareStringObjects(robj
*a
, robj
*b
) {
2950 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2951 char bufa
[128], bufb
[128], *astr
, *bstr
;
2954 if (a
== b
) return 0;
2955 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2956 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2962 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2963 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2969 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2972 static size_t stringObjectLen(robj
*o
) {
2973 redisAssert(o
->type
== REDIS_STRING
);
2974 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2975 return sdslen(o
->ptr
);
2979 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2983 /*============================ RDB saving/loading =========================== */
2985 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2986 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2990 static int rdbSaveTime(FILE *fp
, time_t t
) {
2991 int32_t t32
= (int32_t) t
;
2992 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2996 /* check rdbLoadLen() comments for more info */
2997 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2998 unsigned char buf
[2];
3001 /* Save a 6 bit len */
3002 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3003 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3004 } else if (len
< (1<<14)) {
3005 /* Save a 14 bit len */
3006 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3008 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3010 /* Save a 32 bit len */
3011 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3012 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3014 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3019 /* String objects in the form "2391" "-100" without any space and with a
3020 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3021 * encoded as integers to save space */
3022 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3024 char *endptr
, buf
[32];
3026 /* Check if it's possible to encode this value as a number */
3027 value
= strtoll(s
, &endptr
, 10);
3028 if (endptr
[0] != '\0') return 0;
3029 snprintf(buf
,32,"%lld",value
);
3031 /* If the number converted back into a string is not identical
3032 * then it's not possible to encode the string as integer */
3033 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3035 /* Finally check if it fits in our ranges */
3036 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3037 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3038 enc
[1] = value
&0xFF;
3040 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3041 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3042 enc
[1] = value
&0xFF;
3043 enc
[2] = (value
>>8)&0xFF;
3045 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3046 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3047 enc
[1] = value
&0xFF;
3048 enc
[2] = (value
>>8)&0xFF;
3049 enc
[3] = (value
>>16)&0xFF;
3050 enc
[4] = (value
>>24)&0xFF;
3057 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3058 size_t comprlen
, outlen
;
3062 /* We require at least four bytes compression for this to be worth it */
3063 if (len
<= 4) return 0;
3065 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3066 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3067 if (comprlen
== 0) {
3071 /* Data compressed! Let's save it on disk */
3072 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3073 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3074 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3075 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3076 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3085 /* Save a string objet as [len][data] on disk. If the object is a string
3086 * representation of an integer value we try to safe it in a special form */
3087 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3090 /* Try integer encoding */
3092 unsigned char buf
[5];
3093 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3094 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3099 /* Try LZF compression - under 20 bytes it's unable to compress even
3100 * aaaaaaaaaaaaaaaaaa so skip it */
3101 if (server
.rdbcompression
&& len
> 20) {
3104 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3105 if (retval
== -1) return -1;
3106 if (retval
> 0) return 0;
3107 /* retval == 0 means data can't be compressed, save the old way */
3110 /* Store verbatim */
3111 if (rdbSaveLen(fp
,len
) == -1) return -1;
3112 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3116 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3117 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3120 /* Avoid incr/decr ref count business when possible.
3121 * This plays well with copy-on-write given that we are probably
3122 * in a child process (BGSAVE). Also this makes sure key objects
3123 * of swapped objects are not incRefCount-ed (an assert does not allow
3124 * this in order to avoid bugs) */
3125 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3126 obj
= getDecodedObject(obj
);
3127 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3130 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3135 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3136 * 8 bit integer specifing the length of the representation.
3137 * This 8 bit integer has special values in order to specify the following
3143 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3144 unsigned char buf
[128];
3150 } else if (!isfinite(val
)) {
3152 buf
[0] = (val
< 0) ? 255 : 254;
3154 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3155 buf
[0] = strlen((char*)buf
+1);
3158 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3162 /* Save a Redis object. */
3163 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3164 if (o
->type
== REDIS_STRING
) {
3165 /* Save a string value */
3166 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3167 } else if (o
->type
== REDIS_LIST
) {
3168 /* Save a list value */
3169 list
*list
= o
->ptr
;
3173 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3174 listRewind(list
,&li
);
3175 while((ln
= listNext(&li
))) {
3176 robj
*eleobj
= listNodeValue(ln
);
3178 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3180 } else if (o
->type
== REDIS_SET
) {
3181 /* Save a set value */
3183 dictIterator
*di
= dictGetIterator(set
);
3186 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3187 while((de
= dictNext(di
)) != NULL
) {
3188 robj
*eleobj
= dictGetEntryKey(de
);
3190 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3192 dictReleaseIterator(di
);
3193 } else if (o
->type
== REDIS_ZSET
) {
3194 /* Save a set value */
3196 dictIterator
*di
= dictGetIterator(zs
->dict
);
3199 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3200 while((de
= dictNext(di
)) != NULL
) {
3201 robj
*eleobj
= dictGetEntryKey(de
);
3202 double *score
= dictGetEntryVal(de
);
3204 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3205 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3207 dictReleaseIterator(di
);
3208 } else if (o
->type
== REDIS_HASH
) {
3209 /* Save a hash value */
3210 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3211 unsigned char *p
= zipmapRewind(o
->ptr
);
3212 unsigned int count
= zipmapLen(o
->ptr
);
3213 unsigned char *key
, *val
;
3214 unsigned int klen
, vlen
;
3216 if (rdbSaveLen(fp
,count
) == -1) return -1;
3217 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3218 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3219 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3222 dictIterator
*di
= dictGetIterator(o
->ptr
);
3225 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3226 while((de
= dictNext(di
)) != NULL
) {
3227 robj
*key
= dictGetEntryKey(de
);
3228 robj
*val
= dictGetEntryVal(de
);
3230 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3231 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3233 dictReleaseIterator(di
);
3241 /* Return the length the object will have on disk if saved with
3242 * the rdbSaveObject() function. Currently we use a trick to get
3243 * this length with very little changes to the code. In the future
3244 * we could switch to a faster solution. */
3245 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3246 if (fp
== NULL
) fp
= server
.devnull
;
3248 assert(rdbSaveObject(fp
,o
) != 1);
3252 /* Return the number of pages required to save this object in the swap file */
3253 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3254 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3256 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3259 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3260 static int rdbSave(char *filename
) {
3261 dictIterator
*di
= NULL
;
3266 time_t now
= time(NULL
);
3268 /* Wait for I/O therads to terminate, just in case this is a
3269 * foreground-saving, to avoid seeking the swap file descriptor at the
3271 if (server
.vm_enabled
)
3272 waitEmptyIOJobsQueue();
3274 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3275 fp
= fopen(tmpfile
,"w");
3277 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3280 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3281 for (j
= 0; j
< server
.dbnum
; j
++) {
3282 redisDb
*db
= server
.db
+j
;
3284 if (dictSize(d
) == 0) continue;
3285 di
= dictGetIterator(d
);
3291 /* Write the SELECT DB opcode */
3292 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3293 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3295 /* Iterate this DB writing every entry */
3296 while((de
= dictNext(di
)) != NULL
) {
3297 robj
*key
= dictGetEntryKey(de
);
3298 robj
*o
= dictGetEntryVal(de
);
3299 time_t expiretime
= getExpire(db
,key
);
3301 /* Save the expire time */
3302 if (expiretime
!= -1) {
3303 /* If this key is already expired skip it */
3304 if (expiretime
< now
) continue;
3305 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3306 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3308 /* Save the key and associated value. This requires special
3309 * handling if the value is swapped out. */
3310 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3311 key
->storage
== REDIS_VM_SWAPPING
) {
3312 /* Save type, key, value */
3313 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3314 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3315 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3317 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3319 /* Get a preview of the object in memory */
3320 po
= vmPreviewObject(key
);
3321 /* Save type, key, value */
3322 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3323 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3324 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3325 /* Remove the loaded object from memory */
3329 dictReleaseIterator(di
);
3332 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3334 /* Make sure data will not remain on the OS's output buffers */
3339 /* Use RENAME to make sure the DB file is changed atomically only
3340 * if the generate DB file is ok. */
3341 if (rename(tmpfile
,filename
) == -1) {
3342 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3346 redisLog(REDIS_NOTICE
,"DB saved on disk");
3348 server
.lastsave
= time(NULL
);
3354 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3355 if (di
) dictReleaseIterator(di
);
3359 static int rdbSaveBackground(char *filename
) {
3362 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3363 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3364 if ((childpid
= fork()) == 0) {
3366 if (server
.vm_enabled
) vmReopenSwapFile();
3368 if (rdbSave(filename
) == REDIS_OK
) {
3375 if (childpid
== -1) {
3376 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3380 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3381 server
.bgsavechildpid
= childpid
;
3384 return REDIS_OK
; /* unreached */
3387 static void rdbRemoveTempFile(pid_t childpid
) {
3390 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3394 static int rdbLoadType(FILE *fp
) {
3396 if (fread(&type
,1,1,fp
) == 0) return -1;
3400 static time_t rdbLoadTime(FILE *fp
) {
3402 if (fread(&t32
,4,1,fp
) == 0) return -1;
3403 return (time_t) t32
;
3406 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3407 * of this file for a description of how this are stored on disk.
3409 * isencoded is set to 1 if the readed length is not actually a length but
3410 * an "encoding type", check the above comments for more info */
3411 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3412 unsigned char buf
[2];
3416 if (isencoded
) *isencoded
= 0;
3417 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3418 type
= (buf
[0]&0xC0)>>6;
3419 if (type
== REDIS_RDB_6BITLEN
) {
3420 /* Read a 6 bit len */
3422 } else if (type
== REDIS_RDB_ENCVAL
) {
3423 /* Read a 6 bit len encoding type */
3424 if (isencoded
) *isencoded
= 1;
3426 } else if (type
== REDIS_RDB_14BITLEN
) {
3427 /* Read a 14 bit len */
3428 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3429 return ((buf
[0]&0x3F)<<8)|buf
[1];
3431 /* Read a 32 bit len */
3432 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3437 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3438 unsigned char enc
[4];
3441 if (enctype
== REDIS_RDB_ENC_INT8
) {
3442 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3443 val
= (signed char)enc
[0];
3444 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3446 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3447 v
= enc
[0]|(enc
[1]<<8);
3449 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3451 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3452 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3455 val
= 0; /* anti-warning */
3458 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3461 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3462 unsigned int len
, clen
;
3463 unsigned char *c
= NULL
;
3466 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3467 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3468 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3469 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3470 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3471 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3473 return createObject(REDIS_STRING
,val
);
3480 static robj
*rdbLoadStringObject(FILE*fp
) {
3485 len
= rdbLoadLen(fp
,&isencoded
);
3488 case REDIS_RDB_ENC_INT8
:
3489 case REDIS_RDB_ENC_INT16
:
3490 case REDIS_RDB_ENC_INT32
:
3491 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3492 case REDIS_RDB_ENC_LZF
:
3493 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3499 if (len
== REDIS_RDB_LENERR
) return NULL
;
3500 val
= sdsnewlen(NULL
,len
);
3501 if (len
&& fread(val
,len
,1,fp
) == 0) {
3505 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3508 /* For information about double serialization check rdbSaveDoubleValue() */
3509 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3513 if (fread(&len
,1,1,fp
) == 0) return -1;
3515 case 255: *val
= R_NegInf
; return 0;
3516 case 254: *val
= R_PosInf
; return 0;
3517 case 253: *val
= R_Nan
; return 0;
3519 if (fread(buf
,len
,1,fp
) == 0) return -1;
3521 sscanf(buf
, "%lg", val
);
3526 /* Load a Redis object of the specified type from the specified file.
3527 * On success a newly allocated object is returned, otherwise NULL. */
3528 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3531 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3532 if (type
== REDIS_STRING
) {
3533 /* Read string value */
3534 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3535 tryObjectEncoding(o
);
3536 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3537 /* Read list/set value */
3540 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3541 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3542 /* It's faster to expand the dict to the right size asap in order
3543 * to avoid rehashing */
3544 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3545 dictExpand(o
->ptr
,listlen
);
3546 /* Load every single element of the list/set */
3550 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3551 tryObjectEncoding(ele
);
3552 if (type
== REDIS_LIST
) {
3553 listAddNodeTail((list
*)o
->ptr
,ele
);
3555 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3558 } else if (type
== REDIS_ZSET
) {
3559 /* Read list/set value */
3563 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3564 o
= createZsetObject();
3566 /* Load every single element of the list/set */
3569 double *score
= zmalloc(sizeof(double));
3571 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3572 tryObjectEncoding(ele
);
3573 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3574 dictAdd(zs
->dict
,ele
,score
);
3575 zslInsert(zs
->zsl
,*score
,ele
);
3576 incrRefCount(ele
); /* added to skiplist */
3578 } else if (type
== REDIS_HASH
) {
3581 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3582 o
= createHashObject();
3583 /* Too many entries? Use an hash table. */
3584 if (hashlen
> server
.hash_max_zipmap_entries
)
3585 convertToRealHash(o
);
3586 /* Load every key/value, then set it into the zipmap or hash
3587 * table, as needed. */
3591 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3592 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3593 /* If we are using a zipmap and there are too big values
3594 * the object is converted to real hash table encoding. */
3595 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3596 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3597 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3599 convertToRealHash(o
);
3602 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3603 unsigned char *zm
= o
->ptr
;
3605 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3606 val
->ptr
,sdslen(val
->ptr
),NULL
);
3611 tryObjectEncoding(key
);
3612 tryObjectEncoding(val
);
3613 dictAdd((dict
*)o
->ptr
,key
,val
);
3622 static int rdbLoad(char *filename
) {
3624 robj
*keyobj
= NULL
;
3626 int type
, retval
, rdbver
;
3627 dict
*d
= server
.db
[0].dict
;
3628 redisDb
*db
= server
.db
+0;
3630 time_t expiretime
= -1, now
= time(NULL
);
3631 long long loadedkeys
= 0;
3633 fp
= fopen(filename
,"r");
3634 if (!fp
) return REDIS_ERR
;
3635 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3637 if (memcmp(buf
,"REDIS",5) != 0) {
3639 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3642 rdbver
= atoi(buf
+5);
3645 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3652 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3653 if (type
== REDIS_EXPIRETIME
) {
3654 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3655 /* We read the time so we need to read the object type again */
3656 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3658 if (type
== REDIS_EOF
) break;
3659 /* Handle SELECT DB opcode as a special case */
3660 if (type
== REDIS_SELECTDB
) {
3661 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3663 if (dbid
>= (unsigned)server
.dbnum
) {
3664 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3667 db
= server
.db
+dbid
;
3672 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3674 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3675 /* Add the new object in the hash table */
3676 retval
= dictAdd(d
,keyobj
,o
);
3677 if (retval
== DICT_ERR
) {
3678 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3681 /* Set the expire time if needed */
3682 if (expiretime
!= -1) {
3683 setExpire(db
,keyobj
,expiretime
);
3684 /* Delete this key if already expired */
3685 if (expiretime
< now
) deleteKey(db
,keyobj
);
3689 /* Handle swapping while loading big datasets when VM is on */
3691 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3692 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3693 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3700 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3701 if (keyobj
) decrRefCount(keyobj
);
3702 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3704 return REDIS_ERR
; /* Just to avoid warning */
3707 /*================================== Commands =============================== */
3709 static void authCommand(redisClient
*c
) {
3710 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3711 c
->authenticated
= 1;
3712 addReply(c
,shared
.ok
);
3714 c
->authenticated
= 0;
3715 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3719 static void pingCommand(redisClient
*c
) {
3720 addReply(c
,shared
.pong
);
3723 static void echoCommand(redisClient
*c
) {
3724 addReplyBulk(c
,c
->argv
[1]);
3727 /*=================================== Strings =============================== */
3729 static void setGenericCommand(redisClient
*c
, int nx
) {
3732 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3733 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3734 if (retval
== DICT_ERR
) {
3736 /* If the key is about a swapped value, we want a new key object
3737 * to overwrite the old. So we delete the old key in the database.
3738 * This will also make sure that swap pages about the old object
3739 * will be marked as free. */
3740 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3741 incrRefCount(c
->argv
[1]);
3742 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3743 incrRefCount(c
->argv
[2]);
3745 addReply(c
,shared
.czero
);
3749 incrRefCount(c
->argv
[1]);
3750 incrRefCount(c
->argv
[2]);
3753 removeExpire(c
->db
,c
->argv
[1]);
3754 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3757 static void setCommand(redisClient
*c
) {
3758 setGenericCommand(c
,0);
3761 static void setnxCommand(redisClient
*c
) {
3762 setGenericCommand(c
,1);
3765 static int getGenericCommand(redisClient
*c
) {
3768 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3771 if (o
->type
!= REDIS_STRING
) {
3772 addReply(c
,shared
.wrongtypeerr
);
3780 static void getCommand(redisClient
*c
) {
3781 getGenericCommand(c
);
3784 static void getsetCommand(redisClient
*c
) {
3785 if (getGenericCommand(c
) == REDIS_ERR
) return;
3786 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3787 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3789 incrRefCount(c
->argv
[1]);
3791 incrRefCount(c
->argv
[2]);
3793 removeExpire(c
->db
,c
->argv
[1]);
3796 static void mgetCommand(redisClient
*c
) {
3799 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3800 for (j
= 1; j
< c
->argc
; j
++) {
3801 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3803 addReply(c
,shared
.nullbulk
);
3805 if (o
->type
!= REDIS_STRING
) {
3806 addReply(c
,shared
.nullbulk
);
3814 static void msetGenericCommand(redisClient
*c
, int nx
) {
3815 int j
, busykeys
= 0;
3817 if ((c
->argc
% 2) == 0) {
3818 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3821 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3822 * set nothing at all if at least one already key exists. */
3824 for (j
= 1; j
< c
->argc
; j
+= 2) {
3825 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3831 addReply(c
, shared
.czero
);
3835 for (j
= 1; j
< c
->argc
; j
+= 2) {
3838 tryObjectEncoding(c
->argv
[j
+1]);
3839 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3840 if (retval
== DICT_ERR
) {
3841 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3842 incrRefCount(c
->argv
[j
+1]);
3844 incrRefCount(c
->argv
[j
]);
3845 incrRefCount(c
->argv
[j
+1]);
3847 removeExpire(c
->db
,c
->argv
[j
]);
3849 server
.dirty
+= (c
->argc
-1)/2;
3850 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3853 static void msetCommand(redisClient
*c
) {
3854 msetGenericCommand(c
,0);
3857 static void msetnxCommand(redisClient
*c
) {
3858 msetGenericCommand(c
,1);
3861 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3866 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3870 if (o
->type
!= REDIS_STRING
) {
3875 if (o
->encoding
== REDIS_ENCODING_RAW
)
3876 value
= strtoll(o
->ptr
, &eptr
, 10);
3877 else if (o
->encoding
== REDIS_ENCODING_INT
)
3878 value
= (long)o
->ptr
;
3880 redisAssert(1 != 1);
3885 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3886 tryObjectEncoding(o
);
3887 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3888 if (retval
== DICT_ERR
) {
3889 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3890 removeExpire(c
->db
,c
->argv
[1]);
3892 incrRefCount(c
->argv
[1]);
3895 addReply(c
,shared
.colon
);
3897 addReply(c
,shared
.crlf
);
3900 static void incrCommand(redisClient
*c
) {
3901 incrDecrCommand(c
,1);
3904 static void decrCommand(redisClient
*c
) {
3905 incrDecrCommand(c
,-1);
3908 static void incrbyCommand(redisClient
*c
) {
3909 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3910 incrDecrCommand(c
,incr
);
3913 static void decrbyCommand(redisClient
*c
) {
3914 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3915 incrDecrCommand(c
,-incr
);
3918 static void appendCommand(redisClient
*c
) {
3923 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3925 /* Create the key */
3926 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3927 incrRefCount(c
->argv
[1]);
3928 incrRefCount(c
->argv
[2]);
3929 totlen
= stringObjectLen(c
->argv
[2]);
3933 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3936 o
= dictGetEntryVal(de
);
3937 if (o
->type
!= REDIS_STRING
) {
3938 addReply(c
,shared
.wrongtypeerr
);
3941 /* If the object is specially encoded or shared we have to make
3943 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3944 robj
*decoded
= getDecodedObject(o
);
3946 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3947 decrRefCount(decoded
);
3948 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3951 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3952 o
->ptr
= sdscatlen(o
->ptr
,
3953 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3955 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3956 (unsigned long) c
->argv
[2]->ptr
);
3958 totlen
= sdslen(o
->ptr
);
3961 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3964 static void substrCommand(redisClient
*c
) {
3966 long start
= atoi(c
->argv
[2]->ptr
);
3967 long end
= atoi(c
->argv
[3]->ptr
);
3968 size_t rangelen
, strlen
;
3971 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
3972 checkType(c
,o
,REDIS_STRING
)) return;
3974 o
= getDecodedObject(o
);
3975 strlen
= sdslen(o
->ptr
);
3977 /* convert negative indexes */
3978 if (start
< 0) start
= strlen
+start
;
3979 if (end
< 0) end
= strlen
+end
;
3980 if (start
< 0) start
= 0;
3981 if (end
< 0) end
= 0;
3983 /* indexes sanity checks */
3984 if (start
> end
|| (size_t)start
>= strlen
) {
3985 /* Out of range start or start > end result in null reply */
3986 addReply(c
,shared
.nullbulk
);
3990 if ((size_t)end
>= strlen
) end
= strlen
-1;
3991 rangelen
= (end
-start
)+1;
3993 /* Return the result */
3994 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
3995 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
3996 addReplySds(c
,range
);
3997 addReply(c
,shared
.crlf
);
4001 /* ========================= Type agnostic commands ========================= */
4003 static void delCommand(redisClient
*c
) {
4006 for (j
= 1; j
< c
->argc
; j
++) {
4007 if (deleteKey(c
->db
,c
->argv
[j
])) {
4012 addReplyLong(c
,deleted
);
4015 static void existsCommand(redisClient
*c
) {
4016 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4019 static void selectCommand(redisClient
*c
) {
4020 int id
= atoi(c
->argv
[1]->ptr
);
4022 if (selectDb(c
,id
) == REDIS_ERR
) {
4023 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4025 addReply(c
,shared
.ok
);
4029 static void randomkeyCommand(redisClient
*c
) {
4033 de
= dictGetRandomKey(c
->db
->dict
);
4034 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4037 addReply(c
,shared
.plus
);
4038 addReply(c
,shared
.crlf
);
4040 addReply(c
,shared
.plus
);
4041 addReply(c
,dictGetEntryKey(de
));
4042 addReply(c
,shared
.crlf
);
4046 static void keysCommand(redisClient
*c
) {
4049 sds pattern
= c
->argv
[1]->ptr
;
4050 int plen
= sdslen(pattern
);
4051 unsigned long numkeys
= 0;
4052 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4054 di
= dictGetIterator(c
->db
->dict
);
4056 decrRefCount(lenobj
);
4057 while((de
= dictNext(di
)) != NULL
) {
4058 robj
*keyobj
= dictGetEntryKey(de
);
4060 sds key
= keyobj
->ptr
;
4061 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4062 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4063 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4064 addReplyBulk(c
,keyobj
);
4069 dictReleaseIterator(di
);
4070 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4073 static void dbsizeCommand(redisClient
*c
) {
4075 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4078 static void lastsaveCommand(redisClient
*c
) {
4080 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4083 static void typeCommand(redisClient
*c
) {
4087 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4092 case REDIS_STRING
: type
= "+string"; break;
4093 case REDIS_LIST
: type
= "+list"; break;
4094 case REDIS_SET
: type
= "+set"; break;
4095 case REDIS_ZSET
: type
= "+zset"; break;
4096 case REDIS_HASH
: type
= "+hash"; break;
4097 default: type
= "+unknown"; break;
4100 addReplySds(c
,sdsnew(type
));
4101 addReply(c
,shared
.crlf
);
4104 static void saveCommand(redisClient
*c
) {
4105 if (server
.bgsavechildpid
!= -1) {
4106 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4109 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4110 addReply(c
,shared
.ok
);
4112 addReply(c
,shared
.err
);
4116 static void bgsaveCommand(redisClient
*c
) {
4117 if (server
.bgsavechildpid
!= -1) {
4118 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4121 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4122 char *status
= "+Background saving started\r\n";
4123 addReplySds(c
,sdsnew(status
));
4125 addReply(c
,shared
.err
);
4129 static void shutdownCommand(redisClient
*c
) {
4130 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4131 /* Kill the saving child if there is a background saving in progress.
4132 We want to avoid race conditions, for instance our saving child may
4133 overwrite the synchronous saving did by SHUTDOWN. */
4134 if (server
.bgsavechildpid
!= -1) {
4135 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4136 kill(server
.bgsavechildpid
,SIGKILL
);
4137 rdbRemoveTempFile(server
.bgsavechildpid
);
4139 if (server
.appendonly
) {
4140 /* Append only file: fsync() the AOF and exit */
4141 fsync(server
.appendfd
);
4142 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4145 /* Snapshotting. Perform a SYNC SAVE and exit */
4146 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4147 if (server
.daemonize
)
4148 unlink(server
.pidfile
);
4149 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4150 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4151 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4154 /* Ooops.. error saving! The best we can do is to continue
4155 * operating. Note that if there was a background saving process,
4156 * in the next cron() Redis will be notified that the background
4157 * saving aborted, handling special stuff like slaves pending for
4158 * synchronization... */
4159 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4161 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4166 static void renameGenericCommand(redisClient
*c
, int nx
) {
4169 /* To use the same key as src and dst is probably an error */
4170 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4171 addReply(c
,shared
.sameobjecterr
);
4175 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4179 deleteIfVolatile(c
->db
,c
->argv
[2]);
4180 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4183 addReply(c
,shared
.czero
);
4186 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4188 incrRefCount(c
->argv
[2]);
4190 deleteKey(c
->db
,c
->argv
[1]);
4192 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4195 static void renameCommand(redisClient
*c
) {
4196 renameGenericCommand(c
,0);
4199 static void renamenxCommand(redisClient
*c
) {
4200 renameGenericCommand(c
,1);
4203 static void moveCommand(redisClient
*c
) {
4208 /* Obtain source and target DB pointers */
4211 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4212 addReply(c
,shared
.outofrangeerr
);
4216 selectDb(c
,srcid
); /* Back to the source DB */
4218 /* If the user is moving using as target the same
4219 * DB as the source DB it is probably an error. */
4221 addReply(c
,shared
.sameobjecterr
);
4225 /* Check if the element exists and get a reference */
4226 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4228 addReply(c
,shared
.czero
);
4232 /* Try to add the element to the target DB */
4233 deleteIfVolatile(dst
,c
->argv
[1]);
4234 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4235 addReply(c
,shared
.czero
);
4238 incrRefCount(c
->argv
[1]);
4241 /* OK! key moved, free the entry in the source DB */
4242 deleteKey(src
,c
->argv
[1]);
4244 addReply(c
,shared
.cone
);
4247 /* =================================== Lists ================================ */
4248 static void pushGenericCommand(redisClient
*c
, int where
) {
4252 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4254 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4255 addReply(c
,shared
.cone
);
4258 lobj
= createListObject();
4260 if (where
== REDIS_HEAD
) {
4261 listAddNodeHead(list
,c
->argv
[2]);
4263 listAddNodeTail(list
,c
->argv
[2]);
4265 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4266 incrRefCount(c
->argv
[1]);
4267 incrRefCount(c
->argv
[2]);
4269 if (lobj
->type
!= REDIS_LIST
) {
4270 addReply(c
,shared
.wrongtypeerr
);
4273 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4274 addReply(c
,shared
.cone
);
4278 if (where
== REDIS_HEAD
) {
4279 listAddNodeHead(list
,c
->argv
[2]);
4281 listAddNodeTail(list
,c
->argv
[2]);
4283 incrRefCount(c
->argv
[2]);
4286 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4289 static void lpushCommand(redisClient
*c
) {
4290 pushGenericCommand(c
,REDIS_HEAD
);
4293 static void rpushCommand(redisClient
*c
) {
4294 pushGenericCommand(c
,REDIS_TAIL
);
4297 static void llenCommand(redisClient
*c
) {
4301 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4302 checkType(c
,o
,REDIS_LIST
)) return;
4305 addReplyUlong(c
,listLength(l
));
4308 static void lindexCommand(redisClient
*c
) {
4310 int index
= atoi(c
->argv
[2]->ptr
);
4314 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4315 checkType(c
,o
,REDIS_LIST
)) return;
4318 ln
= listIndex(list
, index
);
4320 addReply(c
,shared
.nullbulk
);
4322 robj
*ele
= listNodeValue(ln
);
4323 addReplyBulk(c
,ele
);
4327 static void lsetCommand(redisClient
*c
) {
4329 int index
= atoi(c
->argv
[2]->ptr
);
4333 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4334 checkType(c
,o
,REDIS_LIST
)) return;
4337 ln
= listIndex(list
, index
);
4339 addReply(c
,shared
.outofrangeerr
);
4341 robj
*ele
= listNodeValue(ln
);
4344 listNodeValue(ln
) = c
->argv
[3];
4345 incrRefCount(c
->argv
[3]);
4346 addReply(c
,shared
.ok
);
4351 static void popGenericCommand(redisClient
*c
, int where
) {
4356 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4357 checkType(c
,o
,REDIS_LIST
)) return;
4360 if (where
== REDIS_HEAD
)
4361 ln
= listFirst(list
);
4363 ln
= listLast(list
);
4366 addReply(c
,shared
.nullbulk
);
4368 robj
*ele
= listNodeValue(ln
);
4369 addReplyBulk(c
,ele
);
4370 listDelNode(list
,ln
);
4375 static void lpopCommand(redisClient
*c
) {
4376 popGenericCommand(c
,REDIS_HEAD
);
4379 static void rpopCommand(redisClient
*c
) {
4380 popGenericCommand(c
,REDIS_TAIL
);
4383 static void lrangeCommand(redisClient
*c
) {
4385 int start
= atoi(c
->argv
[2]->ptr
);
4386 int end
= atoi(c
->argv
[3]->ptr
);
4393 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4394 checkType(c
,o
,REDIS_LIST
)) return;
4396 llen
= listLength(list
);
4398 /* convert negative indexes */
4399 if (start
< 0) start
= llen
+start
;
4400 if (end
< 0) end
= llen
+end
;
4401 if (start
< 0) start
= 0;
4402 if (end
< 0) end
= 0;
4404 /* indexes sanity checks */
4405 if (start
> end
|| start
>= llen
) {
4406 /* Out of range start or start > end result in empty list */
4407 addReply(c
,shared
.emptymultibulk
);
4410 if (end
>= llen
) end
= llen
-1;
4411 rangelen
= (end
-start
)+1;
4413 /* Return the result in form of a multi-bulk reply */
4414 ln
= listIndex(list
, start
);
4415 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4416 for (j
= 0; j
< rangelen
; j
++) {
4417 ele
= listNodeValue(ln
);
4418 addReplyBulk(c
,ele
);
4423 static void ltrimCommand(redisClient
*c
) {
4425 int start
= atoi(c
->argv
[2]->ptr
);
4426 int end
= atoi(c
->argv
[3]->ptr
);
4428 int j
, ltrim
, rtrim
;
4432 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4433 checkType(c
,o
,REDIS_LIST
)) return;
4435 llen
= listLength(list
);
4437 /* convert negative indexes */
4438 if (start
< 0) start
= llen
+start
;
4439 if (end
< 0) end
= llen
+end
;
4440 if (start
< 0) start
= 0;
4441 if (end
< 0) end
= 0;
4443 /* indexes sanity checks */
4444 if (start
> end
|| start
>= llen
) {
4445 /* Out of range start or start > end result in empty list */
4449 if (end
>= llen
) end
= llen
-1;
4454 /* Remove list elements to perform the trim */
4455 for (j
= 0; j
< ltrim
; j
++) {
4456 ln
= listFirst(list
);
4457 listDelNode(list
,ln
);
4459 for (j
= 0; j
< rtrim
; j
++) {
4460 ln
= listLast(list
);
4461 listDelNode(list
,ln
);
4464 addReply(c
,shared
.ok
);
4467 static void lremCommand(redisClient
*c
) {
4470 listNode
*ln
, *next
;
4471 int toremove
= atoi(c
->argv
[2]->ptr
);
4475 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4476 checkType(c
,o
,REDIS_LIST
)) return;
4480 toremove
= -toremove
;
4483 ln
= fromtail
? list
->tail
: list
->head
;
4485 robj
*ele
= listNodeValue(ln
);
4487 next
= fromtail
? ln
->prev
: ln
->next
;
4488 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4489 listDelNode(list
,ln
);
4492 if (toremove
&& removed
== toremove
) break;
4496 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4499 /* This is the semantic of this command:
4500 * RPOPLPUSH srclist dstlist:
4501 * IF LLEN(srclist) > 0
4502 * element = RPOP srclist
4503 * LPUSH dstlist element
4510 * The idea is to be able to get an element from a list in a reliable way
4511 * since the element is not just returned but pushed against another list
4512 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4514 static void rpoplpushcommand(redisClient
*c
) {
4519 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4520 checkType(c
,sobj
,REDIS_LIST
)) return;
4521 srclist
= sobj
->ptr
;
4522 ln
= listLast(srclist
);
4525 addReply(c
,shared
.nullbulk
);
4527 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4528 robj
*ele
= listNodeValue(ln
);
4531 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4532 addReply(c
,shared
.wrongtypeerr
);
4536 /* Add the element to the target list (unless it's directly
4537 * passed to some BLPOP-ing client */
4538 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4540 /* Create the list if the key does not exist */
4541 dobj
= createListObject();
4542 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4543 incrRefCount(c
->argv
[2]);
4545 dstlist
= dobj
->ptr
;
4546 listAddNodeHead(dstlist
,ele
);
4550 /* Send the element to the client as reply as well */
4551 addReplyBulk(c
,ele
);
4553 /* Finally remove the element from the source list */
4554 listDelNode(srclist
,ln
);
4559 /* ==================================== Sets ================================ */
4561 static void saddCommand(redisClient
*c
) {
4564 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4566 set
= createSetObject();
4567 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4568 incrRefCount(c
->argv
[1]);
4570 if (set
->type
!= REDIS_SET
) {
4571 addReply(c
,shared
.wrongtypeerr
);
4575 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4576 incrRefCount(c
->argv
[2]);
4578 addReply(c
,shared
.cone
);
4580 addReply(c
,shared
.czero
);
4584 static void sremCommand(redisClient
*c
) {
4587 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4588 checkType(c
,set
,REDIS_SET
)) return;
4590 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4592 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4593 addReply(c
,shared
.cone
);
4595 addReply(c
,shared
.czero
);
4599 static void smoveCommand(redisClient
*c
) {
4600 robj
*srcset
, *dstset
;
4602 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4603 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4605 /* If the source key does not exist return 0, if it's of the wrong type
4607 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4608 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4611 /* Error if the destination key is not a set as well */
4612 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4613 addReply(c
,shared
.wrongtypeerr
);
4616 /* Remove the element from the source set */
4617 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4618 /* Key not found in the src set! return zero */
4619 addReply(c
,shared
.czero
);
4623 /* Add the element to the destination set */
4625 dstset
= createSetObject();
4626 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4627 incrRefCount(c
->argv
[2]);
4629 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4630 incrRefCount(c
->argv
[3]);
4631 addReply(c
,shared
.cone
);
4634 static void sismemberCommand(redisClient
*c
) {
4637 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4638 checkType(c
,set
,REDIS_SET
)) return;
4640 if (dictFind(set
->ptr
,c
->argv
[2]))
4641 addReply(c
,shared
.cone
);
4643 addReply(c
,shared
.czero
);
4646 static void scardCommand(redisClient
*c
) {
4650 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4651 checkType(c
,o
,REDIS_SET
)) return;
4654 addReplyUlong(c
,dictSize(s
));
4657 static void spopCommand(redisClient
*c
) {
4661 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4662 checkType(c
,set
,REDIS_SET
)) return;
4664 de
= dictGetRandomKey(set
->ptr
);
4666 addReply(c
,shared
.nullbulk
);
4668 robj
*ele
= dictGetEntryKey(de
);
4670 addReplyBulk(c
,ele
);
4671 dictDelete(set
->ptr
,ele
);
4672 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4677 static void srandmemberCommand(redisClient
*c
) {
4681 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4682 checkType(c
,set
,REDIS_SET
)) return;
4684 de
= dictGetRandomKey(set
->ptr
);
4686 addReply(c
,shared
.nullbulk
);
4688 robj
*ele
= dictGetEntryKey(de
);
4690 addReplyBulk(c
,ele
);
4694 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4695 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4697 return dictSize(*d1
)-dictSize(*d2
);
4700 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4701 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4704 robj
*lenobj
= NULL
, *dstset
= NULL
;
4705 unsigned long j
, cardinality
= 0;
4707 for (j
= 0; j
< setsnum
; j
++) {
4711 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4712 lookupKeyRead(c
->db
,setskeys
[j
]);
4716 if (deleteKey(c
->db
,dstkey
))
4718 addReply(c
,shared
.czero
);
4720 addReply(c
,shared
.nullmultibulk
);
4724 if (setobj
->type
!= REDIS_SET
) {
4726 addReply(c
,shared
.wrongtypeerr
);
4729 dv
[j
] = setobj
->ptr
;
4731 /* Sort sets from the smallest to largest, this will improve our
4732 * algorithm's performace */
4733 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4735 /* The first thing we should output is the total number of elements...
4736 * since this is a multi-bulk write, but at this stage we don't know
4737 * the intersection set size, so we use a trick, append an empty object
4738 * to the output list and save the pointer to later modify it with the
4741 lenobj
= createObject(REDIS_STRING
,NULL
);
4743 decrRefCount(lenobj
);
4745 /* If we have a target key where to store the resulting set
4746 * create this key with an empty set inside */
4747 dstset
= createSetObject();
4750 /* Iterate all the elements of the first (smallest) set, and test
4751 * the element against all the other sets, if at least one set does
4752 * not include the element it is discarded */
4753 di
= dictGetIterator(dv
[0]);
4755 while((de
= dictNext(di
)) != NULL
) {
4758 for (j
= 1; j
< setsnum
; j
++)
4759 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4761 continue; /* at least one set does not contain the member */
4762 ele
= dictGetEntryKey(de
);
4764 addReplyBulk(c
,ele
);
4767 dictAdd(dstset
->ptr
,ele
,NULL
);
4771 dictReleaseIterator(di
);
4774 /* Store the resulting set into the target */
4775 deleteKey(c
->db
,dstkey
);
4776 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4777 incrRefCount(dstkey
);
4781 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4783 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4784 dictSize((dict
*)dstset
->ptr
)));
4790 static void sinterCommand(redisClient
*c
) {
4791 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4794 static void sinterstoreCommand(redisClient
*c
) {
4795 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4798 #define REDIS_OP_UNION 0
4799 #define REDIS_OP_DIFF 1
4800 #define REDIS_OP_INTER 2
4802 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4803 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4806 robj
*dstset
= NULL
;
4807 int j
, cardinality
= 0;
4809 for (j
= 0; j
< setsnum
; j
++) {
4813 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4814 lookupKeyRead(c
->db
,setskeys
[j
]);
4819 if (setobj
->type
!= REDIS_SET
) {
4821 addReply(c
,shared
.wrongtypeerr
);
4824 dv
[j
] = setobj
->ptr
;
4827 /* We need a temp set object to store our union. If the dstkey
4828 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4829 * this set object will be the resulting object to set into the target key*/
4830 dstset
= createSetObject();
4832 /* Iterate all the elements of all the sets, add every element a single
4833 * time to the result set */
4834 for (j
= 0; j
< setsnum
; j
++) {
4835 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4836 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4838 di
= dictGetIterator(dv
[j
]);
4840 while((de
= dictNext(di
)) != NULL
) {
4843 /* dictAdd will not add the same element multiple times */
4844 ele
= dictGetEntryKey(de
);
4845 if (op
== REDIS_OP_UNION
|| j
== 0) {
4846 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4850 } else if (op
== REDIS_OP_DIFF
) {
4851 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4856 dictReleaseIterator(di
);
4858 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4861 /* Output the content of the resulting set, if not in STORE mode */
4863 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4864 di
= dictGetIterator(dstset
->ptr
);
4865 while((de
= dictNext(di
)) != NULL
) {
4868 ele
= dictGetEntryKey(de
);
4869 addReplyBulk(c
,ele
);
4871 dictReleaseIterator(di
);
4873 /* If we have a target key where to store the resulting set
4874 * create this key with the result set inside */
4875 deleteKey(c
->db
,dstkey
);
4876 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4877 incrRefCount(dstkey
);
4882 decrRefCount(dstset
);
4884 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4885 dictSize((dict
*)dstset
->ptr
)));
4891 static void sunionCommand(redisClient
*c
) {
4892 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4895 static void sunionstoreCommand(redisClient
*c
) {
4896 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4899 static void sdiffCommand(redisClient
*c
) {
4900 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4903 static void sdiffstoreCommand(redisClient
*c
) {
4904 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4907 /* ==================================== ZSets =============================== */
4909 /* ZSETs are ordered sets using two data structures to hold the same elements
4910 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4913 * The elements are added to an hash table mapping Redis objects to scores.
4914 * At the same time the elements are added to a skip list mapping scores
4915 * to Redis objects (so objects are sorted by scores in this "view"). */
4917 /* This skiplist implementation is almost a C translation of the original
4918 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4919 * Alternative to Balanced Trees", modified in three ways:
4920 * a) this implementation allows for repeated values.
4921 * b) the comparison is not just by key (our 'score') but by satellite data.
4922 * c) there is a back pointer, so it's a doubly linked list with the back
4923 * pointers being only at "level 1". This allows to traverse the list
4924 * from tail to head, useful for ZREVRANGE. */
4926 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4927 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4929 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4931 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4937 static zskiplist
*zslCreate(void) {
4941 zsl
= zmalloc(sizeof(*zsl
));
4944 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4945 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4946 zsl
->header
->forward
[j
] = NULL
;
4948 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4949 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4950 zsl
->header
->span
[j
] = 0;
4952 zsl
->header
->backward
= NULL
;
4957 static void zslFreeNode(zskiplistNode
*node
) {
4958 decrRefCount(node
->obj
);
4959 zfree(node
->forward
);
4964 static void zslFree(zskiplist
*zsl
) {
4965 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4967 zfree(zsl
->header
->forward
);
4968 zfree(zsl
->header
->span
);
4971 next
= node
->forward
[0];
4978 static int zslRandomLevel(void) {
4980 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4985 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4986 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4987 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
4991 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4992 /* store rank that is crossed to reach the insert position */
4993 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
4995 while (x
->forward
[i
] &&
4996 (x
->forward
[i
]->score
< score
||
4997 (x
->forward
[i
]->score
== score
&&
4998 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
4999 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5004 /* we assume the key is not already inside, since we allow duplicated
5005 * scores, and the re-insertion of score and redis object should never
5006 * happpen since the caller of zslInsert() should test in the hash table
5007 * if the element is already inside or not. */
5008 level
= zslRandomLevel();
5009 if (level
> zsl
->level
) {
5010 for (i
= zsl
->level
; i
< level
; i
++) {
5012 update
[i
] = zsl
->header
;
5013 update
[i
]->span
[i
-1] = zsl
->length
;
5017 x
= zslCreateNode(level
,score
,obj
);
5018 for (i
= 0; i
< level
; i
++) {
5019 x
->forward
[i
] = update
[i
]->forward
[i
];
5020 update
[i
]->forward
[i
] = x
;
5022 /* update span covered by update[i] as x is inserted here */
5024 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5025 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5029 /* increment span for untouched levels */
5030 for (i
= level
; i
< zsl
->level
; i
++) {
5031 update
[i
]->span
[i
-1]++;
5034 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5036 x
->forward
[0]->backward
= x
;
5042 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5043 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5045 for (i
= 0; i
< zsl
->level
; i
++) {
5046 if (update
[i
]->forward
[i
] == x
) {
5048 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5050 update
[i
]->forward
[i
] = x
->forward
[i
];
5052 /* invariant: i > 0, because update[0]->forward[0]
5053 * is always equal to x */
5054 update
[i
]->span
[i
-1] -= 1;
5057 if (x
->forward
[0]) {
5058 x
->forward
[0]->backward
= x
->backward
;
5060 zsl
->tail
= x
->backward
;
5062 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5067 /* Delete an element with matching score/object from the skiplist. */
5068 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5069 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5073 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5074 while (x
->forward
[i
] &&
5075 (x
->forward
[i
]->score
< score
||
5076 (x
->forward
[i
]->score
== score
&&
5077 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5081 /* We may have multiple elements with the same score, what we need
5082 * is to find the element with both the right score and object. */
5084 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5085 zslDeleteNode(zsl
, x
, update
);
5089 return 0; /* not found */
5091 return 0; /* not found */
5094 /* Delete all the elements with score between min and max from the skiplist.
5095 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5096 * Note that this function takes the reference to the hash table view of the
5097 * sorted set, in order to remove the elements from the hash table too. */
5098 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5099 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5100 unsigned long removed
= 0;
5104 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5105 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5109 /* We may have multiple elements with the same score, what we need
5110 * is to find the element with both the right score and object. */
5112 while (x
&& x
->score
<= max
) {
5113 zskiplistNode
*next
= x
->forward
[0];
5114 zslDeleteNode(zsl
, x
, update
);
5115 dictDelete(dict
,x
->obj
);
5120 return removed
; /* not found */
5123 /* Delete all the elements with rank between start and end from the skiplist.
5124 * Start and end are inclusive. Note that start and end need to be 1-based */
5125 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5126 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5127 unsigned long traversed
= 0, removed
= 0;
5131 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5132 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5133 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5141 while (x
&& traversed
<= end
) {
5142 zskiplistNode
*next
= x
->forward
[0];
5143 zslDeleteNode(zsl
, x
, update
);
5144 dictDelete(dict
,x
->obj
);
5153 /* Find the first node having a score equal or greater than the specified one.
5154 * Returns NULL if there is no match. */
5155 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5160 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5161 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5164 /* We may have multiple elements with the same score, what we need
5165 * is to find the element with both the right score and object. */
5166 return x
->forward
[0];
5169 /* Find the rank for an element by both score and key.
5170 * Returns 0 when the element cannot be found, rank otherwise.
5171 * Note that the rank is 1-based due to the span of zsl->header to the
5173 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5175 unsigned long rank
= 0;
5179 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5180 while (x
->forward
[i
] &&
5181 (x
->forward
[i
]->score
< score
||
5182 (x
->forward
[i
]->score
== score
&&
5183 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5184 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5188 /* x might be equal to zsl->header, so test if obj is non-NULL */
5189 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5196 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5197 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5199 unsigned long traversed
= 0;
5203 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5204 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5206 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5209 if (traversed
== rank
) {
5216 /* The actual Z-commands implementations */
5218 /* This generic command implements both ZADD and ZINCRBY.
5219 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5220 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5221 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5226 zsetobj
= lookupKeyWrite(c
->db
,key
);
5227 if (zsetobj
== NULL
) {
5228 zsetobj
= createZsetObject();
5229 dictAdd(c
->db
->dict
,key
,zsetobj
);
5232 if (zsetobj
->type
!= REDIS_ZSET
) {
5233 addReply(c
,shared
.wrongtypeerr
);
5239 /* Ok now since we implement both ZADD and ZINCRBY here the code
5240 * needs to handle the two different conditions. It's all about setting
5241 * '*score', that is, the new score to set, to the right value. */
5242 score
= zmalloc(sizeof(double));
5246 /* Read the old score. If the element was not present starts from 0 */
5247 de
= dictFind(zs
->dict
,ele
);
5249 double *oldscore
= dictGetEntryVal(de
);
5250 *score
= *oldscore
+ scoreval
;
5258 /* What follows is a simple remove and re-insert operation that is common
5259 * to both ZADD and ZINCRBY... */
5260 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5261 /* case 1: New element */
5262 incrRefCount(ele
); /* added to hash */
5263 zslInsert(zs
->zsl
,*score
,ele
);
5264 incrRefCount(ele
); /* added to skiplist */
5267 addReplyDouble(c
,*score
);
5269 addReply(c
,shared
.cone
);
5274 /* case 2: Score update operation */
5275 de
= dictFind(zs
->dict
,ele
);
5276 redisAssert(de
!= NULL
);
5277 oldscore
= dictGetEntryVal(de
);
5278 if (*score
!= *oldscore
) {
5281 /* Remove and insert the element in the skip list with new score */
5282 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5283 redisAssert(deleted
!= 0);
5284 zslInsert(zs
->zsl
,*score
,ele
);
5286 /* Update the score in the hash table */
5287 dictReplace(zs
->dict
,ele
,score
);
5293 addReplyDouble(c
,*score
);
5295 addReply(c
,shared
.czero
);
5299 static void zaddCommand(redisClient
*c
) {
5302 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5303 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5306 static void zincrbyCommand(redisClient
*c
) {
5309 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5310 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5313 static void zremCommand(redisClient
*c
) {
5320 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5321 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5324 de
= dictFind(zs
->dict
,c
->argv
[2]);
5326 addReply(c
,shared
.czero
);
5329 /* Delete from the skiplist */
5330 oldscore
= dictGetEntryVal(de
);
5331 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5332 redisAssert(deleted
!= 0);
5334 /* Delete from the hash table */
5335 dictDelete(zs
->dict
,c
->argv
[2]);
5336 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5338 addReply(c
,shared
.cone
);
5341 static void zremrangebyscoreCommand(redisClient
*c
) {
5342 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5343 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5348 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5349 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5352 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5353 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5354 server
.dirty
+= deleted
;
5355 addReplyLong(c
,deleted
);
5358 static void zremrangebyrankCommand(redisClient
*c
) {
5359 int start
= atoi(c
->argv
[2]->ptr
);
5360 int end
= atoi(c
->argv
[3]->ptr
);
5366 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5367 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5369 llen
= zs
->zsl
->length
;
5371 /* convert negative indexes */
5372 if (start
< 0) start
= llen
+start
;
5373 if (end
< 0) end
= llen
+end
;
5374 if (start
< 0) start
= 0;
5375 if (end
< 0) end
= 0;
5377 /* indexes sanity checks */
5378 if (start
> end
|| start
>= llen
) {
5379 addReply(c
,shared
.czero
);
5382 if (end
>= llen
) end
= llen
-1;
5384 /* increment start and end because zsl*Rank functions
5385 * use 1-based rank */
5386 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5387 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5388 server
.dirty
+= deleted
;
5389 addReplyLong(c
, deleted
);
5397 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5398 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5399 unsigned long size1
, size2
;
5400 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5401 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5402 return size1
- size2
;
5405 #define REDIS_AGGR_SUM 1
5406 #define REDIS_AGGR_MIN 2
5407 #define REDIS_AGGR_MAX 3
5409 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5410 if (aggregate
== REDIS_AGGR_SUM
) {
5411 *target
= *target
+ val
;
5412 } else if (aggregate
== REDIS_AGGR_MIN
) {
5413 *target
= val
< *target
? val
: *target
;
5414 } else if (aggregate
== REDIS_AGGR_MAX
) {
5415 *target
= val
> *target
? val
: *target
;
5418 redisAssert(0 != 0);
5422 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5424 int aggregate
= REDIS_AGGR_SUM
;
5431 /* expect zsetnum input keys to be given */
5432 zsetnum
= atoi(c
->argv
[2]->ptr
);
5434 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5438 /* test if the expected number of keys would overflow */
5439 if (3+zsetnum
> c
->argc
) {
5440 addReply(c
,shared
.syntaxerr
);
5444 /* read keys to be used for input */
5445 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5446 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5447 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5451 if (zsetobj
->type
!= REDIS_ZSET
) {
5453 addReply(c
,shared
.wrongtypeerr
);
5456 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5459 /* default all weights to 1 */
5460 src
[i
].weight
= 1.0;
5463 /* parse optional extra arguments */
5465 int remaining
= c
->argc
- j
;
5468 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5470 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5471 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5473 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5475 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5476 aggregate
= REDIS_AGGR_SUM
;
5477 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5478 aggregate
= REDIS_AGGR_MIN
;
5479 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5480 aggregate
= REDIS_AGGR_MAX
;
5483 addReply(c
,shared
.syntaxerr
);
5489 addReply(c
,shared
.syntaxerr
);
5495 /* sort sets from the smallest to largest, this will improve our
5496 * algorithm's performance */
5497 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5499 dstobj
= createZsetObject();
5500 dstzset
= dstobj
->ptr
;
5502 if (op
== REDIS_OP_INTER
) {
5503 /* skip going over all entries if the smallest zset is NULL or empty */
5504 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5505 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5506 * from small to large, all src[i > 0].dict are non-empty too */
5507 di
= dictGetIterator(src
[0].dict
);
5508 while((de
= dictNext(di
)) != NULL
) {
5509 double *score
= zmalloc(sizeof(double)), value
;
5510 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5512 for (j
= 1; j
< zsetnum
; j
++) {
5513 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5515 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5516 zunionInterAggregate(score
, value
, aggregate
);
5522 /* skip entry when not present in every source dict */
5526 robj
*o
= dictGetEntryKey(de
);
5527 dictAdd(dstzset
->dict
,o
,score
);
5528 incrRefCount(o
); /* added to dictionary */
5529 zslInsert(dstzset
->zsl
,*score
,o
);
5530 incrRefCount(o
); /* added to skiplist */
5533 dictReleaseIterator(di
);
5535 } else if (op
== REDIS_OP_UNION
) {
5536 for (i
= 0; i
< zsetnum
; i
++) {
5537 if (!src
[i
].dict
) continue;
5539 di
= dictGetIterator(src
[i
].dict
);
5540 while((de
= dictNext(di
)) != NULL
) {
5541 /* skip key when already processed */
5542 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5544 double *score
= zmalloc(sizeof(double)), value
;
5545 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5547 /* because the zsets are sorted by size, its only possible
5548 * for sets at larger indices to hold this entry */
5549 for (j
= (i
+1); j
< zsetnum
; j
++) {
5550 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5552 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5553 zunionInterAggregate(score
, value
, aggregate
);
5557 robj
*o
= dictGetEntryKey(de
);
5558 dictAdd(dstzset
->dict
,o
,score
);
5559 incrRefCount(o
); /* added to dictionary */
5560 zslInsert(dstzset
->zsl
,*score
,o
);
5561 incrRefCount(o
); /* added to skiplist */
5563 dictReleaseIterator(di
);
5566 /* unknown operator */
5567 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5570 deleteKey(c
->db
,dstkey
);
5571 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5572 incrRefCount(dstkey
);
5574 addReplyLong(c
, dstzset
->zsl
->length
);
5579 static void zunionCommand(redisClient
*c
) {
5580 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5583 static void zinterCommand(redisClient
*c
) {
5584 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5587 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5589 int start
= atoi(c
->argv
[2]->ptr
);
5590 int end
= atoi(c
->argv
[3]->ptr
);
5599 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5601 } else if (c
->argc
>= 5) {
5602 addReply(c
,shared
.syntaxerr
);
5606 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5607 checkType(c
,o
,REDIS_ZSET
)) return;
5612 /* convert negative indexes */
5613 if (start
< 0) start
= llen
+start
;
5614 if (end
< 0) end
= llen
+end
;
5615 if (start
< 0) start
= 0;
5616 if (end
< 0) end
= 0;
5618 /* indexes sanity checks */
5619 if (start
> end
|| start
>= llen
) {
5620 /* Out of range start or start > end result in empty list */
5621 addReply(c
,shared
.emptymultibulk
);
5624 if (end
>= llen
) end
= llen
-1;
5625 rangelen
= (end
-start
)+1;
5627 /* check if starting point is trivial, before searching
5628 * the element in log(N) time */
5630 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5633 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5636 /* Return the result in form of a multi-bulk reply */
5637 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5638 withscores
? (rangelen
*2) : rangelen
));
5639 for (j
= 0; j
< rangelen
; j
++) {
5641 addReplyBulk(c
,ele
);
5643 addReplyDouble(c
,ln
->score
);
5644 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5648 static void zrangeCommand(redisClient
*c
) {
5649 zrangeGenericCommand(c
,0);
5652 static void zrevrangeCommand(redisClient
*c
) {
5653 zrangeGenericCommand(c
,1);
5656 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5657 * If justcount is non-zero, just the count is returned. */
5658 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5661 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5662 int offset
= 0, limit
= -1;
5666 /* Parse the min-max interval. If one of the values is prefixed
5667 * by the "(" character, it's considered "open". For instance
5668 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5669 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5670 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5671 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5674 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5676 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5677 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5680 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5683 /* Parse "WITHSCORES": note that if the command was called with
5684 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5685 * enter the following paths to parse WITHSCORES and LIMIT. */
5686 if (c
->argc
== 5 || c
->argc
== 8) {
5687 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5692 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5696 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5701 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5702 addReply(c
,shared
.syntaxerr
);
5704 } else if (c
->argc
== (7 + withscores
)) {
5705 offset
= atoi(c
->argv
[5]->ptr
);
5706 limit
= atoi(c
->argv
[6]->ptr
);
5707 if (offset
< 0) offset
= 0;
5710 /* Ok, lookup the key and get the range */
5711 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5713 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5715 if (o
->type
!= REDIS_ZSET
) {
5716 addReply(c
,shared
.wrongtypeerr
);
5718 zset
*zsetobj
= o
->ptr
;
5719 zskiplist
*zsl
= zsetobj
->zsl
;
5721 robj
*ele
, *lenobj
= NULL
;
5722 unsigned long rangelen
= 0;
5724 /* Get the first node with the score >= min, or with
5725 * score > min if 'minex' is true. */
5726 ln
= zslFirstWithScore(zsl
,min
);
5727 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5730 /* No element matching the speciifed interval */
5731 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5735 /* We don't know in advance how many matching elements there
5736 * are in the list, so we push this object that will represent
5737 * the multi-bulk length in the output buffer, and will "fix"
5740 lenobj
= createObject(REDIS_STRING
,NULL
);
5742 decrRefCount(lenobj
);
5745 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5748 ln
= ln
->forward
[0];
5751 if (limit
== 0) break;
5754 addReplyBulk(c
,ele
);
5756 addReplyDouble(c
,ln
->score
);
5758 ln
= ln
->forward
[0];
5760 if (limit
> 0) limit
--;
5763 addReplyLong(c
,(long)rangelen
);
5765 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5766 withscores
? (rangelen
*2) : rangelen
);
5772 static void zrangebyscoreCommand(redisClient
*c
) {
5773 genericZrangebyscoreCommand(c
,0);
5776 static void zcountCommand(redisClient
*c
) {
5777 genericZrangebyscoreCommand(c
,1);
5780 static void zcardCommand(redisClient
*c
) {
5784 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5785 checkType(c
,o
,REDIS_ZSET
)) return;
5788 addReplyUlong(c
,zs
->zsl
->length
);
5791 static void zscoreCommand(redisClient
*c
) {
5796 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5797 checkType(c
,o
,REDIS_ZSET
)) return;
5800 de
= dictFind(zs
->dict
,c
->argv
[2]);
5802 addReply(c
,shared
.nullbulk
);
5804 double *score
= dictGetEntryVal(de
);
5806 addReplyDouble(c
,*score
);
5810 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5818 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5819 checkType(c
,o
,REDIS_ZSET
)) return;
5823 de
= dictFind(zs
->dict
,c
->argv
[2]);
5825 addReply(c
,shared
.nullbulk
);
5829 score
= dictGetEntryVal(de
);
5830 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5833 addReplyLong(c
, zsl
->length
- rank
);
5835 addReplyLong(c
, rank
-1);
5838 addReply(c
,shared
.nullbulk
);
5842 static void zrankCommand(redisClient
*c
) {
5843 zrankGenericCommand(c
, 0);
5846 static void zrevrankCommand(redisClient
*c
) {
5847 zrankGenericCommand(c
, 1);
5850 /* =================================== Hashes =============================== */
5851 static void hsetCommand(redisClient
*c
) {
5853 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5856 o
= createHashObject();
5857 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5858 incrRefCount(c
->argv
[1]);
5860 if (o
->type
!= REDIS_HASH
) {
5861 addReply(c
,shared
.wrongtypeerr
);
5865 /* We want to convert the zipmap into an hash table right now if the
5866 * entry to be added is too big. Note that we check if the object
5867 * is integer encoded before to try fetching the length in the test below.
5868 * This is because integers are small, but currently stringObjectLen()
5869 * performs a slow conversion: not worth it. */
5870 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5871 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5872 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5873 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5874 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5876 convertToRealHash(o
);
5879 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5880 unsigned char *zm
= o
->ptr
;
5881 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5883 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5884 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
5885 decrRefCount(valobj
);
5888 /* And here there is the second check for hash conversion...
5889 * we want to do it only if the operation was not just an update as
5890 * zipmapLen() is O(N). */
5891 if (!update
&& zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
5892 convertToRealHash(o
);
5894 tryObjectEncoding(c
->argv
[2]);
5895 /* note that c->argv[3] is already encoded, as the latest arg
5896 * of a bulk command is always integer encoded if possible. */
5897 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
5898 incrRefCount(c
->argv
[2]);
5902 incrRefCount(c
->argv
[3]);
5905 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
5908 static void hgetCommand(redisClient
*c
) {
5911 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5912 checkType(c
,o
,REDIS_HASH
)) return;
5914 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5915 unsigned char *zm
= o
->ptr
;
5920 field
= getDecodedObject(c
->argv
[2]);
5921 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
5922 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
5923 addReplySds(c
,sdsnewlen(val
,vlen
));
5924 addReply(c
,shared
.crlf
);
5925 decrRefCount(field
);
5928 addReply(c
,shared
.nullbulk
);
5929 decrRefCount(field
);
5933 struct dictEntry
*de
;
5935 de
= dictFind(o
->ptr
,c
->argv
[2]);
5937 addReply(c
,shared
.nullbulk
);
5939 robj
*e
= dictGetEntryVal(de
);
5946 static void hdelCommand(redisClient
*c
) {
5950 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5951 checkType(c
,o
,REDIS_HASH
)) return;
5953 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5954 robj
*field
= getDecodedObject(c
->argv
[2]);
5956 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
5957 (unsigned char*) field
->ptr
,
5958 sdslen(field
->ptr
), &deleted
);
5959 decrRefCount(field
);
5961 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
5963 if (deleted
) server
.dirty
++;
5964 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
5967 static void hlenCommand(redisClient
*c
) {
5971 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5972 checkType(c
,o
,REDIS_HASH
)) return;
5974 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
5975 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
5976 addReplyUlong(c
,len
);
5979 #define REDIS_GETALL_KEYS 1
5980 #define REDIS_GETALL_VALS 2
5981 static void genericHgetallCommand(redisClient
*c
, int flags
) {
5983 unsigned long count
= 0;
5985 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
5986 || checkType(c
,o
,REDIS_HASH
)) return;
5988 lenobj
= createObject(REDIS_STRING
,NULL
);
5990 decrRefCount(lenobj
);
5992 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5993 unsigned char *p
= zipmapRewind(o
->ptr
);
5994 unsigned char *field
, *val
;
5995 unsigned int flen
, vlen
;
5997 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
6000 if (flags
& REDIS_GETALL_KEYS
) {
6001 aux
= createStringObject((char*)field
,flen
);
6002 addReplyBulk(c
,aux
);
6006 if (flags
& REDIS_GETALL_VALS
) {
6007 aux
= createStringObject((char*)val
,vlen
);
6008 addReplyBulk(c
,aux
);
6014 dictIterator
*di
= dictGetIterator(o
->ptr
);
6017 while((de
= dictNext(di
)) != NULL
) {
6018 robj
*fieldobj
= dictGetEntryKey(de
);
6019 robj
*valobj
= dictGetEntryVal(de
);
6021 if (flags
& REDIS_GETALL_KEYS
) {
6022 addReplyBulk(c
,fieldobj
);
6025 if (flags
& REDIS_GETALL_VALS
) {
6026 addReplyBulk(c
,valobj
);
6030 dictReleaseIterator(di
);
6032 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6035 static void hkeysCommand(redisClient
*c
) {
6036 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6039 static void hvalsCommand(redisClient
*c
) {
6040 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6043 static void hgetallCommand(redisClient
*c
) {
6044 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6047 static void hexistsCommand(redisClient
*c
) {
6051 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6052 checkType(c
,o
,REDIS_HASH
)) return;
6054 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6056 unsigned char *zm
= o
->ptr
;
6058 field
= getDecodedObject(c
->argv
[2]);
6059 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6060 decrRefCount(field
);
6062 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6064 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6067 static void convertToRealHash(robj
*o
) {
6068 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6069 unsigned int klen
, vlen
;
6070 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6072 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6073 p
= zipmapRewind(zm
);
6074 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6075 robj
*keyobj
, *valobj
;
6077 keyobj
= createStringObject((char*)key
,klen
);
6078 valobj
= createStringObject((char*)val
,vlen
);
6079 tryObjectEncoding(keyobj
);
6080 tryObjectEncoding(valobj
);
6081 dictAdd(dict
,keyobj
,valobj
);
6083 o
->encoding
= REDIS_ENCODING_HT
;
6088 /* ========================= Non type-specific commands ==================== */
6090 static void flushdbCommand(redisClient
*c
) {
6091 server
.dirty
+= dictSize(c
->db
->dict
);
6092 dictEmpty(c
->db
->dict
);
6093 dictEmpty(c
->db
->expires
);
6094 addReply(c
,shared
.ok
);
6097 static void flushallCommand(redisClient
*c
) {
6098 server
.dirty
+= emptyDb();
6099 addReply(c
,shared
.ok
);
6100 rdbSave(server
.dbfilename
);
6104 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6105 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6107 so
->pattern
= pattern
;
6111 /* Return the value associated to the key with a name obtained
6112 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6113 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6117 int prefixlen
, sublen
, postfixlen
;
6118 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6122 char buf
[REDIS_SORTKEY_MAX
+1];
6125 /* If the pattern is "#" return the substitution object itself in order
6126 * to implement the "SORT ... GET #" feature. */
6127 spat
= pattern
->ptr
;
6128 if (spat
[0] == '#' && spat
[1] == '\0') {
6132 /* The substitution object may be specially encoded. If so we create
6133 * a decoded object on the fly. Otherwise getDecodedObject will just
6134 * increment the ref count, that we'll decrement later. */
6135 subst
= getDecodedObject(subst
);
6138 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6139 p
= strchr(spat
,'*');
6141 decrRefCount(subst
);
6146 sublen
= sdslen(ssub
);
6147 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6148 memcpy(keyname
.buf
,spat
,prefixlen
);
6149 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6150 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6151 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6152 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6154 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6155 decrRefCount(subst
);
6157 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6158 return lookupKeyRead(db
,&keyobj
);
6161 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6162 * the additional parameter is not standard but a BSD-specific we have to
6163 * pass sorting parameters via the global 'server' structure */
6164 static int sortCompare(const void *s1
, const void *s2
) {
6165 const redisSortObject
*so1
= s1
, *so2
= s2
;
6168 if (!server
.sort_alpha
) {
6169 /* Numeric sorting. Here it's trivial as we precomputed scores */
6170 if (so1
->u
.score
> so2
->u
.score
) {
6172 } else if (so1
->u
.score
< so2
->u
.score
) {
6178 /* Alphanumeric sorting */
6179 if (server
.sort_bypattern
) {
6180 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6181 /* At least one compare object is NULL */
6182 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6184 else if (so1
->u
.cmpobj
== NULL
)
6189 /* We have both the objects, use strcoll */
6190 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6193 /* Compare elements directly */
6196 dec1
= getDecodedObject(so1
->obj
);
6197 dec2
= getDecodedObject(so2
->obj
);
6198 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6203 return server
.sort_desc
? -cmp
: cmp
;
6206 /* The SORT command is the most complex command in Redis. Warning: this code
6207 * is optimized for speed and a bit less for readability */
6208 static void sortCommand(redisClient
*c
) {
6211 int desc
= 0, alpha
= 0;
6212 int limit_start
= 0, limit_count
= -1, start
, end
;
6213 int j
, dontsort
= 0, vectorlen
;
6214 int getop
= 0; /* GET operation counter */
6215 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6216 redisSortObject
*vector
; /* Resulting vector to sort */
6218 /* Lookup the key to sort. It must be of the right types */
6219 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6220 if (sortval
== NULL
) {
6221 addReply(c
,shared
.nullmultibulk
);
6224 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6225 sortval
->type
!= REDIS_ZSET
)
6227 addReply(c
,shared
.wrongtypeerr
);
6231 /* Create a list of operations to perform for every sorted element.
6232 * Operations can be GET/DEL/INCR/DECR */
6233 operations
= listCreate();
6234 listSetFreeMethod(operations
,zfree
);
6237 /* Now we need to protect sortval incrementing its count, in the future
6238 * SORT may have options able to overwrite/delete keys during the sorting
6239 * and the sorted key itself may get destroied */
6240 incrRefCount(sortval
);
6242 /* The SORT command has an SQL-alike syntax, parse it */
6243 while(j
< c
->argc
) {
6244 int leftargs
= c
->argc
-j
-1;
6245 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6247 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6249 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6251 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6252 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6253 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6255 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6256 storekey
= c
->argv
[j
+1];
6258 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6259 sortby
= c
->argv
[j
+1];
6260 /* If the BY pattern does not contain '*', i.e. it is constant,
6261 * we don't need to sort nor to lookup the weight keys. */
6262 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6264 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6265 listAddNodeTail(operations
,createSortOperation(
6266 REDIS_SORT_GET
,c
->argv
[j
+1]));
6270 decrRefCount(sortval
);
6271 listRelease(operations
);
6272 addReply(c
,shared
.syntaxerr
);
6278 /* Load the sorting vector with all the objects to sort */
6279 switch(sortval
->type
) {
6280 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6281 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6282 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6283 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6285 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6288 if (sortval
->type
== REDIS_LIST
) {
6289 list
*list
= sortval
->ptr
;
6293 listRewind(list
,&li
);
6294 while((ln
= listNext(&li
))) {
6295 robj
*ele
= ln
->value
;
6296 vector
[j
].obj
= ele
;
6297 vector
[j
].u
.score
= 0;
6298 vector
[j
].u
.cmpobj
= NULL
;
6306 if (sortval
->type
== REDIS_SET
) {
6309 zset
*zs
= sortval
->ptr
;
6313 di
= dictGetIterator(set
);
6314 while((setele
= dictNext(di
)) != NULL
) {
6315 vector
[j
].obj
= dictGetEntryKey(setele
);
6316 vector
[j
].u
.score
= 0;
6317 vector
[j
].u
.cmpobj
= NULL
;
6320 dictReleaseIterator(di
);
6322 redisAssert(j
== vectorlen
);
6324 /* Now it's time to load the right scores in the sorting vector */
6325 if (dontsort
== 0) {
6326 for (j
= 0; j
< vectorlen
; j
++) {
6330 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6331 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6333 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6335 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6336 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6338 /* Don't need to decode the object if it's
6339 * integer-encoded (the only encoding supported) so
6340 * far. We can just cast it */
6341 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6342 vector
[j
].u
.score
= (long)byval
->ptr
;
6344 redisAssert(1 != 1);
6349 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6350 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6352 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6353 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6355 redisAssert(1 != 1);
6362 /* We are ready to sort the vector... perform a bit of sanity check
6363 * on the LIMIT option too. We'll use a partial version of quicksort. */
6364 start
= (limit_start
< 0) ? 0 : limit_start
;
6365 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6366 if (start
>= vectorlen
) {
6367 start
= vectorlen
-1;
6370 if (end
>= vectorlen
) end
= vectorlen
-1;
6372 if (dontsort
== 0) {
6373 server
.sort_desc
= desc
;
6374 server
.sort_alpha
= alpha
;
6375 server
.sort_bypattern
= sortby
? 1 : 0;
6376 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6377 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6379 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6382 /* Send command output to the output buffer, performing the specified
6383 * GET/DEL/INCR/DECR operations if any. */
6384 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6385 if (storekey
== NULL
) {
6386 /* STORE option not specified, sent the sorting result to client */
6387 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6388 for (j
= start
; j
<= end
; j
++) {
6392 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6393 listRewind(operations
,&li
);
6394 while((ln
= listNext(&li
))) {
6395 redisSortOperation
*sop
= ln
->value
;
6396 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6399 if (sop
->type
== REDIS_SORT_GET
) {
6400 if (!val
|| val
->type
!= REDIS_STRING
) {
6401 addReply(c
,shared
.nullbulk
);
6403 addReplyBulk(c
,val
);
6406 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6411 robj
*listObject
= createListObject();
6412 list
*listPtr
= (list
*) listObject
->ptr
;
6414 /* STORE option specified, set the sorting result as a List object */
6415 for (j
= start
; j
<= end
; j
++) {
6420 listAddNodeTail(listPtr
,vector
[j
].obj
);
6421 incrRefCount(vector
[j
].obj
);
6423 listRewind(operations
,&li
);
6424 while((ln
= listNext(&li
))) {
6425 redisSortOperation
*sop
= ln
->value
;
6426 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6429 if (sop
->type
== REDIS_SORT_GET
) {
6430 if (!val
|| val
->type
!= REDIS_STRING
) {
6431 listAddNodeTail(listPtr
,createStringObject("",0));
6433 listAddNodeTail(listPtr
,val
);
6437 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6441 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6442 incrRefCount(storekey
);
6444 /* Note: we add 1 because the DB is dirty anyway since even if the
6445 * SORT result is empty a new key is set and maybe the old content
6447 server
.dirty
+= 1+outputlen
;
6448 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6452 decrRefCount(sortval
);
6453 listRelease(operations
);
6454 for (j
= 0; j
< vectorlen
; j
++) {
6455 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6456 decrRefCount(vector
[j
].u
.cmpobj
);
6461 /* Convert an amount of bytes into a human readable string in the form
6462 * of 100B, 2G, 100M, 4K, and so forth. */
6463 static void bytesToHuman(char *s
, unsigned long long n
) {
6468 sprintf(s
,"%lluB",n
);
6470 } else if (n
< (1024*1024)) {
6471 d
= (double)n
/(1024);
6472 sprintf(s
,"%.2fK",d
);
6473 } else if (n
< (1024LL*1024*1024)) {
6474 d
= (double)n
/(1024*1024);
6475 sprintf(s
,"%.2fM",d
);
6476 } else if (n
< (1024LL*1024*1024*1024)) {
6477 d
= (double)n
/(1024LL*1024*1024);
6478 sprintf(s
,"%.2fG",d
);
6482 /* Create the string returned by the INFO command. This is decoupled
6483 * by the INFO command itself as we need to report the same information
6484 * on memory corruption problems. */
6485 static sds
genRedisInfoString(void) {
6487 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6491 bytesToHuman(hmem
,zmalloc_used_memory());
6492 info
= sdscatprintf(sdsempty(),
6493 "redis_version:%s\r\n"
6495 "multiplexing_api:%s\r\n"
6496 "process_id:%ld\r\n"
6497 "uptime_in_seconds:%ld\r\n"
6498 "uptime_in_days:%ld\r\n"
6499 "connected_clients:%d\r\n"
6500 "connected_slaves:%d\r\n"
6501 "blocked_clients:%d\r\n"
6502 "used_memory:%zu\r\n"
6503 "used_memory_human:%s\r\n"
6504 "changes_since_last_save:%lld\r\n"
6505 "bgsave_in_progress:%d\r\n"
6506 "last_save_time:%ld\r\n"
6507 "bgrewriteaof_in_progress:%d\r\n"
6508 "total_connections_received:%lld\r\n"
6509 "total_commands_processed:%lld\r\n"
6510 "hash_max_zipmap_entries:%ld\r\n"
6511 "hash_max_zipmap_value:%ld\r\n"
6515 (sizeof(long) == 8) ? "64" : "32",
6520 listLength(server
.clients
)-listLength(server
.slaves
),
6521 listLength(server
.slaves
),
6522 server
.blpop_blocked_clients
,
6523 zmalloc_used_memory(),
6526 server
.bgsavechildpid
!= -1,
6528 server
.bgrewritechildpid
!= -1,
6529 server
.stat_numconnections
,
6530 server
.stat_numcommands
,
6531 server
.hash_max_zipmap_entries
,
6532 server
.hash_max_zipmap_value
,
6533 server
.vm_enabled
!= 0,
6534 server
.masterhost
== NULL
? "master" : "slave"
6536 if (server
.masterhost
) {
6537 info
= sdscatprintf(info
,
6538 "master_host:%s\r\n"
6539 "master_port:%d\r\n"
6540 "master_link_status:%s\r\n"
6541 "master_last_io_seconds_ago:%d\r\n"
6544 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6546 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6549 if (server
.vm_enabled
) {
6551 info
= sdscatprintf(info
,
6552 "vm_conf_max_memory:%llu\r\n"
6553 "vm_conf_page_size:%llu\r\n"
6554 "vm_conf_pages:%llu\r\n"
6555 "vm_stats_used_pages:%llu\r\n"
6556 "vm_stats_swapped_objects:%llu\r\n"
6557 "vm_stats_swappin_count:%llu\r\n"
6558 "vm_stats_swappout_count:%llu\r\n"
6559 "vm_stats_io_newjobs_len:%lu\r\n"
6560 "vm_stats_io_processing_len:%lu\r\n"
6561 "vm_stats_io_processed_len:%lu\r\n"
6562 "vm_stats_io_active_threads:%lu\r\n"
6563 "vm_stats_blocked_clients:%lu\r\n"
6564 ,(unsigned long long) server
.vm_max_memory
,
6565 (unsigned long long) server
.vm_page_size
,
6566 (unsigned long long) server
.vm_pages
,
6567 (unsigned long long) server
.vm_stats_used_pages
,
6568 (unsigned long long) server
.vm_stats_swapped_objects
,
6569 (unsigned long long) server
.vm_stats_swapins
,
6570 (unsigned long long) server
.vm_stats_swapouts
,
6571 (unsigned long) listLength(server
.io_newjobs
),
6572 (unsigned long) listLength(server
.io_processing
),
6573 (unsigned long) listLength(server
.io_processed
),
6574 (unsigned long) server
.io_active_threads
,
6575 (unsigned long) server
.vm_blocked_clients
6579 for (j
= 0; j
< server
.dbnum
; j
++) {
6580 long long keys
, vkeys
;
6582 keys
= dictSize(server
.db
[j
].dict
);
6583 vkeys
= dictSize(server
.db
[j
].expires
);
6584 if (keys
|| vkeys
) {
6585 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6592 static void infoCommand(redisClient
*c
) {
6593 sds info
= genRedisInfoString();
6594 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6595 (unsigned long)sdslen(info
)));
6596 addReplySds(c
,info
);
6597 addReply(c
,shared
.crlf
);
6600 static void monitorCommand(redisClient
*c
) {
6601 /* ignore MONITOR if aleady slave or in monitor mode */
6602 if (c
->flags
& REDIS_SLAVE
) return;
6604 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6606 listAddNodeTail(server
.monitors
,c
);
6607 addReply(c
,shared
.ok
);
6610 /* ================================= Expire ================================= */
6611 static int removeExpire(redisDb
*db
, robj
*key
) {
6612 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6619 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6620 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6628 /* Return the expire time of the specified key, or -1 if no expire
6629 * is associated with this key (i.e. the key is non volatile) */
6630 static time_t getExpire(redisDb
*db
, robj
*key
) {
6633 /* No expire? return ASAP */
6634 if (dictSize(db
->expires
) == 0 ||
6635 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6637 return (time_t) dictGetEntryVal(de
);
6640 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6644 /* No expire? return ASAP */
6645 if (dictSize(db
->expires
) == 0 ||
6646 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6648 /* Lookup the expire */
6649 when
= (time_t) dictGetEntryVal(de
);
6650 if (time(NULL
) <= when
) return 0;
6652 /* Delete the key */
6653 dictDelete(db
->expires
,key
);
6654 return dictDelete(db
->dict
,key
) == DICT_OK
;
6657 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6660 /* No expire? return ASAP */
6661 if (dictSize(db
->expires
) == 0 ||
6662 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6664 /* Delete the key */
6666 dictDelete(db
->expires
,key
);
6667 return dictDelete(db
->dict
,key
) == DICT_OK
;
6670 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6673 de
= dictFind(c
->db
->dict
,key
);
6675 addReply(c
,shared
.czero
);
6679 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6680 addReply(c
, shared
.cone
);
6683 time_t when
= time(NULL
)+seconds
;
6684 if (setExpire(c
->db
,key
,when
)) {
6685 addReply(c
,shared
.cone
);
6688 addReply(c
,shared
.czero
);
6694 static void expireCommand(redisClient
*c
) {
6695 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6698 static void expireatCommand(redisClient
*c
) {
6699 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6702 static void ttlCommand(redisClient
*c
) {
6706 expire
= getExpire(c
->db
,c
->argv
[1]);
6708 ttl
= (int) (expire
-time(NULL
));
6709 if (ttl
< 0) ttl
= -1;
6711 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6714 /* ================================ MULTI/EXEC ============================== */
6716 /* Client state initialization for MULTI/EXEC */
6717 static void initClientMultiState(redisClient
*c
) {
6718 c
->mstate
.commands
= NULL
;
6719 c
->mstate
.count
= 0;
6722 /* Release all the resources associated with MULTI/EXEC state */
6723 static void freeClientMultiState(redisClient
*c
) {
6726 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6728 multiCmd
*mc
= c
->mstate
.commands
+j
;
6730 for (i
= 0; i
< mc
->argc
; i
++)
6731 decrRefCount(mc
->argv
[i
]);
6734 zfree(c
->mstate
.commands
);
6737 /* Add a new command into the MULTI commands queue */
6738 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6742 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6743 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6744 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6747 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6748 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6749 for (j
= 0; j
< c
->argc
; j
++)
6750 incrRefCount(mc
->argv
[j
]);
6754 static void multiCommand(redisClient
*c
) {
6755 c
->flags
|= REDIS_MULTI
;
6756 addReply(c
,shared
.ok
);
6759 static void discardCommand(redisClient
*c
) {
6760 if (!(c
->flags
& REDIS_MULTI
)) {
6761 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6765 freeClientMultiState(c
);
6766 initClientMultiState(c
);
6767 c
->flags
&= (~REDIS_MULTI
);
6768 addReply(c
,shared
.ok
);
6771 static void execCommand(redisClient
*c
) {
6776 if (!(c
->flags
& REDIS_MULTI
)) {
6777 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6781 orig_argv
= c
->argv
;
6782 orig_argc
= c
->argc
;
6783 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6784 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6785 c
->argc
= c
->mstate
.commands
[j
].argc
;
6786 c
->argv
= c
->mstate
.commands
[j
].argv
;
6787 call(c
,c
->mstate
.commands
[j
].cmd
);
6789 c
->argv
= orig_argv
;
6790 c
->argc
= orig_argc
;
6791 freeClientMultiState(c
);
6792 initClientMultiState(c
);
6793 c
->flags
&= (~REDIS_MULTI
);
6796 /* =========================== Blocking Operations ========================= */
6798 /* Currently Redis blocking operations support is limited to list POP ops,
6799 * so the current implementation is not fully generic, but it is also not
6800 * completely specific so it will not require a rewrite to support new
6801 * kind of blocking operations in the future.
6803 * Still it's important to note that list blocking operations can be already
6804 * used as a notification mechanism in order to implement other blocking
6805 * operations at application level, so there must be a very strong evidence
6806 * of usefulness and generality before new blocking operations are implemented.
6808 * This is how the current blocking POP works, we use BLPOP as example:
6809 * - If the user calls BLPOP and the key exists and contains a non empty list
6810 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6811 * if there is not to block.
6812 * - If instead BLPOP is called and the key does not exists or the list is
6813 * empty we need to block. In order to do so we remove the notification for
6814 * new data to read in the client socket (so that we'll not serve new
6815 * requests if the blocking request is not served). Also we put the client
6816 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6817 * blocking for this keys.
6818 * - If a PUSH operation against a key with blocked clients waiting is
6819 * performed, we serve the first in the list: basically instead to push
6820 * the new element inside the list we return it to the (first / oldest)
6821 * blocking client, unblock the client, and remove it form the list.
6823 * The above comment and the source code should be enough in order to understand
6824 * the implementation and modify / fix it later.
6827 /* Set a client in blocking mode for the specified key, with the specified
6829 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6834 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6835 c
->blockingkeysnum
= numkeys
;
6836 c
->blockingto
= timeout
;
6837 for (j
= 0; j
< numkeys
; j
++) {
6838 /* Add the key in the client structure, to map clients -> keys */
6839 c
->blockingkeys
[j
] = keys
[j
];
6840 incrRefCount(keys
[j
]);
6842 /* And in the other "side", to map keys -> clients */
6843 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6847 /* For every key we take a list of clients blocked for it */
6849 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6850 incrRefCount(keys
[j
]);
6851 assert(retval
== DICT_OK
);
6853 l
= dictGetEntryVal(de
);
6855 listAddNodeTail(l
,c
);
6857 /* Mark the client as a blocked client */
6858 c
->flags
|= REDIS_BLOCKED
;
6859 server
.blpop_blocked_clients
++;
6862 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6863 static void unblockClientWaitingData(redisClient
*c
) {
6868 assert(c
->blockingkeys
!= NULL
);
6869 /* The client may wait for multiple keys, so unblock it for every key. */
6870 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6871 /* Remove this client from the list of clients waiting for this key. */
6872 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6874 l
= dictGetEntryVal(de
);
6875 listDelNode(l
,listSearchKey(l
,c
));
6876 /* If the list is empty we need to remove it to avoid wasting memory */
6877 if (listLength(l
) == 0)
6878 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6879 decrRefCount(c
->blockingkeys
[j
]);
6881 /* Cleanup the client structure */
6882 zfree(c
->blockingkeys
);
6883 c
->blockingkeys
= NULL
;
6884 c
->flags
&= (~REDIS_BLOCKED
);
6885 server
.blpop_blocked_clients
--;
6886 /* We want to process data if there is some command waiting
6887 * in the input buffer. Note that this is safe even if
6888 * unblockClientWaitingData() gets called from freeClient() because
6889 * freeClient() will be smart enough to call this function
6890 * *after* c->querybuf was set to NULL. */
6891 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6894 /* This should be called from any function PUSHing into lists.
6895 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6896 * 'ele' is the element pushed.
6898 * If the function returns 0 there was no client waiting for a list push
6901 * If the function returns 1 there was a client waiting for a list push
6902 * against this key, the element was passed to this client thus it's not
6903 * needed to actually add it to the list and the caller should return asap. */
6904 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6905 struct dictEntry
*de
;
6906 redisClient
*receiver
;
6910 de
= dictFind(c
->db
->blockingkeys
,key
);
6911 if (de
== NULL
) return 0;
6912 l
= dictGetEntryVal(de
);
6915 receiver
= ln
->value
;
6917 addReplySds(receiver
,sdsnew("*2\r\n"));
6918 addReplyBulk(receiver
,key
);
6919 addReplyBulk(receiver
,ele
);
6920 unblockClientWaitingData(receiver
);
6924 /* Blocking RPOP/LPOP */
6925 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6930 for (j
= 1; j
< c
->argc
-1; j
++) {
6931 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6933 if (o
->type
!= REDIS_LIST
) {
6934 addReply(c
,shared
.wrongtypeerr
);
6937 list
*list
= o
->ptr
;
6938 if (listLength(list
) != 0) {
6939 /* If the list contains elements fall back to the usual
6940 * non-blocking POP operation */
6941 robj
*argv
[2], **orig_argv
;
6944 /* We need to alter the command arguments before to call
6945 * popGenericCommand() as the command takes a single key. */
6946 orig_argv
= c
->argv
;
6947 orig_argc
= c
->argc
;
6948 argv
[1] = c
->argv
[j
];
6952 /* Also the return value is different, we need to output
6953 * the multi bulk reply header and the key name. The
6954 * "real" command will add the last element (the value)
6955 * for us. If this souds like an hack to you it's just
6956 * because it is... */
6957 addReplySds(c
,sdsnew("*2\r\n"));
6958 addReplyBulk(c
,argv
[1]);
6959 popGenericCommand(c
,where
);
6961 /* Fix the client structure with the original stuff */
6962 c
->argv
= orig_argv
;
6963 c
->argc
= orig_argc
;
6969 /* If the list is empty or the key does not exists we must block */
6970 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6971 if (timeout
> 0) timeout
+= time(NULL
);
6972 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6975 static void blpopCommand(redisClient
*c
) {
6976 blockingPopGenericCommand(c
,REDIS_HEAD
);
6979 static void brpopCommand(redisClient
*c
) {
6980 blockingPopGenericCommand(c
,REDIS_TAIL
);
6983 /* =============================== Replication ============================= */
6985 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6986 ssize_t nwritten
, ret
= size
;
6987 time_t start
= time(NULL
);
6991 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6992 nwritten
= write(fd
,ptr
,size
);
6993 if (nwritten
== -1) return -1;
6997 if ((time(NULL
)-start
) > timeout
) {
7005 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7006 ssize_t nread
, totread
= 0;
7007 time_t start
= time(NULL
);
7011 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7012 nread
= read(fd
,ptr
,size
);
7013 if (nread
== -1) return -1;
7018 if ((time(NULL
)-start
) > timeout
) {
7026 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7033 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7036 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7047 static void syncCommand(redisClient
*c
) {
7048 /* ignore SYNC if aleady slave or in monitor mode */
7049 if (c
->flags
& REDIS_SLAVE
) return;
7051 /* SYNC can't be issued when the server has pending data to send to
7052 * the client about already issued commands. We need a fresh reply
7053 * buffer registering the differences between the BGSAVE and the current
7054 * dataset, so that we can copy to other slaves if needed. */
7055 if (listLength(c
->reply
) != 0) {
7056 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7060 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7061 /* Here we need to check if there is a background saving operation
7062 * in progress, or if it is required to start one */
7063 if (server
.bgsavechildpid
!= -1) {
7064 /* Ok a background save is in progress. Let's check if it is a good
7065 * one for replication, i.e. if there is another slave that is
7066 * registering differences since the server forked to save */
7071 listRewind(server
.slaves
,&li
);
7072 while((ln
= listNext(&li
))) {
7074 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7077 /* Perfect, the server is already registering differences for
7078 * another slave. Set the right state, and copy the buffer. */
7079 listRelease(c
->reply
);
7080 c
->reply
= listDup(slave
->reply
);
7081 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7082 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7084 /* No way, we need to wait for the next BGSAVE in order to
7085 * register differences */
7086 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7087 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7090 /* Ok we don't have a BGSAVE in progress, let's start one */
7091 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7092 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7093 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7094 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7097 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7100 c
->flags
|= REDIS_SLAVE
;
7102 listAddNodeTail(server
.slaves
,c
);
7106 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7107 redisClient
*slave
= privdata
;
7109 REDIS_NOTUSED(mask
);
7110 char buf
[REDIS_IOBUF_LEN
];
7111 ssize_t nwritten
, buflen
;
7113 if (slave
->repldboff
== 0) {
7114 /* Write the bulk write count before to transfer the DB. In theory here
7115 * we don't know how much room there is in the output buffer of the
7116 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7117 * operations) will never be smaller than the few bytes we need. */
7120 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7122 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7130 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7131 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7133 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7134 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7138 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7139 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7144 slave
->repldboff
+= nwritten
;
7145 if (slave
->repldboff
== slave
->repldbsize
) {
7146 close(slave
->repldbfd
);
7147 slave
->repldbfd
= -1;
7148 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7149 slave
->replstate
= REDIS_REPL_ONLINE
;
7150 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7151 sendReplyToClient
, slave
) == AE_ERR
) {
7155 addReplySds(slave
,sdsempty());
7156 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7160 /* This function is called at the end of every backgrond saving.
7161 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7162 * otherwise REDIS_ERR is passed to the function.
7164 * The goal of this function is to handle slaves waiting for a successful
7165 * background saving in order to perform non-blocking synchronization. */
7166 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7168 int startbgsave
= 0;
7171 listRewind(server
.slaves
,&li
);
7172 while((ln
= listNext(&li
))) {
7173 redisClient
*slave
= ln
->value
;
7175 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7177 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7178 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7179 struct redis_stat buf
;
7181 if (bgsaveerr
!= REDIS_OK
) {
7183 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7186 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7187 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7189 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7192 slave
->repldboff
= 0;
7193 slave
->repldbsize
= buf
.st_size
;
7194 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7195 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7196 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7203 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7206 listRewind(server
.slaves
,&li
);
7207 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7208 while((ln
= listNext(&li
))) {
7209 redisClient
*slave
= ln
->value
;
7211 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7218 static int syncWithMaster(void) {
7219 char buf
[1024], tmpfile
[256], authcmd
[1024];
7221 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7222 int dfd
, maxtries
= 5;
7225 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7230 /* AUTH with the master if required. */
7231 if(server
.masterauth
) {
7232 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7233 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7235 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7239 /* Read the AUTH result. */
7240 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7242 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7246 if (buf
[0] != '+') {
7248 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7253 /* Issue the SYNC command */
7254 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7256 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7260 /* Read the bulk write count */
7261 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7263 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7267 if (buf
[0] != '$') {
7269 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7272 dumpsize
= strtol(buf
+1,NULL
,10);
7273 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7274 /* Read the bulk write data on a temp file */
7276 snprintf(tmpfile
,256,
7277 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7278 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7279 if (dfd
!= -1) break;
7284 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7288 int nread
, nwritten
;
7290 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7292 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7298 nwritten
= write(dfd
,buf
,nread
);
7299 if (nwritten
== -1) {
7300 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7308 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7309 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7315 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7316 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7320 server
.master
= createClient(fd
);
7321 server
.master
->flags
|= REDIS_MASTER
;
7322 server
.master
->authenticated
= 1;
7323 server
.replstate
= REDIS_REPL_CONNECTED
;
7327 static void slaveofCommand(redisClient
*c
) {
7328 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7329 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7330 if (server
.masterhost
) {
7331 sdsfree(server
.masterhost
);
7332 server
.masterhost
= NULL
;
7333 if (server
.master
) freeClient(server
.master
);
7334 server
.replstate
= REDIS_REPL_NONE
;
7335 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7338 sdsfree(server
.masterhost
);
7339 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7340 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7341 if (server
.master
) freeClient(server
.master
);
7342 server
.replstate
= REDIS_REPL_CONNECT
;
7343 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7344 server
.masterhost
, server
.masterport
);
7346 addReply(c
,shared
.ok
);
7349 /* ============================ Maxmemory directive ======================== */
7351 /* Try to free one object form the pre-allocated objects free list.
7352 * This is useful under low mem conditions as by default we take 1 million
7353 * free objects allocated. On success REDIS_OK is returned, otherwise
7355 static int tryFreeOneObjectFromFreelist(void) {
7358 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7359 if (listLength(server
.objfreelist
)) {
7360 listNode
*head
= listFirst(server
.objfreelist
);
7361 o
= listNodeValue(head
);
7362 listDelNode(server
.objfreelist
,head
);
7363 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7367 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7372 /* This function gets called when 'maxmemory' is set on the config file to limit
7373 * the max memory used by the server, and we are out of memory.
7374 * This function will try to, in order:
7376 * - Free objects from the free list
7377 * - Try to remove keys with an EXPIRE set
7379 * It is not possible to free enough memory to reach used-memory < maxmemory
7380 * the server will start refusing commands that will enlarge even more the
7383 static void freeMemoryIfNeeded(void) {
7384 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7385 int j
, k
, freed
= 0;
7387 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7388 for (j
= 0; j
< server
.dbnum
; j
++) {
7390 robj
*minkey
= NULL
;
7391 struct dictEntry
*de
;
7393 if (dictSize(server
.db
[j
].expires
)) {
7395 /* From a sample of three keys drop the one nearest to
7396 * the natural expire */
7397 for (k
= 0; k
< 3; k
++) {
7400 de
= dictGetRandomKey(server
.db
[j
].expires
);
7401 t
= (time_t) dictGetEntryVal(de
);
7402 if (minttl
== -1 || t
< minttl
) {
7403 minkey
= dictGetEntryKey(de
);
7407 deleteKey(server
.db
+j
,minkey
);
7410 if (!freed
) return; /* nothing to free... */
7414 /* ============================== Append Only file ========================== */
7416 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7417 sds buf
= sdsempty();
7423 /* The DB this command was targetting is not the same as the last command
7424 * we appendend. To issue a SELECT command is needed. */
7425 if (dictid
!= server
.appendseldb
) {
7428 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7429 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7430 (unsigned long)strlen(seldb
),seldb
);
7431 server
.appendseldb
= dictid
;
7434 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7435 * EXPIREs into EXPIREATs calls */
7436 if (cmd
->proc
== expireCommand
) {
7439 tmpargv
[0] = createStringObject("EXPIREAT",8);
7440 tmpargv
[1] = argv
[1];
7441 incrRefCount(argv
[1]);
7442 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7443 tmpargv
[2] = createObject(REDIS_STRING
,
7444 sdscatprintf(sdsempty(),"%ld",when
));
7448 /* Append the actual command */
7449 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7450 for (j
= 0; j
< argc
; j
++) {
7453 o
= getDecodedObject(o
);
7454 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7455 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7456 buf
= sdscatlen(buf
,"\r\n",2);
7460 /* Free the objects from the modified argv for EXPIREAT */
7461 if (cmd
->proc
== expireCommand
) {
7462 for (j
= 0; j
< 3; j
++)
7463 decrRefCount(argv
[j
]);
7466 /* We want to perform a single write. This should be guaranteed atomic
7467 * at least if the filesystem we are writing is a real physical one.
7468 * While this will save us against the server being killed I don't think
7469 * there is much to do about the whole server stopping for power problems
7471 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7472 if (nwritten
!= (signed)sdslen(buf
)) {
7473 /* Ooops, we are in troubles. The best thing to do for now is
7474 * to simply exit instead to give the illusion that everything is
7475 * working as expected. */
7476 if (nwritten
== -1) {
7477 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7479 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7483 /* If a background append only file rewriting is in progress we want to
7484 * accumulate the differences between the child DB and the current one
7485 * in a buffer, so that when the child process will do its work we
7486 * can append the differences to the new append only file. */
7487 if (server
.bgrewritechildpid
!= -1)
7488 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7492 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7493 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7494 now
-server
.lastfsync
> 1))
7496 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7497 server
.lastfsync
= now
;
7501 /* In Redis commands are always executed in the context of a client, so in
7502 * order to load the append only file we need to create a fake client. */
7503 static struct redisClient
*createFakeClient(void) {
7504 struct redisClient
*c
= zmalloc(sizeof(*c
));
7508 c
->querybuf
= sdsempty();
7512 /* We set the fake client as a slave waiting for the synchronization
7513 * so that Redis will not try to send replies to this client. */
7514 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7515 c
->reply
= listCreate();
7516 listSetFreeMethod(c
->reply
,decrRefCount
);
7517 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7521 static void freeFakeClient(struct redisClient
*c
) {
7522 sdsfree(c
->querybuf
);
7523 listRelease(c
->reply
);
7527 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7528 * error (the append only file is zero-length) REDIS_ERR is returned. On
7529 * fatal error an error message is logged and the program exists. */
7530 int loadAppendOnlyFile(char *filename
) {
7531 struct redisClient
*fakeClient
;
7532 FILE *fp
= fopen(filename
,"r");
7533 struct redis_stat sb
;
7534 unsigned long long loadedkeys
= 0;
7536 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7540 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7544 fakeClient
= createFakeClient();
7551 struct redisCommand
*cmd
;
7553 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7559 if (buf
[0] != '*') goto fmterr
;
7561 argv
= zmalloc(sizeof(robj
*)*argc
);
7562 for (j
= 0; j
< argc
; j
++) {
7563 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7564 if (buf
[0] != '$') goto fmterr
;
7565 len
= strtol(buf
+1,NULL
,10);
7566 argsds
= sdsnewlen(NULL
,len
);
7567 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7568 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7569 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7572 /* Command lookup */
7573 cmd
= lookupCommand(argv
[0]->ptr
);
7575 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7578 /* Try object sharing and encoding */
7579 if (server
.shareobjects
) {
7581 for(j
= 1; j
< argc
; j
++)
7582 argv
[j
] = tryObjectSharing(argv
[j
]);
7584 if (cmd
->flags
& REDIS_CMD_BULK
)
7585 tryObjectEncoding(argv
[argc
-1]);
7586 /* Run the command in the context of a fake client */
7587 fakeClient
->argc
= argc
;
7588 fakeClient
->argv
= argv
;
7589 cmd
->proc(fakeClient
);
7590 /* Discard the reply objects list from the fake client */
7591 while(listLength(fakeClient
->reply
))
7592 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7593 /* Clean up, ready for the next command */
7594 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7596 /* Handle swapping while loading big datasets when VM is on */
7598 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7599 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7600 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7605 freeFakeClient(fakeClient
);
7610 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7612 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7616 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7620 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7621 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7625 /* Avoid the incr/decr ref count business if possible to help
7626 * copy-on-write (we are often in a child process when this function
7628 * Also makes sure that key objects don't get incrRefCount-ed when VM
7630 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7631 obj
= getDecodedObject(obj
);
7634 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7635 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7636 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7638 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7639 if (decrrc
) decrRefCount(obj
);
7642 if (decrrc
) decrRefCount(obj
);
7646 /* Write binary-safe string into a file in the bulkformat
7647 * $<count>\r\n<payload>\r\n */
7648 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7651 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7652 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7653 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7654 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7658 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7659 static int fwriteBulkDouble(FILE *fp
, double d
) {
7660 char buf
[128], dbuf
[128];
7662 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7663 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7664 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7665 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7669 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7670 static int fwriteBulkLong(FILE *fp
, long l
) {
7671 char buf
[128], lbuf
[128];
7673 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7674 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7675 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7676 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7680 /* Write a sequence of commands able to fully rebuild the dataset into
7681 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7682 static int rewriteAppendOnlyFile(char *filename
) {
7683 dictIterator
*di
= NULL
;
7688 time_t now
= time(NULL
);
7690 /* Note that we have to use a different temp name here compared to the
7691 * one used by rewriteAppendOnlyFileBackground() function. */
7692 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7693 fp
= fopen(tmpfile
,"w");
7695 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7698 for (j
= 0; j
< server
.dbnum
; j
++) {
7699 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7700 redisDb
*db
= server
.db
+j
;
7702 if (dictSize(d
) == 0) continue;
7703 di
= dictGetIterator(d
);
7709 /* SELECT the new DB */
7710 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7711 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7713 /* Iterate this DB writing every entry */
7714 while((de
= dictNext(di
)) != NULL
) {
7719 key
= dictGetEntryKey(de
);
7720 /* If the value for this key is swapped, load a preview in memory.
7721 * We use a "swapped" flag to remember if we need to free the
7722 * value object instead to just increment the ref count anyway
7723 * in order to avoid copy-on-write of pages if we are forked() */
7724 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7725 key
->storage
== REDIS_VM_SWAPPING
) {
7726 o
= dictGetEntryVal(de
);
7729 o
= vmPreviewObject(key
);
7732 expiretime
= getExpire(db
,key
);
7734 /* Save the key and associated value */
7735 if (o
->type
== REDIS_STRING
) {
7736 /* Emit a SET command */
7737 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7738 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7740 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7741 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7742 } else if (o
->type
== REDIS_LIST
) {
7743 /* Emit the RPUSHes needed to rebuild the list */
7744 list
*list
= o
->ptr
;
7748 listRewind(list
,&li
);
7749 while((ln
= listNext(&li
))) {
7750 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7751 robj
*eleobj
= listNodeValue(ln
);
7753 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7754 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7755 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7757 } else if (o
->type
== REDIS_SET
) {
7758 /* Emit the SADDs needed to rebuild the set */
7760 dictIterator
*di
= dictGetIterator(set
);
7763 while((de
= dictNext(di
)) != NULL
) {
7764 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7765 robj
*eleobj
= dictGetEntryKey(de
);
7767 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7768 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7769 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7771 dictReleaseIterator(di
);
7772 } else if (o
->type
== REDIS_ZSET
) {
7773 /* Emit the ZADDs needed to rebuild the sorted set */
7775 dictIterator
*di
= dictGetIterator(zs
->dict
);
7778 while((de
= dictNext(di
)) != NULL
) {
7779 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7780 robj
*eleobj
= dictGetEntryKey(de
);
7781 double *score
= dictGetEntryVal(de
);
7783 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7784 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7785 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7786 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7788 dictReleaseIterator(di
);
7789 } else if (o
->type
== REDIS_HASH
) {
7790 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7792 /* Emit the HSETs needed to rebuild the hash */
7793 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7794 unsigned char *p
= zipmapRewind(o
->ptr
);
7795 unsigned char *field
, *val
;
7796 unsigned int flen
, vlen
;
7798 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
7799 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7800 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7801 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
7803 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
7807 dictIterator
*di
= dictGetIterator(o
->ptr
);
7810 while((de
= dictNext(di
)) != NULL
) {
7811 robj
*field
= dictGetEntryKey(de
);
7812 robj
*val
= dictGetEntryVal(de
);
7814 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7815 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7816 if (fwriteBulkObject(fp
,field
) == -1) return -1;
7817 if (fwriteBulkObject(fp
,val
) == -1) return -1;
7819 dictReleaseIterator(di
);
7824 /* Save the expire time */
7825 if (expiretime
!= -1) {
7826 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7827 /* If this key is already expired skip it */
7828 if (expiretime
< now
) continue;
7829 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7830 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7831 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7833 if (swapped
) decrRefCount(o
);
7835 dictReleaseIterator(di
);
7838 /* Make sure data will not remain on the OS's output buffers */
7843 /* Use RENAME to make sure the DB file is changed atomically only
7844 * if the generate DB file is ok. */
7845 if (rename(tmpfile
,filename
) == -1) {
7846 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7850 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7856 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7857 if (di
) dictReleaseIterator(di
);
7861 /* This is how rewriting of the append only file in background works:
7863 * 1) The user calls BGREWRITEAOF
7864 * 2) Redis calls this function, that forks():
7865 * 2a) the child rewrite the append only file in a temp file.
7866 * 2b) the parent accumulates differences in server.bgrewritebuf.
7867 * 3) When the child finished '2a' exists.
7868 * 4) The parent will trap the exit code, if it's OK, will append the
7869 * data accumulated into server.bgrewritebuf into the temp file, and
7870 * finally will rename(2) the temp file in the actual file name.
7871 * The the new file is reopened as the new append only file. Profit!
7873 static int rewriteAppendOnlyFileBackground(void) {
7876 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7877 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7878 if ((childpid
= fork()) == 0) {
7882 if (server
.vm_enabled
) vmReopenSwapFile();
7884 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7885 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7892 if (childpid
== -1) {
7893 redisLog(REDIS_WARNING
,
7894 "Can't rewrite append only file in background: fork: %s",
7898 redisLog(REDIS_NOTICE
,
7899 "Background append only file rewriting started by pid %d",childpid
);
7900 server
.bgrewritechildpid
= childpid
;
7901 /* We set appendseldb to -1 in order to force the next call to the
7902 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7903 * accumulated by the parent into server.bgrewritebuf will start
7904 * with a SELECT statement and it will be safe to merge. */
7905 server
.appendseldb
= -1;
7908 return REDIS_OK
; /* unreached */
7911 static void bgrewriteaofCommand(redisClient
*c
) {
7912 if (server
.bgrewritechildpid
!= -1) {
7913 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7916 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7917 char *status
= "+Background append only file rewriting started\r\n";
7918 addReplySds(c
,sdsnew(status
));
7920 addReply(c
,shared
.err
);
7924 static void aofRemoveTempFile(pid_t childpid
) {
7927 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7931 /* Virtual Memory is composed mainly of two subsystems:
7932 * - Blocking Virutal Memory
7933 * - Threaded Virtual Memory I/O
7934 * The two parts are not fully decoupled, but functions are split among two
7935 * different sections of the source code (delimited by comments) in order to
7936 * make more clear what functionality is about the blocking VM and what about
7937 * the threaded (not blocking) VM.
7941 * Redis VM is a blocking VM (one that blocks reading swapped values from
7942 * disk into memory when a value swapped out is needed in memory) that is made
7943 * unblocking by trying to examine the command argument vector in order to
7944 * load in background values that will likely be needed in order to exec
7945 * the command. The command is executed only once all the relevant keys
7946 * are loaded into memory.
7948 * This basically is almost as simple of a blocking VM, but almost as parallel
7949 * as a fully non-blocking VM.
7952 /* =================== Virtual Memory - Blocking Side ====================== */
7954 /* substitute the first occurrence of '%p' with the process pid in the
7955 * swap file name. */
7956 static void expandVmSwapFilename(void) {
7957 char *p
= strstr(server
.vm_swap_file
,"%p");
7963 new = sdscat(new,server
.vm_swap_file
);
7964 new = sdscatprintf(new,"%ld",(long) getpid());
7965 new = sdscat(new,p
+2);
7966 zfree(server
.vm_swap_file
);
7967 server
.vm_swap_file
= new;
7970 static void vmInit(void) {
7975 if (server
.vm_max_threads
!= 0)
7976 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7978 expandVmSwapFilename();
7979 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7980 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7981 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7983 if (server
.vm_fp
== NULL
) {
7984 redisLog(REDIS_WARNING
,
7985 "Impossible to open the swap file: %s. Exiting.",
7989 server
.vm_fd
= fileno(server
.vm_fp
);
7990 server
.vm_next_page
= 0;
7991 server
.vm_near_pages
= 0;
7992 server
.vm_stats_used_pages
= 0;
7993 server
.vm_stats_swapped_objects
= 0;
7994 server
.vm_stats_swapouts
= 0;
7995 server
.vm_stats_swapins
= 0;
7996 totsize
= server
.vm_pages
*server
.vm_page_size
;
7997 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7998 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7999 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8003 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8005 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8006 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8007 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8008 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8010 /* Initialize threaded I/O (used by Virtual Memory) */
8011 server
.io_newjobs
= listCreate();
8012 server
.io_processing
= listCreate();
8013 server
.io_processed
= listCreate();
8014 server
.io_ready_clients
= listCreate();
8015 pthread_mutex_init(&server
.io_mutex
,NULL
);
8016 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8017 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8018 server
.io_active_threads
= 0;
8019 if (pipe(pipefds
) == -1) {
8020 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8024 server
.io_ready_pipe_read
= pipefds
[0];
8025 server
.io_ready_pipe_write
= pipefds
[1];
8026 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8027 /* LZF requires a lot of stack */
8028 pthread_attr_init(&server
.io_threads_attr
);
8029 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8030 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8031 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8032 /* Listen for events in the threaded I/O pipe */
8033 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8034 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8035 oom("creating file event");
8038 /* Mark the page as used */
8039 static void vmMarkPageUsed(off_t page
) {
8040 off_t byte
= page
/8;
8042 redisAssert(vmFreePage(page
) == 1);
8043 server
.vm_bitmap
[byte
] |= 1<<bit
;
8046 /* Mark N contiguous pages as used, with 'page' being the first. */
8047 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8050 for (j
= 0; j
< count
; j
++)
8051 vmMarkPageUsed(page
+j
);
8052 server
.vm_stats_used_pages
+= count
;
8053 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8054 (long long)count
, (long long)page
);
8057 /* Mark the page as free */
8058 static void vmMarkPageFree(off_t page
) {
8059 off_t byte
= page
/8;
8061 redisAssert(vmFreePage(page
) == 0);
8062 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8065 /* Mark N contiguous pages as free, with 'page' being the first. */
8066 static void vmMarkPagesFree(off_t page
, off_t count
) {
8069 for (j
= 0; j
< count
; j
++)
8070 vmMarkPageFree(page
+j
);
8071 server
.vm_stats_used_pages
-= count
;
8072 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8073 (long long)count
, (long long)page
);
8076 /* Test if the page is free */
8077 static int vmFreePage(off_t page
) {
8078 off_t byte
= page
/8;
8080 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8083 /* Find N contiguous free pages storing the first page of the cluster in *first.
8084 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8085 * REDIS_ERR is returned.
8087 * This function uses a simple algorithm: we try to allocate
8088 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8089 * again from the start of the swap file searching for free spaces.
8091 * If it looks pretty clear that there are no free pages near our offset
8092 * we try to find less populated places doing a forward jump of
8093 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8094 * without hurry, and then we jump again and so forth...
8096 * This function can be improved using a free list to avoid to guess
8097 * too much, since we could collect data about freed pages.
8099 * note: I implemented this function just after watching an episode of
8100 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8102 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8103 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8105 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8106 server
.vm_near_pages
= 0;
8107 server
.vm_next_page
= 0;
8109 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8110 base
= server
.vm_next_page
;
8112 while(offset
< server
.vm_pages
) {
8113 off_t
this = base
+offset
;
8115 /* If we overflow, restart from page zero */
8116 if (this >= server
.vm_pages
) {
8117 this -= server
.vm_pages
;
8119 /* Just overflowed, what we found on tail is no longer
8120 * interesting, as it's no longer contiguous. */
8124 if (vmFreePage(this)) {
8125 /* This is a free page */
8127 /* Already got N free pages? Return to the caller, with success */
8129 *first
= this-(n
-1);
8130 server
.vm_next_page
= this+1;
8131 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8135 /* The current one is not a free page */
8139 /* Fast-forward if the current page is not free and we already
8140 * searched enough near this place. */
8142 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8143 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8145 /* Note that even if we rewind after the jump, we are don't need
8146 * to make sure numfree is set to zero as we only jump *if* it
8147 * is set to zero. */
8149 /* Otherwise just check the next page */
8156 /* Write the specified object at the specified page of the swap file */
8157 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8158 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8159 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8160 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8161 redisLog(REDIS_WARNING
,
8162 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8166 rdbSaveObject(server
.vm_fp
,o
);
8167 fflush(server
.vm_fp
);
8168 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8172 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8173 * needed to later retrieve the object into the key object.
8174 * If we can't find enough contiguous empty pages to swap the object on disk
8175 * REDIS_ERR is returned. */
8176 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8177 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8180 assert(key
->storage
== REDIS_VM_MEMORY
);
8181 assert(key
->refcount
== 1);
8182 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8183 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8184 key
->vm
.page
= page
;
8185 key
->vm
.usedpages
= pages
;
8186 key
->storage
= REDIS_VM_SWAPPED
;
8187 key
->vtype
= val
->type
;
8188 decrRefCount(val
); /* Deallocate the object from memory. */
8189 vmMarkPagesUsed(page
,pages
);
8190 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8191 (unsigned char*) key
->ptr
,
8192 (unsigned long long) page
, (unsigned long long) pages
);
8193 server
.vm_stats_swapped_objects
++;
8194 server
.vm_stats_swapouts
++;
8198 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8201 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8202 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8203 redisLog(REDIS_WARNING
,
8204 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8208 o
= rdbLoadObject(type
,server
.vm_fp
);
8210 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8213 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8217 /* Load the value object relative to the 'key' object from swap to memory.
8218 * The newly allocated object is returned.
8220 * If preview is true the unserialized object is returned to the caller but
8221 * no changes are made to the key object, nor the pages are marked as freed */
8222 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8225 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8226 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8228 key
->storage
= REDIS_VM_MEMORY
;
8229 key
->vm
.atime
= server
.unixtime
;
8230 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8231 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8232 (unsigned char*) key
->ptr
);
8233 server
.vm_stats_swapped_objects
--;
8235 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8236 (unsigned char*) key
->ptr
);
8238 server
.vm_stats_swapins
++;
8242 /* Plain object loading, from swap to memory */
8243 static robj
*vmLoadObject(robj
*key
) {
8244 /* If we are loading the object in background, stop it, we
8245 * need to load this object synchronously ASAP. */
8246 if (key
->storage
== REDIS_VM_LOADING
)
8247 vmCancelThreadedIOJob(key
);
8248 return vmGenericLoadObject(key
,0);
8251 /* Just load the value on disk, without to modify the key.
8252 * This is useful when we want to perform some operation on the value
8253 * without to really bring it from swap to memory, like while saving the
8254 * dataset or rewriting the append only log. */
8255 static robj
*vmPreviewObject(robj
*key
) {
8256 return vmGenericLoadObject(key
,1);
8259 /* How a good candidate is this object for swapping?
8260 * The better candidate it is, the greater the returned value.
8262 * Currently we try to perform a fast estimation of the object size in
8263 * memory, and combine it with aging informations.
8265 * Basically swappability = idle-time * log(estimated size)
8267 * Bigger objects are preferred over smaller objects, but not
8268 * proportionally, this is why we use the logarithm. This algorithm is
8269 * just a first try and will probably be tuned later. */
8270 static double computeObjectSwappability(robj
*o
) {
8271 time_t age
= server
.unixtime
- o
->vm
.atime
;
8275 struct dictEntry
*de
;
8278 if (age
<= 0) return 0;
8281 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8284 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8289 listNode
*ln
= listFirst(l
);
8291 asize
= sizeof(list
);
8293 robj
*ele
= ln
->value
;
8296 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8297 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8299 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8304 z
= (o
->type
== REDIS_ZSET
);
8305 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8307 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8308 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8313 de
= dictGetRandomKey(d
);
8314 ele
= dictGetEntryKey(de
);
8315 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8316 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8318 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8319 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8323 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8324 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8325 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8326 unsigned int klen
, vlen
;
8327 unsigned char *key
, *val
;
8329 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8333 asize
= len
*(klen
+vlen
+3);
8334 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8336 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8341 de
= dictGetRandomKey(d
);
8342 ele
= dictGetEntryKey(de
);
8343 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8344 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8346 ele
= dictGetEntryVal(de
);
8347 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8348 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8350 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8355 return (double)age
*log(1+asize
);
8358 /* Try to swap an object that's a good candidate for swapping.
8359 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8360 * to swap any object at all.
8362 * If 'usethreaded' is true, Redis will try to swap the object in background
8363 * using I/O threads. */
8364 static int vmSwapOneObject(int usethreads
) {
8366 struct dictEntry
*best
= NULL
;
8367 double best_swappability
= 0;
8368 redisDb
*best_db
= NULL
;
8371 for (j
= 0; j
< server
.dbnum
; j
++) {
8372 redisDb
*db
= server
.db
+j
;
8373 /* Why maxtries is set to 100?
8374 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8375 * are swappable objects */
8378 if (dictSize(db
->dict
) == 0) continue;
8379 for (i
= 0; i
< 5; i
++) {
8381 double swappability
;
8383 if (maxtries
) maxtries
--;
8384 de
= dictGetRandomKey(db
->dict
);
8385 key
= dictGetEntryKey(de
);
8386 val
= dictGetEntryVal(de
);
8387 /* Only swap objects that are currently in memory.
8389 * Also don't swap shared objects if threaded VM is on, as we
8390 * try to ensure that the main thread does not touch the
8391 * object while the I/O thread is using it, but we can't
8392 * control other keys without adding additional mutex. */
8393 if (key
->storage
!= REDIS_VM_MEMORY
||
8394 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8395 if (maxtries
) i
--; /* don't count this try */
8398 swappability
= computeObjectSwappability(val
);
8399 if (!best
|| swappability
> best_swappability
) {
8401 best_swappability
= swappability
;
8406 if (best
== NULL
) return REDIS_ERR
;
8407 key
= dictGetEntryKey(best
);
8408 val
= dictGetEntryVal(best
);
8410 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8411 key
->ptr
, best_swappability
);
8413 /* Unshare the key if needed */
8414 if (key
->refcount
> 1) {
8415 robj
*newkey
= dupStringObject(key
);
8417 key
= dictGetEntryKey(best
) = newkey
;
8421 vmSwapObjectThreaded(key
,val
,best_db
);
8424 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8425 dictGetEntryVal(best
) = NULL
;
8433 static int vmSwapOneObjectBlocking() {
8434 return vmSwapOneObject(0);
8437 static int vmSwapOneObjectThreaded() {
8438 return vmSwapOneObject(1);
8441 /* Return true if it's safe to swap out objects in a given moment.
8442 * Basically we don't want to swap objects out while there is a BGSAVE
8443 * or a BGAEOREWRITE running in backgroud. */
8444 static int vmCanSwapOut(void) {
8445 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8448 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8449 * and was deleted. Otherwise 0 is returned. */
8450 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8454 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8455 foundkey
= dictGetEntryKey(de
);
8456 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8461 /* =================== Virtual Memory - Threaded I/O ======================= */
8463 static void freeIOJob(iojob
*j
) {
8464 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8465 j
->type
== REDIS_IOJOB_DO_SWAP
||
8466 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8467 decrRefCount(j
->val
);
8468 decrRefCount(j
->key
);
8472 /* Every time a thread finished a Job, it writes a byte into the write side
8473 * of an unix pipe in order to "awake" the main thread, and this function
8475 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8479 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8481 REDIS_NOTUSED(mask
);
8482 REDIS_NOTUSED(privdata
);
8484 /* For every byte we read in the read side of the pipe, there is one
8485 * I/O job completed to process. */
8486 while((retval
= read(fd
,buf
,1)) == 1) {
8490 struct dictEntry
*de
;
8492 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8494 /* Get the processed element (the oldest one) */
8496 assert(listLength(server
.io_processed
) != 0);
8497 if (toprocess
== -1) {
8498 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8499 if (toprocess
<= 0) toprocess
= 1;
8501 ln
= listFirst(server
.io_processed
);
8503 listDelNode(server
.io_processed
,ln
);
8505 /* If this job is marked as canceled, just ignore it */
8510 /* Post process it in the main thread, as there are things we
8511 * can do just here to avoid race conditions and/or invasive locks */
8512 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
);
8513 de
= dictFind(j
->db
->dict
,j
->key
);
8515 key
= dictGetEntryKey(de
);
8516 if (j
->type
== REDIS_IOJOB_LOAD
) {
8519 /* Key loaded, bring it at home */
8520 key
->storage
= REDIS_VM_MEMORY
;
8521 key
->vm
.atime
= server
.unixtime
;
8522 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8523 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8524 (unsigned char*) key
->ptr
);
8525 server
.vm_stats_swapped_objects
--;
8526 server
.vm_stats_swapins
++;
8527 dictGetEntryVal(de
) = j
->val
;
8528 incrRefCount(j
->val
);
8531 /* Handle clients waiting for this key to be loaded. */
8532 handleClientsBlockedOnSwappedKey(db
,key
);
8533 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8534 /* Now we know the amount of pages required to swap this object.
8535 * Let's find some space for it, and queue this task again
8536 * rebranded as REDIS_IOJOB_DO_SWAP. */
8537 if (!vmCanSwapOut() ||
8538 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8540 /* Ooops... no space or we can't swap as there is
8541 * a fork()ed Redis trying to save stuff on disk. */
8543 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8545 /* Note that we need to mark this pages as used now,
8546 * if the job will be canceled, we'll mark them as freed
8548 vmMarkPagesUsed(j
->page
,j
->pages
);
8549 j
->type
= REDIS_IOJOB_DO_SWAP
;
8554 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8557 /* Key swapped. We can finally free some memory. */
8558 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8559 printf("key->storage: %d\n",key
->storage
);
8560 printf("key->name: %s\n",(char*)key
->ptr
);
8561 printf("key->refcount: %d\n",key
->refcount
);
8562 printf("val: %p\n",(void*)j
->val
);
8563 printf("val->type: %d\n",j
->val
->type
);
8564 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8566 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8567 val
= dictGetEntryVal(de
);
8568 key
->vm
.page
= j
->page
;
8569 key
->vm
.usedpages
= j
->pages
;
8570 key
->storage
= REDIS_VM_SWAPPED
;
8571 key
->vtype
= j
->val
->type
;
8572 decrRefCount(val
); /* Deallocate the object from memory. */
8573 dictGetEntryVal(de
) = NULL
;
8574 redisLog(REDIS_DEBUG
,
8575 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8576 (unsigned char*) key
->ptr
,
8577 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8578 server
.vm_stats_swapped_objects
++;
8579 server
.vm_stats_swapouts
++;
8581 /* Put a few more swap requests in queue if we are still
8583 if (trytoswap
&& vmCanSwapOut() &&
8584 zmalloc_used_memory() > server
.vm_max_memory
)
8589 more
= listLength(server
.io_newjobs
) <
8590 (unsigned) server
.vm_max_threads
;
8592 /* Don't waste CPU time if swappable objects are rare. */
8593 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8601 if (processed
== toprocess
) return;
8603 if (retval
< 0 && errno
!= EAGAIN
) {
8604 redisLog(REDIS_WARNING
,
8605 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8610 static void lockThreadedIO(void) {
8611 pthread_mutex_lock(&server
.io_mutex
);
8614 static void unlockThreadedIO(void) {
8615 pthread_mutex_unlock(&server
.io_mutex
);
8618 /* Remove the specified object from the threaded I/O queue if still not
8619 * processed, otherwise make sure to flag it as canceled. */
8620 static void vmCancelThreadedIOJob(robj
*o
) {
8622 server
.io_newjobs
, /* 0 */
8623 server
.io_processing
, /* 1 */
8624 server
.io_processed
/* 2 */
8628 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8631 /* Search for a matching key in one of the queues */
8632 for (i
= 0; i
< 3; i
++) {
8636 listRewind(lists
[i
],&li
);
8637 while ((ln
= listNext(&li
)) != NULL
) {
8638 iojob
*job
= ln
->value
;
8640 if (job
->canceled
) continue; /* Skip this, already canceled. */
8641 if (compareStringObjects(job
->key
,o
) == 0) {
8642 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8643 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8644 /* Mark the pages as free since the swap didn't happened
8645 * or happened but is now discarded. */
8646 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8647 vmMarkPagesFree(job
->page
,job
->pages
);
8648 /* Cancel the job. It depends on the list the job is
8651 case 0: /* io_newjobs */
8652 /* If the job was yet not processed the best thing to do
8653 * is to remove it from the queue at all */
8655 listDelNode(lists
[i
],ln
);
8657 case 1: /* io_processing */
8658 /* Oh Shi- the thread is messing with the Job:
8660 * Probably it's accessing the object if this is a
8661 * PREPARE_SWAP or DO_SWAP job.
8662 * If it's a LOAD job it may be reading from disk and
8663 * if we don't wait for the job to terminate before to
8664 * cancel it, maybe in a few microseconds data can be
8665 * corrupted in this pages. So the short story is:
8667 * Better to wait for the job to move into the
8668 * next queue (processed)... */
8670 /* We try again and again until the job is completed. */
8672 /* But let's wait some time for the I/O thread
8673 * to finish with this job. After all this condition
8674 * should be very rare. */
8677 case 2: /* io_processed */
8678 /* The job was already processed, that's easy...
8679 * just mark it as canceled so that we'll ignore it
8680 * when processing completed jobs. */
8684 /* Finally we have to adjust the storage type of the object
8685 * in order to "UNDO" the operaiton. */
8686 if (o
->storage
== REDIS_VM_LOADING
)
8687 o
->storage
= REDIS_VM_SWAPPED
;
8688 else if (o
->storage
== REDIS_VM_SWAPPING
)
8689 o
->storage
= REDIS_VM_MEMORY
;
8696 assert(1 != 1); /* We should never reach this */
8699 static void *IOThreadEntryPoint(void *arg
) {
8704 pthread_detach(pthread_self());
8706 /* Get a new job to process */
8708 if (listLength(server
.io_newjobs
) == 0) {
8709 /* No new jobs in queue, exit. */
8710 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8711 (long) pthread_self());
8712 server
.io_active_threads
--;
8716 ln
= listFirst(server
.io_newjobs
);
8718 listDelNode(server
.io_newjobs
,ln
);
8719 /* Add the job in the processing queue */
8720 j
->thread
= pthread_self();
8721 listAddNodeTail(server
.io_processing
,j
);
8722 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8724 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8725 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8727 /* Process the Job */
8728 if (j
->type
== REDIS_IOJOB_LOAD
) {
8729 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8730 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8731 FILE *fp
= fopen("/dev/null","w+");
8732 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8734 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8735 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8739 /* Done: insert the job into the processed queue */
8740 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8741 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8743 listDelNode(server
.io_processing
,ln
);
8744 listAddNodeTail(server
.io_processed
,j
);
8747 /* Signal the main thread there is new stuff to process */
8748 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8750 return NULL
; /* never reached */
8753 static void spawnIOThread(void) {
8755 sigset_t mask
, omask
;
8759 sigaddset(&mask
,SIGCHLD
);
8760 sigaddset(&mask
,SIGHUP
);
8761 sigaddset(&mask
,SIGPIPE
);
8762 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8763 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
8764 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
8768 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8769 server
.io_active_threads
++;
8772 /* We need to wait for the last thread to exit before we are able to
8773 * fork() in order to BGSAVE or BGREWRITEAOF. */
8774 static void waitEmptyIOJobsQueue(void) {
8776 int io_processed_len
;
8779 if (listLength(server
.io_newjobs
) == 0 &&
8780 listLength(server
.io_processing
) == 0 &&
8781 server
.io_active_threads
== 0)
8786 /* While waiting for empty jobs queue condition we post-process some
8787 * finshed job, as I/O threads may be hanging trying to write against
8788 * the io_ready_pipe_write FD but there are so much pending jobs that
8790 io_processed_len
= listLength(server
.io_processed
);
8792 if (io_processed_len
) {
8793 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8794 usleep(1000); /* 1 millisecond */
8796 usleep(10000); /* 10 milliseconds */
8801 static void vmReopenSwapFile(void) {
8802 /* Note: we don't close the old one as we are in the child process
8803 * and don't want to mess at all with the original file object. */
8804 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8805 if (server
.vm_fp
== NULL
) {
8806 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8807 server
.vm_swap_file
);
8810 server
.vm_fd
= fileno(server
.vm_fp
);
8813 /* This function must be called while with threaded IO locked */
8814 static void queueIOJob(iojob
*j
) {
8815 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8816 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8817 listAddNodeTail(server
.io_newjobs
,j
);
8818 if (server
.io_active_threads
< server
.vm_max_threads
)
8822 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8825 assert(key
->storage
== REDIS_VM_MEMORY
);
8826 assert(key
->refcount
== 1);
8828 j
= zmalloc(sizeof(*j
));
8829 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8831 j
->key
= dupStringObject(key
);
8835 j
->thread
= (pthread_t
) -1;
8836 key
->storage
= REDIS_VM_SWAPPING
;
8844 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8846 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8847 * If there is not already a job loading the key, it is craeted.
8848 * The key is added to the io_keys list in the client structure, and also
8849 * in the hash table mapping swapped keys to waiting clients, that is,
8850 * server.io_waited_keys. */
8851 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8852 struct dictEntry
*de
;
8856 /* If the key does not exist or is already in RAM we don't need to
8857 * block the client at all. */
8858 de
= dictFind(c
->db
->dict
,key
);
8859 if (de
== NULL
) return 0;
8860 o
= dictGetEntryKey(de
);
8861 if (o
->storage
== REDIS_VM_MEMORY
) {
8863 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8864 /* We were swapping the key, undo it! */
8865 vmCancelThreadedIOJob(o
);
8869 /* OK: the key is either swapped, or being loaded just now. */
8871 /* Add the key to the list of keys this client is waiting for.
8872 * This maps clients to keys they are waiting for. */
8873 listAddNodeTail(c
->io_keys
,key
);
8876 /* Add the client to the swapped keys => clients waiting map. */
8877 de
= dictFind(c
->db
->io_keys
,key
);
8881 /* For every key we take a list of clients blocked for it */
8883 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8885 assert(retval
== DICT_OK
);
8887 l
= dictGetEntryVal(de
);
8889 listAddNodeTail(l
,c
);
8891 /* Are we already loading the key from disk? If not create a job */
8892 if (o
->storage
== REDIS_VM_SWAPPED
) {
8895 o
->storage
= REDIS_VM_LOADING
;
8896 j
= zmalloc(sizeof(*j
));
8897 j
->type
= REDIS_IOJOB_LOAD
;
8899 j
->key
= dupStringObject(key
);
8900 j
->key
->vtype
= o
->vtype
;
8901 j
->page
= o
->vm
.page
;
8904 j
->thread
= (pthread_t
) -1;
8912 /* Preload keys needed for the ZUNION and ZINTER commands. */
8913 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
8915 num
= atoi(c
->argv
[2]->ptr
);
8916 for (i
= 0; i
< num
; i
++) {
8917 waitForSwappedKey(c
,c
->argv
[3+i
]);
8921 /* Is this client attempting to run a command against swapped keys?
8922 * If so, block it ASAP, load the keys in background, then resume it.
8924 * The important idea about this function is that it can fail! If keys will
8925 * still be swapped when the client is resumed, this key lookups will
8926 * just block loading keys from disk. In practical terms this should only
8927 * happen with SORT BY command or if there is a bug in this function.
8929 * Return 1 if the client is marked as blocked, 0 if the client can
8930 * continue as the keys it is going to access appear to be in memory. */
8931 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8934 if (cmd
->vm_preload_proc
!= NULL
) {
8935 cmd
->vm_preload_proc(c
);
8937 if (cmd
->vm_firstkey
== 0) return 0;
8938 last
= cmd
->vm_lastkey
;
8939 if (last
< 0) last
= c
->argc
+last
;
8940 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8941 waitForSwappedKey(c
,c
->argv
[j
]);
8944 /* If the client was blocked for at least one key, mark it as blocked. */
8945 if (listLength(c
->io_keys
)) {
8946 c
->flags
|= REDIS_IO_WAIT
;
8947 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8948 server
.vm_blocked_clients
++;
8955 /* Remove the 'key' from the list of blocked keys for a given client.
8957 * The function returns 1 when there are no longer blocking keys after
8958 * the current one was removed (and the client can be unblocked). */
8959 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8963 struct dictEntry
*de
;
8965 /* Remove the key from the list of keys this client is waiting for. */
8966 listRewind(c
->io_keys
,&li
);
8967 while ((ln
= listNext(&li
)) != NULL
) {
8968 if (compareStringObjects(ln
->value
,key
) == 0) {
8969 listDelNode(c
->io_keys
,ln
);
8975 /* Remove the client form the key => waiting clients map. */
8976 de
= dictFind(c
->db
->io_keys
,key
);
8978 l
= dictGetEntryVal(de
);
8979 ln
= listSearchKey(l
,c
);
8982 if (listLength(l
) == 0)
8983 dictDelete(c
->db
->io_keys
,key
);
8985 return listLength(c
->io_keys
) == 0;
8988 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8989 struct dictEntry
*de
;
8994 de
= dictFind(db
->io_keys
,key
);
8997 l
= dictGetEntryVal(de
);
8998 len
= listLength(l
);
8999 /* Note: we can't use something like while(listLength(l)) as the list
9000 * can be freed by the calling function when we remove the last element. */
9003 redisClient
*c
= ln
->value
;
9005 if (dontWaitForSwappedKey(c
,key
)) {
9006 /* Put the client in the list of clients ready to go as we
9007 * loaded all the keys about it. */
9008 listAddNodeTail(server
.io_ready_clients
,c
);
9013 /* ================================= Debugging ============================== */
9015 static void debugCommand(redisClient
*c
) {
9016 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9018 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9019 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9020 addReply(c
,shared
.err
);
9024 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9025 addReply(c
,shared
.err
);
9028 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9029 addReply(c
,shared
.ok
);
9030 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9032 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9033 addReply(c
,shared
.err
);
9036 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9037 addReply(c
,shared
.ok
);
9038 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9039 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9043 addReply(c
,shared
.nokeyerr
);
9046 key
= dictGetEntryKey(de
);
9047 val
= dictGetEntryVal(de
);
9048 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9049 key
->storage
== REDIS_VM_SWAPPING
)) {
9053 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9054 strenc
= strencoding
[val
->encoding
];
9056 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9059 addReplySds(c
,sdscatprintf(sdsempty(),
9060 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9061 "encoding:%s serializedlength:%lld\r\n",
9062 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9063 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9065 addReplySds(c
,sdscatprintf(sdsempty(),
9066 "+Key at:%p refcount:%d, value swapped at: page %llu "
9067 "using %llu pages\r\n",
9068 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9069 (unsigned long long) key
->vm
.usedpages
));
9071 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9072 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9075 if (!server
.vm_enabled
) {
9076 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9080 addReply(c
,shared
.nokeyerr
);
9083 key
= dictGetEntryKey(de
);
9084 val
= dictGetEntryVal(de
);
9085 /* If the key is shared we want to create a copy */
9086 if (key
->refcount
> 1) {
9087 robj
*newkey
= dupStringObject(key
);
9089 key
= dictGetEntryKey(de
) = newkey
;
9092 if (key
->storage
!= REDIS_VM_MEMORY
) {
9093 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9094 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9095 dictGetEntryVal(de
) = NULL
;
9096 addReply(c
,shared
.ok
);
9098 addReply(c
,shared
.err
);
9101 addReplySds(c
,sdsnew(
9102 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9106 static void _redisAssert(char *estr
, char *file
, int line
) {
9107 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9108 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9109 #ifdef HAVE_BACKTRACE
9110 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9115 /* =================================== Main! ================================ */
9118 int linuxOvercommitMemoryValue(void) {
9119 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9123 if (fgets(buf
,64,fp
) == NULL
) {
9132 void linuxOvercommitMemoryWarning(void) {
9133 if (linuxOvercommitMemoryValue() == 0) {
9134 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.");
9137 #endif /* __linux__ */
9139 static void daemonize(void) {
9143 if (fork() != 0) exit(0); /* parent exits */
9144 setsid(); /* create a new session */
9146 /* Every output goes to /dev/null. If Redis is daemonized but
9147 * the 'logfile' is set to 'stdout' in the configuration file
9148 * it will not log at all. */
9149 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9150 dup2(fd
, STDIN_FILENO
);
9151 dup2(fd
, STDOUT_FILENO
);
9152 dup2(fd
, STDERR_FILENO
);
9153 if (fd
> STDERR_FILENO
) close(fd
);
9155 /* Try to write the pid file */
9156 fp
= fopen(server
.pidfile
,"w");
9158 fprintf(fp
,"%d\n",getpid());
9163 static void version() {
9164 printf("Redis server version %s\n", REDIS_VERSION
);
9168 int main(int argc
, char **argv
) {
9173 if ((strcmp(argv
[1], "-v") == 0) || (strcmp(argv
[1], "--version") == 0)) {
9176 resetServerSaveParams();
9177 loadServerConfig(argv
[1]);
9178 } else if (argc
> 2) {
9179 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9182 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'");
9184 if (server
.daemonize
) daemonize();
9186 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9188 linuxOvercommitMemoryWarning();
9191 if (server
.appendonly
) {
9192 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9193 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9195 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9196 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9198 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9199 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9201 aeDeleteEventLoop(server
.el
);
9205 /* ============================= Backtrace support ========================= */
9207 #ifdef HAVE_BACKTRACE
9208 static char *findFuncName(void *pointer
, unsigned long *offset
);
9210 static void *getMcontextEip(ucontext_t
*uc
) {
9211 #if defined(__FreeBSD__)
9212 return (void*) uc
->uc_mcontext
.mc_eip
;
9213 #elif defined(__dietlibc__)
9214 return (void*) uc
->uc_mcontext
.eip
;
9215 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9217 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9219 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9221 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9222 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9223 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9225 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9227 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9228 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9229 #elif defined(__ia64__) /* Linux IA64 */
9230 return (void*) uc
->uc_mcontext
.sc_ip
;
9236 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9238 char **messages
= NULL
;
9239 int i
, trace_size
= 0;
9240 unsigned long offset
=0;
9241 ucontext_t
*uc
= (ucontext_t
*) secret
;
9243 REDIS_NOTUSED(info
);
9245 redisLog(REDIS_WARNING
,
9246 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9247 infostring
= genRedisInfoString();
9248 redisLog(REDIS_WARNING
, "%s",infostring
);
9249 /* It's not safe to sdsfree() the returned string under memory
9250 * corruption conditions. Let it leak as we are going to abort */
9252 trace_size
= backtrace(trace
, 100);
9253 /* overwrite sigaction with caller's address */
9254 if (getMcontextEip(uc
) != NULL
) {
9255 trace
[1] = getMcontextEip(uc
);
9257 messages
= backtrace_symbols(trace
, trace_size
);
9259 for (i
=1; i
<trace_size
; ++i
) {
9260 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9262 p
= strchr(messages
[i
],'+');
9263 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9264 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9266 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9269 /* free(messages); Don't call free() with possibly corrupted memory. */
9273 static void setupSigSegvAction(void) {
9274 struct sigaction act
;
9276 sigemptyset (&act
.sa_mask
);
9277 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9278 * is used. Otherwise, sa_handler is used */
9279 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9280 act
.sa_sigaction
= segvHandler
;
9281 sigaction (SIGSEGV
, &act
, NULL
);
9282 sigaction (SIGBUS
, &act
, NULL
);
9283 sigaction (SIGFPE
, &act
, NULL
);
9284 sigaction (SIGILL
, &act
, NULL
);
9285 sigaction (SIGBUS
, &act
, NULL
);
9289 #include "staticsymbols.h"
9290 /* This function try to convert a pointer into a function name. It's used in
9291 * oreder to provide a backtrace under segmentation fault that's able to
9292 * display functions declared as static (otherwise the backtrace is useless). */
9293 static char *findFuncName(void *pointer
, unsigned long *offset
){
9295 unsigned long off
, minoff
= 0;
9297 /* Try to match against the Symbol with the smallest offset */
9298 for (i
=0; symsTable
[i
].pointer
; i
++) {
9299 unsigned long lp
= (unsigned long) pointer
;
9301 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9302 off
=lp
-symsTable
[i
].pointer
;
9303 if (ret
< 0 || off
< minoff
) {
9309 if (ret
== -1) return NULL
;
9311 return symsTable
[ret
].name
;
9313 #else /* HAVE_BACKTRACE */
9314 static void setupSigSegvAction(void) {
9316 #endif /* HAVE_BACKTRACE */