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.10"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
65 #include "solarisfixes.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
83 /* Static server configuration */
84 #define REDIS_SERVERPORT 6379 /* TCP port */
85 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
86 #define REDIS_IOBUF_LEN 1024
87 #define REDIS_LOADBUF_LEN 1024
88 #define REDIS_STATIC_ARGS 8
89 #define REDIS_DEFAULT_DBNUM 16
90 #define REDIS_CONFIGLINE_MAX 1024
91 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
92 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
93 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
94 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
95 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
97 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
98 #define REDIS_WRITEV_THRESHOLD 3
99 /* Max number of iovecs used for each writev call */
100 #define REDIS_WRITEV_IOVEC_COUNT 256
102 /* Hash table parameters */
103 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
106 #define REDIS_CMD_BULK 1 /* Bulk write command */
107 #define REDIS_CMD_INLINE 2 /* Inline command */
108 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
109 this flags will return an error when the 'maxmemory' option is set in the
110 config file and the server is using more than maxmemory bytes of memory.
111 In short this commands are denied on low memory conditions. */
112 #define REDIS_CMD_DENYOOM 4
113 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
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 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
240 static void _redisAssert(char *estr
, char *file
, int line
);
241 static void _redisPanic(char *msg
, char *file
, int line
);
243 /*================================= Data types ============================== */
245 /* A redis object, that is a type able to hold a string / list / set */
247 /* The VM object structure */
248 struct redisObjectVM
{
249 off_t page
; /* the page at witch the object is stored on disk */
250 off_t usedpages
; /* number of pages used on disk */
251 time_t atime
; /* Last access time */
254 /* The actual Redis Object */
255 typedef struct redisObject
{
258 unsigned char encoding
;
259 unsigned char storage
; /* If this object is a key, where is the value?
260 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
261 unsigned char vtype
; /* If this object is a key, and value is swapped out,
262 * this is the type of the swapped out object. */
264 /* VM fields, this are only allocated if VM is active, otherwise the
265 * object allocation function will just allocate
266 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
267 * Redis without VM active will not have any overhead. */
268 struct redisObjectVM vm
;
271 /* Macro used to initalize a Redis object allocated on the stack.
272 * Note that this macro is taken near the structure definition to make sure
273 * we'll update it when the structure is changed, to avoid bugs like
274 * bug #85 introduced exactly in this way. */
275 #define initStaticStringObject(_var,_ptr) do { \
277 _var.type = REDIS_STRING; \
278 _var.encoding = REDIS_ENCODING_RAW; \
280 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
283 typedef struct redisDb
{
284 dict
*dict
; /* The keyspace for this DB */
285 dict
*expires
; /* Timeout of keys with a timeout set */
286 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
287 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
291 /* Client MULTI/EXEC state */
292 typedef struct multiCmd
{
295 struct redisCommand
*cmd
;
298 typedef struct multiState
{
299 multiCmd
*commands
; /* Array of MULTI commands */
300 int count
; /* Total number of MULTI commands */
303 /* With multiplexing we need to take per-clinet state.
304 * Clients are taken in a liked list. */
305 typedef struct redisClient
{
310 robj
**argv
, **mbargv
;
312 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
313 int multibulk
; /* multi bulk command format active */
316 time_t lastinteraction
; /* time of the last interaction, used for timeout */
317 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
318 int slaveseldb
; /* slave selected db, if this client is a slave */
319 int authenticated
; /* when requirepass is non-NULL */
320 int replstate
; /* replication state if this is a slave */
321 int repldbfd
; /* replication DB file descriptor */
322 long repldboff
; /* replication DB file offset */
323 off_t repldbsize
; /* replication DB file size */
324 multiState mstate
; /* MULTI/EXEC state */
325 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
326 * operation such as BLPOP. Otherwise NULL. */
327 int blockingkeysnum
; /* Number of blocking keys */
328 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
329 * is >= blockingto then the operation timed out. */
330 list
*io_keys
; /* Keys this client is waiting to be loaded from the
331 * swap file in order to continue. */
332 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
333 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
341 /* Global server state structure */
346 long long dirty
; /* changes to DB from the last save */
348 list
*slaves
, *monitors
;
349 char neterr
[ANET_ERR_LEN
];
351 int cronloops
; /* number of times the cron function run */
352 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
353 time_t lastsave
; /* Unix time of last save succeeede */
354 /* Fields used only for stats */
355 time_t stat_starttime
; /* server start time */
356 long long stat_numcommands
; /* number of processed commands */
357 long long stat_numconnections
; /* number of connections received */
358 long long stat_expiredkeys
; /* number of expired keys */
371 pid_t bgsavechildpid
;
372 pid_t bgrewritechildpid
;
373 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
374 sds aofbuf
; /* AOF buffer, written before entering the event loop */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
384 /* Replication related */
389 redisClient
*master
; /* client that is master for this slave */
391 unsigned int maxclients
;
392 unsigned long long maxmemory
;
393 unsigned int blpop_blocked_clients
;
394 unsigned int vm_blocked_clients
;
395 /* Sort parameters - qsort_r() is only available under BSD so we
396 * have to take this state global, in order to pass it to sortCompare() */
400 /* Virtual memory configuration */
405 unsigned long long vm_max_memory
;
407 size_t hash_max_zipmap_entries
;
408 size_t hash_max_zipmap_value
;
409 /* Virtual memory state */
412 off_t vm_next_page
; /* Next probably empty page */
413 off_t vm_near_pages
; /* Number of pages allocated sequentially */
414 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
415 time_t unixtime
; /* Unix time sampled every second. */
416 /* Virtual memory I/O threads stuff */
417 /* An I/O thread process an element taken from the io_jobs queue and
418 * put the result of the operation in the io_done list. While the
419 * job is being processed, it's put on io_processing queue. */
420 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
421 list
*io_processing
; /* List of VM I/O jobs being processed */
422 list
*io_processed
; /* List of VM I/O jobs already processed */
423 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
424 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
425 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
426 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
427 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
428 int io_active_threads
; /* Number of running I/O threads */
429 int vm_max_threads
; /* Max number of I/O threads running at the same time */
430 /* Our main thread is blocked on the event loop, locking for sockets ready
431 * to be read or written, so when a threaded I/O operation is ready to be
432 * processed by the main thread, the I/O thread will use a unix pipe to
433 * awake the main thread. The followings are the two pipe FDs. */
434 int io_ready_pipe_read
;
435 int io_ready_pipe_write
;
436 /* Virtual memory stats */
437 unsigned long long vm_stats_used_pages
;
438 unsigned long long vm_stats_swapped_objects
;
439 unsigned long long vm_stats_swapouts
;
440 unsigned long long vm_stats_swapins
;
442 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
443 list
*pubsub_patterns
; /* A list of pubsub_patterns */
448 typedef struct pubsubPattern
{
453 typedef void redisCommandProc(redisClient
*c
);
454 typedef void redisVmPreloadProc(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
455 struct redisCommand
{
457 redisCommandProc
*proc
;
460 /* Use a function to determine which keys need to be loaded
461 * in the background prior to executing this command. Takes precedence
462 * over vm_firstkey and others, ignored when NULL */
463 redisVmPreloadProc
*vm_preload_proc
;
464 /* What keys should be loaded in background when calling this command? */
465 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
466 int vm_lastkey
; /* THe last argument that's a key */
467 int vm_keystep
; /* The step between first and last key */
470 struct redisFunctionSym
{
472 unsigned long pointer
;
475 typedef struct _redisSortObject
{
483 typedef struct _redisSortOperation
{
486 } redisSortOperation
;
488 /* ZSETs use a specialized version of Skiplists */
490 typedef struct zskiplistNode
{
491 struct zskiplistNode
**forward
;
492 struct zskiplistNode
*backward
;
498 typedef struct zskiplist
{
499 struct zskiplistNode
*header
, *tail
;
500 unsigned long length
;
504 typedef struct zset
{
509 /* Our shared "common" objects */
511 #define REDIS_SHARED_INTEGERS 10000
512 struct sharedObjectsStruct
{
513 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
514 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
515 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
516 *outofrangeerr
, *plus
,
517 *select0
, *select1
, *select2
, *select3
, *select4
,
518 *select5
, *select6
, *select7
, *select8
, *select9
,
519 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
520 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
521 *integers
[REDIS_SHARED_INTEGERS
];
524 /* Global vars that are actally used as constants. The following double
525 * values are used for double on-disk serialization, and are initialized
526 * at runtime to avoid strange compiler optimizations. */
528 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
530 /* VM threaded I/O request message */
531 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
532 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
533 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
534 typedef struct iojob
{
535 int type
; /* Request type, REDIS_IOJOB_* */
536 redisDb
*db
;/* Redis database */
537 robj
*key
; /* This I/O request is about swapping this key */
538 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
539 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
540 off_t page
; /* Swap page where to read/write the object */
541 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
542 int canceled
; /* True if this command was canceled by blocking side of VM */
543 pthread_t thread
; /* ID of the thread processing this entry */
546 /*================================ Prototypes =============================== */
548 static void freeStringObject(robj
*o
);
549 static void freeListObject(robj
*o
);
550 static void freeSetObject(robj
*o
);
551 static void decrRefCount(void *o
);
552 static robj
*createObject(int type
, void *ptr
);
553 static void freeClient(redisClient
*c
);
554 static int rdbLoad(char *filename
);
555 static void addReply(redisClient
*c
, robj
*obj
);
556 static void addReplySds(redisClient
*c
, sds s
);
557 static void incrRefCount(robj
*o
);
558 static int rdbSaveBackground(char *filename
);
559 static robj
*createStringObject(char *ptr
, size_t len
);
560 static robj
*dupStringObject(robj
*o
);
561 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
562 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
563 static void flushAppendOnlyFile(void);
564 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
565 static int syncWithMaster(void);
566 static robj
*tryObjectEncoding(robj
*o
);
567 static robj
*getDecodedObject(robj
*o
);
568 static int removeExpire(redisDb
*db
, robj
*key
);
569 static int expireIfNeeded(redisDb
*db
, robj
*key
);
570 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
571 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
572 static int deleteKey(redisDb
*db
, robj
*key
);
573 static time_t getExpire(redisDb
*db
, robj
*key
);
574 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
575 static void updateSlavesWaitingBgsave(int bgsaveerr
);
576 static void freeMemoryIfNeeded(void);
577 static int processCommand(redisClient
*c
);
578 static void setupSigSegvAction(void);
579 static void rdbRemoveTempFile(pid_t childpid
);
580 static void aofRemoveTempFile(pid_t childpid
);
581 static size_t stringObjectLen(robj
*o
);
582 static void processInputBuffer(redisClient
*c
);
583 static zskiplist
*zslCreate(void);
584 static void zslFree(zskiplist
*zsl
);
585 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
586 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
587 static void initClientMultiState(redisClient
*c
);
588 static void freeClientMultiState(redisClient
*c
);
589 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
590 static void unblockClientWaitingData(redisClient
*c
);
591 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
592 static void vmInit(void);
593 static void vmMarkPagesFree(off_t page
, off_t count
);
594 static robj
*vmLoadObject(robj
*key
);
595 static robj
*vmPreviewObject(robj
*key
);
596 static int vmSwapOneObjectBlocking(void);
597 static int vmSwapOneObjectThreaded(void);
598 static int vmCanSwapOut(void);
599 static int tryFreeOneObjectFromFreelist(void);
600 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
601 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
602 static void vmCancelThreadedIOJob(robj
*o
);
603 static void lockThreadedIO(void);
604 static void unlockThreadedIO(void);
605 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
606 static void freeIOJob(iojob
*j
);
607 static void queueIOJob(iojob
*j
);
608 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
609 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
610 static void waitEmptyIOJobsQueue(void);
611 static void vmReopenSwapFile(void);
612 static int vmFreePage(off_t page
);
613 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
614 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
615 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
);
616 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
617 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
618 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
619 static struct redisCommand
*lookupCommand(char *name
);
620 static void call(redisClient
*c
, struct redisCommand
*cmd
);
621 static void resetClient(redisClient
*c
);
622 static void convertToRealHash(robj
*o
);
623 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
624 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
625 static void freePubsubPattern(void *p
);
626 static int listMatchPubsubPattern(void *a
, void *b
);
627 static int compareStringObjects(robj
*a
, robj
*b
);
628 static int equalStringObjects(robj
*a
, robj
*b
);
630 static int rewriteAppendOnlyFileBackground(void);
631 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
633 static void authCommand(redisClient
*c
);
634 static void pingCommand(redisClient
*c
);
635 static void echoCommand(redisClient
*c
);
636 static void setCommand(redisClient
*c
);
637 static void setnxCommand(redisClient
*c
);
638 static void setexCommand(redisClient
*c
);
639 static void getCommand(redisClient
*c
);
640 static void delCommand(redisClient
*c
);
641 static void existsCommand(redisClient
*c
);
642 static void incrCommand(redisClient
*c
);
643 static void decrCommand(redisClient
*c
);
644 static void incrbyCommand(redisClient
*c
);
645 static void decrbyCommand(redisClient
*c
);
646 static void selectCommand(redisClient
*c
);
647 static void randomkeyCommand(redisClient
*c
);
648 static void keysCommand(redisClient
*c
);
649 static void dbsizeCommand(redisClient
*c
);
650 static void lastsaveCommand(redisClient
*c
);
651 static void saveCommand(redisClient
*c
);
652 static void bgsaveCommand(redisClient
*c
);
653 static void bgrewriteaofCommand(redisClient
*c
);
654 static void shutdownCommand(redisClient
*c
);
655 static void moveCommand(redisClient
*c
);
656 static void renameCommand(redisClient
*c
);
657 static void renamenxCommand(redisClient
*c
);
658 static void lpushCommand(redisClient
*c
);
659 static void rpushCommand(redisClient
*c
);
660 static void lpopCommand(redisClient
*c
);
661 static void rpopCommand(redisClient
*c
);
662 static void llenCommand(redisClient
*c
);
663 static void lindexCommand(redisClient
*c
);
664 static void lrangeCommand(redisClient
*c
);
665 static void ltrimCommand(redisClient
*c
);
666 static void typeCommand(redisClient
*c
);
667 static void lsetCommand(redisClient
*c
);
668 static void saddCommand(redisClient
*c
);
669 static void sremCommand(redisClient
*c
);
670 static void smoveCommand(redisClient
*c
);
671 static void sismemberCommand(redisClient
*c
);
672 static void scardCommand(redisClient
*c
);
673 static void spopCommand(redisClient
*c
);
674 static void srandmemberCommand(redisClient
*c
);
675 static void sinterCommand(redisClient
*c
);
676 static void sinterstoreCommand(redisClient
*c
);
677 static void sunionCommand(redisClient
*c
);
678 static void sunionstoreCommand(redisClient
*c
);
679 static void sdiffCommand(redisClient
*c
);
680 static void sdiffstoreCommand(redisClient
*c
);
681 static void syncCommand(redisClient
*c
);
682 static void flushdbCommand(redisClient
*c
);
683 static void flushallCommand(redisClient
*c
);
684 static void sortCommand(redisClient
*c
);
685 static void lremCommand(redisClient
*c
);
686 static void rpoplpushcommand(redisClient
*c
);
687 static void infoCommand(redisClient
*c
);
688 static void mgetCommand(redisClient
*c
);
689 static void monitorCommand(redisClient
*c
);
690 static void expireCommand(redisClient
*c
);
691 static void expireatCommand(redisClient
*c
);
692 static void getsetCommand(redisClient
*c
);
693 static void ttlCommand(redisClient
*c
);
694 static void slaveofCommand(redisClient
*c
);
695 static void debugCommand(redisClient
*c
);
696 static void msetCommand(redisClient
*c
);
697 static void msetnxCommand(redisClient
*c
);
698 static void zaddCommand(redisClient
*c
);
699 static void zincrbyCommand(redisClient
*c
);
700 static void zrangeCommand(redisClient
*c
);
701 static void zrangebyscoreCommand(redisClient
*c
);
702 static void zcountCommand(redisClient
*c
);
703 static void zrevrangeCommand(redisClient
*c
);
704 static void zcardCommand(redisClient
*c
);
705 static void zremCommand(redisClient
*c
);
706 static void zscoreCommand(redisClient
*c
);
707 static void zremrangebyscoreCommand(redisClient
*c
);
708 static void multiCommand(redisClient
*c
);
709 static void execCommand(redisClient
*c
);
710 static void discardCommand(redisClient
*c
);
711 static void blpopCommand(redisClient
*c
);
712 static void brpopCommand(redisClient
*c
);
713 static void appendCommand(redisClient
*c
);
714 static void substrCommand(redisClient
*c
);
715 static void zrankCommand(redisClient
*c
);
716 static void zrevrankCommand(redisClient
*c
);
717 static void hsetCommand(redisClient
*c
);
718 static void hsetnxCommand(redisClient
*c
);
719 static void hgetCommand(redisClient
*c
);
720 static void hmsetCommand(redisClient
*c
);
721 static void hmgetCommand(redisClient
*c
);
722 static void hdelCommand(redisClient
*c
);
723 static void hlenCommand(redisClient
*c
);
724 static void zremrangebyrankCommand(redisClient
*c
);
725 static void zunionCommand(redisClient
*c
);
726 static void zinterCommand(redisClient
*c
);
727 static void hkeysCommand(redisClient
*c
);
728 static void hvalsCommand(redisClient
*c
);
729 static void hgetallCommand(redisClient
*c
);
730 static void hexistsCommand(redisClient
*c
);
731 static void configCommand(redisClient
*c
);
732 static void hincrbyCommand(redisClient
*c
);
733 static void subscribeCommand(redisClient
*c
);
734 static void unsubscribeCommand(redisClient
*c
);
735 static void psubscribeCommand(redisClient
*c
);
736 static void punsubscribeCommand(redisClient
*c
);
737 static void publishCommand(redisClient
*c
);
739 /*================================= Globals ================================= */
742 static struct redisServer server
; /* server global state */
743 static struct redisCommand cmdTable
[] = {
744 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
746 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
747 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
748 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
749 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
751 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
753 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
754 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
755 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
756 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
757 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
764 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
765 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
766 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
767 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
768 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
769 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
770 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
771 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
772 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
775 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
776 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
777 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
778 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
779 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
780 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
781 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
783 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
784 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
785 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
786 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
788 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
789 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
792 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
793 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
794 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
796 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
797 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
798 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
802 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
803 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
804 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
805 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
807 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
809 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
810 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
811 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
812 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
813 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
814 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
817 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
818 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
819 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
826 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
832 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,execBlockClientOnSwappedKeys
,0,0,0},
834 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
839 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
842 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
845 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
846 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
847 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
848 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
849 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
850 {NULL
,NULL
,0,0,NULL
,0,0,0}
853 /*============================ Utility functions ============================ */
855 /* Glob-style pattern matching. */
856 static int stringmatchlen(const char *pattern
, int patternLen
,
857 const char *string
, int stringLen
, int nocase
)
862 while (pattern
[1] == '*') {
867 return 1; /* match */
869 if (stringmatchlen(pattern
+1, patternLen
-1,
870 string
, stringLen
, nocase
))
871 return 1; /* match */
875 return 0; /* no match */
879 return 0; /* no match */
889 not = pattern
[0] == '^';
896 if (pattern
[0] == '\\') {
899 if (pattern
[0] == string
[0])
901 } else if (pattern
[0] == ']') {
903 } else if (patternLen
== 0) {
907 } else if (pattern
[1] == '-' && patternLen
>= 3) {
908 int start
= pattern
[0];
909 int end
= pattern
[2];
917 start
= tolower(start
);
923 if (c
>= start
&& c
<= end
)
927 if (pattern
[0] == string
[0])
930 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
940 return 0; /* no match */
946 if (patternLen
>= 2) {
953 if (pattern
[0] != string
[0])
954 return 0; /* no match */
956 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
957 return 0; /* no match */
965 if (stringLen
== 0) {
966 while(*pattern
== '*') {
973 if (patternLen
== 0 && stringLen
== 0)
978 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
979 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
982 /* Convert a string representing an amount of memory into the number of
983 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
986 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
988 static long long memtoll(const char *p
, int *err
) {
991 long mul
; /* unit multiplier */
996 /* Search the first non digit character. */
999 while(*u
&& isdigit(*u
)) u
++;
1000 if (*u
== '\0' || !strcasecmp(u
,"b")) {
1002 } else if (!strcasecmp(u
,"k")) {
1004 } else if (!strcasecmp(u
,"kb")) {
1006 } else if (!strcasecmp(u
,"m")) {
1008 } else if (!strcasecmp(u
,"mb")) {
1010 } else if (!strcasecmp(u
,"g")) {
1011 mul
= 1000L*1000*1000;
1012 } else if (!strcasecmp(u
,"gb")) {
1013 mul
= 1024L*1024*1024;
1019 if (digits
>= sizeof(buf
)) {
1023 memcpy(buf
,p
,digits
);
1025 val
= strtoll(buf
,NULL
,10);
1029 /* Convert a long long into a string. Returns the number of
1030 * characters needed to represent the number, that can be shorter if passed
1031 * buffer length is not enough to store the whole number. */
1032 static int ll2string(char *s
, size_t len
, long long value
) {
1034 unsigned long long v
;
1037 if (len
== 0) return 0;
1038 v
= (value
< 0) ? -value
: value
;
1039 p
= buf
+31; /* point to the last character */
1044 if (value
< 0) *p
-- = '-';
1047 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1053 static void redisLog(int level
, const char *fmt
, ...) {
1057 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1061 if (level
>= server
.verbosity
) {
1067 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1068 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1069 vfprintf(fp
, fmt
, ap
);
1075 if (server
.logfile
) fclose(fp
);
1078 /*====================== Hash table type implementation ==================== */
1080 /* This is an hash table type that uses the SDS dynamic strings libary as
1081 * keys and radis objects as values (objects can hold SDS strings,
1084 static void dictVanillaFree(void *privdata
, void *val
)
1086 DICT_NOTUSED(privdata
);
1090 static void dictListDestructor(void *privdata
, void *val
)
1092 DICT_NOTUSED(privdata
);
1093 listRelease((list
*)val
);
1096 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1100 DICT_NOTUSED(privdata
);
1102 l1
= sdslen((sds
)key1
);
1103 l2
= sdslen((sds
)key2
);
1104 if (l1
!= l2
) return 0;
1105 return memcmp(key1
, key2
, l1
) == 0;
1108 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1110 DICT_NOTUSED(privdata
);
1112 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1116 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1119 const robj
*o1
= key1
, *o2
= key2
;
1120 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1123 static unsigned int dictObjHash(const void *key
) {
1124 const robj
*o
= key
;
1125 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1128 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1131 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1134 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1135 o2
->encoding
== REDIS_ENCODING_INT
)
1136 return o1
->ptr
== o2
->ptr
;
1138 o1
= getDecodedObject(o1
);
1139 o2
= getDecodedObject(o2
);
1140 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1146 static unsigned int dictEncObjHash(const void *key
) {
1147 robj
*o
= (robj
*) key
;
1149 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1150 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1152 if (o
->encoding
== REDIS_ENCODING_INT
) {
1156 len
= ll2string(buf
,32,(long)o
->ptr
);
1157 return dictGenHashFunction((unsigned char*)buf
, len
);
1161 o
= getDecodedObject(o
);
1162 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1169 /* Sets type and expires */
1170 static dictType setDictType
= {
1171 dictEncObjHash
, /* hash function */
1174 dictEncObjKeyCompare
, /* key compare */
1175 dictRedisObjectDestructor
, /* key destructor */
1176 NULL
/* val destructor */
1179 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1180 static dictType zsetDictType
= {
1181 dictEncObjHash
, /* hash function */
1184 dictEncObjKeyCompare
, /* key compare */
1185 dictRedisObjectDestructor
, /* key destructor */
1186 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1190 static dictType dbDictType
= {
1191 dictObjHash
, /* hash function */
1194 dictObjKeyCompare
, /* key compare */
1195 dictRedisObjectDestructor
, /* key destructor */
1196 dictRedisObjectDestructor
/* val destructor */
1200 static dictType keyptrDictType
= {
1201 dictObjHash
, /* hash function */
1204 dictObjKeyCompare
, /* key compare */
1205 dictRedisObjectDestructor
, /* key destructor */
1206 NULL
/* val destructor */
1209 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1210 static dictType hashDictType
= {
1211 dictEncObjHash
, /* hash function */
1214 dictEncObjKeyCompare
, /* key compare */
1215 dictRedisObjectDestructor
, /* key destructor */
1216 dictRedisObjectDestructor
/* val destructor */
1219 /* Keylist hash table type has unencoded redis objects as keys and
1220 * lists as values. It's used for blocking operations (BLPOP) and to
1221 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1222 static dictType keylistDictType
= {
1223 dictObjHash
, /* hash function */
1226 dictObjKeyCompare
, /* key compare */
1227 dictRedisObjectDestructor
, /* key destructor */
1228 dictListDestructor
/* val destructor */
1231 static void version();
1233 /* ========================= Random utility functions ======================= */
1235 /* Redis generally does not try to recover from out of memory conditions
1236 * when allocating objects or strings, it is not clear if it will be possible
1237 * to report this condition to the client since the networking layer itself
1238 * is based on heap allocation for send buffers, so we simply abort.
1239 * At least the code will be simpler to read... */
1240 static void oom(const char *msg
) {
1241 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1246 /* ====================== Redis server networking stuff ===================== */
1247 static void closeTimedoutClients(void) {
1250 time_t now
= time(NULL
);
1253 listRewind(server
.clients
,&li
);
1254 while ((ln
= listNext(&li
)) != NULL
) {
1255 c
= listNodeValue(ln
);
1256 if (server
.maxidletime
&&
1257 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1258 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1259 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1260 listLength(c
->pubsub_patterns
) == 0 &&
1261 (now
- c
->lastinteraction
> server
.maxidletime
))
1263 redisLog(REDIS_VERBOSE
,"Closing idle client");
1265 } else if (c
->flags
& REDIS_BLOCKED
) {
1266 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1267 addReply(c
,shared
.nullmultibulk
);
1268 unblockClientWaitingData(c
);
1274 static int htNeedsResize(dict
*dict
) {
1275 long long size
, used
;
1277 size
= dictSlots(dict
);
1278 used
= dictSize(dict
);
1279 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1280 (used
*100/size
< REDIS_HT_MINFILL
));
1283 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1284 * we resize the hash table to save memory */
1285 static void tryResizeHashTables(void) {
1288 for (j
= 0; j
< server
.dbnum
; j
++) {
1289 if (htNeedsResize(server
.db
[j
].dict
))
1290 dictResize(server
.db
[j
].dict
);
1291 if (htNeedsResize(server
.db
[j
].expires
))
1292 dictResize(server
.db
[j
].expires
);
1296 /* Our hash table implementation performs rehashing incrementally while
1297 * we write/read from the hash table. Still if the server is idle, the hash
1298 * table will use two tables for a long time. So we try to use 1 millisecond
1299 * of CPU time at every serverCron() loop in order to rehash some key. */
1300 static void incrementallyRehash(void) {
1303 for (j
= 0; j
< server
.dbnum
; j
++) {
1304 if (dictIsRehashing(server
.db
[j
].dict
)) {
1305 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1306 break; /* already used our millisecond for this loop... */
1311 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1312 void backgroundSaveDoneHandler(int statloc
) {
1313 int exitcode
= WEXITSTATUS(statloc
);
1314 int bysignal
= WIFSIGNALED(statloc
);
1316 if (!bysignal
&& exitcode
== 0) {
1317 redisLog(REDIS_NOTICE
,
1318 "Background saving terminated with success");
1320 server
.lastsave
= time(NULL
);
1321 } else if (!bysignal
&& exitcode
!= 0) {
1322 redisLog(REDIS_WARNING
, "Background saving error");
1324 redisLog(REDIS_WARNING
,
1325 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1326 rdbRemoveTempFile(server
.bgsavechildpid
);
1328 server
.bgsavechildpid
= -1;
1329 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1330 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1331 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1334 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1336 void backgroundRewriteDoneHandler(int statloc
) {
1337 int exitcode
= WEXITSTATUS(statloc
);
1338 int bysignal
= WIFSIGNALED(statloc
);
1340 if (!bysignal
&& exitcode
== 0) {
1344 redisLog(REDIS_NOTICE
,
1345 "Background append only file rewriting terminated with success");
1346 /* Now it's time to flush the differences accumulated by the parent */
1347 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1348 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1350 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1353 /* Flush our data... */
1354 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1355 (signed) sdslen(server
.bgrewritebuf
)) {
1356 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
));
1360 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1361 /* Now our work is to rename the temp file into the stable file. And
1362 * switch the file descriptor used by the server for append only. */
1363 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1364 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1368 /* Mission completed... almost */
1369 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1370 if (server
.appendfd
!= -1) {
1371 /* If append only is actually enabled... */
1372 close(server
.appendfd
);
1373 server
.appendfd
= fd
;
1375 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1376 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1378 /* If append only is disabled we just generate a dump in this
1379 * format. Why not? */
1382 } else if (!bysignal
&& exitcode
!= 0) {
1383 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1385 redisLog(REDIS_WARNING
,
1386 "Background append only file rewriting terminated by signal %d",
1390 sdsfree(server
.bgrewritebuf
);
1391 server
.bgrewritebuf
= sdsempty();
1392 aofRemoveTempFile(server
.bgrewritechildpid
);
1393 server
.bgrewritechildpid
= -1;
1396 /* This function is called once a background process of some kind terminates,
1397 * as we want to avoid resizing the hash tables when there is a child in order
1398 * to play well with copy-on-write (otherwise when a resize happens lots of
1399 * memory pages are copied). The goal of this function is to update the ability
1400 * for dict.c to resize the hash tables accordingly to the fact we have o not
1401 * running childs. */
1402 static void updateDictResizePolicy(void) {
1403 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1406 dictDisableResize();
1409 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1410 int j
, loops
= server
.cronloops
++;
1411 REDIS_NOTUSED(eventLoop
);
1413 REDIS_NOTUSED(clientData
);
1415 /* We take a cached value of the unix time in the global state because
1416 * with virtual memory and aging there is to store the current time
1417 * in objects at every object access, and accuracy is not needed.
1418 * To access a global var is faster than calling time(NULL) */
1419 server
.unixtime
= time(NULL
);
1421 /* Show some info about non-empty databases */
1422 for (j
= 0; j
< server
.dbnum
; j
++) {
1423 long long size
, used
, vkeys
;
1425 size
= dictSlots(server
.db
[j
].dict
);
1426 used
= dictSize(server
.db
[j
].dict
);
1427 vkeys
= dictSize(server
.db
[j
].expires
);
1428 if (!(loops
% 50) && (used
|| vkeys
)) {
1429 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1430 /* dictPrintStats(server.dict); */
1434 /* We don't want to resize the hash tables while a bacground saving
1435 * is in progress: the saving child is created using fork() that is
1436 * implemented with a copy-on-write semantic in most modern systems, so
1437 * if we resize the HT while there is the saving child at work actually
1438 * a lot of memory movements in the parent will cause a lot of pages
1440 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1441 if (!(loops
% 10)) tryResizeHashTables();
1442 if (server
.activerehashing
) incrementallyRehash();
1445 /* Show information about connected clients */
1446 if (!(loops
% 50)) {
1447 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1448 listLength(server
.clients
)-listLength(server
.slaves
),
1449 listLength(server
.slaves
),
1450 zmalloc_used_memory());
1453 /* Close connections of timedout clients */
1454 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1455 closeTimedoutClients();
1457 /* Check if a background saving or AOF rewrite in progress terminated */
1458 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1462 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1463 if (pid
== server
.bgsavechildpid
) {
1464 backgroundSaveDoneHandler(statloc
);
1466 backgroundRewriteDoneHandler(statloc
);
1468 updateDictResizePolicy();
1471 /* If there is not a background saving in progress check if
1472 * we have to save now */
1473 time_t now
= time(NULL
);
1474 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1475 struct saveparam
*sp
= server
.saveparams
+j
;
1477 if (server
.dirty
>= sp
->changes
&&
1478 now
-server
.lastsave
> sp
->seconds
) {
1479 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1480 sp
->changes
, sp
->seconds
);
1481 rdbSaveBackground(server
.dbfilename
);
1487 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1488 * will use few CPU cycles if there are few expiring keys, otherwise
1489 * it will get more aggressive to avoid that too much memory is used by
1490 * keys that can be removed from the keyspace. */
1491 for (j
= 0; j
< server
.dbnum
; j
++) {
1493 redisDb
*db
= server
.db
+j
;
1495 /* Continue to expire if at the end of the cycle more than 25%
1496 * of the keys were expired. */
1498 long num
= dictSize(db
->expires
);
1499 time_t now
= time(NULL
);
1502 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1503 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1508 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1509 t
= (time_t) dictGetEntryVal(de
);
1511 deleteKey(db
,dictGetEntryKey(de
));
1513 server
.stat_expiredkeys
++;
1516 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1519 /* Swap a few keys on disk if we are over the memory limit and VM
1520 * is enbled. Try to free objects from the free list first. */
1521 if (vmCanSwapOut()) {
1522 while (server
.vm_enabled
&& zmalloc_used_memory() >
1523 server
.vm_max_memory
)
1527 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1528 retval
= (server
.vm_max_threads
== 0) ?
1529 vmSwapOneObjectBlocking() :
1530 vmSwapOneObjectThreaded();
1531 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1532 zmalloc_used_memory() >
1533 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1535 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1537 /* Note that when using threade I/O we free just one object,
1538 * because anyway when the I/O thread in charge to swap this
1539 * object out will finish, the handler of completed jobs
1540 * will try to swap more objects if we are still out of memory. */
1541 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1545 /* Check if we should connect to a MASTER */
1546 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1547 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1548 if (syncWithMaster() == REDIS_OK
) {
1549 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1550 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1556 /* This function gets called every time Redis is entering the
1557 * main loop of the event driven library, that is, before to sleep
1558 * for ready file descriptors. */
1559 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1560 REDIS_NOTUSED(eventLoop
);
1562 /* Awake clients that got all the swapped keys they requested */
1563 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1567 listRewind(server
.io_ready_clients
,&li
);
1568 while((ln
= listNext(&li
))) {
1569 redisClient
*c
= ln
->value
;
1570 struct redisCommand
*cmd
;
1572 /* Resume the client. */
1573 listDelNode(server
.io_ready_clients
,ln
);
1574 c
->flags
&= (~REDIS_IO_WAIT
);
1575 server
.vm_blocked_clients
--;
1576 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1577 readQueryFromClient
, c
);
1578 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1579 assert(cmd
!= NULL
);
1582 /* There may be more data to process in the input buffer. */
1583 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1584 processInputBuffer(c
);
1587 /* Write the AOF buffer on disk */
1588 flushAppendOnlyFile();
1591 static void createSharedObjects(void) {
1594 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1595 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1596 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1597 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1598 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1599 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1600 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1601 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1602 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1603 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1604 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1605 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1606 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1607 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1608 "-ERR no such key\r\n"));
1609 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1610 "-ERR syntax error\r\n"));
1611 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1612 "-ERR source and destination objects are the same\r\n"));
1613 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1614 "-ERR index out of range\r\n"));
1615 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1616 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1617 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1618 shared
.select0
= createStringObject("select 0\r\n",10);
1619 shared
.select1
= createStringObject("select 1\r\n",10);
1620 shared
.select2
= createStringObject("select 2\r\n",10);
1621 shared
.select3
= createStringObject("select 3\r\n",10);
1622 shared
.select4
= createStringObject("select 4\r\n",10);
1623 shared
.select5
= createStringObject("select 5\r\n",10);
1624 shared
.select6
= createStringObject("select 6\r\n",10);
1625 shared
.select7
= createStringObject("select 7\r\n",10);
1626 shared
.select8
= createStringObject("select 8\r\n",10);
1627 shared
.select9
= createStringObject("select 9\r\n",10);
1628 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1629 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1630 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1631 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1632 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1633 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1634 shared
.mbulk3
= createStringObject("*3\r\n",4);
1635 shared
.mbulk4
= createStringObject("*4\r\n",4);
1636 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1637 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1638 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1642 static void appendServerSaveParams(time_t seconds
, int changes
) {
1643 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1644 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1645 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1646 server
.saveparamslen
++;
1649 static void resetServerSaveParams() {
1650 zfree(server
.saveparams
);
1651 server
.saveparams
= NULL
;
1652 server
.saveparamslen
= 0;
1655 static void initServerConfig() {
1656 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1657 server
.port
= REDIS_SERVERPORT
;
1658 server
.verbosity
= REDIS_VERBOSE
;
1659 server
.maxidletime
= REDIS_MAXIDLETIME
;
1660 server
.saveparams
= NULL
;
1661 server
.logfile
= NULL
; /* NULL = log on standard output */
1662 server
.bindaddr
= NULL
;
1663 server
.glueoutputbuf
= 1;
1664 server
.daemonize
= 0;
1665 server
.appendonly
= 0;
1666 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1667 server
.lastfsync
= time(NULL
);
1668 server
.appendfd
= -1;
1669 server
.appendseldb
= -1; /* Make sure the first time will not match */
1670 server
.pidfile
= zstrdup("/var/run/redis.pid");
1671 server
.dbfilename
= zstrdup("dump.rdb");
1672 server
.appendfilename
= zstrdup("appendonly.aof");
1673 server
.requirepass
= NULL
;
1674 server
.rdbcompression
= 1;
1675 server
.activerehashing
= 1;
1676 server
.maxclients
= 0;
1677 server
.blpop_blocked_clients
= 0;
1678 server
.maxmemory
= 0;
1679 server
.vm_enabled
= 0;
1680 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1681 server
.vm_page_size
= 256; /* 256 bytes per page */
1682 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1683 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1684 server
.vm_max_threads
= 4;
1685 server
.vm_blocked_clients
= 0;
1686 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1687 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1689 resetServerSaveParams();
1691 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1692 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1693 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1694 /* Replication related */
1696 server
.masterauth
= NULL
;
1697 server
.masterhost
= NULL
;
1698 server
.masterport
= 6379;
1699 server
.master
= NULL
;
1700 server
.replstate
= REDIS_REPL_NONE
;
1702 /* Double constants initialization */
1704 R_PosInf
= 1.0/R_Zero
;
1705 R_NegInf
= -1.0/R_Zero
;
1706 R_Nan
= R_Zero
/R_Zero
;
1709 static void initServer() {
1712 signal(SIGHUP
, SIG_IGN
);
1713 signal(SIGPIPE
, SIG_IGN
);
1714 setupSigSegvAction();
1716 server
.devnull
= fopen("/dev/null","w");
1717 if (server
.devnull
== NULL
) {
1718 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1721 server
.clients
= listCreate();
1722 server
.slaves
= listCreate();
1723 server
.monitors
= listCreate();
1724 server
.objfreelist
= listCreate();
1725 createSharedObjects();
1726 server
.el
= aeCreateEventLoop();
1727 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1728 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1729 if (server
.fd
== -1) {
1730 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1733 for (j
= 0; j
< server
.dbnum
; j
++) {
1734 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1735 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1736 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1737 if (server
.vm_enabled
)
1738 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1739 server
.db
[j
].id
= j
;
1741 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1742 server
.pubsub_patterns
= listCreate();
1743 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1744 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1745 server
.cronloops
= 0;
1746 server
.bgsavechildpid
= -1;
1747 server
.bgrewritechildpid
= -1;
1748 server
.bgrewritebuf
= sdsempty();
1749 server
.aofbuf
= sdsempty();
1750 server
.lastsave
= time(NULL
);
1752 server
.stat_numcommands
= 0;
1753 server
.stat_numconnections
= 0;
1754 server
.stat_expiredkeys
= 0;
1755 server
.stat_starttime
= time(NULL
);
1756 server
.unixtime
= time(NULL
);
1757 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1758 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1759 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1761 if (server
.appendonly
) {
1762 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1763 if (server
.appendfd
== -1) {
1764 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1770 if (server
.vm_enabled
) vmInit();
1773 /* Empty the whole database */
1774 static long long emptyDb() {
1776 long long removed
= 0;
1778 for (j
= 0; j
< server
.dbnum
; j
++) {
1779 removed
+= dictSize(server
.db
[j
].dict
);
1780 dictEmpty(server
.db
[j
].dict
);
1781 dictEmpty(server
.db
[j
].expires
);
1786 static int yesnotoi(char *s
) {
1787 if (!strcasecmp(s
,"yes")) return 1;
1788 else if (!strcasecmp(s
,"no")) return 0;
1792 /* I agree, this is a very rudimental way to load a configuration...
1793 will improve later if the config gets more complex */
1794 static void loadServerConfig(char *filename
) {
1796 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1800 if (filename
[0] == '-' && filename
[1] == '\0')
1803 if ((fp
= fopen(filename
,"r")) == NULL
) {
1804 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1809 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1815 line
= sdstrim(line
," \t\r\n");
1817 /* Skip comments and blank lines*/
1818 if (line
[0] == '#' || line
[0] == '\0') {
1823 /* Split into arguments */
1824 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1825 sdstolower(argv
[0]);
1827 /* Execute config directives */
1828 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1829 server
.maxidletime
= atoi(argv
[1]);
1830 if (server
.maxidletime
< 0) {
1831 err
= "Invalid timeout value"; goto loaderr
;
1833 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1834 server
.port
= atoi(argv
[1]);
1835 if (server
.port
< 1 || server
.port
> 65535) {
1836 err
= "Invalid port"; goto loaderr
;
1838 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1839 server
.bindaddr
= zstrdup(argv
[1]);
1840 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1841 int seconds
= atoi(argv
[1]);
1842 int changes
= atoi(argv
[2]);
1843 if (seconds
< 1 || changes
< 0) {
1844 err
= "Invalid save parameters"; goto loaderr
;
1846 appendServerSaveParams(seconds
,changes
);
1847 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1848 if (chdir(argv
[1]) == -1) {
1849 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1850 argv
[1], strerror(errno
));
1853 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1854 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1855 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1856 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1857 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1859 err
= "Invalid log level. Must be one of debug, notice, warning";
1862 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1865 server
.logfile
= zstrdup(argv
[1]);
1866 if (!strcasecmp(server
.logfile
,"stdout")) {
1867 zfree(server
.logfile
);
1868 server
.logfile
= NULL
;
1870 if (server
.logfile
) {
1871 /* Test if we are able to open the file. The server will not
1872 * be able to abort just for this problem later... */
1873 logfp
= fopen(server
.logfile
,"a");
1874 if (logfp
== NULL
) {
1875 err
= sdscatprintf(sdsempty(),
1876 "Can't open the log file: %s", strerror(errno
));
1881 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1882 server
.dbnum
= atoi(argv
[1]);
1883 if (server
.dbnum
< 1) {
1884 err
= "Invalid number of databases"; goto loaderr
;
1886 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1887 loadServerConfig(argv
[1]);
1888 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1889 server
.maxclients
= atoi(argv
[1]);
1890 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1891 server
.maxmemory
= memtoll(argv
[1],NULL
);
1892 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1893 server
.masterhost
= sdsnew(argv
[1]);
1894 server
.masterport
= atoi(argv
[2]);
1895 server
.replstate
= REDIS_REPL_CONNECT
;
1896 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1897 server
.masterauth
= zstrdup(argv
[1]);
1898 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1899 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1900 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1902 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1903 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1904 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1906 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1907 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1908 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1910 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1911 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1912 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1914 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1915 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1916 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1918 } else if (!strcasecmp(argv
[0],"appendfilename") && argc
== 2) {
1919 zfree(server
.appendfilename
);
1920 server
.appendfilename
= zstrdup(argv
[1]);
1921 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1922 if (!strcasecmp(argv
[1],"no")) {
1923 server
.appendfsync
= APPENDFSYNC_NO
;
1924 } else if (!strcasecmp(argv
[1],"always")) {
1925 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1926 } else if (!strcasecmp(argv
[1],"everysec")) {
1927 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1929 err
= "argument must be 'no', 'always' or 'everysec'";
1932 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1933 server
.requirepass
= zstrdup(argv
[1]);
1934 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1935 zfree(server
.pidfile
);
1936 server
.pidfile
= zstrdup(argv
[1]);
1937 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1938 zfree(server
.dbfilename
);
1939 server
.dbfilename
= zstrdup(argv
[1]);
1940 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1941 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1942 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1944 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1945 zfree(server
.vm_swap_file
);
1946 server
.vm_swap_file
= zstrdup(argv
[1]);
1947 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1948 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1949 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1950 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1951 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1952 server
.vm_pages
= memtoll(argv
[1], NULL
);
1953 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1954 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1955 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1956 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1957 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1958 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1960 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1962 for (j
= 0; j
< argc
; j
++)
1967 if (fp
!= stdin
) fclose(fp
);
1971 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1972 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1973 fprintf(stderr
, ">>> '%s'\n", line
);
1974 fprintf(stderr
, "%s\n", err
);
1978 static void freeClientArgv(redisClient
*c
) {
1981 for (j
= 0; j
< c
->argc
; j
++)
1982 decrRefCount(c
->argv
[j
]);
1983 for (j
= 0; j
< c
->mbargc
; j
++)
1984 decrRefCount(c
->mbargv
[j
]);
1989 static void freeClient(redisClient
*c
) {
1992 /* Note that if the client we are freeing is blocked into a blocking
1993 * call, we have to set querybuf to NULL *before* to call
1994 * unblockClientWaitingData() to avoid processInputBuffer() will get
1995 * called. Also it is important to remove the file events after
1996 * this, because this call adds the READABLE event. */
1997 sdsfree(c
->querybuf
);
1999 if (c
->flags
& REDIS_BLOCKED
)
2000 unblockClientWaitingData(c
);
2002 /* Unsubscribe from all the pubsub channels */
2003 pubsubUnsubscribeAllChannels(c
,0);
2004 pubsubUnsubscribeAllPatterns(c
,0);
2005 dictRelease(c
->pubsub_channels
);
2006 listRelease(c
->pubsub_patterns
);
2007 /* Obvious cleanup */
2008 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2009 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2010 listRelease(c
->reply
);
2013 /* Remove from the list of clients */
2014 ln
= listSearchKey(server
.clients
,c
);
2015 redisAssert(ln
!= NULL
);
2016 listDelNode(server
.clients
,ln
);
2017 /* Remove from the list of clients waiting for swapped keys */
2018 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2019 ln
= listSearchKey(server
.io_ready_clients
,c
);
2021 listDelNode(server
.io_ready_clients
,ln
);
2022 server
.vm_blocked_clients
--;
2025 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2026 ln
= listFirst(c
->io_keys
);
2027 dontWaitForSwappedKey(c
,ln
->value
);
2029 listRelease(c
->io_keys
);
2030 /* Master/slave cleanup */
2031 if (c
->flags
& REDIS_SLAVE
) {
2032 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2034 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2035 ln
= listSearchKey(l
,c
);
2036 redisAssert(ln
!= NULL
);
2039 if (c
->flags
& REDIS_MASTER
) {
2040 server
.master
= NULL
;
2041 server
.replstate
= REDIS_REPL_CONNECT
;
2043 /* Release memory */
2046 freeClientMultiState(c
);
2050 #define GLUEREPLY_UP_TO (1024)
2051 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2053 char buf
[GLUEREPLY_UP_TO
];
2058 listRewind(c
->reply
,&li
);
2059 while((ln
= listNext(&li
))) {
2063 objlen
= sdslen(o
->ptr
);
2064 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2065 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2067 listDelNode(c
->reply
,ln
);
2069 if (copylen
== 0) return;
2073 /* Now the output buffer is empty, add the new single element */
2074 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2075 listAddNodeHead(c
->reply
,o
);
2078 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2079 redisClient
*c
= privdata
;
2080 int nwritten
= 0, totwritten
= 0, objlen
;
2083 REDIS_NOTUSED(mask
);
2085 /* Use writev() if we have enough buffers to send */
2086 if (!server
.glueoutputbuf
&&
2087 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2088 !(c
->flags
& REDIS_MASTER
))
2090 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2094 while(listLength(c
->reply
)) {
2095 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2096 glueReplyBuffersIfNeeded(c
);
2098 o
= listNodeValue(listFirst(c
->reply
));
2099 objlen
= sdslen(o
->ptr
);
2102 listDelNode(c
->reply
,listFirst(c
->reply
));
2106 if (c
->flags
& REDIS_MASTER
) {
2107 /* Don't reply to a master */
2108 nwritten
= objlen
- c
->sentlen
;
2110 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2111 if (nwritten
<= 0) break;
2113 c
->sentlen
+= nwritten
;
2114 totwritten
+= nwritten
;
2115 /* If we fully sent the object on head go to the next one */
2116 if (c
->sentlen
== objlen
) {
2117 listDelNode(c
->reply
,listFirst(c
->reply
));
2120 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2121 * bytes, in a single threaded server it's a good idea to serve
2122 * other clients as well, even if a very large request comes from
2123 * super fast link that is always able to accept data (in real world
2124 * scenario think about 'KEYS *' against the loopback interfae) */
2125 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2127 if (nwritten
== -1) {
2128 if (errno
== EAGAIN
) {
2131 redisLog(REDIS_VERBOSE
,
2132 "Error writing to client: %s", strerror(errno
));
2137 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2138 if (listLength(c
->reply
) == 0) {
2140 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2144 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2146 redisClient
*c
= privdata
;
2147 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2149 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2150 int offset
, ion
= 0;
2152 REDIS_NOTUSED(mask
);
2155 while (listLength(c
->reply
)) {
2156 offset
= c
->sentlen
;
2160 /* fill-in the iov[] array */
2161 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2162 o
= listNodeValue(node
);
2163 objlen
= sdslen(o
->ptr
);
2165 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2168 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2169 break; /* no more iovecs */
2171 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2172 iov
[ion
].iov_len
= objlen
- offset
;
2173 willwrite
+= objlen
- offset
;
2174 offset
= 0; /* just for the first item */
2181 /* write all collected blocks at once */
2182 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2183 if (errno
!= EAGAIN
) {
2184 redisLog(REDIS_VERBOSE
,
2185 "Error writing to client: %s", strerror(errno
));
2192 totwritten
+= nwritten
;
2193 offset
= c
->sentlen
;
2195 /* remove written robjs from c->reply */
2196 while (nwritten
&& listLength(c
->reply
)) {
2197 o
= listNodeValue(listFirst(c
->reply
));
2198 objlen
= sdslen(o
->ptr
);
2200 if(nwritten
>= objlen
- offset
) {
2201 listDelNode(c
->reply
, listFirst(c
->reply
));
2202 nwritten
-= objlen
- offset
;
2206 c
->sentlen
+= nwritten
;
2214 c
->lastinteraction
= time(NULL
);
2216 if (listLength(c
->reply
) == 0) {
2218 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2222 static struct redisCommand
*lookupCommand(char *name
) {
2224 while(cmdTable
[j
].name
!= NULL
) {
2225 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2231 /* resetClient prepare the client to process the next command */
2232 static void resetClient(redisClient
*c
) {
2238 /* Call() is the core of Redis execution of a command */
2239 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2242 dirty
= server
.dirty
;
2244 dirty
= server
.dirty
-dirty
;
2246 if (server
.appendonly
&& dirty
)
2247 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2248 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2249 listLength(server
.slaves
))
2250 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2251 if (listLength(server
.monitors
))
2252 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2253 server
.stat_numcommands
++;
2256 /* If this function gets called we already read a whole
2257 * command, argments are in the client argv/argc fields.
2258 * processCommand() execute the command or prepare the
2259 * server for a bulk read from the client.
2261 * If 1 is returned the client is still alive and valid and
2262 * and other operations can be performed by the caller. Otherwise
2263 * if 0 is returned the client was destroied (i.e. after QUIT). */
2264 static int processCommand(redisClient
*c
) {
2265 struct redisCommand
*cmd
;
2267 /* Free some memory if needed (maxmemory setting) */
2268 if (server
.maxmemory
) freeMemoryIfNeeded();
2270 /* Handle the multi bulk command type. This is an alternative protocol
2271 * supported by Redis in order to receive commands that are composed of
2272 * multiple binary-safe "bulk" arguments. The latency of processing is
2273 * a bit higher but this allows things like multi-sets, so if this
2274 * protocol is used only for MSET and similar commands this is a big win. */
2275 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2276 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2277 if (c
->multibulk
<= 0) {
2281 decrRefCount(c
->argv
[c
->argc
-1]);
2285 } else if (c
->multibulk
) {
2286 if (c
->bulklen
== -1) {
2287 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2288 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2292 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2293 decrRefCount(c
->argv
[0]);
2294 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2296 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2301 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2305 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2306 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2310 if (c
->multibulk
== 0) {
2314 /* Here we need to swap the multi-bulk argc/argv with the
2315 * normal argc/argv of the client structure. */
2317 c
->argv
= c
->mbargv
;
2318 c
->mbargv
= auxargv
;
2321 c
->argc
= c
->mbargc
;
2322 c
->mbargc
= auxargc
;
2324 /* We need to set bulklen to something different than -1
2325 * in order for the code below to process the command without
2326 * to try to read the last argument of a bulk command as
2327 * a special argument. */
2329 /* continue below and process the command */
2336 /* -- end of multi bulk commands processing -- */
2338 /* The QUIT command is handled as a special case. Normal command
2339 * procs are unable to close the client connection safely */
2340 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2345 /* Now lookup the command and check ASAP about trivial error conditions
2346 * such wrong arity, bad command name and so forth. */
2347 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2350 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2351 (char*)c
->argv
[0]->ptr
));
2354 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2355 (c
->argc
< -cmd
->arity
)) {
2357 sdscatprintf(sdsempty(),
2358 "-ERR wrong number of arguments for '%s' command\r\n",
2362 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2363 /* This is a bulk command, we have to read the last argument yet. */
2364 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2366 decrRefCount(c
->argv
[c
->argc
-1]);
2367 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2369 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2374 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2375 /* It is possible that the bulk read is already in the
2376 * buffer. Check this condition and handle it accordingly.
2377 * This is just a fast path, alternative to call processInputBuffer().
2378 * It's a good idea since the code is small and this condition
2379 * happens most of the times. */
2380 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2381 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2383 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2385 /* Otherwise return... there is to read the last argument
2386 * from the socket. */
2390 /* Let's try to encode the bulk object to save space. */
2391 if (cmd
->flags
& REDIS_CMD_BULK
)
2392 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2394 /* Check if the user is authenticated */
2395 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2396 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2401 /* Handle the maxmemory directive */
2402 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2403 zmalloc_used_memory() > server
.maxmemory
)
2405 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2410 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2411 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2413 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2414 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2415 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2420 /* Exec the command */
2421 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2422 queueMultiCommand(c
,cmd
);
2423 addReply(c
,shared
.queued
);
2425 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2426 blockClientOnSwappedKeys(c
,cmd
)) return 1;
2430 /* Prepare the client for the next command */
2435 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2440 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2441 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2442 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2443 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2446 if (argc
<= REDIS_STATIC_ARGS
) {
2449 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2452 lenobj
= createObject(REDIS_STRING
,
2453 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2454 lenobj
->refcount
= 0;
2455 outv
[outc
++] = lenobj
;
2456 for (j
= 0; j
< argc
; j
++) {
2457 lenobj
= createObject(REDIS_STRING
,
2458 sdscatprintf(sdsempty(),"$%lu\r\n",
2459 (unsigned long) stringObjectLen(argv
[j
])));
2460 lenobj
->refcount
= 0;
2461 outv
[outc
++] = lenobj
;
2462 outv
[outc
++] = argv
[j
];
2463 outv
[outc
++] = shared
.crlf
;
2466 /* Increment all the refcounts at start and decrement at end in order to
2467 * be sure to free objects if there is no slave in a replication state
2468 * able to be feed with commands */
2469 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2470 listRewind(slaves
,&li
);
2471 while((ln
= listNext(&li
))) {
2472 redisClient
*slave
= ln
->value
;
2474 /* Don't feed slaves that are still waiting for BGSAVE to start */
2475 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2477 /* Feed all the other slaves, MONITORs and so on */
2478 if (slave
->slaveseldb
!= dictid
) {
2482 case 0: selectcmd
= shared
.select0
; break;
2483 case 1: selectcmd
= shared
.select1
; break;
2484 case 2: selectcmd
= shared
.select2
; break;
2485 case 3: selectcmd
= shared
.select3
; break;
2486 case 4: selectcmd
= shared
.select4
; break;
2487 case 5: selectcmd
= shared
.select5
; break;
2488 case 6: selectcmd
= shared
.select6
; break;
2489 case 7: selectcmd
= shared
.select7
; break;
2490 case 8: selectcmd
= shared
.select8
; break;
2491 case 9: selectcmd
= shared
.select9
; break;
2493 selectcmd
= createObject(REDIS_STRING
,
2494 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2495 selectcmd
->refcount
= 0;
2498 addReply(slave
,selectcmd
);
2499 slave
->slaveseldb
= dictid
;
2501 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2503 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2504 if (outv
!= static_outv
) zfree(outv
);
2507 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2508 s
= sdscatlen(s
,"\"",1);
2513 s
= sdscatprintf(s
,"\\%c",*p
);
2515 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2516 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2517 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2518 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2519 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2522 s
= sdscatprintf(s
,"%c",*p
);
2524 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2529 return sdscatlen(s
,"\"",1);
2532 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2536 sds cmdrepr
= sdsnew("+");
2540 gettimeofday(&tv
,NULL
);
2541 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2542 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2544 for (j
= 0; j
< argc
; j
++) {
2545 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2546 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2548 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2549 sdslen(argv
[j
]->ptr
));
2552 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2554 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2555 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2557 listRewind(monitors
,&li
);
2558 while((ln
= listNext(&li
))) {
2559 redisClient
*monitor
= ln
->value
;
2560 addReply(monitor
,cmdobj
);
2562 decrRefCount(cmdobj
);
2565 static void processInputBuffer(redisClient
*c
) {
2567 /* Before to process the input buffer, make sure the client is not
2568 * waitig for a blocking operation such as BLPOP. Note that the first
2569 * iteration the client is never blocked, otherwise the processInputBuffer
2570 * would not be called at all, but after the execution of the first commands
2571 * in the input buffer the client may be blocked, and the "goto again"
2572 * will try to reiterate. The following line will make it return asap. */
2573 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2574 if (c
->bulklen
== -1) {
2575 /* Read the first line of the query */
2576 char *p
= strchr(c
->querybuf
,'\n');
2583 query
= c
->querybuf
;
2584 c
->querybuf
= sdsempty();
2585 querylen
= 1+(p
-(query
));
2586 if (sdslen(query
) > querylen
) {
2587 /* leave data after the first line of the query in the buffer */
2588 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2590 *p
= '\0'; /* remove "\n" */
2591 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2592 sdsupdatelen(query
);
2594 /* Now we can split the query in arguments */
2595 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2598 if (c
->argv
) zfree(c
->argv
);
2599 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2601 for (j
= 0; j
< argc
; j
++) {
2602 if (sdslen(argv
[j
])) {
2603 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2611 /* Execute the command. If the client is still valid
2612 * after processCommand() return and there is something
2613 * on the query buffer try to process the next command. */
2614 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2616 /* Nothing to process, argc == 0. Just process the query
2617 * buffer if it's not empty or return to the caller */
2618 if (sdslen(c
->querybuf
)) goto again
;
2621 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2622 redisLog(REDIS_VERBOSE
, "Client protocol error");
2627 /* Bulk read handling. Note that if we are at this point
2628 the client already sent a command terminated with a newline,
2629 we are reading the bulk data that is actually the last
2630 argument of the command. */
2631 int qbl
= sdslen(c
->querybuf
);
2633 if (c
->bulklen
<= qbl
) {
2634 /* Copy everything but the final CRLF as final argument */
2635 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2637 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2638 /* Process the command. If the client is still valid after
2639 * the processing and there is more data in the buffer
2640 * try to parse it. */
2641 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2647 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2648 redisClient
*c
= (redisClient
*) privdata
;
2649 char buf
[REDIS_IOBUF_LEN
];
2652 REDIS_NOTUSED(mask
);
2654 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2656 if (errno
== EAGAIN
) {
2659 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2663 } else if (nread
== 0) {
2664 redisLog(REDIS_VERBOSE
, "Client closed connection");
2669 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2670 c
->lastinteraction
= time(NULL
);
2674 processInputBuffer(c
);
2677 static int selectDb(redisClient
*c
, int id
) {
2678 if (id
< 0 || id
>= server
.dbnum
)
2680 c
->db
= &server
.db
[id
];
2684 static void *dupClientReplyValue(void *o
) {
2685 incrRefCount((robj
*)o
);
2689 static int listMatchObjects(void *a
, void *b
) {
2690 return equalStringObjects(a
,b
);
2693 static redisClient
*createClient(int fd
) {
2694 redisClient
*c
= zmalloc(sizeof(*c
));
2696 anetNonBlock(NULL
,fd
);
2697 anetTcpNoDelay(NULL
,fd
);
2698 if (!c
) return NULL
;
2701 c
->querybuf
= sdsempty();
2710 c
->lastinteraction
= time(NULL
);
2711 c
->authenticated
= 0;
2712 c
->replstate
= REDIS_REPL_NONE
;
2713 c
->reply
= listCreate();
2714 listSetFreeMethod(c
->reply
,decrRefCount
);
2715 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2716 c
->blockingkeys
= NULL
;
2717 c
->blockingkeysnum
= 0;
2718 c
->io_keys
= listCreate();
2719 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2720 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2721 c
->pubsub_patterns
= listCreate();
2722 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2723 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2724 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2725 readQueryFromClient
, c
) == AE_ERR
) {
2729 listAddNodeTail(server
.clients
,c
);
2730 initClientMultiState(c
);
2734 static void addReply(redisClient
*c
, robj
*obj
) {
2735 if (listLength(c
->reply
) == 0 &&
2736 (c
->replstate
== REDIS_REPL_NONE
||
2737 c
->replstate
== REDIS_REPL_ONLINE
) &&
2738 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2739 sendReplyToClient
, c
) == AE_ERR
) return;
2741 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2742 obj
= dupStringObject(obj
);
2743 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2745 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2748 static void addReplySds(redisClient
*c
, sds s
) {
2749 robj
*o
= createObject(REDIS_STRING
,s
);
2754 static void addReplyDouble(redisClient
*c
, double d
) {
2757 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2758 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2759 (unsigned long) strlen(buf
),buf
));
2762 static void addReplyLong(redisClient
*c
, long l
) {
2767 addReply(c
,shared
.czero
);
2769 } else if (l
== 1) {
2770 addReply(c
,shared
.cone
);
2773 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2774 addReplySds(c
,sdsnewlen(buf
,len
));
2777 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2782 addReply(c
,shared
.czero
);
2784 } else if (ll
== 1) {
2785 addReply(c
,shared
.cone
);
2788 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2789 addReplySds(c
,sdsnewlen(buf
,len
));
2792 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2797 addReply(c
,shared
.czero
);
2799 } else if (ul
== 1) {
2800 addReply(c
,shared
.cone
);
2803 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2804 addReplySds(c
,sdsnewlen(buf
,len
));
2807 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2810 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2811 len
= sdslen(obj
->ptr
);
2813 long n
= (long)obj
->ptr
;
2815 /* Compute how many bytes will take this integer as a radix 10 string */
2821 while((n
= n
/10) != 0) {
2825 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2828 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2829 addReplyBulkLen(c
,obj
);
2831 addReply(c
,shared
.crlf
);
2834 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2835 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2837 addReply(c
,shared
.nullbulk
);
2839 robj
*o
= createStringObject(s
,strlen(s
));
2845 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2850 REDIS_NOTUSED(mask
);
2851 REDIS_NOTUSED(privdata
);
2853 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2854 if (cfd
== AE_ERR
) {
2855 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2858 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2859 if ((c
= createClient(cfd
)) == NULL
) {
2860 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2861 close(cfd
); /* May be already closed, just ingore errors */
2864 /* If maxclient directive is set and this is one client more... close the
2865 * connection. Note that we create the client instead to check before
2866 * for this condition, since now the socket is already set in nonblocking
2867 * mode and we can send an error for free using the Kernel I/O */
2868 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2869 char *err
= "-ERR max number of clients reached\r\n";
2871 /* That's a best effort error message, don't check write errors */
2872 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2873 /* Nothing to do, Just to avoid the warning... */
2878 server
.stat_numconnections
++;
2881 /* ======================= Redis objects implementation ===================== */
2883 static robj
*createObject(int type
, void *ptr
) {
2886 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2887 if (listLength(server
.objfreelist
)) {
2888 listNode
*head
= listFirst(server
.objfreelist
);
2889 o
= listNodeValue(head
);
2890 listDelNode(server
.objfreelist
,head
);
2891 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2893 if (server
.vm_enabled
) {
2894 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2895 o
= zmalloc(sizeof(*o
));
2897 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2901 o
->encoding
= REDIS_ENCODING_RAW
;
2904 if (server
.vm_enabled
) {
2905 /* Note that this code may run in the context of an I/O thread
2906 * and accessing to server.unixtime in theory is an error
2907 * (no locks). But in practice this is safe, and even if we read
2908 * garbage Redis will not fail, as it's just a statistical info */
2909 o
->vm
.atime
= server
.unixtime
;
2910 o
->storage
= REDIS_VM_MEMORY
;
2915 static robj
*createStringObject(char *ptr
, size_t len
) {
2916 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2919 static robj
*createStringObjectFromLongLong(long long value
) {
2921 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2922 incrRefCount(shared
.integers
[value
]);
2923 o
= shared
.integers
[value
];
2925 o
= createObject(REDIS_STRING
, NULL
);
2926 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2927 o
->encoding
= REDIS_ENCODING_INT
;
2928 o
->ptr
= (void*)((long)value
);
2930 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
2936 static robj
*dupStringObject(robj
*o
) {
2937 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2938 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2941 static robj
*createListObject(void) {
2942 list
*l
= listCreate();
2944 listSetFreeMethod(l
,decrRefCount
);
2945 return createObject(REDIS_LIST
,l
);
2948 static robj
*createSetObject(void) {
2949 dict
*d
= dictCreate(&setDictType
,NULL
);
2950 return createObject(REDIS_SET
,d
);
2953 static robj
*createHashObject(void) {
2954 /* All the Hashes start as zipmaps. Will be automatically converted
2955 * into hash tables if there are enough elements or big elements
2957 unsigned char *zm
= zipmapNew();
2958 robj
*o
= createObject(REDIS_HASH
,zm
);
2959 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2963 static robj
*createZsetObject(void) {
2964 zset
*zs
= zmalloc(sizeof(*zs
));
2966 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2967 zs
->zsl
= zslCreate();
2968 return createObject(REDIS_ZSET
,zs
);
2971 static void freeStringObject(robj
*o
) {
2972 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2977 static void freeListObject(robj
*o
) {
2978 listRelease((list
*) o
->ptr
);
2981 static void freeSetObject(robj
*o
) {
2982 dictRelease((dict
*) o
->ptr
);
2985 static void freeZsetObject(robj
*o
) {
2988 dictRelease(zs
->dict
);
2993 static void freeHashObject(robj
*o
) {
2994 switch (o
->encoding
) {
2995 case REDIS_ENCODING_HT
:
2996 dictRelease((dict
*) o
->ptr
);
2998 case REDIS_ENCODING_ZIPMAP
:
3002 redisPanic("Unknown hash encoding type");
3007 static void incrRefCount(robj
*o
) {
3011 static void decrRefCount(void *obj
) {
3014 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3015 /* Object is a key of a swapped out value, or in the process of being
3017 if (server
.vm_enabled
&&
3018 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3020 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3021 redisAssert(o
->type
== REDIS_STRING
);
3022 freeStringObject(o
);
3023 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3024 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3025 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3026 !listAddNodeHead(server
.objfreelist
,o
))
3028 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3029 server
.vm_stats_swapped_objects
--;
3032 /* Object is in memory, or in the process of being swapped out. */
3033 if (--(o
->refcount
) == 0) {
3034 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3035 vmCancelThreadedIOJob(obj
);
3037 case REDIS_STRING
: freeStringObject(o
); break;
3038 case REDIS_LIST
: freeListObject(o
); break;
3039 case REDIS_SET
: freeSetObject(o
); break;
3040 case REDIS_ZSET
: freeZsetObject(o
); break;
3041 case REDIS_HASH
: freeHashObject(o
); break;
3042 default: redisPanic("Unknown object type"); break;
3044 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3045 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3046 !listAddNodeHead(server
.objfreelist
,o
))
3048 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3052 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3053 dictEntry
*de
= dictFind(db
->dict
,key
);
3055 robj
*key
= dictGetEntryKey(de
);
3056 robj
*val
= dictGetEntryVal(de
);
3058 if (server
.vm_enabled
) {
3059 if (key
->storage
== REDIS_VM_MEMORY
||
3060 key
->storage
== REDIS_VM_SWAPPING
)
3062 /* If we were swapping the object out, stop it, this key
3064 if (key
->storage
== REDIS_VM_SWAPPING
)
3065 vmCancelThreadedIOJob(key
);
3066 /* Update the access time of the key for the aging algorithm. */
3067 key
->vm
.atime
= server
.unixtime
;
3069 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3071 /* Our value was swapped on disk. Bring it at home. */
3072 redisAssert(val
== NULL
);
3073 val
= vmLoadObject(key
);
3074 dictGetEntryVal(de
) = val
;
3076 /* Clients blocked by the VM subsystem may be waiting for
3078 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3087 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3088 expireIfNeeded(db
,key
);
3089 return lookupKey(db
,key
);
3092 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3093 deleteIfVolatile(db
,key
);
3094 return lookupKey(db
,key
);
3097 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3098 robj
*o
= lookupKeyRead(c
->db
, key
);
3099 if (!o
) addReply(c
,reply
);
3103 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3104 robj
*o
= lookupKeyWrite(c
->db
, key
);
3105 if (!o
) addReply(c
,reply
);
3109 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3110 if (o
->type
!= type
) {
3111 addReply(c
,shared
.wrongtypeerr
);
3117 static int deleteKey(redisDb
*db
, robj
*key
) {
3120 /* We need to protect key from destruction: after the first dictDelete()
3121 * it may happen that 'key' is no longer valid if we don't increment
3122 * it's count. This may happen when we get the object reference directly
3123 * from the hash table with dictRandomKey() or dict iterators */
3125 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3126 retval
= dictDelete(db
->dict
,key
);
3129 return retval
== DICT_OK
;
3132 /* Check if the nul-terminated string 's' can be represented by a long
3133 * (that is, is a number that fits into long without any other space or
3134 * character before or after the digits).
3136 * If so, the function returns REDIS_OK and *longval is set to the value
3137 * of the number. Otherwise REDIS_ERR is returned */
3138 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3139 char buf
[32], *endptr
;
3143 value
= strtol(s
, &endptr
, 10);
3144 if (endptr
[0] != '\0') return REDIS_ERR
;
3145 slen
= ll2string(buf
,32,value
);
3147 /* If the number converted back into a string is not identical
3148 * then it's not possible to encode the string as integer */
3149 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3150 if (longval
) *longval
= value
;
3154 /* Try to encode a string object in order to save space */
3155 static robj
*tryObjectEncoding(robj
*o
) {
3159 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3160 return o
; /* Already encoded */
3162 /* It's not safe to encode shared objects: shared objects can be shared
3163 * everywhere in the "object space" of Redis. Encoded objects can only
3164 * appear as "values" (and not, for instance, as keys) */
3165 if (o
->refcount
> 1) return o
;
3167 /* Currently we try to encode only strings */
3168 redisAssert(o
->type
== REDIS_STRING
);
3170 /* Check if we can represent this string as a long integer */
3171 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3173 /* Ok, this object can be encoded */
3174 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3176 incrRefCount(shared
.integers
[value
]);
3177 return shared
.integers
[value
];
3179 o
->encoding
= REDIS_ENCODING_INT
;
3181 o
->ptr
= (void*) value
;
3186 /* Get a decoded version of an encoded object (returned as a new object).
3187 * If the object is already raw-encoded just increment the ref count. */
3188 static robj
*getDecodedObject(robj
*o
) {
3191 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3195 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3198 ll2string(buf
,32,(long)o
->ptr
);
3199 dec
= createStringObject(buf
,strlen(buf
));
3202 redisPanic("Unknown encoding type");
3206 /* Compare two string objects via strcmp() or alike.
3207 * Note that the objects may be integer-encoded. In such a case we
3208 * use ll2string() to get a string representation of the numbers on the stack
3209 * and compare the strings, it's much faster than calling getDecodedObject().
3211 * Important note: if objects are not integer encoded, but binary-safe strings,
3212 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3214 static int compareStringObjects(robj
*a
, robj
*b
) {
3215 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3216 char bufa
[128], bufb
[128], *astr
, *bstr
;
3219 if (a
== b
) return 0;
3220 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3221 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3227 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3228 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3234 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3237 /* Equal string objects return 1 if the two objects are the same from the
3238 * point of view of a string comparison, otherwise 0 is returned. Note that
3239 * this function is faster then checking for (compareStringObject(a,b) == 0)
3240 * because it can perform some more optimization. */
3241 static int equalStringObjects(robj
*a
, robj
*b
) {
3242 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3243 return a
->ptr
== b
->ptr
;
3245 return compareStringObjects(a
,b
) == 0;
3249 static size_t stringObjectLen(robj
*o
) {
3250 redisAssert(o
->type
== REDIS_STRING
);
3251 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3252 return sdslen(o
->ptr
);
3256 return ll2string(buf
,32,(long)o
->ptr
);
3260 static int getDoubleFromObject(robj
*o
, double *target
) {
3267 redisAssert(o
->type
== REDIS_STRING
);
3268 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3269 value
= strtod(o
->ptr
, &eptr
);
3270 if (eptr
[0] != '\0') return REDIS_ERR
;
3271 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3272 value
= (long)o
->ptr
;
3274 redisPanic("Unknown string encoding");
3282 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3284 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3286 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3288 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3297 static int getLongLongFromObject(robj
*o
, long long *target
) {
3304 redisAssert(o
->type
== REDIS_STRING
);
3305 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3306 value
= strtoll(o
->ptr
, &eptr
, 10);
3307 if (eptr
[0] != '\0') return REDIS_ERR
;
3308 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3309 value
= (long)o
->ptr
;
3311 redisPanic("Unknown string encoding");
3319 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3321 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3323 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3325 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3334 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3337 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3338 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3340 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3342 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3351 /*============================ RDB saving/loading =========================== */
3353 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3354 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3358 static int rdbSaveTime(FILE *fp
, time_t t
) {
3359 int32_t t32
= (int32_t) t
;
3360 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3364 /* check rdbLoadLen() comments for more info */
3365 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3366 unsigned char buf
[2];
3369 /* Save a 6 bit len */
3370 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3371 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3372 } else if (len
< (1<<14)) {
3373 /* Save a 14 bit len */
3374 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3376 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3378 /* Save a 32 bit len */
3379 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3380 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3382 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3387 /* Encode 'value' as an integer if possible (if integer will fit the
3388 * supported range). If the function sucessful encoded the integer
3389 * then the (up to 5 bytes) encoded representation is written in the
3390 * string pointed by 'enc' and the length is returned. Otherwise
3392 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3393 /* Finally check if it fits in our ranges */
3394 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3395 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3396 enc
[1] = value
&0xFF;
3398 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3399 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3400 enc
[1] = value
&0xFF;
3401 enc
[2] = (value
>>8)&0xFF;
3403 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3404 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3405 enc
[1] = value
&0xFF;
3406 enc
[2] = (value
>>8)&0xFF;
3407 enc
[3] = (value
>>16)&0xFF;
3408 enc
[4] = (value
>>24)&0xFF;
3415 /* String objects in the form "2391" "-100" without any space and with a
3416 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3417 * encoded as integers to save space */
3418 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3420 char *endptr
, buf
[32];
3422 /* Check if it's possible to encode this value as a number */
3423 value
= strtoll(s
, &endptr
, 10);
3424 if (endptr
[0] != '\0') return 0;
3425 ll2string(buf
,32,value
);
3427 /* If the number converted back into a string is not identical
3428 * then it's not possible to encode the string as integer */
3429 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3431 return rdbEncodeInteger(value
,enc
);
3434 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3435 size_t comprlen
, outlen
;
3439 /* We require at least four bytes compression for this to be worth it */
3440 if (len
<= 4) return 0;
3442 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3443 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3444 if (comprlen
== 0) {
3448 /* Data compressed! Let's save it on disk */
3449 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3450 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3451 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3452 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3453 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3462 /* Save a string objet as [len][data] on disk. If the object is a string
3463 * representation of an integer value we try to safe it in a special form */
3464 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3467 /* Try integer encoding */
3469 unsigned char buf
[5];
3470 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3471 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3476 /* Try LZF compression - under 20 bytes it's unable to compress even
3477 * aaaaaaaaaaaaaaaaaa so skip it */
3478 if (server
.rdbcompression
&& len
> 20) {
3481 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3482 if (retval
== -1) return -1;
3483 if (retval
> 0) return 0;
3484 /* retval == 0 means data can't be compressed, save the old way */
3487 /* Store verbatim */
3488 if (rdbSaveLen(fp
,len
) == -1) return -1;
3489 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3493 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3494 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3497 /* Avoid to decode the object, then encode it again, if the
3498 * object is alrady integer encoded. */
3499 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3500 long val
= (long) obj
->ptr
;
3501 unsigned char buf
[5];
3504 if ((enclen
= rdbEncodeInteger(val
,buf
)) > 0) {
3505 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3508 /* otherwise... fall throught and continue with the usual
3512 /* Avoid incr/decr ref count business when possible.
3513 * This plays well with copy-on-write given that we are probably
3514 * in a child process (BGSAVE). Also this makes sure key objects
3515 * of swapped objects are not incRefCount-ed (an assert does not allow
3516 * this in order to avoid bugs) */
3517 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3518 obj
= getDecodedObject(obj
);
3519 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3522 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3527 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3528 * 8 bit integer specifing the length of the representation.
3529 * This 8 bit integer has special values in order to specify the following
3535 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3536 unsigned char buf
[128];
3542 } else if (!isfinite(val
)) {
3544 buf
[0] = (val
< 0) ? 255 : 254;
3546 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3547 /* Check if the float is in a safe range to be casted into a
3548 * long long. We are assuming that long long is 64 bit here.
3549 * Also we are assuming that there are no implementations around where
3550 * double has precision < 52 bit.
3552 * Under this assumptions we test if a double is inside an interval
3553 * where casting to long long is safe. Then using two castings we
3554 * make sure the decimal part is zero. If all this is true we use
3555 * integer printing function that is much faster. */
3556 double min
= -4503599627370495; /* (2^52)-1 */
3557 double max
= 4503599627370496; /* -(2^52) */
3558 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3559 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3562 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3563 buf
[0] = strlen((char*)buf
+1);
3566 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3570 /* Save a Redis object. */
3571 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3572 if (o
->type
== REDIS_STRING
) {
3573 /* Save a string value */
3574 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3575 } else if (o
->type
== REDIS_LIST
) {
3576 /* Save a list value */
3577 list
*list
= o
->ptr
;
3581 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3582 listRewind(list
,&li
);
3583 while((ln
= listNext(&li
))) {
3584 robj
*eleobj
= listNodeValue(ln
);
3586 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3588 } else if (o
->type
== REDIS_SET
) {
3589 /* Save a set value */
3591 dictIterator
*di
= dictGetIterator(set
);
3594 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3595 while((de
= dictNext(di
)) != NULL
) {
3596 robj
*eleobj
= dictGetEntryKey(de
);
3598 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3600 dictReleaseIterator(di
);
3601 } else if (o
->type
== REDIS_ZSET
) {
3602 /* Save a set value */
3604 dictIterator
*di
= dictGetIterator(zs
->dict
);
3607 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3608 while((de
= dictNext(di
)) != NULL
) {
3609 robj
*eleobj
= dictGetEntryKey(de
);
3610 double *score
= dictGetEntryVal(de
);
3612 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3613 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3615 dictReleaseIterator(di
);
3616 } else if (o
->type
== REDIS_HASH
) {
3617 /* Save a hash value */
3618 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3619 unsigned char *p
= zipmapRewind(o
->ptr
);
3620 unsigned int count
= zipmapLen(o
->ptr
);
3621 unsigned char *key
, *val
;
3622 unsigned int klen
, vlen
;
3624 if (rdbSaveLen(fp
,count
) == -1) return -1;
3625 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3626 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3627 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3630 dictIterator
*di
= dictGetIterator(o
->ptr
);
3633 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3634 while((de
= dictNext(di
)) != NULL
) {
3635 robj
*key
= dictGetEntryKey(de
);
3636 robj
*val
= dictGetEntryVal(de
);
3638 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3639 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3641 dictReleaseIterator(di
);
3644 redisPanic("Unknown object type");
3649 /* Return the length the object will have on disk if saved with
3650 * the rdbSaveObject() function. Currently we use a trick to get
3651 * this length with very little changes to the code. In the future
3652 * we could switch to a faster solution. */
3653 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3654 if (fp
== NULL
) fp
= server
.devnull
;
3656 assert(rdbSaveObject(fp
,o
) != 1);
3660 /* Return the number of pages required to save this object in the swap file */
3661 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3662 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3664 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3667 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3668 static int rdbSave(char *filename
) {
3669 dictIterator
*di
= NULL
;
3674 time_t now
= time(NULL
);
3676 /* Wait for I/O therads to terminate, just in case this is a
3677 * foreground-saving, to avoid seeking the swap file descriptor at the
3679 if (server
.vm_enabled
)
3680 waitEmptyIOJobsQueue();
3682 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3683 fp
= fopen(tmpfile
,"w");
3685 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3688 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3689 for (j
= 0; j
< server
.dbnum
; j
++) {
3690 redisDb
*db
= server
.db
+j
;
3692 if (dictSize(d
) == 0) continue;
3693 di
= dictGetIterator(d
);
3699 /* Write the SELECT DB opcode */
3700 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3701 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3703 /* Iterate this DB writing every entry */
3704 while((de
= dictNext(di
)) != NULL
) {
3705 robj
*key
= dictGetEntryKey(de
);
3706 robj
*o
= dictGetEntryVal(de
);
3707 time_t expiretime
= getExpire(db
,key
);
3709 /* Save the expire time */
3710 if (expiretime
!= -1) {
3711 /* If this key is already expired skip it */
3712 if (expiretime
< now
) continue;
3713 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3714 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3716 /* Save the key and associated value. This requires special
3717 * handling if the value is swapped out. */
3718 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3719 key
->storage
== REDIS_VM_SWAPPING
) {
3720 /* Save type, key, value */
3721 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3722 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3723 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3725 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3727 /* Get a preview of the object in memory */
3728 po
= vmPreviewObject(key
);
3729 /* Save type, key, value */
3730 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3731 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3732 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3733 /* Remove the loaded object from memory */
3737 dictReleaseIterator(di
);
3740 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3742 /* Make sure data will not remain on the OS's output buffers */
3747 /* Use RENAME to make sure the DB file is changed atomically only
3748 * if the generate DB file is ok. */
3749 if (rename(tmpfile
,filename
) == -1) {
3750 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3754 redisLog(REDIS_NOTICE
,"DB saved on disk");
3756 server
.lastsave
= time(NULL
);
3762 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3763 if (di
) dictReleaseIterator(di
);
3767 static int rdbSaveBackground(char *filename
) {
3770 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3771 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3772 if ((childpid
= fork()) == 0) {
3774 if (server
.vm_enabled
) vmReopenSwapFile();
3776 if (rdbSave(filename
) == REDIS_OK
) {
3783 if (childpid
== -1) {
3784 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3788 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3789 server
.bgsavechildpid
= childpid
;
3790 updateDictResizePolicy();
3793 return REDIS_OK
; /* unreached */
3796 static void rdbRemoveTempFile(pid_t childpid
) {
3799 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3803 static int rdbLoadType(FILE *fp
) {
3805 if (fread(&type
,1,1,fp
) == 0) return -1;
3809 static time_t rdbLoadTime(FILE *fp
) {
3811 if (fread(&t32
,4,1,fp
) == 0) return -1;
3812 return (time_t) t32
;
3815 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3816 * of this file for a description of how this are stored on disk.
3818 * isencoded is set to 1 if the readed length is not actually a length but
3819 * an "encoding type", check the above comments for more info */
3820 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3821 unsigned char buf
[2];
3825 if (isencoded
) *isencoded
= 0;
3826 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3827 type
= (buf
[0]&0xC0)>>6;
3828 if (type
== REDIS_RDB_6BITLEN
) {
3829 /* Read a 6 bit len */
3831 } else if (type
== REDIS_RDB_ENCVAL
) {
3832 /* Read a 6 bit len encoding type */
3833 if (isencoded
) *isencoded
= 1;
3835 } else if (type
== REDIS_RDB_14BITLEN
) {
3836 /* Read a 14 bit len */
3837 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3838 return ((buf
[0]&0x3F)<<8)|buf
[1];
3840 /* Read a 32 bit len */
3841 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3846 /* Load an integer-encoded object from file 'fp', with the specified
3847 * encoding type 'enctype'. If encode is true the function may return
3848 * an integer-encoded object as reply, otherwise the returned object
3849 * will always be encoded as a raw string. */
3850 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3851 unsigned char enc
[4];
3854 if (enctype
== REDIS_RDB_ENC_INT8
) {
3855 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3856 val
= (signed char)enc
[0];
3857 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3859 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3860 v
= enc
[0]|(enc
[1]<<8);
3862 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3864 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3865 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3868 val
= 0; /* anti-warning */
3869 redisPanic("Unknown RDB integer encoding type");
3872 return createStringObjectFromLongLong(val
);
3874 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3877 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3878 unsigned int len
, clen
;
3879 unsigned char *c
= NULL
;
3882 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3883 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3884 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3885 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3886 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3887 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3889 return createObject(REDIS_STRING
,val
);
3896 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3901 len
= rdbLoadLen(fp
,&isencoded
);
3904 case REDIS_RDB_ENC_INT8
:
3905 case REDIS_RDB_ENC_INT16
:
3906 case REDIS_RDB_ENC_INT32
:
3907 return rdbLoadIntegerObject(fp
,len
,encode
);
3908 case REDIS_RDB_ENC_LZF
:
3909 return rdbLoadLzfStringObject(fp
);
3911 redisPanic("Unknown RDB encoding type");
3915 if (len
== REDIS_RDB_LENERR
) return NULL
;
3916 val
= sdsnewlen(NULL
,len
);
3917 if (len
&& fread(val
,len
,1,fp
) == 0) {
3921 return createObject(REDIS_STRING
,val
);
3924 static robj
*rdbLoadStringObject(FILE *fp
) {
3925 return rdbGenericLoadStringObject(fp
,0);
3928 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3929 return rdbGenericLoadStringObject(fp
,1);
3932 /* For information about double serialization check rdbSaveDoubleValue() */
3933 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3937 if (fread(&len
,1,1,fp
) == 0) return -1;
3939 case 255: *val
= R_NegInf
; return 0;
3940 case 254: *val
= R_PosInf
; return 0;
3941 case 253: *val
= R_Nan
; return 0;
3943 if (fread(buf
,len
,1,fp
) == 0) return -1;
3945 sscanf(buf
, "%lg", val
);
3950 /* Load a Redis object of the specified type from the specified file.
3951 * On success a newly allocated object is returned, otherwise NULL. */
3952 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3955 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3956 if (type
== REDIS_STRING
) {
3957 /* Read string value */
3958 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3959 o
= tryObjectEncoding(o
);
3960 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3961 /* Read list/set value */
3964 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3965 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3966 /* It's faster to expand the dict to the right size asap in order
3967 * to avoid rehashing */
3968 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3969 dictExpand(o
->ptr
,listlen
);
3970 /* Load every single element of the list/set */
3974 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3975 ele
= tryObjectEncoding(ele
);
3976 if (type
== REDIS_LIST
) {
3977 listAddNodeTail((list
*)o
->ptr
,ele
);
3979 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3982 } else if (type
== REDIS_ZSET
) {
3983 /* Read list/set value */
3987 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3988 o
= createZsetObject();
3990 /* Load every single element of the list/set */
3993 double *score
= zmalloc(sizeof(double));
3995 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3996 ele
= tryObjectEncoding(ele
);
3997 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3998 dictAdd(zs
->dict
,ele
,score
);
3999 zslInsert(zs
->zsl
,*score
,ele
);
4000 incrRefCount(ele
); /* added to skiplist */
4002 } else if (type
== REDIS_HASH
) {
4005 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4006 o
= createHashObject();
4007 /* Too many entries? Use an hash table. */
4008 if (hashlen
> server
.hash_max_zipmap_entries
)
4009 convertToRealHash(o
);
4010 /* Load every key/value, then set it into the zipmap or hash
4011 * table, as needed. */
4015 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4016 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4017 /* If we are using a zipmap and there are too big values
4018 * the object is converted to real hash table encoding. */
4019 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4020 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
4021 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
4023 convertToRealHash(o
);
4026 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
4027 unsigned char *zm
= o
->ptr
;
4029 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4030 val
->ptr
,sdslen(val
->ptr
),NULL
);
4035 key
= tryObjectEncoding(key
);
4036 val
= tryObjectEncoding(val
);
4037 dictAdd((dict
*)o
->ptr
,key
,val
);
4041 redisPanic("Unknown object type");
4046 static int rdbLoad(char *filename
) {
4049 int type
, retval
, rdbver
;
4050 int swap_all_values
= 0;
4051 dict
*d
= server
.db
[0].dict
;
4052 redisDb
*db
= server
.db
+0;
4054 time_t expiretime
, now
= time(NULL
);
4055 long long loadedkeys
= 0;
4057 fp
= fopen(filename
,"r");
4058 if (!fp
) return REDIS_ERR
;
4059 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4061 if (memcmp(buf
,"REDIS",5) != 0) {
4063 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4066 rdbver
= atoi(buf
+5);
4069 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4077 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4078 if (type
== REDIS_EXPIRETIME
) {
4079 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4080 /* We read the time so we need to read the object type again */
4081 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4083 if (type
== REDIS_EOF
) break;
4084 /* Handle SELECT DB opcode as a special case */
4085 if (type
== REDIS_SELECTDB
) {
4086 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4088 if (dbid
>= (unsigned)server
.dbnum
) {
4089 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4092 db
= server
.db
+dbid
;
4097 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4099 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4100 /* Check if the key already expired */
4101 if (expiretime
!= -1 && expiretime
< now
) {
4106 /* Add the new object in the hash table */
4107 retval
= dictAdd(d
,key
,val
);
4108 if (retval
== DICT_ERR
) {
4109 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4113 /* Set the expire time if needed */
4114 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4116 /* Handle swapping while loading big datasets when VM is on */
4118 /* If we detecter we are hopeless about fitting something in memory
4119 * we just swap every new key on disk. Directly...
4120 * Note that's important to check for this condition before resorting
4121 * to random sampling, otherwise we may try to swap already
4123 if (swap_all_values
) {
4124 dictEntry
*de
= dictFind(d
,key
);
4126 /* de may be NULL since the key already expired */
4128 key
= dictGetEntryKey(de
);
4129 val
= dictGetEntryVal(de
);
4131 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4132 dictGetEntryVal(de
) = NULL
;
4138 /* If we have still some hope of having some value fitting memory
4139 * then we try random sampling. */
4140 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4141 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4142 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4144 if (zmalloc_used_memory() > server
.vm_max_memory
)
4145 swap_all_values
= 1; /* We are already using too much mem */
4151 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4152 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4154 return REDIS_ERR
; /* Just to avoid warning */
4157 /*================================== Commands =============================== */
4159 static void authCommand(redisClient
*c
) {
4160 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4161 c
->authenticated
= 1;
4162 addReply(c
,shared
.ok
);
4164 c
->authenticated
= 0;
4165 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4169 static void pingCommand(redisClient
*c
) {
4170 addReply(c
,shared
.pong
);
4173 static void echoCommand(redisClient
*c
) {
4174 addReplyBulk(c
,c
->argv
[1]);
4177 /*=================================== Strings =============================== */
4179 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4181 long seconds
= 0; /* initialized to avoid an harmness warning */
4184 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4187 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4192 if (nx
) deleteIfVolatile(c
->db
,key
);
4193 retval
= dictAdd(c
->db
->dict
,key
,val
);
4194 if (retval
== DICT_ERR
) {
4196 /* If the key is about a swapped value, we want a new key object
4197 * to overwrite the old. So we delete the old key in the database.
4198 * This will also make sure that swap pages about the old object
4199 * will be marked as free. */
4200 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4202 dictReplace(c
->db
->dict
,key
,val
);
4205 addReply(c
,shared
.czero
);
4213 removeExpire(c
->db
,key
);
4214 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4215 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4218 static void setCommand(redisClient
*c
) {
4219 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4222 static void setnxCommand(redisClient
*c
) {
4223 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4226 static void setexCommand(redisClient
*c
) {
4227 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4230 static int getGenericCommand(redisClient
*c
) {
4233 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4236 if (o
->type
!= REDIS_STRING
) {
4237 addReply(c
,shared
.wrongtypeerr
);
4245 static void getCommand(redisClient
*c
) {
4246 getGenericCommand(c
);
4249 static void getsetCommand(redisClient
*c
) {
4250 if (getGenericCommand(c
) == REDIS_ERR
) return;
4251 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4252 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4254 incrRefCount(c
->argv
[1]);
4256 incrRefCount(c
->argv
[2]);
4258 removeExpire(c
->db
,c
->argv
[1]);
4261 static void mgetCommand(redisClient
*c
) {
4264 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4265 for (j
= 1; j
< c
->argc
; j
++) {
4266 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4268 addReply(c
,shared
.nullbulk
);
4270 if (o
->type
!= REDIS_STRING
) {
4271 addReply(c
,shared
.nullbulk
);
4279 static void msetGenericCommand(redisClient
*c
, int nx
) {
4280 int j
, busykeys
= 0;
4282 if ((c
->argc
% 2) == 0) {
4283 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4286 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4287 * set nothing at all if at least one already key exists. */
4289 for (j
= 1; j
< c
->argc
; j
+= 2) {
4290 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4296 addReply(c
, shared
.czero
);
4300 for (j
= 1; j
< c
->argc
; j
+= 2) {
4303 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4304 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4305 if (retval
== DICT_ERR
) {
4306 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4307 incrRefCount(c
->argv
[j
+1]);
4309 incrRefCount(c
->argv
[j
]);
4310 incrRefCount(c
->argv
[j
+1]);
4312 removeExpire(c
->db
,c
->argv
[j
]);
4314 server
.dirty
+= (c
->argc
-1)/2;
4315 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4318 static void msetCommand(redisClient
*c
) {
4319 msetGenericCommand(c
,0);
4322 static void msetnxCommand(redisClient
*c
) {
4323 msetGenericCommand(c
,1);
4326 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4331 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4332 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4333 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4336 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4337 o
= tryObjectEncoding(o
);
4338 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4339 if (retval
== DICT_ERR
) {
4340 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4341 removeExpire(c
->db
,c
->argv
[1]);
4343 incrRefCount(c
->argv
[1]);
4346 addReply(c
,shared
.colon
);
4348 addReply(c
,shared
.crlf
);
4351 static void incrCommand(redisClient
*c
) {
4352 incrDecrCommand(c
,1);
4355 static void decrCommand(redisClient
*c
) {
4356 incrDecrCommand(c
,-1);
4359 static void incrbyCommand(redisClient
*c
) {
4362 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4363 incrDecrCommand(c
,incr
);
4366 static void decrbyCommand(redisClient
*c
) {
4369 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4370 incrDecrCommand(c
,-incr
);
4373 static void appendCommand(redisClient
*c
) {
4378 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4380 /* Create the key */
4381 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4382 incrRefCount(c
->argv
[1]);
4383 incrRefCount(c
->argv
[2]);
4384 totlen
= stringObjectLen(c
->argv
[2]);
4388 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4391 o
= dictGetEntryVal(de
);
4392 if (o
->type
!= REDIS_STRING
) {
4393 addReply(c
,shared
.wrongtypeerr
);
4396 /* If the object is specially encoded or shared we have to make
4398 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4399 robj
*decoded
= getDecodedObject(o
);
4401 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4402 decrRefCount(decoded
);
4403 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4406 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4407 o
->ptr
= sdscatlen(o
->ptr
,
4408 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4410 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4411 (unsigned long) c
->argv
[2]->ptr
);
4413 totlen
= sdslen(o
->ptr
);
4416 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4419 static void substrCommand(redisClient
*c
) {
4421 long start
= atoi(c
->argv
[2]->ptr
);
4422 long end
= atoi(c
->argv
[3]->ptr
);
4423 size_t rangelen
, strlen
;
4426 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4427 checkType(c
,o
,REDIS_STRING
)) return;
4429 o
= getDecodedObject(o
);
4430 strlen
= sdslen(o
->ptr
);
4432 /* convert negative indexes */
4433 if (start
< 0) start
= strlen
+start
;
4434 if (end
< 0) end
= strlen
+end
;
4435 if (start
< 0) start
= 0;
4436 if (end
< 0) end
= 0;
4438 /* indexes sanity checks */
4439 if (start
> end
|| (size_t)start
>= strlen
) {
4440 /* Out of range start or start > end result in null reply */
4441 addReply(c
,shared
.nullbulk
);
4445 if ((size_t)end
>= strlen
) end
= strlen
-1;
4446 rangelen
= (end
-start
)+1;
4448 /* Return the result */
4449 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4450 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4451 addReplySds(c
,range
);
4452 addReply(c
,shared
.crlf
);
4456 /* ========================= Type agnostic commands ========================= */
4458 static void delCommand(redisClient
*c
) {
4461 for (j
= 1; j
< c
->argc
; j
++) {
4462 if (deleteKey(c
->db
,c
->argv
[j
])) {
4467 addReplyLong(c
,deleted
);
4470 static void existsCommand(redisClient
*c
) {
4471 expireIfNeeded(c
->db
,c
->argv
[1]);
4472 if (dictFind(c
->db
->dict
,c
->argv
[1])) {
4473 addReply(c
, shared
.cone
);
4475 addReply(c
, shared
.czero
);
4479 static void selectCommand(redisClient
*c
) {
4480 int id
= atoi(c
->argv
[1]->ptr
);
4482 if (selectDb(c
,id
) == REDIS_ERR
) {
4483 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4485 addReply(c
,shared
.ok
);
4489 static void randomkeyCommand(redisClient
*c
) {
4494 de
= dictGetRandomKey(c
->db
->dict
);
4495 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4499 addReply(c
,shared
.nullbulk
);
4503 key
= dictGetEntryKey(de
);
4504 if (server
.vm_enabled
) {
4505 key
= dupStringObject(key
);
4506 addReplyBulk(c
,key
);
4509 addReplyBulk(c
,key
);
4513 static void keysCommand(redisClient
*c
) {
4516 sds pattern
= c
->argv
[1]->ptr
;
4517 int plen
= sdslen(pattern
);
4518 unsigned long numkeys
= 0;
4519 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4521 di
= dictGetIterator(c
->db
->dict
);
4523 decrRefCount(lenobj
);
4524 while((de
= dictNext(di
)) != NULL
) {
4525 robj
*keyobj
= dictGetEntryKey(de
);
4527 sds key
= keyobj
->ptr
;
4528 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4529 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4530 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4531 addReplyBulk(c
,keyobj
);
4536 dictReleaseIterator(di
);
4537 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4540 static void dbsizeCommand(redisClient
*c
) {
4542 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4545 static void lastsaveCommand(redisClient
*c
) {
4547 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4550 static void typeCommand(redisClient
*c
) {
4554 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4559 case REDIS_STRING
: type
= "+string"; break;
4560 case REDIS_LIST
: type
= "+list"; break;
4561 case REDIS_SET
: type
= "+set"; break;
4562 case REDIS_ZSET
: type
= "+zset"; break;
4563 case REDIS_HASH
: type
= "+hash"; break;
4564 default: type
= "+unknown"; break;
4567 addReplySds(c
,sdsnew(type
));
4568 addReply(c
,shared
.crlf
);
4571 static void saveCommand(redisClient
*c
) {
4572 if (server
.bgsavechildpid
!= -1) {
4573 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4576 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4577 addReply(c
,shared
.ok
);
4579 addReply(c
,shared
.err
);
4583 static void bgsaveCommand(redisClient
*c
) {
4584 if (server
.bgsavechildpid
!= -1) {
4585 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4588 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4589 char *status
= "+Background saving started\r\n";
4590 addReplySds(c
,sdsnew(status
));
4592 addReply(c
,shared
.err
);
4596 static void shutdownCommand(redisClient
*c
) {
4597 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4598 /* Kill the saving child if there is a background saving in progress.
4599 We want to avoid race conditions, for instance our saving child may
4600 overwrite the synchronous saving did by SHUTDOWN. */
4601 if (server
.bgsavechildpid
!= -1) {
4602 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4603 kill(server
.bgsavechildpid
,SIGKILL
);
4604 rdbRemoveTempFile(server
.bgsavechildpid
);
4606 if (server
.appendonly
) {
4607 /* Append only file: fsync() the AOF and exit */
4608 fsync(server
.appendfd
);
4609 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4612 /* Snapshotting. Perform a SYNC SAVE and exit */
4613 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4614 if (server
.daemonize
)
4615 unlink(server
.pidfile
);
4616 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4617 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4620 /* Ooops.. error saving! The best we can do is to continue
4621 * operating. Note that if there was a background saving process,
4622 * in the next cron() Redis will be notified that the background
4623 * saving aborted, handling special stuff like slaves pending for
4624 * synchronization... */
4625 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4627 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4632 static void renameGenericCommand(redisClient
*c
, int nx
) {
4635 /* To use the same key as src and dst is probably an error */
4636 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4637 addReply(c
,shared
.sameobjecterr
);
4641 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4645 deleteIfVolatile(c
->db
,c
->argv
[2]);
4646 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4649 addReply(c
,shared
.czero
);
4652 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4654 incrRefCount(c
->argv
[2]);
4656 deleteKey(c
->db
,c
->argv
[1]);
4658 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4661 static void renameCommand(redisClient
*c
) {
4662 renameGenericCommand(c
,0);
4665 static void renamenxCommand(redisClient
*c
) {
4666 renameGenericCommand(c
,1);
4669 static void moveCommand(redisClient
*c
) {
4674 /* Obtain source and target DB pointers */
4677 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4678 addReply(c
,shared
.outofrangeerr
);
4682 selectDb(c
,srcid
); /* Back to the source DB */
4684 /* If the user is moving using as target the same
4685 * DB as the source DB it is probably an error. */
4687 addReply(c
,shared
.sameobjecterr
);
4691 /* Check if the element exists and get a reference */
4692 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4694 addReply(c
,shared
.czero
);
4698 /* Try to add the element to the target DB */
4699 deleteIfVolatile(dst
,c
->argv
[1]);
4700 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4701 addReply(c
,shared
.czero
);
4704 incrRefCount(c
->argv
[1]);
4707 /* OK! key moved, free the entry in the source DB */
4708 deleteKey(src
,c
->argv
[1]);
4710 addReply(c
,shared
.cone
);
4713 /* =================================== Lists ================================ */
4714 static void pushGenericCommand(redisClient
*c
, int where
) {
4718 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4720 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4721 addReply(c
,shared
.cone
);
4724 lobj
= createListObject();
4726 if (where
== REDIS_HEAD
) {
4727 listAddNodeHead(list
,c
->argv
[2]);
4729 listAddNodeTail(list
,c
->argv
[2]);
4731 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4732 incrRefCount(c
->argv
[1]);
4733 incrRefCount(c
->argv
[2]);
4735 if (lobj
->type
!= REDIS_LIST
) {
4736 addReply(c
,shared
.wrongtypeerr
);
4739 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4740 addReply(c
,shared
.cone
);
4744 if (where
== REDIS_HEAD
) {
4745 listAddNodeHead(list
,c
->argv
[2]);
4747 listAddNodeTail(list
,c
->argv
[2]);
4749 incrRefCount(c
->argv
[2]);
4752 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4755 static void lpushCommand(redisClient
*c
) {
4756 pushGenericCommand(c
,REDIS_HEAD
);
4759 static void rpushCommand(redisClient
*c
) {
4760 pushGenericCommand(c
,REDIS_TAIL
);
4763 static void llenCommand(redisClient
*c
) {
4767 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4768 checkType(c
,o
,REDIS_LIST
)) return;
4771 addReplyUlong(c
,listLength(l
));
4774 static void lindexCommand(redisClient
*c
) {
4776 int index
= atoi(c
->argv
[2]->ptr
);
4780 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4781 checkType(c
,o
,REDIS_LIST
)) return;
4784 ln
= listIndex(list
, index
);
4786 addReply(c
,shared
.nullbulk
);
4788 robj
*ele
= listNodeValue(ln
);
4789 addReplyBulk(c
,ele
);
4793 static void lsetCommand(redisClient
*c
) {
4795 int index
= atoi(c
->argv
[2]->ptr
);
4799 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4800 checkType(c
,o
,REDIS_LIST
)) return;
4803 ln
= listIndex(list
, index
);
4805 addReply(c
,shared
.outofrangeerr
);
4807 robj
*ele
= listNodeValue(ln
);
4810 listNodeValue(ln
) = c
->argv
[3];
4811 incrRefCount(c
->argv
[3]);
4812 addReply(c
,shared
.ok
);
4817 static void popGenericCommand(redisClient
*c
, int where
) {
4822 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4823 checkType(c
,o
,REDIS_LIST
)) return;
4826 if (where
== REDIS_HEAD
)
4827 ln
= listFirst(list
);
4829 ln
= listLast(list
);
4832 addReply(c
,shared
.nullbulk
);
4834 robj
*ele
= listNodeValue(ln
);
4835 addReplyBulk(c
,ele
);
4836 listDelNode(list
,ln
);
4837 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4842 static void lpopCommand(redisClient
*c
) {
4843 popGenericCommand(c
,REDIS_HEAD
);
4846 static void rpopCommand(redisClient
*c
) {
4847 popGenericCommand(c
,REDIS_TAIL
);
4850 static void lrangeCommand(redisClient
*c
) {
4852 int start
= atoi(c
->argv
[2]->ptr
);
4853 int end
= atoi(c
->argv
[3]->ptr
);
4860 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4861 || checkType(c
,o
,REDIS_LIST
)) return;
4863 llen
= listLength(list
);
4865 /* convert negative indexes */
4866 if (start
< 0) start
= llen
+start
;
4867 if (end
< 0) end
= llen
+end
;
4868 if (start
< 0) start
= 0;
4869 if (end
< 0) end
= 0;
4871 /* indexes sanity checks */
4872 if (start
> end
|| start
>= llen
) {
4873 /* Out of range start or start > end result in empty list */
4874 addReply(c
,shared
.emptymultibulk
);
4877 if (end
>= llen
) end
= llen
-1;
4878 rangelen
= (end
-start
)+1;
4880 /* Return the result in form of a multi-bulk reply */
4881 ln
= listIndex(list
, start
);
4882 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4883 for (j
= 0; j
< rangelen
; j
++) {
4884 ele
= listNodeValue(ln
);
4885 addReplyBulk(c
,ele
);
4890 static void ltrimCommand(redisClient
*c
) {
4892 int start
= atoi(c
->argv
[2]->ptr
);
4893 int end
= atoi(c
->argv
[3]->ptr
);
4895 int j
, ltrim
, rtrim
;
4899 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4900 checkType(c
,o
,REDIS_LIST
)) return;
4902 llen
= listLength(list
);
4904 /* convert negative indexes */
4905 if (start
< 0) start
= llen
+start
;
4906 if (end
< 0) end
= llen
+end
;
4907 if (start
< 0) start
= 0;
4908 if (end
< 0) end
= 0;
4910 /* indexes sanity checks */
4911 if (start
> end
|| start
>= llen
) {
4912 /* Out of range start or start > end result in empty list */
4916 if (end
>= llen
) end
= llen
-1;
4921 /* Remove list elements to perform the trim */
4922 for (j
= 0; j
< ltrim
; j
++) {
4923 ln
= listFirst(list
);
4924 listDelNode(list
,ln
);
4926 for (j
= 0; j
< rtrim
; j
++) {
4927 ln
= listLast(list
);
4928 listDelNode(list
,ln
);
4930 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4932 addReply(c
,shared
.ok
);
4935 static void lremCommand(redisClient
*c
) {
4938 listNode
*ln
, *next
;
4939 int toremove
= atoi(c
->argv
[2]->ptr
);
4943 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4944 checkType(c
,o
,REDIS_LIST
)) return;
4948 toremove
= -toremove
;
4951 ln
= fromtail
? list
->tail
: list
->head
;
4953 robj
*ele
= listNodeValue(ln
);
4955 next
= fromtail
? ln
->prev
: ln
->next
;
4956 if (equalStringObjects(ele
,c
->argv
[3])) {
4957 listDelNode(list
,ln
);
4960 if (toremove
&& removed
== toremove
) break;
4964 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4965 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4968 /* This is the semantic of this command:
4969 * RPOPLPUSH srclist dstlist:
4970 * IF LLEN(srclist) > 0
4971 * element = RPOP srclist
4972 * LPUSH dstlist element
4979 * The idea is to be able to get an element from a list in a reliable way
4980 * since the element is not just returned but pushed against another list
4981 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4983 static void rpoplpushcommand(redisClient
*c
) {
4988 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4989 checkType(c
,sobj
,REDIS_LIST
)) return;
4990 srclist
= sobj
->ptr
;
4991 ln
= listLast(srclist
);
4994 addReply(c
,shared
.nullbulk
);
4996 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4997 robj
*ele
= listNodeValue(ln
);
5000 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
5001 addReply(c
,shared
.wrongtypeerr
);
5005 /* Add the element to the target list (unless it's directly
5006 * passed to some BLPOP-ing client */
5007 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
5009 /* Create the list if the key does not exist */
5010 dobj
= createListObject();
5011 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
5012 incrRefCount(c
->argv
[2]);
5014 dstlist
= dobj
->ptr
;
5015 listAddNodeHead(dstlist
,ele
);
5019 /* Send the element to the client as reply as well */
5020 addReplyBulk(c
,ele
);
5022 /* Finally remove the element from the source list */
5023 listDelNode(srclist
,ln
);
5024 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5029 /* ==================================== Sets ================================ */
5031 static void saddCommand(redisClient
*c
) {
5034 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5036 set
= createSetObject();
5037 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5038 incrRefCount(c
->argv
[1]);
5040 if (set
->type
!= REDIS_SET
) {
5041 addReply(c
,shared
.wrongtypeerr
);
5045 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5046 incrRefCount(c
->argv
[2]);
5048 addReply(c
,shared
.cone
);
5050 addReply(c
,shared
.czero
);
5054 static void sremCommand(redisClient
*c
) {
5057 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5058 checkType(c
,set
,REDIS_SET
)) return;
5060 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5062 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5063 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5064 addReply(c
,shared
.cone
);
5066 addReply(c
,shared
.czero
);
5070 static void smoveCommand(redisClient
*c
) {
5071 robj
*srcset
, *dstset
;
5073 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5074 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5076 /* If the source key does not exist return 0, if it's of the wrong type
5078 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5079 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5082 /* Error if the destination key is not a set as well */
5083 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5084 addReply(c
,shared
.wrongtypeerr
);
5087 /* Remove the element from the source set */
5088 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5089 /* Key not found in the src set! return zero */
5090 addReply(c
,shared
.czero
);
5093 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5094 deleteKey(c
->db
,c
->argv
[1]);
5096 /* Add the element to the destination set */
5098 dstset
= createSetObject();
5099 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5100 incrRefCount(c
->argv
[2]);
5102 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5103 incrRefCount(c
->argv
[3]);
5104 addReply(c
,shared
.cone
);
5107 static void sismemberCommand(redisClient
*c
) {
5110 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5111 checkType(c
,set
,REDIS_SET
)) return;
5113 if (dictFind(set
->ptr
,c
->argv
[2]))
5114 addReply(c
,shared
.cone
);
5116 addReply(c
,shared
.czero
);
5119 static void scardCommand(redisClient
*c
) {
5123 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5124 checkType(c
,o
,REDIS_SET
)) return;
5127 addReplyUlong(c
,dictSize(s
));
5130 static void spopCommand(redisClient
*c
) {
5134 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5135 checkType(c
,set
,REDIS_SET
)) return;
5137 de
= dictGetRandomKey(set
->ptr
);
5139 addReply(c
,shared
.nullbulk
);
5141 robj
*ele
= dictGetEntryKey(de
);
5143 addReplyBulk(c
,ele
);
5144 dictDelete(set
->ptr
,ele
);
5145 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5146 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5151 static void srandmemberCommand(redisClient
*c
) {
5155 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5156 checkType(c
,set
,REDIS_SET
)) return;
5158 de
= dictGetRandomKey(set
->ptr
);
5160 addReply(c
,shared
.nullbulk
);
5162 robj
*ele
= dictGetEntryKey(de
);
5164 addReplyBulk(c
,ele
);
5168 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5169 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5171 return dictSize(*d1
)-dictSize(*d2
);
5174 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5175 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5178 robj
*lenobj
= NULL
, *dstset
= NULL
;
5179 unsigned long j
, cardinality
= 0;
5181 for (j
= 0; j
< setsnum
; j
++) {
5185 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5186 lookupKeyRead(c
->db
,setskeys
[j
]);
5190 if (deleteKey(c
->db
,dstkey
))
5192 addReply(c
,shared
.czero
);
5194 addReply(c
,shared
.emptymultibulk
);
5198 if (setobj
->type
!= REDIS_SET
) {
5200 addReply(c
,shared
.wrongtypeerr
);
5203 dv
[j
] = setobj
->ptr
;
5205 /* Sort sets from the smallest to largest, this will improve our
5206 * algorithm's performace */
5207 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5209 /* The first thing we should output is the total number of elements...
5210 * since this is a multi-bulk write, but at this stage we don't know
5211 * the intersection set size, so we use a trick, append an empty object
5212 * to the output list and save the pointer to later modify it with the
5215 lenobj
= createObject(REDIS_STRING
,NULL
);
5217 decrRefCount(lenobj
);
5219 /* If we have a target key where to store the resulting set
5220 * create this key with an empty set inside */
5221 dstset
= createSetObject();
5224 /* Iterate all the elements of the first (smallest) set, and test
5225 * the element against all the other sets, if at least one set does
5226 * not include the element it is discarded */
5227 di
= dictGetIterator(dv
[0]);
5229 while((de
= dictNext(di
)) != NULL
) {
5232 for (j
= 1; j
< setsnum
; j
++)
5233 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5235 continue; /* at least one set does not contain the member */
5236 ele
= dictGetEntryKey(de
);
5238 addReplyBulk(c
,ele
);
5241 dictAdd(dstset
->ptr
,ele
,NULL
);
5245 dictReleaseIterator(di
);
5248 /* Store the resulting set into the target, if the intersection
5249 * is not an empty set. */
5250 deleteKey(c
->db
,dstkey
);
5251 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5252 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5253 incrRefCount(dstkey
);
5254 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5256 decrRefCount(dstset
);
5257 addReply(c
,shared
.czero
);
5261 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5266 static void sinterCommand(redisClient
*c
) {
5267 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5270 static void sinterstoreCommand(redisClient
*c
) {
5271 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5274 #define REDIS_OP_UNION 0
5275 #define REDIS_OP_DIFF 1
5276 #define REDIS_OP_INTER 2
5278 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5279 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5282 robj
*dstset
= NULL
;
5283 int j
, cardinality
= 0;
5285 for (j
= 0; j
< setsnum
; j
++) {
5289 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5290 lookupKeyRead(c
->db
,setskeys
[j
]);
5295 if (setobj
->type
!= REDIS_SET
) {
5297 addReply(c
,shared
.wrongtypeerr
);
5300 dv
[j
] = setobj
->ptr
;
5303 /* We need a temp set object to store our union. If the dstkey
5304 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5305 * this set object will be the resulting object to set into the target key*/
5306 dstset
= createSetObject();
5308 /* Iterate all the elements of all the sets, add every element a single
5309 * time to the result set */
5310 for (j
= 0; j
< setsnum
; j
++) {
5311 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5312 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5314 di
= dictGetIterator(dv
[j
]);
5316 while((de
= dictNext(di
)) != NULL
) {
5319 /* dictAdd will not add the same element multiple times */
5320 ele
= dictGetEntryKey(de
);
5321 if (op
== REDIS_OP_UNION
|| j
== 0) {
5322 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5326 } else if (op
== REDIS_OP_DIFF
) {
5327 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5332 dictReleaseIterator(di
);
5334 /* result set is empty? Exit asap. */
5335 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5338 /* Output the content of the resulting set, if not in STORE mode */
5340 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5341 di
= dictGetIterator(dstset
->ptr
);
5342 while((de
= dictNext(di
)) != NULL
) {
5345 ele
= dictGetEntryKey(de
);
5346 addReplyBulk(c
,ele
);
5348 dictReleaseIterator(di
);
5349 decrRefCount(dstset
);
5351 /* If we have a target key where to store the resulting set
5352 * create this key with the result set inside */
5353 deleteKey(c
->db
,dstkey
);
5354 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5355 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5356 incrRefCount(dstkey
);
5357 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5359 decrRefCount(dstset
);
5360 addReply(c
,shared
.czero
);
5367 static void sunionCommand(redisClient
*c
) {
5368 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5371 static void sunionstoreCommand(redisClient
*c
) {
5372 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5375 static void sdiffCommand(redisClient
*c
) {
5376 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5379 static void sdiffstoreCommand(redisClient
*c
) {
5380 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5383 /* ==================================== ZSets =============================== */
5385 /* ZSETs are ordered sets using two data structures to hold the same elements
5386 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5389 * The elements are added to an hash table mapping Redis objects to scores.
5390 * At the same time the elements are added to a skip list mapping scores
5391 * to Redis objects (so objects are sorted by scores in this "view"). */
5393 /* This skiplist implementation is almost a C translation of the original
5394 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5395 * Alternative to Balanced Trees", modified in three ways:
5396 * a) this implementation allows for repeated values.
5397 * b) the comparison is not just by key (our 'score') but by satellite data.
5398 * c) there is a back pointer, so it's a doubly linked list with the back
5399 * pointers being only at "level 1". This allows to traverse the list
5400 * from tail to head, useful for ZREVRANGE. */
5402 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5403 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5405 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5407 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5413 static zskiplist
*zslCreate(void) {
5417 zsl
= zmalloc(sizeof(*zsl
));
5420 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5421 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5422 zsl
->header
->forward
[j
] = NULL
;
5424 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5425 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5426 zsl
->header
->span
[j
] = 0;
5428 zsl
->header
->backward
= NULL
;
5433 static void zslFreeNode(zskiplistNode
*node
) {
5434 decrRefCount(node
->obj
);
5435 zfree(node
->forward
);
5440 static void zslFree(zskiplist
*zsl
) {
5441 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5443 zfree(zsl
->header
->forward
);
5444 zfree(zsl
->header
->span
);
5447 next
= node
->forward
[0];
5454 static int zslRandomLevel(void) {
5456 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5458 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5461 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5462 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5463 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5467 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5468 /* store rank that is crossed to reach the insert position */
5469 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5471 while (x
->forward
[i
] &&
5472 (x
->forward
[i
]->score
< score
||
5473 (x
->forward
[i
]->score
== score
&&
5474 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5475 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5480 /* we assume the key is not already inside, since we allow duplicated
5481 * scores, and the re-insertion of score and redis object should never
5482 * happpen since the caller of zslInsert() should test in the hash table
5483 * if the element is already inside or not. */
5484 level
= zslRandomLevel();
5485 if (level
> zsl
->level
) {
5486 for (i
= zsl
->level
; i
< level
; i
++) {
5488 update
[i
] = zsl
->header
;
5489 update
[i
]->span
[i
-1] = zsl
->length
;
5493 x
= zslCreateNode(level
,score
,obj
);
5494 for (i
= 0; i
< level
; i
++) {
5495 x
->forward
[i
] = update
[i
]->forward
[i
];
5496 update
[i
]->forward
[i
] = x
;
5498 /* update span covered by update[i] as x is inserted here */
5500 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5501 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5505 /* increment span for untouched levels */
5506 for (i
= level
; i
< zsl
->level
; i
++) {
5507 update
[i
]->span
[i
-1]++;
5510 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5512 x
->forward
[0]->backward
= x
;
5518 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5519 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5521 for (i
= 0; i
< zsl
->level
; i
++) {
5522 if (update
[i
]->forward
[i
] == x
) {
5524 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5526 update
[i
]->forward
[i
] = x
->forward
[i
];
5528 /* invariant: i > 0, because update[0]->forward[0]
5529 * is always equal to x */
5530 update
[i
]->span
[i
-1] -= 1;
5533 if (x
->forward
[0]) {
5534 x
->forward
[0]->backward
= x
->backward
;
5536 zsl
->tail
= x
->backward
;
5538 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5543 /* Delete an element with matching score/object from the skiplist. */
5544 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5545 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5549 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5550 while (x
->forward
[i
] &&
5551 (x
->forward
[i
]->score
< score
||
5552 (x
->forward
[i
]->score
== score
&&
5553 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5557 /* We may have multiple elements with the same score, what we need
5558 * is to find the element with both the right score and object. */
5560 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5561 zslDeleteNode(zsl
, x
, update
);
5565 return 0; /* not found */
5567 return 0; /* not found */
5570 /* Delete all the elements with score between min and max from the skiplist.
5571 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5572 * Note that this function takes the reference to the hash table view of the
5573 * sorted set, in order to remove the elements from the hash table too. */
5574 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5575 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5576 unsigned long removed
= 0;
5580 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5581 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5585 /* We may have multiple elements with the same score, what we need
5586 * is to find the element with both the right score and object. */
5588 while (x
&& x
->score
<= max
) {
5589 zskiplistNode
*next
= x
->forward
[0];
5590 zslDeleteNode(zsl
, x
, update
);
5591 dictDelete(dict
,x
->obj
);
5596 return removed
; /* not found */
5599 /* Delete all the elements with rank between start and end from the skiplist.
5600 * Start and end are inclusive. Note that start and end need to be 1-based */
5601 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5602 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5603 unsigned long traversed
= 0, removed
= 0;
5607 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5608 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5609 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5617 while (x
&& traversed
<= end
) {
5618 zskiplistNode
*next
= x
->forward
[0];
5619 zslDeleteNode(zsl
, x
, update
);
5620 dictDelete(dict
,x
->obj
);
5629 /* Find the first node having a score equal or greater than the specified one.
5630 * Returns NULL if there is no match. */
5631 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5636 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5637 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5640 /* We may have multiple elements with the same score, what we need
5641 * is to find the element with both the right score and object. */
5642 return x
->forward
[0];
5645 /* Find the rank for an element by both score and key.
5646 * Returns 0 when the element cannot be found, rank otherwise.
5647 * Note that the rank is 1-based due to the span of zsl->header to the
5649 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5651 unsigned long rank
= 0;
5655 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5656 while (x
->forward
[i
] &&
5657 (x
->forward
[i
]->score
< score
||
5658 (x
->forward
[i
]->score
== score
&&
5659 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5660 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5664 /* x might be equal to zsl->header, so test if obj is non-NULL */
5665 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5672 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5673 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5675 unsigned long traversed
= 0;
5679 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5680 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5682 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5685 if (traversed
== rank
) {
5692 /* The actual Z-commands implementations */
5694 /* This generic command implements both ZADD and ZINCRBY.
5695 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5696 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5697 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5702 zsetobj
= lookupKeyWrite(c
->db
,key
);
5703 if (zsetobj
== NULL
) {
5704 zsetobj
= createZsetObject();
5705 dictAdd(c
->db
->dict
,key
,zsetobj
);
5708 if (zsetobj
->type
!= REDIS_ZSET
) {
5709 addReply(c
,shared
.wrongtypeerr
);
5715 /* Ok now since we implement both ZADD and ZINCRBY here the code
5716 * needs to handle the two different conditions. It's all about setting
5717 * '*score', that is, the new score to set, to the right value. */
5718 score
= zmalloc(sizeof(double));
5722 /* Read the old score. If the element was not present starts from 0 */
5723 de
= dictFind(zs
->dict
,ele
);
5725 double *oldscore
= dictGetEntryVal(de
);
5726 *score
= *oldscore
+ scoreval
;
5734 /* What follows is a simple remove and re-insert operation that is common
5735 * to both ZADD and ZINCRBY... */
5736 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5737 /* case 1: New element */
5738 incrRefCount(ele
); /* added to hash */
5739 zslInsert(zs
->zsl
,*score
,ele
);
5740 incrRefCount(ele
); /* added to skiplist */
5743 addReplyDouble(c
,*score
);
5745 addReply(c
,shared
.cone
);
5750 /* case 2: Score update operation */
5751 de
= dictFind(zs
->dict
,ele
);
5752 redisAssert(de
!= NULL
);
5753 oldscore
= dictGetEntryVal(de
);
5754 if (*score
!= *oldscore
) {
5757 /* Remove and insert the element in the skip list with new score */
5758 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5759 redisAssert(deleted
!= 0);
5760 zslInsert(zs
->zsl
,*score
,ele
);
5762 /* Update the score in the hash table */
5763 dictReplace(zs
->dict
,ele
,score
);
5769 addReplyDouble(c
,*score
);
5771 addReply(c
,shared
.czero
);
5775 static void zaddCommand(redisClient
*c
) {
5778 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5779 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5782 static void zincrbyCommand(redisClient
*c
) {
5785 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5786 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5789 static void zremCommand(redisClient
*c
) {
5796 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5797 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5800 de
= dictFind(zs
->dict
,c
->argv
[2]);
5802 addReply(c
,shared
.czero
);
5805 /* Delete from the skiplist */
5806 oldscore
= dictGetEntryVal(de
);
5807 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5808 redisAssert(deleted
!= 0);
5810 /* Delete from the hash table */
5811 dictDelete(zs
->dict
,c
->argv
[2]);
5812 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5813 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5815 addReply(c
,shared
.cone
);
5818 static void zremrangebyscoreCommand(redisClient
*c
) {
5825 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5826 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5828 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5829 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5832 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5833 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5834 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5835 server
.dirty
+= deleted
;
5836 addReplyLong(c
,deleted
);
5839 static void zremrangebyrankCommand(redisClient
*c
) {
5847 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5848 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5850 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5851 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5853 llen
= zs
->zsl
->length
;
5855 /* convert negative indexes */
5856 if (start
< 0) start
= llen
+start
;
5857 if (end
< 0) end
= llen
+end
;
5858 if (start
< 0) start
= 0;
5859 if (end
< 0) end
= 0;
5861 /* indexes sanity checks */
5862 if (start
> end
|| start
>= llen
) {
5863 addReply(c
,shared
.czero
);
5866 if (end
>= llen
) end
= llen
-1;
5868 /* increment start and end because zsl*Rank functions
5869 * use 1-based rank */
5870 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5871 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5872 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5873 server
.dirty
+= deleted
;
5874 addReplyLong(c
, deleted
);
5882 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5883 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5884 unsigned long size1
, size2
;
5885 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5886 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5887 return size1
- size2
;
5890 #define REDIS_AGGR_SUM 1
5891 #define REDIS_AGGR_MIN 2
5892 #define REDIS_AGGR_MAX 3
5894 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5895 if (aggregate
== REDIS_AGGR_SUM
) {
5896 *target
= *target
+ val
;
5897 } else if (aggregate
== REDIS_AGGR_MIN
) {
5898 *target
= val
< *target
? val
: *target
;
5899 } else if (aggregate
== REDIS_AGGR_MAX
) {
5900 *target
= val
> *target
? val
: *target
;
5903 redisPanic("Unknown ZUNION/INTER aggregate type");
5907 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5909 int aggregate
= REDIS_AGGR_SUM
;
5916 /* expect zsetnum input keys to be given */
5917 zsetnum
= atoi(c
->argv
[2]->ptr
);
5919 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5923 /* test if the expected number of keys would overflow */
5924 if (3+zsetnum
> c
->argc
) {
5925 addReply(c
,shared
.syntaxerr
);
5929 /* read keys to be used for input */
5930 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5931 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5932 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5936 if (zsetobj
->type
!= REDIS_ZSET
) {
5938 addReply(c
,shared
.wrongtypeerr
);
5941 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5944 /* default all weights to 1 */
5945 src
[i
].weight
= 1.0;
5948 /* parse optional extra arguments */
5950 int remaining
= c
->argc
- j
;
5953 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5955 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5956 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5959 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5961 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5962 aggregate
= REDIS_AGGR_SUM
;
5963 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5964 aggregate
= REDIS_AGGR_MIN
;
5965 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5966 aggregate
= REDIS_AGGR_MAX
;
5969 addReply(c
,shared
.syntaxerr
);
5975 addReply(c
,shared
.syntaxerr
);
5981 /* sort sets from the smallest to largest, this will improve our
5982 * algorithm's performance */
5983 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5985 dstobj
= createZsetObject();
5986 dstzset
= dstobj
->ptr
;
5988 if (op
== REDIS_OP_INTER
) {
5989 /* skip going over all entries if the smallest zset is NULL or empty */
5990 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5991 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5992 * from small to large, all src[i > 0].dict are non-empty too */
5993 di
= dictGetIterator(src
[0].dict
);
5994 while((de
= dictNext(di
)) != NULL
) {
5995 double *score
= zmalloc(sizeof(double)), value
;
5996 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5998 for (j
= 1; j
< zsetnum
; j
++) {
5999 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6001 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
6002 zunionInterAggregate(score
, value
, aggregate
);
6008 /* skip entry when not present in every source dict */
6012 robj
*o
= dictGetEntryKey(de
);
6013 dictAdd(dstzset
->dict
,o
,score
);
6014 incrRefCount(o
); /* added to dictionary */
6015 zslInsert(dstzset
->zsl
,*score
,o
);
6016 incrRefCount(o
); /* added to skiplist */
6019 dictReleaseIterator(di
);
6021 } else if (op
== REDIS_OP_UNION
) {
6022 for (i
= 0; i
< zsetnum
; i
++) {
6023 if (!src
[i
].dict
) continue;
6025 di
= dictGetIterator(src
[i
].dict
);
6026 while((de
= dictNext(di
)) != NULL
) {
6027 /* skip key when already processed */
6028 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6030 double *score
= zmalloc(sizeof(double)), value
;
6031 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
6033 /* because the zsets are sorted by size, its only possible
6034 * for sets at larger indices to hold this entry */
6035 for (j
= (i
+1); j
< zsetnum
; j
++) {
6036 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6038 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
6039 zunionInterAggregate(score
, value
, aggregate
);
6043 robj
*o
= dictGetEntryKey(de
);
6044 dictAdd(dstzset
->dict
,o
,score
);
6045 incrRefCount(o
); /* added to dictionary */
6046 zslInsert(dstzset
->zsl
,*score
,o
);
6047 incrRefCount(o
); /* added to skiplist */
6049 dictReleaseIterator(di
);
6052 /* unknown operator */
6053 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6056 deleteKey(c
->db
,dstkey
);
6057 if (dstzset
->zsl
->length
) {
6058 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6059 incrRefCount(dstkey
);
6060 addReplyLong(c
, dstzset
->zsl
->length
);
6063 decrRefCount(dstobj
);
6064 addReply(c
, shared
.czero
);
6069 static void zunionCommand(redisClient
*c
) {
6070 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6073 static void zinterCommand(redisClient
*c
) {
6074 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6077 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6089 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6090 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6092 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6094 } else if (c
->argc
>= 5) {
6095 addReply(c
,shared
.syntaxerr
);
6099 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6100 || checkType(c
,o
,REDIS_ZSET
)) return;
6105 /* convert negative indexes */
6106 if (start
< 0) start
= llen
+start
;
6107 if (end
< 0) end
= llen
+end
;
6108 if (start
< 0) start
= 0;
6109 if (end
< 0) end
= 0;
6111 /* indexes sanity checks */
6112 if (start
> end
|| start
>= llen
) {
6113 /* Out of range start or start > end result in empty list */
6114 addReply(c
,shared
.emptymultibulk
);
6117 if (end
>= llen
) end
= llen
-1;
6118 rangelen
= (end
-start
)+1;
6120 /* check if starting point is trivial, before searching
6121 * the element in log(N) time */
6123 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6126 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6129 /* Return the result in form of a multi-bulk reply */
6130 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6131 withscores
? (rangelen
*2) : rangelen
));
6132 for (j
= 0; j
< rangelen
; j
++) {
6134 addReplyBulk(c
,ele
);
6136 addReplyDouble(c
,ln
->score
);
6137 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6141 static void zrangeCommand(redisClient
*c
) {
6142 zrangeGenericCommand(c
,0);
6145 static void zrevrangeCommand(redisClient
*c
) {
6146 zrangeGenericCommand(c
,1);
6149 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6150 * If justcount is non-zero, just the count is returned. */
6151 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6154 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6155 int offset
= 0, limit
= -1;
6159 /* Parse the min-max interval. If one of the values is prefixed
6160 * by the "(" character, it's considered "open". For instance
6161 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6162 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6163 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6164 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6167 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6169 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6170 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6173 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6176 /* Parse "WITHSCORES": note that if the command was called with
6177 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6178 * enter the following paths to parse WITHSCORES and LIMIT. */
6179 if (c
->argc
== 5 || c
->argc
== 8) {
6180 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6185 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6189 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6194 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6195 addReply(c
,shared
.syntaxerr
);
6197 } else if (c
->argc
== (7 + withscores
)) {
6198 offset
= atoi(c
->argv
[5]->ptr
);
6199 limit
= atoi(c
->argv
[6]->ptr
);
6200 if (offset
< 0) offset
= 0;
6203 /* Ok, lookup the key and get the range */
6204 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6206 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6208 if (o
->type
!= REDIS_ZSET
) {
6209 addReply(c
,shared
.wrongtypeerr
);
6211 zset
*zsetobj
= o
->ptr
;
6212 zskiplist
*zsl
= zsetobj
->zsl
;
6214 robj
*ele
, *lenobj
= NULL
;
6215 unsigned long rangelen
= 0;
6217 /* Get the first node with the score >= min, or with
6218 * score > min if 'minex' is true. */
6219 ln
= zslFirstWithScore(zsl
,min
);
6220 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6223 /* No element matching the speciifed interval */
6224 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6228 /* We don't know in advance how many matching elements there
6229 * are in the list, so we push this object that will represent
6230 * the multi-bulk length in the output buffer, and will "fix"
6233 lenobj
= createObject(REDIS_STRING
,NULL
);
6235 decrRefCount(lenobj
);
6238 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6241 ln
= ln
->forward
[0];
6244 if (limit
== 0) break;
6247 addReplyBulk(c
,ele
);
6249 addReplyDouble(c
,ln
->score
);
6251 ln
= ln
->forward
[0];
6253 if (limit
> 0) limit
--;
6256 addReplyLong(c
,(long)rangelen
);
6258 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6259 withscores
? (rangelen
*2) : rangelen
);
6265 static void zrangebyscoreCommand(redisClient
*c
) {
6266 genericZrangebyscoreCommand(c
,0);
6269 static void zcountCommand(redisClient
*c
) {
6270 genericZrangebyscoreCommand(c
,1);
6273 static void zcardCommand(redisClient
*c
) {
6277 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6278 checkType(c
,o
,REDIS_ZSET
)) return;
6281 addReplyUlong(c
,zs
->zsl
->length
);
6284 static void zscoreCommand(redisClient
*c
) {
6289 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6290 checkType(c
,o
,REDIS_ZSET
)) return;
6293 de
= dictFind(zs
->dict
,c
->argv
[2]);
6295 addReply(c
,shared
.nullbulk
);
6297 double *score
= dictGetEntryVal(de
);
6299 addReplyDouble(c
,*score
);
6303 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6311 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6312 checkType(c
,o
,REDIS_ZSET
)) return;
6316 de
= dictFind(zs
->dict
,c
->argv
[2]);
6318 addReply(c
,shared
.nullbulk
);
6322 score
= dictGetEntryVal(de
);
6323 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6326 addReplyLong(c
, zsl
->length
- rank
);
6328 addReplyLong(c
, rank
-1);
6331 addReply(c
,shared
.nullbulk
);
6335 static void zrankCommand(redisClient
*c
) {
6336 zrankGenericCommand(c
, 0);
6339 static void zrevrankCommand(redisClient
*c
) {
6340 zrankGenericCommand(c
, 1);
6343 /* ========================= Hashes utility functions ======================= */
6344 #define REDIS_HASH_KEY 1
6345 #define REDIS_HASH_VALUE 2
6347 /* Check the length of a number of objects to see if we need to convert a
6348 * zipmap to a real hash. Note that we only check string encoded objects
6349 * as their string length can be queried in constant time. */
6350 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6352 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6354 for (i
= start
; i
<= end
; i
++) {
6355 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6356 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6358 convertToRealHash(subject
);
6364 /* Encode given objects in-place when the hash uses a dict. */
6365 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6366 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6367 if (o1
) *o1
= tryObjectEncoding(*o1
);
6368 if (o2
) *o2
= tryObjectEncoding(*o2
);
6372 /* Get the value from a hash identified by key. Returns either a string
6373 * object or NULL if the value cannot be found. The refcount of the object
6374 * is always increased by 1 when the value was found. */
6375 static robj
*hashGet(robj
*o
, robj
*key
) {
6377 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6380 key
= getDecodedObject(key
);
6381 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6382 value
= createStringObject((char*)v
,vlen
);
6386 dictEntry
*de
= dictFind(o
->ptr
,key
);
6388 value
= dictGetEntryVal(de
);
6389 incrRefCount(value
);
6395 /* Test if the key exists in the given hash. Returns 1 if the key
6396 * exists and 0 when it doesn't. */
6397 static int hashExists(robj
*o
, robj
*key
) {
6398 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6399 key
= getDecodedObject(key
);
6400 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6406 if (dictFind(o
->ptr
,key
) != NULL
) {
6413 /* Add an element, discard the old if the key already exists.
6414 * Return 0 on insert and 1 on update. */
6415 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6417 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6418 key
= getDecodedObject(key
);
6419 value
= getDecodedObject(value
);
6420 o
->ptr
= zipmapSet(o
->ptr
,
6421 key
->ptr
,sdslen(key
->ptr
),
6422 value
->ptr
,sdslen(value
->ptr
), &update
);
6424 decrRefCount(value
);
6426 /* Check if the zipmap needs to be upgraded to a real hash table */
6427 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6428 convertToRealHash(o
);
6430 if (dictReplace(o
->ptr
,key
,value
)) {
6437 incrRefCount(value
);
6442 /* Delete an element from a hash.
6443 * Return 1 on deleted and 0 on not found. */
6444 static int hashDelete(robj
*o
, robj
*key
) {
6446 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6447 key
= getDecodedObject(key
);
6448 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6451 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6452 /* Always check if the dictionary needs a resize after a delete. */
6453 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6458 /* Return the number of elements in a hash. */
6459 static unsigned long hashLength(robj
*o
) {
6460 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6461 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6464 /* Structure to hold hash iteration abstration. Note that iteration over
6465 * hashes involves both fields and values. Because it is possible that
6466 * not both are required, store pointers in the iterator to avoid
6467 * unnecessary memory allocation for fields/values. */
6471 unsigned char *zk
, *zv
;
6472 unsigned int zklen
, zvlen
;
6478 static hashIterator
*hashInitIterator(robj
*subject
) {
6479 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6480 hi
->encoding
= subject
->encoding
;
6481 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6482 hi
->zi
= zipmapRewind(subject
->ptr
);
6483 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6484 hi
->di
= dictGetIterator(subject
->ptr
);
6491 static void hashReleaseIterator(hashIterator
*hi
) {
6492 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6493 dictReleaseIterator(hi
->di
);
6498 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6499 * could be found and REDIS_ERR when the iterator reaches the end. */
6500 static int hashNext(hashIterator
*hi
) {
6501 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6502 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6503 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6505 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6510 /* Get key or value object at current iteration position.
6511 * This increases the refcount of the field object by 1. */
6512 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6514 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6515 if (what
& REDIS_HASH_KEY
) {
6516 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6518 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6521 if (what
& REDIS_HASH_KEY
) {
6522 o
= dictGetEntryKey(hi
->de
);
6524 o
= dictGetEntryVal(hi
->de
);
6531 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6532 robj
*o
= lookupKeyWrite(c
->db
,key
);
6534 o
= createHashObject();
6535 dictAdd(c
->db
->dict
,key
,o
);
6538 if (o
->type
!= REDIS_HASH
) {
6539 addReply(c
,shared
.wrongtypeerr
);
6546 /* ============================= Hash commands ============================== */
6547 static void hsetCommand(redisClient
*c
) {
6551 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6552 hashTryConversion(o
,c
->argv
,2,3);
6553 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6554 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6555 addReply(c
, update
? shared
.czero
: shared
.cone
);
6559 static void hsetnxCommand(redisClient
*c
) {
6561 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6562 hashTryConversion(o
,c
->argv
,2,3);
6564 if (hashExists(o
, c
->argv
[2])) {
6565 addReply(c
, shared
.czero
);
6567 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6568 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6569 addReply(c
, shared
.cone
);
6574 static void hmsetCommand(redisClient
*c
) {
6578 if ((c
->argc
% 2) == 1) {
6579 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6583 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6584 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6585 for (i
= 2; i
< c
->argc
; i
+= 2) {
6586 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6587 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6589 addReply(c
, shared
.ok
);
6593 static void hincrbyCommand(redisClient
*c
) {
6594 long long value
, incr
;
6595 robj
*o
, *current
, *new;
6597 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6598 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6599 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6600 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6601 "hash value is not an integer") != REDIS_OK
) {
6602 decrRefCount(current
);
6605 decrRefCount(current
);
6611 new = createStringObjectFromLongLong(value
);
6612 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6613 hashSet(o
,c
->argv
[2],new);
6615 addReplyLongLong(c
,value
);
6619 static void hgetCommand(redisClient
*c
) {
6621 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6622 checkType(c
,o
,REDIS_HASH
)) return;
6624 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6625 addReplyBulk(c
,value
);
6626 decrRefCount(value
);
6628 addReply(c
,shared
.nullbulk
);
6632 static void hmgetCommand(redisClient
*c
) {
6635 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6636 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6637 addReply(c
,shared
.wrongtypeerr
);
6640 /* Note the check for o != NULL happens inside the loop. This is
6641 * done because objects that cannot be found are considered to be
6642 * an empty hash. The reply should then be a series of NULLs. */
6643 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6644 for (i
= 2; i
< c
->argc
; i
++) {
6645 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6646 addReplyBulk(c
,value
);
6647 decrRefCount(value
);
6649 addReply(c
,shared
.nullbulk
);
6654 static void hdelCommand(redisClient
*c
) {
6656 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6657 checkType(c
,o
,REDIS_HASH
)) return;
6659 if (hashDelete(o
,c
->argv
[2])) {
6660 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6661 addReply(c
,shared
.cone
);
6664 addReply(c
,shared
.czero
);
6668 static void hlenCommand(redisClient
*c
) {
6670 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6671 checkType(c
,o
,REDIS_HASH
)) return;
6673 addReplyUlong(c
,hashLength(o
));
6676 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6677 robj
*o
, *lenobj
, *obj
;
6678 unsigned long count
= 0;
6681 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6682 || checkType(c
,o
,REDIS_HASH
)) return;
6684 lenobj
= createObject(REDIS_STRING
,NULL
);
6686 decrRefCount(lenobj
);
6688 hi
= hashInitIterator(o
);
6689 while (hashNext(hi
) != REDIS_ERR
) {
6690 if (flags
& REDIS_HASH_KEY
) {
6691 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6692 addReplyBulk(c
,obj
);
6696 if (flags
& REDIS_HASH_VALUE
) {
6697 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6698 addReplyBulk(c
,obj
);
6703 hashReleaseIterator(hi
);
6705 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6708 static void hkeysCommand(redisClient
*c
) {
6709 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6712 static void hvalsCommand(redisClient
*c
) {
6713 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6716 static void hgetallCommand(redisClient
*c
) {
6717 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6720 static void hexistsCommand(redisClient
*c
) {
6722 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6723 checkType(c
,o
,REDIS_HASH
)) return;
6725 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6728 static void convertToRealHash(robj
*o
) {
6729 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6730 unsigned int klen
, vlen
;
6731 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6733 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6734 p
= zipmapRewind(zm
);
6735 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6736 robj
*keyobj
, *valobj
;
6738 keyobj
= createStringObject((char*)key
,klen
);
6739 valobj
= createStringObject((char*)val
,vlen
);
6740 keyobj
= tryObjectEncoding(keyobj
);
6741 valobj
= tryObjectEncoding(valobj
);
6742 dictAdd(dict
,keyobj
,valobj
);
6744 o
->encoding
= REDIS_ENCODING_HT
;
6749 /* ========================= Non type-specific commands ==================== */
6751 static void flushdbCommand(redisClient
*c
) {
6752 server
.dirty
+= dictSize(c
->db
->dict
);
6753 dictEmpty(c
->db
->dict
);
6754 dictEmpty(c
->db
->expires
);
6755 addReply(c
,shared
.ok
);
6758 static void flushallCommand(redisClient
*c
) {
6759 server
.dirty
+= emptyDb();
6760 addReply(c
,shared
.ok
);
6761 if (server
.bgsavechildpid
!= -1) {
6762 kill(server
.bgsavechildpid
,SIGKILL
);
6763 rdbRemoveTempFile(server
.bgsavechildpid
);
6765 rdbSave(server
.dbfilename
);
6769 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6770 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6772 so
->pattern
= pattern
;
6776 /* Return the value associated to the key with a name obtained
6777 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6778 * The returned object will always have its refcount increased by 1
6779 * when it is non-NULL. */
6780 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6783 robj keyobj
, fieldobj
, *o
;
6784 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6785 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6789 char buf
[REDIS_SORTKEY_MAX
+1];
6790 } keyname
, fieldname
;
6792 /* If the pattern is "#" return the substitution object itself in order
6793 * to implement the "SORT ... GET #" feature. */
6794 spat
= pattern
->ptr
;
6795 if (spat
[0] == '#' && spat
[1] == '\0') {
6796 incrRefCount(subst
);
6800 /* The substitution object may be specially encoded. If so we create
6801 * a decoded object on the fly. Otherwise getDecodedObject will just
6802 * increment the ref count, that we'll decrement later. */
6803 subst
= getDecodedObject(subst
);
6806 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6807 p
= strchr(spat
,'*');
6809 decrRefCount(subst
);
6813 /* Find out if we're dealing with a hash dereference. */
6814 if ((f
= strstr(p
+1, "->")) != NULL
) {
6815 fieldlen
= sdslen(spat
)-(f
-spat
);
6816 /* this also copies \0 character */
6817 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6818 fieldname
.len
= fieldlen
-2;
6824 sublen
= sdslen(ssub
);
6825 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6826 memcpy(keyname
.buf
,spat
,prefixlen
);
6827 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6828 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6829 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6830 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6831 decrRefCount(subst
);
6833 /* Lookup substituted key */
6834 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6835 o
= lookupKeyRead(db
,&keyobj
);
6836 if (o
== NULL
) return NULL
;
6839 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6841 /* Retrieve value from hash by the field name. This operation
6842 * already increases the refcount of the returned object. */
6843 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6844 o
= hashGet(o
, &fieldobj
);
6846 if (o
->type
!= REDIS_STRING
) return NULL
;
6848 /* Every object that this function returns needs to have its refcount
6849 * increased. sortCommand decreases it again. */
6856 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6857 * the additional parameter is not standard but a BSD-specific we have to
6858 * pass sorting parameters via the global 'server' structure */
6859 static int sortCompare(const void *s1
, const void *s2
) {
6860 const redisSortObject
*so1
= s1
, *so2
= s2
;
6863 if (!server
.sort_alpha
) {
6864 /* Numeric sorting. Here it's trivial as we precomputed scores */
6865 if (so1
->u
.score
> so2
->u
.score
) {
6867 } else if (so1
->u
.score
< so2
->u
.score
) {
6873 /* Alphanumeric sorting */
6874 if (server
.sort_bypattern
) {
6875 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6876 /* At least one compare object is NULL */
6877 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6879 else if (so1
->u
.cmpobj
== NULL
)
6884 /* We have both the objects, use strcoll */
6885 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6888 /* Compare elements directly. */
6889 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6892 return server
.sort_desc
? -cmp
: cmp
;
6895 /* The SORT command is the most complex command in Redis. Warning: this code
6896 * is optimized for speed and a bit less for readability */
6897 static void sortCommand(redisClient
*c
) {
6900 int desc
= 0, alpha
= 0;
6901 int limit_start
= 0, limit_count
= -1, start
, end
;
6902 int j
, dontsort
= 0, vectorlen
;
6903 int getop
= 0; /* GET operation counter */
6904 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6905 redisSortObject
*vector
; /* Resulting vector to sort */
6907 /* Lookup the key to sort. It must be of the right types */
6908 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6909 if (sortval
== NULL
) {
6910 addReply(c
,shared
.emptymultibulk
);
6913 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6914 sortval
->type
!= REDIS_ZSET
)
6916 addReply(c
,shared
.wrongtypeerr
);
6920 /* Create a list of operations to perform for every sorted element.
6921 * Operations can be GET/DEL/INCR/DECR */
6922 operations
= listCreate();
6923 listSetFreeMethod(operations
,zfree
);
6926 /* Now we need to protect sortval incrementing its count, in the future
6927 * SORT may have options able to overwrite/delete keys during the sorting
6928 * and the sorted key itself may get destroied */
6929 incrRefCount(sortval
);
6931 /* The SORT command has an SQL-alike syntax, parse it */
6932 while(j
< c
->argc
) {
6933 int leftargs
= c
->argc
-j
-1;
6934 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6936 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6938 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6940 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6941 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6942 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6944 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6945 storekey
= c
->argv
[j
+1];
6947 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6948 sortby
= c
->argv
[j
+1];
6949 /* If the BY pattern does not contain '*', i.e. it is constant,
6950 * we don't need to sort nor to lookup the weight keys. */
6951 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6953 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6954 listAddNodeTail(operations
,createSortOperation(
6955 REDIS_SORT_GET
,c
->argv
[j
+1]));
6959 decrRefCount(sortval
);
6960 listRelease(operations
);
6961 addReply(c
,shared
.syntaxerr
);
6967 /* Load the sorting vector with all the objects to sort */
6968 switch(sortval
->type
) {
6969 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6970 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6971 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6972 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6974 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6977 if (sortval
->type
== REDIS_LIST
) {
6978 list
*list
= sortval
->ptr
;
6982 listRewind(list
,&li
);
6983 while((ln
= listNext(&li
))) {
6984 robj
*ele
= ln
->value
;
6985 vector
[j
].obj
= ele
;
6986 vector
[j
].u
.score
= 0;
6987 vector
[j
].u
.cmpobj
= NULL
;
6995 if (sortval
->type
== REDIS_SET
) {
6998 zset
*zs
= sortval
->ptr
;
7002 di
= dictGetIterator(set
);
7003 while((setele
= dictNext(di
)) != NULL
) {
7004 vector
[j
].obj
= dictGetEntryKey(setele
);
7005 vector
[j
].u
.score
= 0;
7006 vector
[j
].u
.cmpobj
= NULL
;
7009 dictReleaseIterator(di
);
7011 redisAssert(j
== vectorlen
);
7013 /* Now it's time to load the right scores in the sorting vector */
7014 if (dontsort
== 0) {
7015 for (j
= 0; j
< vectorlen
; j
++) {
7018 /* lookup value to sort by */
7019 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7020 if (!byval
) continue;
7022 /* use object itself to sort by */
7023 byval
= vector
[j
].obj
;
7027 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7029 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7030 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7031 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7032 /* Don't need to decode the object if it's
7033 * integer-encoded (the only encoding supported) so
7034 * far. We can just cast it */
7035 vector
[j
].u
.score
= (long)byval
->ptr
;
7037 redisAssert(1 != 1);
7041 /* when the object was retrieved using lookupKeyByPattern,
7042 * its refcount needs to be decreased. */
7044 decrRefCount(byval
);
7049 /* We are ready to sort the vector... perform a bit of sanity check
7050 * on the LIMIT option too. We'll use a partial version of quicksort. */
7051 start
= (limit_start
< 0) ? 0 : limit_start
;
7052 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7053 if (start
>= vectorlen
) {
7054 start
= vectorlen
-1;
7057 if (end
>= vectorlen
) end
= vectorlen
-1;
7059 if (dontsort
== 0) {
7060 server
.sort_desc
= desc
;
7061 server
.sort_alpha
= alpha
;
7062 server
.sort_bypattern
= sortby
? 1 : 0;
7063 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7064 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7066 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7069 /* Send command output to the output buffer, performing the specified
7070 * GET/DEL/INCR/DECR operations if any. */
7071 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7072 if (storekey
== NULL
) {
7073 /* STORE option not specified, sent the sorting result to client */
7074 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7075 for (j
= start
; j
<= end
; j
++) {
7079 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7080 listRewind(operations
,&li
);
7081 while((ln
= listNext(&li
))) {
7082 redisSortOperation
*sop
= ln
->value
;
7083 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7086 if (sop
->type
== REDIS_SORT_GET
) {
7088 addReply(c
,shared
.nullbulk
);
7090 addReplyBulk(c
,val
);
7094 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7099 robj
*listObject
= createListObject();
7100 list
*listPtr
= (list
*) listObject
->ptr
;
7102 /* STORE option specified, set the sorting result as a List object */
7103 for (j
= start
; j
<= end
; j
++) {
7108 listAddNodeTail(listPtr
,vector
[j
].obj
);
7109 incrRefCount(vector
[j
].obj
);
7111 listRewind(operations
,&li
);
7112 while((ln
= listNext(&li
))) {
7113 redisSortOperation
*sop
= ln
->value
;
7114 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7117 if (sop
->type
== REDIS_SORT_GET
) {
7119 listAddNodeTail(listPtr
,createStringObject("",0));
7121 /* We should do a incrRefCount on val because it is
7122 * added to the list, but also a decrRefCount because
7123 * it is returned by lookupKeyByPattern. This results
7124 * in doing nothing at all. */
7125 listAddNodeTail(listPtr
,val
);
7128 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7132 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7133 incrRefCount(storekey
);
7135 /* Note: we add 1 because the DB is dirty anyway since even if the
7136 * SORT result is empty a new key is set and maybe the old content
7138 server
.dirty
+= 1+outputlen
;
7139 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7143 decrRefCount(sortval
);
7144 listRelease(operations
);
7145 for (j
= 0; j
< vectorlen
; j
++) {
7146 if (alpha
&& vector
[j
].u
.cmpobj
)
7147 decrRefCount(vector
[j
].u
.cmpobj
);
7152 /* Convert an amount of bytes into a human readable string in the form
7153 * of 100B, 2G, 100M, 4K, and so forth. */
7154 static void bytesToHuman(char *s
, unsigned long long n
) {
7159 sprintf(s
,"%lluB",n
);
7161 } else if (n
< (1024*1024)) {
7162 d
= (double)n
/(1024);
7163 sprintf(s
,"%.2fK",d
);
7164 } else if (n
< (1024LL*1024*1024)) {
7165 d
= (double)n
/(1024*1024);
7166 sprintf(s
,"%.2fM",d
);
7167 } else if (n
< (1024LL*1024*1024*1024)) {
7168 d
= (double)n
/(1024LL*1024*1024);
7169 sprintf(s
,"%.2fG",d
);
7173 /* Create the string returned by the INFO command. This is decoupled
7174 * by the INFO command itself as we need to report the same information
7175 * on memory corruption problems. */
7176 static sds
genRedisInfoString(void) {
7178 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7182 bytesToHuman(hmem
,zmalloc_used_memory());
7183 info
= sdscatprintf(sdsempty(),
7184 "redis_version:%s\r\n"
7186 "multiplexing_api:%s\r\n"
7187 "process_id:%ld\r\n"
7188 "uptime_in_seconds:%ld\r\n"
7189 "uptime_in_days:%ld\r\n"
7190 "connected_clients:%d\r\n"
7191 "connected_slaves:%d\r\n"
7192 "blocked_clients:%d\r\n"
7193 "used_memory:%zu\r\n"
7194 "used_memory_human:%s\r\n"
7195 "changes_since_last_save:%lld\r\n"
7196 "bgsave_in_progress:%d\r\n"
7197 "last_save_time:%ld\r\n"
7198 "bgrewriteaof_in_progress:%d\r\n"
7199 "total_connections_received:%lld\r\n"
7200 "total_commands_processed:%lld\r\n"
7201 "expired_keys:%lld\r\n"
7202 "hash_max_zipmap_entries:%ld\r\n"
7203 "hash_max_zipmap_value:%ld\r\n"
7204 "pubsub_channels:%ld\r\n"
7205 "pubsub_patterns:%u\r\n"
7209 (sizeof(long) == 8) ? "64" : "32",
7214 listLength(server
.clients
)-listLength(server
.slaves
),
7215 listLength(server
.slaves
),
7216 server
.blpop_blocked_clients
,
7217 zmalloc_used_memory(),
7220 server
.bgsavechildpid
!= -1,
7222 server
.bgrewritechildpid
!= -1,
7223 server
.stat_numconnections
,
7224 server
.stat_numcommands
,
7225 server
.stat_expiredkeys
,
7226 server
.hash_max_zipmap_entries
,
7227 server
.hash_max_zipmap_value
,
7228 dictSize(server
.pubsub_channels
),
7229 listLength(server
.pubsub_patterns
),
7230 server
.vm_enabled
!= 0,
7231 server
.masterhost
== NULL
? "master" : "slave"
7233 if (server
.masterhost
) {
7234 info
= sdscatprintf(info
,
7235 "master_host:%s\r\n"
7236 "master_port:%d\r\n"
7237 "master_link_status:%s\r\n"
7238 "master_last_io_seconds_ago:%d\r\n"
7241 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7243 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7246 if (server
.vm_enabled
) {
7248 info
= sdscatprintf(info
,
7249 "vm_conf_max_memory:%llu\r\n"
7250 "vm_conf_page_size:%llu\r\n"
7251 "vm_conf_pages:%llu\r\n"
7252 "vm_stats_used_pages:%llu\r\n"
7253 "vm_stats_swapped_objects:%llu\r\n"
7254 "vm_stats_swappin_count:%llu\r\n"
7255 "vm_stats_swappout_count:%llu\r\n"
7256 "vm_stats_io_newjobs_len:%lu\r\n"
7257 "vm_stats_io_processing_len:%lu\r\n"
7258 "vm_stats_io_processed_len:%lu\r\n"
7259 "vm_stats_io_active_threads:%lu\r\n"
7260 "vm_stats_blocked_clients:%lu\r\n"
7261 ,(unsigned long long) server
.vm_max_memory
,
7262 (unsigned long long) server
.vm_page_size
,
7263 (unsigned long long) server
.vm_pages
,
7264 (unsigned long long) server
.vm_stats_used_pages
,
7265 (unsigned long long) server
.vm_stats_swapped_objects
,
7266 (unsigned long long) server
.vm_stats_swapins
,
7267 (unsigned long long) server
.vm_stats_swapouts
,
7268 (unsigned long) listLength(server
.io_newjobs
),
7269 (unsigned long) listLength(server
.io_processing
),
7270 (unsigned long) listLength(server
.io_processed
),
7271 (unsigned long) server
.io_active_threads
,
7272 (unsigned long) server
.vm_blocked_clients
7276 for (j
= 0; j
< server
.dbnum
; j
++) {
7277 long long keys
, vkeys
;
7279 keys
= dictSize(server
.db
[j
].dict
);
7280 vkeys
= dictSize(server
.db
[j
].expires
);
7281 if (keys
|| vkeys
) {
7282 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7289 static void infoCommand(redisClient
*c
) {
7290 sds info
= genRedisInfoString();
7291 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7292 (unsigned long)sdslen(info
)));
7293 addReplySds(c
,info
);
7294 addReply(c
,shared
.crlf
);
7297 static void monitorCommand(redisClient
*c
) {
7298 /* ignore MONITOR if aleady slave or in monitor mode */
7299 if (c
->flags
& REDIS_SLAVE
) return;
7301 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7303 listAddNodeTail(server
.monitors
,c
);
7304 addReply(c
,shared
.ok
);
7307 /* ================================= Expire ================================= */
7308 static int removeExpire(redisDb
*db
, robj
*key
) {
7309 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7316 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7317 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7325 /* Return the expire time of the specified key, or -1 if no expire
7326 * is associated with this key (i.e. the key is non volatile) */
7327 static time_t getExpire(redisDb
*db
, robj
*key
) {
7330 /* No expire? return ASAP */
7331 if (dictSize(db
->expires
) == 0 ||
7332 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7334 return (time_t) dictGetEntryVal(de
);
7337 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7341 /* No expire? return ASAP */
7342 if (dictSize(db
->expires
) == 0 ||
7343 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7345 /* Lookup the expire */
7346 when
= (time_t) dictGetEntryVal(de
);
7347 if (time(NULL
) <= when
) return 0;
7349 /* Delete the key */
7350 dictDelete(db
->expires
,key
);
7351 server
.stat_expiredkeys
++;
7352 return dictDelete(db
->dict
,key
) == DICT_OK
;
7355 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7358 /* No expire? return ASAP */
7359 if (dictSize(db
->expires
) == 0 ||
7360 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7362 /* Delete the key */
7364 server
.stat_expiredkeys
++;
7365 dictDelete(db
->expires
,key
);
7366 return dictDelete(db
->dict
,key
) == DICT_OK
;
7369 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7373 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7377 de
= dictFind(c
->db
->dict
,key
);
7379 addReply(c
,shared
.czero
);
7383 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7384 addReply(c
, shared
.cone
);
7387 time_t when
= time(NULL
)+seconds
;
7388 if (setExpire(c
->db
,key
,when
)) {
7389 addReply(c
,shared
.cone
);
7392 addReply(c
,shared
.czero
);
7398 static void expireCommand(redisClient
*c
) {
7399 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7402 static void expireatCommand(redisClient
*c
) {
7403 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7406 static void ttlCommand(redisClient
*c
) {
7410 expire
= getExpire(c
->db
,c
->argv
[1]);
7412 ttl
= (int) (expire
-time(NULL
));
7413 if (ttl
< 0) ttl
= -1;
7415 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7418 /* ================================ MULTI/EXEC ============================== */
7420 /* Client state initialization for MULTI/EXEC */
7421 static void initClientMultiState(redisClient
*c
) {
7422 c
->mstate
.commands
= NULL
;
7423 c
->mstate
.count
= 0;
7426 /* Release all the resources associated with MULTI/EXEC state */
7427 static void freeClientMultiState(redisClient
*c
) {
7430 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7432 multiCmd
*mc
= c
->mstate
.commands
+j
;
7434 for (i
= 0; i
< mc
->argc
; i
++)
7435 decrRefCount(mc
->argv
[i
]);
7438 zfree(c
->mstate
.commands
);
7441 /* Add a new command into the MULTI commands queue */
7442 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7446 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7447 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7448 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7451 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7452 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7453 for (j
= 0; j
< c
->argc
; j
++)
7454 incrRefCount(mc
->argv
[j
]);
7458 static void multiCommand(redisClient
*c
) {
7459 c
->flags
|= REDIS_MULTI
;
7460 addReply(c
,shared
.ok
);
7463 static void discardCommand(redisClient
*c
) {
7464 if (!(c
->flags
& REDIS_MULTI
)) {
7465 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7469 freeClientMultiState(c
);
7470 initClientMultiState(c
);
7471 c
->flags
&= (~REDIS_MULTI
);
7472 addReply(c
,shared
.ok
);
7475 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7476 * implememntation for more information. */
7477 static void execCommandReplicateMulti(redisClient
*c
) {
7478 struct redisCommand
*cmd
;
7479 robj
*multistring
= createStringObject("MULTI",5);
7481 cmd
= lookupCommand("multi");
7482 if (server
.appendonly
)
7483 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7484 if (listLength(server
.slaves
))
7485 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7486 decrRefCount(multistring
);
7489 static void execCommand(redisClient
*c
) {
7494 if (!(c
->flags
& REDIS_MULTI
)) {
7495 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7499 /* Replicate a MULTI request now that we are sure the block is executed.
7500 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7501 * both the AOF and the replication link will have the same consistency
7502 * and atomicity guarantees. */
7503 execCommandReplicateMulti(c
);
7505 /* Exec all the queued commands */
7506 orig_argv
= c
->argv
;
7507 orig_argc
= c
->argc
;
7508 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7509 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7510 c
->argc
= c
->mstate
.commands
[j
].argc
;
7511 c
->argv
= c
->mstate
.commands
[j
].argv
;
7512 call(c
,c
->mstate
.commands
[j
].cmd
);
7514 c
->argv
= orig_argv
;
7515 c
->argc
= orig_argc
;
7516 freeClientMultiState(c
);
7517 initClientMultiState(c
);
7518 c
->flags
&= (~REDIS_MULTI
);
7519 /* Make sure the EXEC command is always replicated / AOF, since we
7520 * always send the MULTI command (we can't know beforehand if the
7521 * next operations will contain at least a modification to the DB). */
7525 /* =========================== Blocking Operations ========================= */
7527 /* Currently Redis blocking operations support is limited to list POP ops,
7528 * so the current implementation is not fully generic, but it is also not
7529 * completely specific so it will not require a rewrite to support new
7530 * kind of blocking operations in the future.
7532 * Still it's important to note that list blocking operations can be already
7533 * used as a notification mechanism in order to implement other blocking
7534 * operations at application level, so there must be a very strong evidence
7535 * of usefulness and generality before new blocking operations are implemented.
7537 * This is how the current blocking POP works, we use BLPOP as example:
7538 * - If the user calls BLPOP and the key exists and contains a non empty list
7539 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7540 * if there is not to block.
7541 * - If instead BLPOP is called and the key does not exists or the list is
7542 * empty we need to block. In order to do so we remove the notification for
7543 * new data to read in the client socket (so that we'll not serve new
7544 * requests if the blocking request is not served). Also we put the client
7545 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7546 * blocking for this keys.
7547 * - If a PUSH operation against a key with blocked clients waiting is
7548 * performed, we serve the first in the list: basically instead to push
7549 * the new element inside the list we return it to the (first / oldest)
7550 * blocking client, unblock the client, and remove it form the list.
7552 * The above comment and the source code should be enough in order to understand
7553 * the implementation and modify / fix it later.
7556 /* Set a client in blocking mode for the specified key, with the specified
7558 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7563 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7564 c
->blockingkeysnum
= numkeys
;
7565 c
->blockingto
= timeout
;
7566 for (j
= 0; j
< numkeys
; j
++) {
7567 /* Add the key in the client structure, to map clients -> keys */
7568 c
->blockingkeys
[j
] = keys
[j
];
7569 incrRefCount(keys
[j
]);
7571 /* And in the other "side", to map keys -> clients */
7572 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7576 /* For every key we take a list of clients blocked for it */
7578 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7579 incrRefCount(keys
[j
]);
7580 assert(retval
== DICT_OK
);
7582 l
= dictGetEntryVal(de
);
7584 listAddNodeTail(l
,c
);
7586 /* Mark the client as a blocked client */
7587 c
->flags
|= REDIS_BLOCKED
;
7588 server
.blpop_blocked_clients
++;
7591 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7592 static void unblockClientWaitingData(redisClient
*c
) {
7597 assert(c
->blockingkeys
!= NULL
);
7598 /* The client may wait for multiple keys, so unblock it for every key. */
7599 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7600 /* Remove this client from the list of clients waiting for this key. */
7601 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7603 l
= dictGetEntryVal(de
);
7604 listDelNode(l
,listSearchKey(l
,c
));
7605 /* If the list is empty we need to remove it to avoid wasting memory */
7606 if (listLength(l
) == 0)
7607 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7608 decrRefCount(c
->blockingkeys
[j
]);
7610 /* Cleanup the client structure */
7611 zfree(c
->blockingkeys
);
7612 c
->blockingkeys
= NULL
;
7613 c
->flags
&= (~REDIS_BLOCKED
);
7614 server
.blpop_blocked_clients
--;
7615 /* We want to process data if there is some command waiting
7616 * in the input buffer. Note that this is safe even if
7617 * unblockClientWaitingData() gets called from freeClient() because
7618 * freeClient() will be smart enough to call this function
7619 * *after* c->querybuf was set to NULL. */
7620 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7623 /* This should be called from any function PUSHing into lists.
7624 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7625 * 'ele' is the element pushed.
7627 * If the function returns 0 there was no client waiting for a list push
7630 * If the function returns 1 there was a client waiting for a list push
7631 * against this key, the element was passed to this client thus it's not
7632 * needed to actually add it to the list and the caller should return asap. */
7633 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7634 struct dictEntry
*de
;
7635 redisClient
*receiver
;
7639 de
= dictFind(c
->db
->blockingkeys
,key
);
7640 if (de
== NULL
) return 0;
7641 l
= dictGetEntryVal(de
);
7644 receiver
= ln
->value
;
7646 addReplySds(receiver
,sdsnew("*2\r\n"));
7647 addReplyBulk(receiver
,key
);
7648 addReplyBulk(receiver
,ele
);
7649 unblockClientWaitingData(receiver
);
7653 /* Blocking RPOP/LPOP */
7654 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7659 for (j
= 1; j
< c
->argc
-1; j
++) {
7660 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7662 if (o
->type
!= REDIS_LIST
) {
7663 addReply(c
,shared
.wrongtypeerr
);
7666 list
*list
= o
->ptr
;
7667 if (listLength(list
) != 0) {
7668 /* If the list contains elements fall back to the usual
7669 * non-blocking POP operation */
7670 robj
*argv
[2], **orig_argv
;
7673 /* We need to alter the command arguments before to call
7674 * popGenericCommand() as the command takes a single key. */
7675 orig_argv
= c
->argv
;
7676 orig_argc
= c
->argc
;
7677 argv
[1] = c
->argv
[j
];
7681 /* Also the return value is different, we need to output
7682 * the multi bulk reply header and the key name. The
7683 * "real" command will add the last element (the value)
7684 * for us. If this souds like an hack to you it's just
7685 * because it is... */
7686 addReplySds(c
,sdsnew("*2\r\n"));
7687 addReplyBulk(c
,argv
[1]);
7688 popGenericCommand(c
,where
);
7690 /* Fix the client structure with the original stuff */
7691 c
->argv
= orig_argv
;
7692 c
->argc
= orig_argc
;
7698 /* If the list is empty or the key does not exists we must block */
7699 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7700 if (timeout
> 0) timeout
+= time(NULL
);
7701 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7704 static void blpopCommand(redisClient
*c
) {
7705 blockingPopGenericCommand(c
,REDIS_HEAD
);
7708 static void brpopCommand(redisClient
*c
) {
7709 blockingPopGenericCommand(c
,REDIS_TAIL
);
7712 /* =============================== Replication ============================= */
7714 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7715 ssize_t nwritten
, ret
= size
;
7716 time_t start
= time(NULL
);
7720 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7721 nwritten
= write(fd
,ptr
,size
);
7722 if (nwritten
== -1) return -1;
7726 if ((time(NULL
)-start
) > timeout
) {
7734 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7735 ssize_t nread
, totread
= 0;
7736 time_t start
= time(NULL
);
7740 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7741 nread
= read(fd
,ptr
,size
);
7742 if (nread
== -1) return -1;
7747 if ((time(NULL
)-start
) > timeout
) {
7755 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7762 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7765 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7776 static void syncCommand(redisClient
*c
) {
7777 /* ignore SYNC if aleady slave or in monitor mode */
7778 if (c
->flags
& REDIS_SLAVE
) return;
7780 /* SYNC can't be issued when the server has pending data to send to
7781 * the client about already issued commands. We need a fresh reply
7782 * buffer registering the differences between the BGSAVE and the current
7783 * dataset, so that we can copy to other slaves if needed. */
7784 if (listLength(c
->reply
) != 0) {
7785 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7789 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7790 /* Here we need to check if there is a background saving operation
7791 * in progress, or if it is required to start one */
7792 if (server
.bgsavechildpid
!= -1) {
7793 /* Ok a background save is in progress. Let's check if it is a good
7794 * one for replication, i.e. if there is another slave that is
7795 * registering differences since the server forked to save */
7800 listRewind(server
.slaves
,&li
);
7801 while((ln
= listNext(&li
))) {
7803 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7806 /* Perfect, the server is already registering differences for
7807 * another slave. Set the right state, and copy the buffer. */
7808 listRelease(c
->reply
);
7809 c
->reply
= listDup(slave
->reply
);
7810 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7811 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7813 /* No way, we need to wait for the next BGSAVE in order to
7814 * register differences */
7815 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7816 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7819 /* Ok we don't have a BGSAVE in progress, let's start one */
7820 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7821 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7822 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7823 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7826 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7829 c
->flags
|= REDIS_SLAVE
;
7831 listAddNodeTail(server
.slaves
,c
);
7835 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7836 redisClient
*slave
= privdata
;
7838 REDIS_NOTUSED(mask
);
7839 char buf
[REDIS_IOBUF_LEN
];
7840 ssize_t nwritten
, buflen
;
7842 if (slave
->repldboff
== 0) {
7843 /* Write the bulk write count before to transfer the DB. In theory here
7844 * we don't know how much room there is in the output buffer of the
7845 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7846 * operations) will never be smaller than the few bytes we need. */
7849 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7851 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7859 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7860 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7862 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7863 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7867 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7868 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7873 slave
->repldboff
+= nwritten
;
7874 if (slave
->repldboff
== slave
->repldbsize
) {
7875 close(slave
->repldbfd
);
7876 slave
->repldbfd
= -1;
7877 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7878 slave
->replstate
= REDIS_REPL_ONLINE
;
7879 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7880 sendReplyToClient
, slave
) == AE_ERR
) {
7884 addReplySds(slave
,sdsempty());
7885 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7889 /* This function is called at the end of every backgrond saving.
7890 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7891 * otherwise REDIS_ERR is passed to the function.
7893 * The goal of this function is to handle slaves waiting for a successful
7894 * background saving in order to perform non-blocking synchronization. */
7895 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7897 int startbgsave
= 0;
7900 listRewind(server
.slaves
,&li
);
7901 while((ln
= listNext(&li
))) {
7902 redisClient
*slave
= ln
->value
;
7904 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7906 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7907 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7908 struct redis_stat buf
;
7910 if (bgsaveerr
!= REDIS_OK
) {
7912 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7915 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7916 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7918 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7921 slave
->repldboff
= 0;
7922 slave
->repldbsize
= buf
.st_size
;
7923 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7924 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7925 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7932 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7935 listRewind(server
.slaves
,&li
);
7936 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7937 while((ln
= listNext(&li
))) {
7938 redisClient
*slave
= ln
->value
;
7940 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7947 static int syncWithMaster(void) {
7948 char buf
[1024], tmpfile
[256], authcmd
[1024];
7950 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7951 int dfd
, maxtries
= 5;
7954 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7959 /* AUTH with the master if required. */
7960 if(server
.masterauth
) {
7961 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7962 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7964 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7968 /* Read the AUTH result. */
7969 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7971 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7975 if (buf
[0] != '+') {
7977 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7982 /* Issue the SYNC command */
7983 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7985 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7989 /* Read the bulk write count */
7990 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7992 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7996 if (buf
[0] != '$') {
7998 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8001 dumpsize
= strtol(buf
+1,NULL
,10);
8002 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8003 /* Read the bulk write data on a temp file */
8005 snprintf(tmpfile
,256,
8006 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8007 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8008 if (dfd
!= -1) break;
8013 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8017 int nread
, nwritten
;
8019 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8021 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8027 nwritten
= write(dfd
,buf
,nread
);
8028 if (nwritten
== -1) {
8029 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8037 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8038 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8044 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8045 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8049 server
.master
= createClient(fd
);
8050 server
.master
->flags
|= REDIS_MASTER
;
8051 server
.master
->authenticated
= 1;
8052 server
.replstate
= REDIS_REPL_CONNECTED
;
8056 static void slaveofCommand(redisClient
*c
) {
8057 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8058 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8059 if (server
.masterhost
) {
8060 sdsfree(server
.masterhost
);
8061 server
.masterhost
= NULL
;
8062 if (server
.master
) freeClient(server
.master
);
8063 server
.replstate
= REDIS_REPL_NONE
;
8064 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8067 sdsfree(server
.masterhost
);
8068 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8069 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8070 if (server
.master
) freeClient(server
.master
);
8071 server
.replstate
= REDIS_REPL_CONNECT
;
8072 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8073 server
.masterhost
, server
.masterport
);
8075 addReply(c
,shared
.ok
);
8078 /* ============================ Maxmemory directive ======================== */
8080 /* Try to free one object form the pre-allocated objects free list.
8081 * This is useful under low mem conditions as by default we take 1 million
8082 * free objects allocated. On success REDIS_OK is returned, otherwise
8084 static int tryFreeOneObjectFromFreelist(void) {
8087 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8088 if (listLength(server
.objfreelist
)) {
8089 listNode
*head
= listFirst(server
.objfreelist
);
8090 o
= listNodeValue(head
);
8091 listDelNode(server
.objfreelist
,head
);
8092 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8096 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8101 /* This function gets called when 'maxmemory' is set on the config file to limit
8102 * the max memory used by the server, and we are out of memory.
8103 * This function will try to, in order:
8105 * - Free objects from the free list
8106 * - Try to remove keys with an EXPIRE set
8108 * It is not possible to free enough memory to reach used-memory < maxmemory
8109 * the server will start refusing commands that will enlarge even more the
8112 static void freeMemoryIfNeeded(void) {
8113 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8114 int j
, k
, freed
= 0;
8116 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8117 for (j
= 0; j
< server
.dbnum
; j
++) {
8119 robj
*minkey
= NULL
;
8120 struct dictEntry
*de
;
8122 if (dictSize(server
.db
[j
].expires
)) {
8124 /* From a sample of three keys drop the one nearest to
8125 * the natural expire */
8126 for (k
= 0; k
< 3; k
++) {
8129 de
= dictGetRandomKey(server
.db
[j
].expires
);
8130 t
= (time_t) dictGetEntryVal(de
);
8131 if (minttl
== -1 || t
< minttl
) {
8132 minkey
= dictGetEntryKey(de
);
8136 deleteKey(server
.db
+j
,minkey
);
8139 if (!freed
) return; /* nothing to free... */
8143 /* ============================== Append Only file ========================== */
8145 /* Write the append only file buffer on disk.
8147 * Since we are required to write the AOF before replying to the client,
8148 * and the only way the client socket can get a write is entering when the
8149 * the event loop, we accumulate all the AOF writes in a memory
8150 * buffer and write it on disk using this function just before entering
8151 * the event loop again. */
8152 static void flushAppendOnlyFile(void) {
8156 if (sdslen(server
.aofbuf
) == 0) return;
8158 /* We want to perform a single write. This should be guaranteed atomic
8159 * at least if the filesystem we are writing is a real physical one.
8160 * While this will save us against the server being killed I don't think
8161 * there is much to do about the whole server stopping for power problems
8163 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8164 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8165 /* Ooops, we are in troubles. The best thing to do for now is
8166 * aborting instead of giving the illusion that everything is
8167 * working as expected. */
8168 if (nwritten
== -1) {
8169 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8171 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8175 sdsfree(server
.aofbuf
);
8176 server
.aofbuf
= sdsempty();
8178 /* Fsync if needed */
8180 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8181 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8182 now
-server
.lastfsync
> 1))
8184 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8185 * flushing metadata. */
8186 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8187 server
.lastfsync
= now
;
8191 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8193 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8194 for (j
= 0; j
< argc
; j
++) {
8195 robj
*o
= getDecodedObject(argv
[j
]);
8196 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8197 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8198 buf
= sdscatlen(buf
,"\r\n",2);
8204 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8209 /* Make sure we can use strtol */
8210 seconds
= getDecodedObject(seconds
);
8211 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8212 decrRefCount(seconds
);
8214 argv
[0] = createStringObject("EXPIREAT",8);
8216 argv
[2] = createObject(REDIS_STRING
,
8217 sdscatprintf(sdsempty(),"%ld",when
));
8218 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8219 decrRefCount(argv
[0]);
8220 decrRefCount(argv
[2]);
8224 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8225 sds buf
= sdsempty();
8228 /* The DB this command was targetting is not the same as the last command
8229 * we appendend. To issue a SELECT command is needed. */
8230 if (dictid
!= server
.appendseldb
) {
8233 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8234 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8235 (unsigned long)strlen(seldb
),seldb
);
8236 server
.appendseldb
= dictid
;
8239 if (cmd
->proc
== expireCommand
) {
8240 /* Translate EXPIRE into EXPIREAT */
8241 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8242 } else if (cmd
->proc
== setexCommand
) {
8243 /* Translate SETEX to SET and EXPIREAT */
8244 tmpargv
[0] = createStringObject("SET",3);
8245 tmpargv
[1] = argv
[1];
8246 tmpargv
[2] = argv
[3];
8247 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8248 decrRefCount(tmpargv
[0]);
8249 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8251 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8254 /* Append to the AOF buffer. This will be flushed on disk just before
8255 * of re-entering the event loop, so before the client will get a
8256 * positive reply about the operation performed. */
8257 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8259 /* If a background append only file rewriting is in progress we want to
8260 * accumulate the differences between the child DB and the current one
8261 * in a buffer, so that when the child process will do its work we
8262 * can append the differences to the new append only file. */
8263 if (server
.bgrewritechildpid
!= -1)
8264 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8269 /* In Redis commands are always executed in the context of a client, so in
8270 * order to load the append only file we need to create a fake client. */
8271 static struct redisClient
*createFakeClient(void) {
8272 struct redisClient
*c
= zmalloc(sizeof(*c
));
8276 c
->querybuf
= sdsempty();
8280 /* We set the fake client as a slave waiting for the synchronization
8281 * so that Redis will not try to send replies to this client. */
8282 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8283 c
->reply
= listCreate();
8284 listSetFreeMethod(c
->reply
,decrRefCount
);
8285 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8286 initClientMultiState(c
);
8290 static void freeFakeClient(struct redisClient
*c
) {
8291 sdsfree(c
->querybuf
);
8292 listRelease(c
->reply
);
8293 freeClientMultiState(c
);
8297 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8298 * error (the append only file is zero-length) REDIS_ERR is returned. On
8299 * fatal error an error message is logged and the program exists. */
8300 int loadAppendOnlyFile(char *filename
) {
8301 struct redisClient
*fakeClient
;
8302 FILE *fp
= fopen(filename
,"r");
8303 struct redis_stat sb
;
8304 unsigned long long loadedkeys
= 0;
8305 int appendonly
= server
.appendonly
;
8307 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8311 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8315 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8316 * to the same file we're about to read. */
8317 server
.appendonly
= 0;
8319 fakeClient
= createFakeClient();
8326 struct redisCommand
*cmd
;
8328 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8334 if (buf
[0] != '*') goto fmterr
;
8336 argv
= zmalloc(sizeof(robj
*)*argc
);
8337 for (j
= 0; j
< argc
; j
++) {
8338 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8339 if (buf
[0] != '$') goto fmterr
;
8340 len
= strtol(buf
+1,NULL
,10);
8341 argsds
= sdsnewlen(NULL
,len
);
8342 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8343 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8344 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8347 /* Command lookup */
8348 cmd
= lookupCommand(argv
[0]->ptr
);
8350 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8353 /* Try object encoding */
8354 if (cmd
->flags
& REDIS_CMD_BULK
)
8355 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8356 /* Run the command in the context of a fake client */
8357 fakeClient
->argc
= argc
;
8358 fakeClient
->argv
= argv
;
8359 cmd
->proc(fakeClient
);
8360 /* Discard the reply objects list from the fake client */
8361 while(listLength(fakeClient
->reply
))
8362 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8363 /* Clean up, ready for the next command */
8364 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8366 /* Handle swapping while loading big datasets when VM is on */
8368 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8369 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8370 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8375 /* This point can only be reached when EOF is reached without errors.
8376 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8377 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8380 freeFakeClient(fakeClient
);
8381 server
.appendonly
= appendonly
;
8386 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8388 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8392 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8396 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8397 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8401 /* Avoid the incr/decr ref count business if possible to help
8402 * copy-on-write (we are often in a child process when this function
8404 * Also makes sure that key objects don't get incrRefCount-ed when VM
8406 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8407 obj
= getDecodedObject(obj
);
8410 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8411 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8412 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8414 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8415 if (decrrc
) decrRefCount(obj
);
8418 if (decrrc
) decrRefCount(obj
);
8422 /* Write binary-safe string into a file in the bulkformat
8423 * $<count>\r\n<payload>\r\n */
8424 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8427 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8428 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8429 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8430 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8434 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8435 static int fwriteBulkDouble(FILE *fp
, double d
) {
8436 char buf
[128], dbuf
[128];
8438 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8439 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8440 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8441 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8445 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8446 static int fwriteBulkLong(FILE *fp
, long l
) {
8447 char buf
[128], lbuf
[128];
8449 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8450 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8451 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8452 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8456 /* Write a sequence of commands able to fully rebuild the dataset into
8457 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8458 static int rewriteAppendOnlyFile(char *filename
) {
8459 dictIterator
*di
= NULL
;
8464 time_t now
= time(NULL
);
8466 /* Note that we have to use a different temp name here compared to the
8467 * one used by rewriteAppendOnlyFileBackground() function. */
8468 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8469 fp
= fopen(tmpfile
,"w");
8471 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8474 for (j
= 0; j
< server
.dbnum
; j
++) {
8475 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8476 redisDb
*db
= server
.db
+j
;
8478 if (dictSize(d
) == 0) continue;
8479 di
= dictGetIterator(d
);
8485 /* SELECT the new DB */
8486 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8487 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8489 /* Iterate this DB writing every entry */
8490 while((de
= dictNext(di
)) != NULL
) {
8495 key
= dictGetEntryKey(de
);
8496 /* If the value for this key is swapped, load a preview in memory.
8497 * We use a "swapped" flag to remember if we need to free the
8498 * value object instead to just increment the ref count anyway
8499 * in order to avoid copy-on-write of pages if we are forked() */
8500 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8501 key
->storage
== REDIS_VM_SWAPPING
) {
8502 o
= dictGetEntryVal(de
);
8505 o
= vmPreviewObject(key
);
8508 expiretime
= getExpire(db
,key
);
8510 /* Save the key and associated value */
8511 if (o
->type
== REDIS_STRING
) {
8512 /* Emit a SET command */
8513 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8514 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8516 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8517 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8518 } else if (o
->type
== REDIS_LIST
) {
8519 /* Emit the RPUSHes needed to rebuild the list */
8520 list
*list
= o
->ptr
;
8524 listRewind(list
,&li
);
8525 while((ln
= listNext(&li
))) {
8526 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8527 robj
*eleobj
= listNodeValue(ln
);
8529 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8530 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8531 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8533 } else if (o
->type
== REDIS_SET
) {
8534 /* Emit the SADDs needed to rebuild the set */
8536 dictIterator
*di
= dictGetIterator(set
);
8539 while((de
= dictNext(di
)) != NULL
) {
8540 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8541 robj
*eleobj
= dictGetEntryKey(de
);
8543 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8544 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8545 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8547 dictReleaseIterator(di
);
8548 } else if (o
->type
== REDIS_ZSET
) {
8549 /* Emit the ZADDs needed to rebuild the sorted set */
8551 dictIterator
*di
= dictGetIterator(zs
->dict
);
8554 while((de
= dictNext(di
)) != NULL
) {
8555 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8556 robj
*eleobj
= dictGetEntryKey(de
);
8557 double *score
= dictGetEntryVal(de
);
8559 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8560 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8561 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8562 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8564 dictReleaseIterator(di
);
8565 } else if (o
->type
== REDIS_HASH
) {
8566 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8568 /* Emit the HSETs needed to rebuild the hash */
8569 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8570 unsigned char *p
= zipmapRewind(o
->ptr
);
8571 unsigned char *field
, *val
;
8572 unsigned int flen
, vlen
;
8574 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8575 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8576 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8577 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8579 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8583 dictIterator
*di
= dictGetIterator(o
->ptr
);
8586 while((de
= dictNext(di
)) != NULL
) {
8587 robj
*field
= dictGetEntryKey(de
);
8588 robj
*val
= dictGetEntryVal(de
);
8590 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8591 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8592 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8593 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8595 dictReleaseIterator(di
);
8598 redisPanic("Unknown object type");
8600 /* Save the expire time */
8601 if (expiretime
!= -1) {
8602 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8603 /* If this key is already expired skip it */
8604 if (expiretime
< now
) continue;
8605 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8606 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8607 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8609 if (swapped
) decrRefCount(o
);
8611 dictReleaseIterator(di
);
8614 /* Make sure data will not remain on the OS's output buffers */
8619 /* Use RENAME to make sure the DB file is changed atomically only
8620 * if the generate DB file is ok. */
8621 if (rename(tmpfile
,filename
) == -1) {
8622 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8626 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8632 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8633 if (di
) dictReleaseIterator(di
);
8637 /* This is how rewriting of the append only file in background works:
8639 * 1) The user calls BGREWRITEAOF
8640 * 2) Redis calls this function, that forks():
8641 * 2a) the child rewrite the append only file in a temp file.
8642 * 2b) the parent accumulates differences in server.bgrewritebuf.
8643 * 3) When the child finished '2a' exists.
8644 * 4) The parent will trap the exit code, if it's OK, will append the
8645 * data accumulated into server.bgrewritebuf into the temp file, and
8646 * finally will rename(2) the temp file in the actual file name.
8647 * The the new file is reopened as the new append only file. Profit!
8649 static int rewriteAppendOnlyFileBackground(void) {
8652 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8653 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8654 if ((childpid
= fork()) == 0) {
8658 if (server
.vm_enabled
) vmReopenSwapFile();
8660 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8661 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8668 if (childpid
== -1) {
8669 redisLog(REDIS_WARNING
,
8670 "Can't rewrite append only file in background: fork: %s",
8674 redisLog(REDIS_NOTICE
,
8675 "Background append only file rewriting started by pid %d",childpid
);
8676 server
.bgrewritechildpid
= childpid
;
8677 updateDictResizePolicy();
8678 /* We set appendseldb to -1 in order to force the next call to the
8679 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8680 * accumulated by the parent into server.bgrewritebuf will start
8681 * with a SELECT statement and it will be safe to merge. */
8682 server
.appendseldb
= -1;
8685 return REDIS_OK
; /* unreached */
8688 static void bgrewriteaofCommand(redisClient
*c
) {
8689 if (server
.bgrewritechildpid
!= -1) {
8690 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8693 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8694 char *status
= "+Background append only file rewriting started\r\n";
8695 addReplySds(c
,sdsnew(status
));
8697 addReply(c
,shared
.err
);
8701 static void aofRemoveTempFile(pid_t childpid
) {
8704 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8708 /* Virtual Memory is composed mainly of two subsystems:
8709 * - Blocking Virutal Memory
8710 * - Threaded Virtual Memory I/O
8711 * The two parts are not fully decoupled, but functions are split among two
8712 * different sections of the source code (delimited by comments) in order to
8713 * make more clear what functionality is about the blocking VM and what about
8714 * the threaded (not blocking) VM.
8718 * Redis VM is a blocking VM (one that blocks reading swapped values from
8719 * disk into memory when a value swapped out is needed in memory) that is made
8720 * unblocking by trying to examine the command argument vector in order to
8721 * load in background values that will likely be needed in order to exec
8722 * the command. The command is executed only once all the relevant keys
8723 * are loaded into memory.
8725 * This basically is almost as simple of a blocking VM, but almost as parallel
8726 * as a fully non-blocking VM.
8729 /* =================== Virtual Memory - Blocking Side ====================== */
8731 static void vmInit(void) {
8737 if (server
.vm_max_threads
!= 0)
8738 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8740 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8741 /* Try to open the old swap file, otherwise create it */
8742 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8743 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8745 if (server
.vm_fp
== NULL
) {
8746 redisLog(REDIS_WARNING
,
8747 "Can't open the swap file: %s. Exiting.",
8751 server
.vm_fd
= fileno(server
.vm_fp
);
8752 /* Lock the swap file for writing, this is useful in order to avoid
8753 * another instance to use the same swap file for a config error. */
8754 fl
.l_type
= F_WRLCK
;
8755 fl
.l_whence
= SEEK_SET
;
8756 fl
.l_start
= fl
.l_len
= 0;
8757 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8758 redisLog(REDIS_WARNING
,
8759 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server
.vm_swap_file
, strerror(errno
));
8763 server
.vm_next_page
= 0;
8764 server
.vm_near_pages
= 0;
8765 server
.vm_stats_used_pages
= 0;
8766 server
.vm_stats_swapped_objects
= 0;
8767 server
.vm_stats_swapouts
= 0;
8768 server
.vm_stats_swapins
= 0;
8769 totsize
= server
.vm_pages
*server
.vm_page_size
;
8770 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8771 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8772 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8776 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8778 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8779 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8780 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8781 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8783 /* Initialize threaded I/O (used by Virtual Memory) */
8784 server
.io_newjobs
= listCreate();
8785 server
.io_processing
= listCreate();
8786 server
.io_processed
= listCreate();
8787 server
.io_ready_clients
= listCreate();
8788 pthread_mutex_init(&server
.io_mutex
,NULL
);
8789 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8790 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8791 server
.io_active_threads
= 0;
8792 if (pipe(pipefds
) == -1) {
8793 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8797 server
.io_ready_pipe_read
= pipefds
[0];
8798 server
.io_ready_pipe_write
= pipefds
[1];
8799 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8800 /* LZF requires a lot of stack */
8801 pthread_attr_init(&server
.io_threads_attr
);
8802 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8803 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8804 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8805 /* Listen for events in the threaded I/O pipe */
8806 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8807 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8808 oom("creating file event");
8811 /* Mark the page as used */
8812 static void vmMarkPageUsed(off_t page
) {
8813 off_t byte
= page
/8;
8815 redisAssert(vmFreePage(page
) == 1);
8816 server
.vm_bitmap
[byte
] |= 1<<bit
;
8819 /* Mark N contiguous pages as used, with 'page' being the first. */
8820 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8823 for (j
= 0; j
< count
; j
++)
8824 vmMarkPageUsed(page
+j
);
8825 server
.vm_stats_used_pages
+= count
;
8826 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8827 (long long)count
, (long long)page
);
8830 /* Mark the page as free */
8831 static void vmMarkPageFree(off_t page
) {
8832 off_t byte
= page
/8;
8834 redisAssert(vmFreePage(page
) == 0);
8835 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8838 /* Mark N contiguous pages as free, with 'page' being the first. */
8839 static void vmMarkPagesFree(off_t page
, off_t count
) {
8842 for (j
= 0; j
< count
; j
++)
8843 vmMarkPageFree(page
+j
);
8844 server
.vm_stats_used_pages
-= count
;
8845 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8846 (long long)count
, (long long)page
);
8849 /* Test if the page is free */
8850 static int vmFreePage(off_t page
) {
8851 off_t byte
= page
/8;
8853 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8856 /* Find N contiguous free pages storing the first page of the cluster in *first.
8857 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8858 * REDIS_ERR is returned.
8860 * This function uses a simple algorithm: we try to allocate
8861 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8862 * again from the start of the swap file searching for free spaces.
8864 * If it looks pretty clear that there are no free pages near our offset
8865 * we try to find less populated places doing a forward jump of
8866 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8867 * without hurry, and then we jump again and so forth...
8869 * This function can be improved using a free list to avoid to guess
8870 * too much, since we could collect data about freed pages.
8872 * note: I implemented this function just after watching an episode of
8873 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8875 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8876 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8878 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8879 server
.vm_near_pages
= 0;
8880 server
.vm_next_page
= 0;
8882 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8883 base
= server
.vm_next_page
;
8885 while(offset
< server
.vm_pages
) {
8886 off_t
this = base
+offset
;
8888 /* If we overflow, restart from page zero */
8889 if (this >= server
.vm_pages
) {
8890 this -= server
.vm_pages
;
8892 /* Just overflowed, what we found on tail is no longer
8893 * interesting, as it's no longer contiguous. */
8897 if (vmFreePage(this)) {
8898 /* This is a free page */
8900 /* Already got N free pages? Return to the caller, with success */
8902 *first
= this-(n
-1);
8903 server
.vm_next_page
= this+1;
8904 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8908 /* The current one is not a free page */
8912 /* Fast-forward if the current page is not free and we already
8913 * searched enough near this place. */
8915 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8916 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8918 /* Note that even if we rewind after the jump, we are don't need
8919 * to make sure numfree is set to zero as we only jump *if* it
8920 * is set to zero. */
8922 /* Otherwise just check the next page */
8929 /* Write the specified object at the specified page of the swap file */
8930 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8931 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8932 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8933 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8934 redisLog(REDIS_WARNING
,
8935 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8939 rdbSaveObject(server
.vm_fp
,o
);
8940 fflush(server
.vm_fp
);
8941 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8945 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8946 * needed to later retrieve the object into the key object.
8947 * If we can't find enough contiguous empty pages to swap the object on disk
8948 * REDIS_ERR is returned. */
8949 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8950 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8953 assert(key
->storage
== REDIS_VM_MEMORY
);
8954 assert(key
->refcount
== 1);
8955 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8956 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8957 key
->vm
.page
= page
;
8958 key
->vm
.usedpages
= pages
;
8959 key
->storage
= REDIS_VM_SWAPPED
;
8960 key
->vtype
= val
->type
;
8961 decrRefCount(val
); /* Deallocate the object from memory. */
8962 vmMarkPagesUsed(page
,pages
);
8963 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8964 (unsigned char*) key
->ptr
,
8965 (unsigned long long) page
, (unsigned long long) pages
);
8966 server
.vm_stats_swapped_objects
++;
8967 server
.vm_stats_swapouts
++;
8971 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8974 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8975 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8976 redisLog(REDIS_WARNING
,
8977 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8981 o
= rdbLoadObject(type
,server
.vm_fp
);
8983 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8986 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8990 /* Load the value object relative to the 'key' object from swap to memory.
8991 * The newly allocated object is returned.
8993 * If preview is true the unserialized object is returned to the caller but
8994 * no changes are made to the key object, nor the pages are marked as freed */
8995 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8998 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8999 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
9001 key
->storage
= REDIS_VM_MEMORY
;
9002 key
->vm
.atime
= server
.unixtime
;
9003 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9004 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
9005 (unsigned char*) key
->ptr
);
9006 server
.vm_stats_swapped_objects
--;
9008 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
9009 (unsigned char*) key
->ptr
);
9011 server
.vm_stats_swapins
++;
9015 /* Plain object loading, from swap to memory */
9016 static robj
*vmLoadObject(robj
*key
) {
9017 /* If we are loading the object in background, stop it, we
9018 * need to load this object synchronously ASAP. */
9019 if (key
->storage
== REDIS_VM_LOADING
)
9020 vmCancelThreadedIOJob(key
);
9021 return vmGenericLoadObject(key
,0);
9024 /* Just load the value on disk, without to modify the key.
9025 * This is useful when we want to perform some operation on the value
9026 * without to really bring it from swap to memory, like while saving the
9027 * dataset or rewriting the append only log. */
9028 static robj
*vmPreviewObject(robj
*key
) {
9029 return vmGenericLoadObject(key
,1);
9032 /* How a good candidate is this object for swapping?
9033 * The better candidate it is, the greater the returned value.
9035 * Currently we try to perform a fast estimation of the object size in
9036 * memory, and combine it with aging informations.
9038 * Basically swappability = idle-time * log(estimated size)
9040 * Bigger objects are preferred over smaller objects, but not
9041 * proportionally, this is why we use the logarithm. This algorithm is
9042 * just a first try and will probably be tuned later. */
9043 static double computeObjectSwappability(robj
*o
) {
9044 time_t age
= server
.unixtime
- o
->vm
.atime
;
9048 struct dictEntry
*de
;
9051 if (age
<= 0) return 0;
9054 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9057 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9062 listNode
*ln
= listFirst(l
);
9064 asize
= sizeof(list
);
9066 robj
*ele
= ln
->value
;
9069 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9070 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9072 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9077 z
= (o
->type
== REDIS_ZSET
);
9078 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9080 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9081 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9086 de
= dictGetRandomKey(d
);
9087 ele
= dictGetEntryKey(de
);
9088 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9089 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9091 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9092 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9096 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9097 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9098 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9099 unsigned int klen
, vlen
;
9100 unsigned char *key
, *val
;
9102 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9106 asize
= len
*(klen
+vlen
+3);
9107 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9109 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9114 de
= dictGetRandomKey(d
);
9115 ele
= dictGetEntryKey(de
);
9116 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9117 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9119 ele
= dictGetEntryVal(de
);
9120 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9121 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9123 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9128 return (double)age
*log(1+asize
);
9131 /* Try to swap an object that's a good candidate for swapping.
9132 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9133 * to swap any object at all.
9135 * If 'usethreaded' is true, Redis will try to swap the object in background
9136 * using I/O threads. */
9137 static int vmSwapOneObject(int usethreads
) {
9139 struct dictEntry
*best
= NULL
;
9140 double best_swappability
= 0;
9141 redisDb
*best_db
= NULL
;
9144 for (j
= 0; j
< server
.dbnum
; j
++) {
9145 redisDb
*db
= server
.db
+j
;
9146 /* Why maxtries is set to 100?
9147 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9148 * are swappable objects */
9151 if (dictSize(db
->dict
) == 0) continue;
9152 for (i
= 0; i
< 5; i
++) {
9154 double swappability
;
9156 if (maxtries
) maxtries
--;
9157 de
= dictGetRandomKey(db
->dict
);
9158 key
= dictGetEntryKey(de
);
9159 val
= dictGetEntryVal(de
);
9160 /* Only swap objects that are currently in memory.
9162 * Also don't swap shared objects if threaded VM is on, as we
9163 * try to ensure that the main thread does not touch the
9164 * object while the I/O thread is using it, but we can't
9165 * control other keys without adding additional mutex. */
9166 if (key
->storage
!= REDIS_VM_MEMORY
||
9167 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9168 if (maxtries
) i
--; /* don't count this try */
9171 swappability
= computeObjectSwappability(val
);
9172 if (!best
|| swappability
> best_swappability
) {
9174 best_swappability
= swappability
;
9179 if (best
== NULL
) return REDIS_ERR
;
9180 key
= dictGetEntryKey(best
);
9181 val
= dictGetEntryVal(best
);
9183 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9184 key
->ptr
, best_swappability
);
9186 /* Unshare the key if needed */
9187 if (key
->refcount
> 1) {
9188 robj
*newkey
= dupStringObject(key
);
9190 key
= dictGetEntryKey(best
) = newkey
;
9194 vmSwapObjectThreaded(key
,val
,best_db
);
9197 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9198 dictGetEntryVal(best
) = NULL
;
9206 static int vmSwapOneObjectBlocking() {
9207 return vmSwapOneObject(0);
9210 static int vmSwapOneObjectThreaded() {
9211 return vmSwapOneObject(1);
9214 /* Return true if it's safe to swap out objects in a given moment.
9215 * Basically we don't want to swap objects out while there is a BGSAVE
9216 * or a BGAEOREWRITE running in backgroud. */
9217 static int vmCanSwapOut(void) {
9218 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9221 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9222 * and was deleted. Otherwise 0 is returned. */
9223 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9227 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9228 foundkey
= dictGetEntryKey(de
);
9229 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9234 /* =================== Virtual Memory - Threaded I/O ======================= */
9236 static void freeIOJob(iojob
*j
) {
9237 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9238 j
->type
== REDIS_IOJOB_DO_SWAP
||
9239 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9240 decrRefCount(j
->val
);
9241 /* We don't decrRefCount the j->key field as we did't incremented
9242 * the count creating IO Jobs. This is because the key field here is
9243 * just used as an indentifier and if a key is removed the Job should
9244 * never be touched again. */
9248 /* Every time a thread finished a Job, it writes a byte into the write side
9249 * of an unix pipe in order to "awake" the main thread, and this function
9251 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9255 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9257 REDIS_NOTUSED(mask
);
9258 REDIS_NOTUSED(privdata
);
9260 /* For every byte we read in the read side of the pipe, there is one
9261 * I/O job completed to process. */
9262 while((retval
= read(fd
,buf
,1)) == 1) {
9266 struct dictEntry
*de
;
9268 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9270 /* Get the processed element (the oldest one) */
9272 assert(listLength(server
.io_processed
) != 0);
9273 if (toprocess
== -1) {
9274 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9275 if (toprocess
<= 0) toprocess
= 1;
9277 ln
= listFirst(server
.io_processed
);
9279 listDelNode(server
.io_processed
,ln
);
9281 /* If this job is marked as canceled, just ignore it */
9286 /* Post process it in the main thread, as there are things we
9287 * can do just here to avoid race conditions and/or invasive locks */
9288 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
);
9289 de
= dictFind(j
->db
->dict
,j
->key
);
9291 key
= dictGetEntryKey(de
);
9292 if (j
->type
== REDIS_IOJOB_LOAD
) {
9295 /* Key loaded, bring it at home */
9296 key
->storage
= REDIS_VM_MEMORY
;
9297 key
->vm
.atime
= server
.unixtime
;
9298 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9299 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9300 (unsigned char*) key
->ptr
);
9301 server
.vm_stats_swapped_objects
--;
9302 server
.vm_stats_swapins
++;
9303 dictGetEntryVal(de
) = j
->val
;
9304 incrRefCount(j
->val
);
9307 /* Handle clients waiting for this key to be loaded. */
9308 handleClientsBlockedOnSwappedKey(db
,key
);
9309 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9310 /* Now we know the amount of pages required to swap this object.
9311 * Let's find some space for it, and queue this task again
9312 * rebranded as REDIS_IOJOB_DO_SWAP. */
9313 if (!vmCanSwapOut() ||
9314 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9316 /* Ooops... no space or we can't swap as there is
9317 * a fork()ed Redis trying to save stuff on disk. */
9319 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9321 /* Note that we need to mark this pages as used now,
9322 * if the job will be canceled, we'll mark them as freed
9324 vmMarkPagesUsed(j
->page
,j
->pages
);
9325 j
->type
= REDIS_IOJOB_DO_SWAP
;
9330 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9333 /* Key swapped. We can finally free some memory. */
9334 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9335 printf("key->storage: %d\n",key
->storage
);
9336 printf("key->name: %s\n",(char*)key
->ptr
);
9337 printf("key->refcount: %d\n",key
->refcount
);
9338 printf("val: %p\n",(void*)j
->val
);
9339 printf("val->type: %d\n",j
->val
->type
);
9340 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9342 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9343 val
= dictGetEntryVal(de
);
9344 key
->vm
.page
= j
->page
;
9345 key
->vm
.usedpages
= j
->pages
;
9346 key
->storage
= REDIS_VM_SWAPPED
;
9347 key
->vtype
= j
->val
->type
;
9348 decrRefCount(val
); /* Deallocate the object from memory. */
9349 dictGetEntryVal(de
) = NULL
;
9350 redisLog(REDIS_DEBUG
,
9351 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9352 (unsigned char*) key
->ptr
,
9353 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9354 server
.vm_stats_swapped_objects
++;
9355 server
.vm_stats_swapouts
++;
9357 /* Put a few more swap requests in queue if we are still
9359 if (trytoswap
&& vmCanSwapOut() &&
9360 zmalloc_used_memory() > server
.vm_max_memory
)
9365 more
= listLength(server
.io_newjobs
) <
9366 (unsigned) server
.vm_max_threads
;
9368 /* Don't waste CPU time if swappable objects are rare. */
9369 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9377 if (processed
== toprocess
) return;
9379 if (retval
< 0 && errno
!= EAGAIN
) {
9380 redisLog(REDIS_WARNING
,
9381 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9386 static void lockThreadedIO(void) {
9387 pthread_mutex_lock(&server
.io_mutex
);
9390 static void unlockThreadedIO(void) {
9391 pthread_mutex_unlock(&server
.io_mutex
);
9394 /* Remove the specified object from the threaded I/O queue if still not
9395 * processed, otherwise make sure to flag it as canceled. */
9396 static void vmCancelThreadedIOJob(robj
*o
) {
9398 server
.io_newjobs
, /* 0 */
9399 server
.io_processing
, /* 1 */
9400 server
.io_processed
/* 2 */
9404 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9407 /* Search for a matching key in one of the queues */
9408 for (i
= 0; i
< 3; i
++) {
9412 listRewind(lists
[i
],&li
);
9413 while ((ln
= listNext(&li
)) != NULL
) {
9414 iojob
*job
= ln
->value
;
9416 if (job
->canceled
) continue; /* Skip this, already canceled. */
9417 if (job
->key
== o
) {
9418 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9419 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9420 /* Mark the pages as free since the swap didn't happened
9421 * or happened but is now discarded. */
9422 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9423 vmMarkPagesFree(job
->page
,job
->pages
);
9424 /* Cancel the job. It depends on the list the job is
9427 case 0: /* io_newjobs */
9428 /* If the job was yet not processed the best thing to do
9429 * is to remove it from the queue at all */
9431 listDelNode(lists
[i
],ln
);
9433 case 1: /* io_processing */
9434 /* Oh Shi- the thread is messing with the Job:
9436 * Probably it's accessing the object if this is a
9437 * PREPARE_SWAP or DO_SWAP job.
9438 * If it's a LOAD job it may be reading from disk and
9439 * if we don't wait for the job to terminate before to
9440 * cancel it, maybe in a few microseconds data can be
9441 * corrupted in this pages. So the short story is:
9443 * Better to wait for the job to move into the
9444 * next queue (processed)... */
9446 /* We try again and again until the job is completed. */
9448 /* But let's wait some time for the I/O thread
9449 * to finish with this job. After all this condition
9450 * should be very rare. */
9453 case 2: /* io_processed */
9454 /* The job was already processed, that's easy...
9455 * just mark it as canceled so that we'll ignore it
9456 * when processing completed jobs. */
9460 /* Finally we have to adjust the storage type of the object
9461 * in order to "UNDO" the operaiton. */
9462 if (o
->storage
== REDIS_VM_LOADING
)
9463 o
->storage
= REDIS_VM_SWAPPED
;
9464 else if (o
->storage
== REDIS_VM_SWAPPING
)
9465 o
->storage
= REDIS_VM_MEMORY
;
9472 assert(1 != 1); /* We should never reach this */
9475 static void *IOThreadEntryPoint(void *arg
) {
9480 pthread_detach(pthread_self());
9482 /* Get a new job to process */
9484 if (listLength(server
.io_newjobs
) == 0) {
9485 /* No new jobs in queue, exit. */
9486 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9487 (long) pthread_self());
9488 server
.io_active_threads
--;
9492 ln
= listFirst(server
.io_newjobs
);
9494 listDelNode(server
.io_newjobs
,ln
);
9495 /* Add the job in the processing queue */
9496 j
->thread
= pthread_self();
9497 listAddNodeTail(server
.io_processing
,j
);
9498 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9500 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9501 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9503 /* Process the Job */
9504 if (j
->type
== REDIS_IOJOB_LOAD
) {
9505 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9506 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9507 FILE *fp
= fopen("/dev/null","w+");
9508 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9510 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9511 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9515 /* Done: insert the job into the processed queue */
9516 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9517 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9519 listDelNode(server
.io_processing
,ln
);
9520 listAddNodeTail(server
.io_processed
,j
);
9523 /* Signal the main thread there is new stuff to process */
9524 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9526 return NULL
; /* never reached */
9529 static void spawnIOThread(void) {
9531 sigset_t mask
, omask
;
9535 sigaddset(&mask
,SIGCHLD
);
9536 sigaddset(&mask
,SIGHUP
);
9537 sigaddset(&mask
,SIGPIPE
);
9538 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9539 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9540 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9544 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9545 server
.io_active_threads
++;
9548 /* We need to wait for the last thread to exit before we are able to
9549 * fork() in order to BGSAVE or BGREWRITEAOF. */
9550 static void waitEmptyIOJobsQueue(void) {
9552 int io_processed_len
;
9555 if (listLength(server
.io_newjobs
) == 0 &&
9556 listLength(server
.io_processing
) == 0 &&
9557 server
.io_active_threads
== 0)
9562 /* While waiting for empty jobs queue condition we post-process some
9563 * finshed job, as I/O threads may be hanging trying to write against
9564 * the io_ready_pipe_write FD but there are so much pending jobs that
9566 io_processed_len
= listLength(server
.io_processed
);
9568 if (io_processed_len
) {
9569 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9570 usleep(1000); /* 1 millisecond */
9572 usleep(10000); /* 10 milliseconds */
9577 static void vmReopenSwapFile(void) {
9578 /* Note: we don't close the old one as we are in the child process
9579 * and don't want to mess at all with the original file object. */
9580 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9581 if (server
.vm_fp
== NULL
) {
9582 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9583 server
.vm_swap_file
);
9586 server
.vm_fd
= fileno(server
.vm_fp
);
9589 /* This function must be called while with threaded IO locked */
9590 static void queueIOJob(iojob
*j
) {
9591 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9592 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9593 listAddNodeTail(server
.io_newjobs
,j
);
9594 if (server
.io_active_threads
< server
.vm_max_threads
)
9598 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9601 assert(key
->storage
== REDIS_VM_MEMORY
);
9602 assert(key
->refcount
== 1);
9604 j
= zmalloc(sizeof(*j
));
9605 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9611 j
->thread
= (pthread_t
) -1;
9612 key
->storage
= REDIS_VM_SWAPPING
;
9620 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9622 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9623 * If there is not already a job loading the key, it is craeted.
9624 * The key is added to the io_keys list in the client structure, and also
9625 * in the hash table mapping swapped keys to waiting clients, that is,
9626 * server.io_waited_keys. */
9627 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9628 struct dictEntry
*de
;
9632 /* If the key does not exist or is already in RAM we don't need to
9633 * block the client at all. */
9634 de
= dictFind(c
->db
->dict
,key
);
9635 if (de
== NULL
) return 0;
9636 o
= dictGetEntryKey(de
);
9637 if (o
->storage
== REDIS_VM_MEMORY
) {
9639 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9640 /* We were swapping the key, undo it! */
9641 vmCancelThreadedIOJob(o
);
9645 /* OK: the key is either swapped, or being loaded just now. */
9647 /* Add the key to the list of keys this client is waiting for.
9648 * This maps clients to keys they are waiting for. */
9649 listAddNodeTail(c
->io_keys
,key
);
9652 /* Add the client to the swapped keys => clients waiting map. */
9653 de
= dictFind(c
->db
->io_keys
,key
);
9657 /* For every key we take a list of clients blocked for it */
9659 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9661 assert(retval
== DICT_OK
);
9663 l
= dictGetEntryVal(de
);
9665 listAddNodeTail(l
,c
);
9667 /* Are we already loading the key from disk? If not create a job */
9668 if (o
->storage
== REDIS_VM_SWAPPED
) {
9671 o
->storage
= REDIS_VM_LOADING
;
9672 j
= zmalloc(sizeof(*j
));
9673 j
->type
= REDIS_IOJOB_LOAD
;
9676 j
->key
->vtype
= o
->vtype
;
9677 j
->page
= o
->vm
.page
;
9680 j
->thread
= (pthread_t
) -1;
9688 /* Preload keys for any command with first, last and step values for
9689 * the command keys prototype, as defined in the command table. */
9690 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
9692 if (cmd
->vm_firstkey
== 0) return;
9693 last
= cmd
->vm_lastkey
;
9694 if (last
< 0) last
= argc
+last
;
9695 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
9696 redisAssert(j
< argc
);
9697 waitForSwappedKey(c
,argv
[j
]);
9701 /* Preload keys needed for the ZUNION and ZINTER commands.
9702 * Note that the number of keys to preload is user-defined, so we need to
9703 * apply a sanity check against argc. */
9704 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
9708 num
= atoi(argv
[2]->ptr
);
9709 if (num
> (argc
-3)) return;
9710 for (i
= 0; i
< num
; i
++) {
9711 waitForSwappedKey(c
,argv
[3+i
]);
9715 /* Preload keys needed to execute the entire MULTI/EXEC block.
9717 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
9718 * and will block the client when any command requires a swapped out value. */
9719 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
9721 struct redisCommand
*mcmd
;
9724 REDIS_NOTUSED(argc
);
9725 REDIS_NOTUSED(argv
);
9727 if (!(c
->flags
& REDIS_MULTI
)) return;
9728 for (i
= 0; i
< c
->mstate
.count
; i
++) {
9729 mcmd
= c
->mstate
.commands
[i
].cmd
;
9730 margc
= c
->mstate
.commands
[i
].argc
;
9731 margv
= c
->mstate
.commands
[i
].argv
;
9733 if (mcmd
->vm_preload_proc
!= NULL
) {
9734 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
9736 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
9741 /* Is this client attempting to run a command against swapped keys?
9742 * If so, block it ASAP, load the keys in background, then resume it.
9744 * The important idea about this function is that it can fail! If keys will
9745 * still be swapped when the client is resumed, this key lookups will
9746 * just block loading keys from disk. In practical terms this should only
9747 * happen with SORT BY command or if there is a bug in this function.
9749 * Return 1 if the client is marked as blocked, 0 if the client can
9750 * continue as the keys it is going to access appear to be in memory. */
9751 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
9752 if (cmd
->vm_preload_proc
!= NULL
) {
9753 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
9755 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
9758 /* If the client was blocked for at least one key, mark it as blocked. */
9759 if (listLength(c
->io_keys
)) {
9760 c
->flags
|= REDIS_IO_WAIT
;
9761 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9762 server
.vm_blocked_clients
++;
9769 /* Remove the 'key' from the list of blocked keys for a given client.
9771 * The function returns 1 when there are no longer blocking keys after
9772 * the current one was removed (and the client can be unblocked). */
9773 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9777 struct dictEntry
*de
;
9779 /* Remove the key from the list of keys this client is waiting for. */
9780 listRewind(c
->io_keys
,&li
);
9781 while ((ln
= listNext(&li
)) != NULL
) {
9782 if (equalStringObjects(ln
->value
,key
)) {
9783 listDelNode(c
->io_keys
,ln
);
9789 /* Remove the client form the key => waiting clients map. */
9790 de
= dictFind(c
->db
->io_keys
,key
);
9792 l
= dictGetEntryVal(de
);
9793 ln
= listSearchKey(l
,c
);
9796 if (listLength(l
) == 0)
9797 dictDelete(c
->db
->io_keys
,key
);
9799 return listLength(c
->io_keys
) == 0;
9802 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9803 struct dictEntry
*de
;
9808 de
= dictFind(db
->io_keys
,key
);
9811 l
= dictGetEntryVal(de
);
9812 len
= listLength(l
);
9813 /* Note: we can't use something like while(listLength(l)) as the list
9814 * can be freed by the calling function when we remove the last element. */
9817 redisClient
*c
= ln
->value
;
9819 if (dontWaitForSwappedKey(c
,key
)) {
9820 /* Put the client in the list of clients ready to go as we
9821 * loaded all the keys about it. */
9822 listAddNodeTail(server
.io_ready_clients
,c
);
9827 /* =========================== Remote Configuration ========================= */
9829 static void configSetCommand(redisClient
*c
) {
9830 robj
*o
= getDecodedObject(c
->argv
[3]);
9831 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9832 zfree(server
.dbfilename
);
9833 server
.dbfilename
= zstrdup(o
->ptr
);
9834 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9835 zfree(server
.requirepass
);
9836 server
.requirepass
= zstrdup(o
->ptr
);
9837 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9838 zfree(server
.masterauth
);
9839 server
.masterauth
= zstrdup(o
->ptr
);
9840 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9841 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9842 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
9843 if (!strcasecmp(o
->ptr
,"no")) {
9844 server
.appendfsync
= APPENDFSYNC_NO
;
9845 } else if (!strcasecmp(o
->ptr
,"everysec")) {
9846 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
9847 } else if (!strcasecmp(o
->ptr
,"always")) {
9848 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
9852 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
9854 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
9856 /* Perform sanity check before setting the new config:
9857 * - Even number of args
9858 * - Seconds >= 1, changes >= 0 */
9860 sdsfreesplitres(v
,vlen
);
9863 for (j
= 0; j
< vlen
; j
++) {
9867 val
= strtoll(v
[j
], &eptr
, 10);
9868 if (eptr
[0] != '\0' ||
9869 ((j
& 1) == 0 && val
< 1) ||
9870 ((j
& 1) == 1 && val
< 0)) {
9871 sdsfreesplitres(v
,vlen
);
9875 /* Finally set the new config */
9876 resetServerSaveParams();
9877 for (j
= 0; j
< vlen
; j
+= 2) {
9881 seconds
= strtoll(v
[j
],NULL
,10);
9882 changes
= strtoll(v
[j
+1],NULL
,10);
9883 appendServerSaveParams(seconds
, changes
);
9885 sdsfreesplitres(v
,vlen
);
9887 addReplySds(c
,sdscatprintf(sdsempty(),
9888 "-ERR not supported CONFIG parameter %s\r\n",
9889 (char*)c
->argv
[2]->ptr
));
9894 addReply(c
,shared
.ok
);
9897 badfmt
: /* Bad format errors */
9898 addReplySds(c
,sdscatprintf(sdsempty(),
9899 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9901 (char*)c
->argv
[2]->ptr
));
9905 static void configGetCommand(redisClient
*c
) {
9906 robj
*o
= getDecodedObject(c
->argv
[2]);
9907 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9908 char *pattern
= o
->ptr
;
9912 decrRefCount(lenobj
);
9914 if (stringmatch(pattern
,"dbfilename",0)) {
9915 addReplyBulkCString(c
,"dbfilename");
9916 addReplyBulkCString(c
,server
.dbfilename
);
9919 if (stringmatch(pattern
,"requirepass",0)) {
9920 addReplyBulkCString(c
,"requirepass");
9921 addReplyBulkCString(c
,server
.requirepass
);
9924 if (stringmatch(pattern
,"masterauth",0)) {
9925 addReplyBulkCString(c
,"masterauth");
9926 addReplyBulkCString(c
,server
.masterauth
);
9929 if (stringmatch(pattern
,"maxmemory",0)) {
9932 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9933 addReplyBulkCString(c
,"maxmemory");
9934 addReplyBulkCString(c
,buf
);
9937 if (stringmatch(pattern
,"appendfsync",0)) {
9940 switch(server
.appendfsync
) {
9941 case APPENDFSYNC_NO
: policy
= "no"; break;
9942 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
9943 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
9944 default: policy
= "unknown"; break; /* too harmless to panic */
9946 addReplyBulkCString(c
,"appendfsync");
9947 addReplyBulkCString(c
,policy
);
9950 if (stringmatch(pattern
,"save",0)) {
9951 sds buf
= sdsempty();
9954 for (j
= 0; j
< server
.saveparamslen
; j
++) {
9955 buf
= sdscatprintf(buf
,"%ld %d",
9956 server
.saveparams
[j
].seconds
,
9957 server
.saveparams
[j
].changes
);
9958 if (j
!= server
.saveparamslen
-1)
9959 buf
= sdscatlen(buf
," ",1);
9961 addReplyBulkCString(c
,"save");
9962 addReplyBulkCString(c
,buf
);
9967 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9970 static void configCommand(redisClient
*c
) {
9971 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9972 if (c
->argc
!= 4) goto badarity
;
9973 configSetCommand(c
);
9974 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9975 if (c
->argc
!= 3) goto badarity
;
9976 configGetCommand(c
);
9977 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9978 if (c
->argc
!= 2) goto badarity
;
9979 server
.stat_numcommands
= 0;
9980 server
.stat_numconnections
= 0;
9981 server
.stat_expiredkeys
= 0;
9982 server
.stat_starttime
= time(NULL
);
9983 addReply(c
,shared
.ok
);
9985 addReplySds(c
,sdscatprintf(sdsempty(),
9986 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9991 addReplySds(c
,sdscatprintf(sdsempty(),
9992 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9993 (char*) c
->argv
[1]->ptr
));
9996 /* =========================== Pubsub implementation ======================== */
9998 static void freePubsubPattern(void *p
) {
9999 pubsubPattern
*pat
= p
;
10001 decrRefCount(pat
->pattern
);
10005 static int listMatchPubsubPattern(void *a
, void *b
) {
10006 pubsubPattern
*pa
= a
, *pb
= b
;
10008 return (pa
->client
== pb
->client
) &&
10009 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10012 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10013 * 0 if the client was already subscribed to that channel. */
10014 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10015 struct dictEntry
*de
;
10016 list
*clients
= NULL
;
10019 /* Add the channel to the client -> channels hash table */
10020 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10022 incrRefCount(channel
);
10023 /* Add the client to the channel -> list of clients hash table */
10024 de
= dictFind(server
.pubsub_channels
,channel
);
10026 clients
= listCreate();
10027 dictAdd(server
.pubsub_channels
,channel
,clients
);
10028 incrRefCount(channel
);
10030 clients
= dictGetEntryVal(de
);
10032 listAddNodeTail(clients
,c
);
10034 /* Notify the client */
10035 addReply(c
,shared
.mbulk3
);
10036 addReply(c
,shared
.subscribebulk
);
10037 addReplyBulk(c
,channel
);
10038 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10042 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10043 * 0 if the client was not subscribed to the specified channel. */
10044 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10045 struct dictEntry
*de
;
10050 /* Remove the channel from the client -> channels hash table */
10051 incrRefCount(channel
); /* channel may be just a pointer to the same object
10052 we have in the hash tables. Protect it... */
10053 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10055 /* Remove the client from the channel -> clients list hash table */
10056 de
= dictFind(server
.pubsub_channels
,channel
);
10057 assert(de
!= NULL
);
10058 clients
= dictGetEntryVal(de
);
10059 ln
= listSearchKey(clients
,c
);
10060 assert(ln
!= NULL
);
10061 listDelNode(clients
,ln
);
10062 if (listLength(clients
) == 0) {
10063 /* Free the list and associated hash entry at all if this was
10064 * the latest client, so that it will be possible to abuse
10065 * Redis PUBSUB creating millions of channels. */
10066 dictDelete(server
.pubsub_channels
,channel
);
10069 /* Notify the client */
10071 addReply(c
,shared
.mbulk3
);
10072 addReply(c
,shared
.unsubscribebulk
);
10073 addReplyBulk(c
,channel
);
10074 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
10075 listLength(c
->pubsub_patterns
));
10078 decrRefCount(channel
); /* it is finally safe to release it */
10082 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10083 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10086 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10088 pubsubPattern
*pat
;
10089 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10090 incrRefCount(pattern
);
10091 pat
= zmalloc(sizeof(*pat
));
10092 pat
->pattern
= getDecodedObject(pattern
);
10094 listAddNodeTail(server
.pubsub_patterns
,pat
);
10096 /* Notify the client */
10097 addReply(c
,shared
.mbulk3
);
10098 addReply(c
,shared
.psubscribebulk
);
10099 addReplyBulk(c
,pattern
);
10100 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10104 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10105 * 0 if the client was not subscribed to the specified channel. */
10106 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10111 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10112 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10114 listDelNode(c
->pubsub_patterns
,ln
);
10116 pat
.pattern
= pattern
;
10117 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10118 listDelNode(server
.pubsub_patterns
,ln
);
10120 /* Notify the client */
10122 addReply(c
,shared
.mbulk3
);
10123 addReply(c
,shared
.punsubscribebulk
);
10124 addReplyBulk(c
,pattern
);
10125 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
10126 listLength(c
->pubsub_patterns
));
10128 decrRefCount(pattern
);
10132 /* Unsubscribe from all the channels. Return the number of channels the
10133 * client was subscribed from. */
10134 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10135 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10139 while((de
= dictNext(di
)) != NULL
) {
10140 robj
*channel
= dictGetEntryKey(de
);
10142 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10144 dictReleaseIterator(di
);
10148 /* Unsubscribe from all the patterns. Return the number of patterns the
10149 * client was subscribed from. */
10150 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10155 listRewind(c
->pubsub_patterns
,&li
);
10156 while ((ln
= listNext(&li
)) != NULL
) {
10157 robj
*pattern
= ln
->value
;
10159 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10164 /* Publish a message */
10165 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10167 struct dictEntry
*de
;
10171 /* Send to clients listening for that channel */
10172 de
= dictFind(server
.pubsub_channels
,channel
);
10174 list
*list
= dictGetEntryVal(de
);
10178 listRewind(list
,&li
);
10179 while ((ln
= listNext(&li
)) != NULL
) {
10180 redisClient
*c
= ln
->value
;
10182 addReply(c
,shared
.mbulk3
);
10183 addReply(c
,shared
.messagebulk
);
10184 addReplyBulk(c
,channel
);
10185 addReplyBulk(c
,message
);
10189 /* Send to clients listening to matching channels */
10190 if (listLength(server
.pubsub_patterns
)) {
10191 listRewind(server
.pubsub_patterns
,&li
);
10192 channel
= getDecodedObject(channel
);
10193 while ((ln
= listNext(&li
)) != NULL
) {
10194 pubsubPattern
*pat
= ln
->value
;
10196 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10197 sdslen(pat
->pattern
->ptr
),
10198 (char*)channel
->ptr
,
10199 sdslen(channel
->ptr
),0)) {
10200 addReply(pat
->client
,shared
.mbulk4
);
10201 addReply(pat
->client
,shared
.pmessagebulk
);
10202 addReplyBulk(pat
->client
,pat
->pattern
);
10203 addReplyBulk(pat
->client
,channel
);
10204 addReplyBulk(pat
->client
,message
);
10208 decrRefCount(channel
);
10213 static void subscribeCommand(redisClient
*c
) {
10216 for (j
= 1; j
< c
->argc
; j
++)
10217 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10220 static void unsubscribeCommand(redisClient
*c
) {
10221 if (c
->argc
== 1) {
10222 pubsubUnsubscribeAllChannels(c
,1);
10227 for (j
= 1; j
< c
->argc
; j
++)
10228 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10232 static void psubscribeCommand(redisClient
*c
) {
10235 for (j
= 1; j
< c
->argc
; j
++)
10236 pubsubSubscribePattern(c
,c
->argv
[j
]);
10239 static void punsubscribeCommand(redisClient
*c
) {
10240 if (c
->argc
== 1) {
10241 pubsubUnsubscribeAllPatterns(c
,1);
10246 for (j
= 1; j
< c
->argc
; j
++)
10247 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10251 static void publishCommand(redisClient
*c
) {
10252 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10253 addReplyLong(c
,receivers
);
10256 /* ================================= Debugging ============================== */
10258 static void debugCommand(redisClient
*c
) {
10259 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10260 *((char*)-1) = 'x';
10261 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10262 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10263 addReply(c
,shared
.err
);
10267 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10268 addReply(c
,shared
.err
);
10271 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10272 addReply(c
,shared
.ok
);
10273 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10275 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10276 addReply(c
,shared
.err
);
10279 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10280 addReply(c
,shared
.ok
);
10281 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10282 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10286 addReply(c
,shared
.nokeyerr
);
10289 key
= dictGetEntryKey(de
);
10290 val
= dictGetEntryVal(de
);
10291 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10292 key
->storage
== REDIS_VM_SWAPPING
)) {
10296 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10297 strenc
= strencoding
[val
->encoding
];
10299 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10302 addReplySds(c
,sdscatprintf(sdsempty(),
10303 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10304 "encoding:%s serializedlength:%lld\r\n",
10305 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10306 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10308 addReplySds(c
,sdscatprintf(sdsempty(),
10309 "+Key at:%p refcount:%d, value swapped at: page %llu "
10310 "using %llu pages\r\n",
10311 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10312 (unsigned long long) key
->vm
.usedpages
));
10314 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10315 lookupKeyRead(c
->db
,c
->argv
[2]);
10316 addReply(c
,shared
.ok
);
10317 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10318 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10321 if (!server
.vm_enabled
) {
10322 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10326 addReply(c
,shared
.nokeyerr
);
10329 key
= dictGetEntryKey(de
);
10330 val
= dictGetEntryVal(de
);
10331 /* If the key is shared we want to create a copy */
10332 if (key
->refcount
> 1) {
10333 robj
*newkey
= dupStringObject(key
);
10335 key
= dictGetEntryKey(de
) = newkey
;
10338 if (key
->storage
!= REDIS_VM_MEMORY
) {
10339 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10340 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10341 dictGetEntryVal(de
) = NULL
;
10342 addReply(c
,shared
.ok
);
10344 addReply(c
,shared
.err
);
10346 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10351 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10353 for (j
= 0; j
< keys
; j
++) {
10354 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10355 key
= createStringObject(buf
,strlen(buf
));
10356 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10360 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10361 val
= createStringObject(buf
,strlen(buf
));
10362 dictAdd(c
->db
->dict
,key
,val
);
10364 addReply(c
,shared
.ok
);
10366 addReplySds(c
,sdsnew(
10367 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10371 static void _redisAssert(char *estr
, char *file
, int line
) {
10372 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10373 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10374 #ifdef HAVE_BACKTRACE
10375 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10376 *((char*)-1) = 'x';
10380 static void _redisPanic(char *msg
, char *file
, int line
) {
10381 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10382 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10383 #ifdef HAVE_BACKTRACE
10384 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10385 *((char*)-1) = 'x';
10389 /* =================================== Main! ================================ */
10392 int linuxOvercommitMemoryValue(void) {
10393 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10396 if (!fp
) return -1;
10397 if (fgets(buf
,64,fp
) == NULL
) {
10406 void linuxOvercommitMemoryWarning(void) {
10407 if (linuxOvercommitMemoryValue() == 0) {
10408 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. 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.");
10411 #endif /* __linux__ */
10413 static void daemonize(void) {
10417 if (fork() != 0) exit(0); /* parent exits */
10418 setsid(); /* create a new session */
10420 /* Every output goes to /dev/null. If Redis is daemonized but
10421 * the 'logfile' is set to 'stdout' in the configuration file
10422 * it will not log at all. */
10423 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10424 dup2(fd
, STDIN_FILENO
);
10425 dup2(fd
, STDOUT_FILENO
);
10426 dup2(fd
, STDERR_FILENO
);
10427 if (fd
> STDERR_FILENO
) close(fd
);
10429 /* Try to write the pid file */
10430 fp
= fopen(server
.pidfile
,"w");
10432 fprintf(fp
,"%d\n",getpid());
10437 static void version() {
10438 printf("Redis server version %s\n", REDIS_VERSION
);
10442 static void usage() {
10443 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10444 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10448 int main(int argc
, char **argv
) {
10451 initServerConfig();
10453 if (strcmp(argv
[1], "-v") == 0 ||
10454 strcmp(argv
[1], "--version") == 0) version();
10455 if (strcmp(argv
[1], "--help") == 0) usage();
10456 resetServerSaveParams();
10457 loadServerConfig(argv
[1]);
10458 } else if ((argc
> 2)) {
10461 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'");
10463 if (server
.daemonize
) daemonize();
10465 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10467 linuxOvercommitMemoryWarning();
10469 start
= time(NULL
);
10470 if (server
.appendonly
) {
10471 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10472 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10474 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10475 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10477 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10478 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10480 aeDeleteEventLoop(server
.el
);
10484 /* ============================= Backtrace support ========================= */
10486 #ifdef HAVE_BACKTRACE
10487 static char *findFuncName(void *pointer
, unsigned long *offset
);
10489 static void *getMcontextEip(ucontext_t
*uc
) {
10490 #if defined(__FreeBSD__)
10491 return (void*) uc
->uc_mcontext
.mc_eip
;
10492 #elif defined(__dietlibc__)
10493 return (void*) uc
->uc_mcontext
.eip
;
10494 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10496 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10498 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10500 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10501 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10502 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10504 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10506 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10507 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10508 #elif defined(__ia64__) /* Linux IA64 */
10509 return (void*) uc
->uc_mcontext
.sc_ip
;
10515 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10517 char **messages
= NULL
;
10518 int i
, trace_size
= 0;
10519 unsigned long offset
=0;
10520 ucontext_t
*uc
= (ucontext_t
*) secret
;
10522 REDIS_NOTUSED(info
);
10524 redisLog(REDIS_WARNING
,
10525 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10526 infostring
= genRedisInfoString();
10527 redisLog(REDIS_WARNING
, "%s",infostring
);
10528 /* It's not safe to sdsfree() the returned string under memory
10529 * corruption conditions. Let it leak as we are going to abort */
10531 trace_size
= backtrace(trace
, 100);
10532 /* overwrite sigaction with caller's address */
10533 if (getMcontextEip(uc
) != NULL
) {
10534 trace
[1] = getMcontextEip(uc
);
10536 messages
= backtrace_symbols(trace
, trace_size
);
10538 for (i
=1; i
<trace_size
; ++i
) {
10539 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10541 p
= strchr(messages
[i
],'+');
10542 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10543 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10545 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10548 /* free(messages); Don't call free() with possibly corrupted memory. */
10552 static void setupSigSegvAction(void) {
10553 struct sigaction act
;
10555 sigemptyset (&act
.sa_mask
);
10556 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10557 * is used. Otherwise, sa_handler is used */
10558 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10559 act
.sa_sigaction
= segvHandler
;
10560 sigaction (SIGSEGV
, &act
, NULL
);
10561 sigaction (SIGBUS
, &act
, NULL
);
10562 sigaction (SIGFPE
, &act
, NULL
);
10563 sigaction (SIGILL
, &act
, NULL
);
10564 sigaction (SIGBUS
, &act
, NULL
);
10568 #include "staticsymbols.h"
10569 /* This function try to convert a pointer into a function name. It's used in
10570 * oreder to provide a backtrace under segmentation fault that's able to
10571 * display functions declared as static (otherwise the backtrace is useless). */
10572 static char *findFuncName(void *pointer
, unsigned long *offset
){
10574 unsigned long off
, minoff
= 0;
10576 /* Try to match against the Symbol with the smallest offset */
10577 for (i
=0; symsTable
[i
].pointer
; i
++) {
10578 unsigned long lp
= (unsigned long) pointer
;
10580 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10581 off
=lp
-symsTable
[i
].pointer
;
10582 if (ret
< 0 || off
< minoff
) {
10588 if (ret
== -1) return NULL
;
10590 return symsTable
[ret
].name
;
10592 #else /* HAVE_BACKTRACE */
10593 static void setupSigSegvAction(void) {
10595 #endif /* HAVE_BACKTRACE */