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.8"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117 #define REDIS_STRING 0
123 /* Objects encoding. Some kind of objects like Strings and Hashes can be
124 * internally represented in multiple ways. The 'encoding' field of the object
125 * is set to one of this fields for this object. */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
128 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
129 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131 static char* strencoding
[] = {
132 "raw", "int", "zipmap", "hashtable"
135 /* Object types only used for dumping to disk */
136 #define REDIS_EXPIRETIME 253
137 #define REDIS_SELECTDB 254
138 #define REDIS_EOF 255
140 /* Defines related to the dump file format. To store 32 bits lengths for short
141 * keys requires a lot of space, so we check the most significant 2 bits of
142 * the first byte to interpreter the length:
144 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
145 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
146 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
147 * 11|000000 this means: specially encoded object will follow. The six bits
148 * number specify the kind of object that follows.
149 * See the REDIS_RDB_ENC_* defines.
151 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
152 * values, will fit inside. */
153 #define REDIS_RDB_6BITLEN 0
154 #define REDIS_RDB_14BITLEN 1
155 #define REDIS_RDB_32BITLEN 2
156 #define REDIS_RDB_ENCVAL 3
157 #define REDIS_RDB_LENERR UINT_MAX
159 /* When a length of a string object stored on disk has the first two bits
160 * set, the remaining two bits specify a special encoding for the object
161 * accordingly to the following defines: */
162 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
163 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
164 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
165 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167 /* Virtual memory object->where field. */
168 #define REDIS_VM_MEMORY 0 /* The object is on memory */
169 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
170 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
171 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173 /* Virtual memory static configuration stuff.
174 * Check vmFindContiguousPages() to know more about this magic numbers. */
175 #define REDIS_VM_MAX_NEAR_PAGES 65536
176 #define REDIS_VM_MAX_RANDOM_JUMP 4096
177 #define REDIS_VM_MAX_THREADS 32
178 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
179 /* The following is the *percentage* of completed I/O jobs to process when the
180 * handelr is called. While Virtual Memory I/O operations are performed by
181 * threads, this operations must be processed by the main thread when completed
182 * in order to take effect. */
183 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
186 #define REDIS_SLAVE 1 /* This client is a slave server */
187 #define REDIS_MASTER 2 /* This client is a master server */
188 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
189 #define REDIS_MULTI 8 /* This client is in a MULTI context */
190 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
191 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 /* Slave replication state - slave side */
194 #define REDIS_REPL_NONE 0 /* No active replication */
195 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
196 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
198 /* Slave replication state - from the point of view of master
199 * Note that in SEND_BULK and ONLINE state the slave receives new updates
200 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
201 * to start the next background saving in order to send updates to it. */
202 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
203 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
204 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
205 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
207 /* List related stuff */
211 /* Sort operations */
212 #define REDIS_SORT_GET 0
213 #define REDIS_SORT_ASC 1
214 #define REDIS_SORT_DESC 2
215 #define REDIS_SORTKEY_MAX 1024
218 #define REDIS_DEBUG 0
219 #define REDIS_VERBOSE 1
220 #define REDIS_NOTICE 2
221 #define REDIS_WARNING 3
223 /* Anti-warning macro... */
224 #define REDIS_NOTUSED(V) ((void) V)
226 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
227 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
229 /* Append only defines */
230 #define APPENDFSYNC_NO 0
231 #define APPENDFSYNC_ALWAYS 1
232 #define APPENDFSYNC_EVERYSEC 2
234 /* Hashes related defaults */
235 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
236 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
238 /* We can print the stacktrace, so our assert is defined this way: */
239 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
240 static void _redisAssert(char *estr
, char *file
, int line
);
242 /*================================= Data types ============================== */
244 /* A redis object, that is a type able to hold a string / list / set */
246 /* The VM object structure */
247 struct redisObjectVM
{
248 off_t page
; /* the page at witch the object is stored on disk */
249 off_t usedpages
; /* number of pages used on disk */
250 time_t atime
; /* Last access time */
253 /* The actual Redis Object */
254 typedef struct redisObject
{
257 unsigned char encoding
;
258 unsigned char storage
; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype
; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm
;
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
282 typedef struct redisDb
{
283 dict
*dict
; /* The keyspace for this DB */
284 dict
*expires
; /* Timeout of keys with a timeout set */
285 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
286 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd
{
294 struct redisCommand
*cmd
;
297 typedef struct multiState
{
298 multiCmd
*commands
; /* Array of MULTI commands */
299 int count
; /* Total number of MULTI commands */
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient
{
309 robj
**argv
, **mbargv
;
311 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk
; /* multi bulk command format active */
315 time_t lastinteraction
; /* time of the last interaction, used for timeout */
316 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb
; /* slave selected db, if this client is a slave */
318 int authenticated
; /* when requirepass is non-NULL */
319 int replstate
; /* replication state if this is a slave */
320 int repldbfd
; /* replication DB file descriptor */
321 long repldboff
; /* replication DB file offset */
322 off_t repldbsize
; /* replication DB file size */
323 multiState mstate
; /* MULTI/EXEC state */
324 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum
; /* Number of blocking keys */
327 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list
*io_keys
; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
332 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
340 /* Global server state structure */
345 long long dirty
; /* changes to DB from the last save */
347 list
*slaves
, *monitors
;
348 char neterr
[ANET_ERR_LEN
];
350 int cronloops
; /* number of times the cron function run */
351 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
352 time_t lastsave
; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime
; /* server start time */
355 long long stat_numcommands
; /* number of processed commands */
356 long long stat_numconnections
; /* number of connections received */
357 long long stat_expiredkeys
; /* number of expired keys */
370 pid_t bgsavechildpid
;
371 pid_t bgrewritechildpid
;
372 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
373 struct saveparam
*saveparams
;
378 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 #define REDIS_SHARED_INTEGERS 10000
510 struct sharedObjectsStruct
{
511 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
512 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
513 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
514 *outofrangeerr
, *plus
,
515 *select0
, *select1
, *select2
, *select3
, *select4
,
516 *select5
, *select6
, *select7
, *select8
, *select9
,
517 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *psubscribebulk
, *punsubscribebulk
, *integers
[REDIS_SHARED_INTEGERS
];
521 /* Global vars that are actally used as constants. The following double
522 * values are used for double on-disk serialization, and are initialized
523 * at runtime to avoid strange compiler optimizations. */
525 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
527 /* VM threaded I/O request message */
528 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
529 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
530 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
531 typedef struct iojob
{
532 int type
; /* Request type, REDIS_IOJOB_* */
533 redisDb
*db
;/* Redis database */
534 robj
*key
; /* This I/O request is about swapping this key */
535 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
536 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
537 off_t page
; /* Swap page where to read/write the object */
538 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
539 int canceled
; /* True if this command was canceled by blocking side of VM */
540 pthread_t thread
; /* ID of the thread processing this entry */
543 /*================================ Prototypes =============================== */
545 static void freeStringObject(robj
*o
);
546 static void freeListObject(robj
*o
);
547 static void freeSetObject(robj
*o
);
548 static void decrRefCount(void *o
);
549 static robj
*createObject(int type
, void *ptr
);
550 static void freeClient(redisClient
*c
);
551 static int rdbLoad(char *filename
);
552 static void addReply(redisClient
*c
, robj
*obj
);
553 static void addReplySds(redisClient
*c
, sds s
);
554 static void incrRefCount(robj
*o
);
555 static int rdbSaveBackground(char *filename
);
556 static robj
*createStringObject(char *ptr
, size_t len
);
557 static robj
*dupStringObject(robj
*o
);
558 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
559 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
560 static int syncWithMaster(void);
561 static robj
*tryObjectEncoding(robj
*o
);
562 static robj
*getDecodedObject(robj
*o
);
563 static int removeExpire(redisDb
*db
, robj
*key
);
564 static int expireIfNeeded(redisDb
*db
, robj
*key
);
565 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
566 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
567 static int deleteKey(redisDb
*db
, robj
*key
);
568 static time_t getExpire(redisDb
*db
, robj
*key
);
569 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
570 static void updateSlavesWaitingBgsave(int bgsaveerr
);
571 static void freeMemoryIfNeeded(void);
572 static int processCommand(redisClient
*c
);
573 static void setupSigSegvAction(void);
574 static void rdbRemoveTempFile(pid_t childpid
);
575 static void aofRemoveTempFile(pid_t childpid
);
576 static size_t stringObjectLen(robj
*o
);
577 static void processInputBuffer(redisClient
*c
);
578 static zskiplist
*zslCreate(void);
579 static void zslFree(zskiplist
*zsl
);
580 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
581 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
582 static void initClientMultiState(redisClient
*c
);
583 static void freeClientMultiState(redisClient
*c
);
584 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
585 static void unblockClientWaitingData(redisClient
*c
);
586 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
587 static void vmInit(void);
588 static void vmMarkPagesFree(off_t page
, off_t count
);
589 static robj
*vmLoadObject(robj
*key
);
590 static robj
*vmPreviewObject(robj
*key
);
591 static int vmSwapOneObjectBlocking(void);
592 static int vmSwapOneObjectThreaded(void);
593 static int vmCanSwapOut(void);
594 static int tryFreeOneObjectFromFreelist(void);
595 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
596 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
597 static void vmCancelThreadedIOJob(robj
*o
);
598 static void lockThreadedIO(void);
599 static void unlockThreadedIO(void);
600 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
601 static void freeIOJob(iojob
*j
);
602 static void queueIOJob(iojob
*j
);
603 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
604 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
605 static void waitEmptyIOJobsQueue(void);
606 static void vmReopenSwapFile(void);
607 static int vmFreePage(off_t page
);
608 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
609 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
610 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
611 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
612 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
613 static struct redisCommand
*lookupCommand(char *name
);
614 static void call(redisClient
*c
, struct redisCommand
*cmd
);
615 static void resetClient(redisClient
*c
);
616 static void convertToRealHash(robj
*o
);
617 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
618 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
619 static void freePubsubPattern(void *p
);
620 static int listMatchPubsubPattern(void *a
, void *b
);
621 static int compareStringObjects(robj
*a
, robj
*b
);
624 static void authCommand(redisClient
*c
);
625 static void pingCommand(redisClient
*c
);
626 static void echoCommand(redisClient
*c
);
627 static void setCommand(redisClient
*c
);
628 static void setnxCommand(redisClient
*c
);
629 static void getCommand(redisClient
*c
);
630 static void delCommand(redisClient
*c
);
631 static void existsCommand(redisClient
*c
);
632 static void incrCommand(redisClient
*c
);
633 static void decrCommand(redisClient
*c
);
634 static void incrbyCommand(redisClient
*c
);
635 static void decrbyCommand(redisClient
*c
);
636 static void selectCommand(redisClient
*c
);
637 static void randomkeyCommand(redisClient
*c
);
638 static void keysCommand(redisClient
*c
);
639 static void dbsizeCommand(redisClient
*c
);
640 static void lastsaveCommand(redisClient
*c
);
641 static void saveCommand(redisClient
*c
);
642 static void bgsaveCommand(redisClient
*c
);
643 static void bgrewriteaofCommand(redisClient
*c
);
644 static void shutdownCommand(redisClient
*c
);
645 static void moveCommand(redisClient
*c
);
646 static void renameCommand(redisClient
*c
);
647 static void renamenxCommand(redisClient
*c
);
648 static void lpushCommand(redisClient
*c
);
649 static void rpushCommand(redisClient
*c
);
650 static void lpopCommand(redisClient
*c
);
651 static void rpopCommand(redisClient
*c
);
652 static void llenCommand(redisClient
*c
);
653 static void lindexCommand(redisClient
*c
);
654 static void lrangeCommand(redisClient
*c
);
655 static void ltrimCommand(redisClient
*c
);
656 static void typeCommand(redisClient
*c
);
657 static void lsetCommand(redisClient
*c
);
658 static void saddCommand(redisClient
*c
);
659 static void sremCommand(redisClient
*c
);
660 static void smoveCommand(redisClient
*c
);
661 static void sismemberCommand(redisClient
*c
);
662 static void scardCommand(redisClient
*c
);
663 static void spopCommand(redisClient
*c
);
664 static void srandmemberCommand(redisClient
*c
);
665 static void sinterCommand(redisClient
*c
);
666 static void sinterstoreCommand(redisClient
*c
);
667 static void sunionCommand(redisClient
*c
);
668 static void sunionstoreCommand(redisClient
*c
);
669 static void sdiffCommand(redisClient
*c
);
670 static void sdiffstoreCommand(redisClient
*c
);
671 static void syncCommand(redisClient
*c
);
672 static void flushdbCommand(redisClient
*c
);
673 static void flushallCommand(redisClient
*c
);
674 static void sortCommand(redisClient
*c
);
675 static void lremCommand(redisClient
*c
);
676 static void rpoplpushcommand(redisClient
*c
);
677 static void infoCommand(redisClient
*c
);
678 static void mgetCommand(redisClient
*c
);
679 static void monitorCommand(redisClient
*c
);
680 static void expireCommand(redisClient
*c
);
681 static void expireatCommand(redisClient
*c
);
682 static void getsetCommand(redisClient
*c
);
683 static void ttlCommand(redisClient
*c
);
684 static void slaveofCommand(redisClient
*c
);
685 static void debugCommand(redisClient
*c
);
686 static void msetCommand(redisClient
*c
);
687 static void msetnxCommand(redisClient
*c
);
688 static void zaddCommand(redisClient
*c
);
689 static void zincrbyCommand(redisClient
*c
);
690 static void zrangeCommand(redisClient
*c
);
691 static void zrangebyscoreCommand(redisClient
*c
);
692 static void zcountCommand(redisClient
*c
);
693 static void zrevrangeCommand(redisClient
*c
);
694 static void zcardCommand(redisClient
*c
);
695 static void zremCommand(redisClient
*c
);
696 static void zscoreCommand(redisClient
*c
);
697 static void zremrangebyscoreCommand(redisClient
*c
);
698 static void multiCommand(redisClient
*c
);
699 static void execCommand(redisClient
*c
);
700 static void discardCommand(redisClient
*c
);
701 static void blpopCommand(redisClient
*c
);
702 static void brpopCommand(redisClient
*c
);
703 static void appendCommand(redisClient
*c
);
704 static void substrCommand(redisClient
*c
);
705 static void zrankCommand(redisClient
*c
);
706 static void zrevrankCommand(redisClient
*c
);
707 static void hsetCommand(redisClient
*c
);
708 static void hgetCommand(redisClient
*c
);
709 static void hmsetCommand(redisClient
*c
);
710 static void hmgetCommand(redisClient
*c
);
711 static void hdelCommand(redisClient
*c
);
712 static void hlenCommand(redisClient
*c
);
713 static void zremrangebyrankCommand(redisClient
*c
);
714 static void zunionCommand(redisClient
*c
);
715 static void zinterCommand(redisClient
*c
);
716 static void hkeysCommand(redisClient
*c
);
717 static void hvalsCommand(redisClient
*c
);
718 static void hgetallCommand(redisClient
*c
);
719 static void hexistsCommand(redisClient
*c
);
720 static void configCommand(redisClient
*c
);
721 static void hincrbyCommand(redisClient
*c
);
722 static void subscribeCommand(redisClient
*c
);
723 static void unsubscribeCommand(redisClient
*c
);
724 static void psubscribeCommand(redisClient
*c
);
725 static void punsubscribeCommand(redisClient
*c
);
726 static void publishCommand(redisClient
*c
);
728 /*================================= Globals ================================= */
731 static struct redisServer server
; /* server global state */
732 static struct redisCommand cmdTable
[] = {
733 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
734 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
735 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
736 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
737 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
738 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
739 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
740 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
741 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
742 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
743 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
744 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
752 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
755 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
756 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
757 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
759 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
760 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
764 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
765 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
766 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
767 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
768 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
769 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
770 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
771 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
772 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
773 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
775 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
776 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
777 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
780 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
783 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
784 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
785 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
786 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
787 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
788 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
789 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
791 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
792 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
793 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
794 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
795 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
796 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
797 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
798 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
800 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
801 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
802 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
803 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
805 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
807 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
808 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
809 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
810 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
813 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
819 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
821 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
826 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
829 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
832 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
837 {NULL
,NULL
,0,0,NULL
,0,0,0}
840 /*============================ Utility functions ============================ */
842 /* Glob-style pattern matching. */
843 static int stringmatchlen(const char *pattern
, int patternLen
,
844 const char *string
, int stringLen
, int nocase
)
849 while (pattern
[1] == '*') {
854 return 1; /* match */
856 if (stringmatchlen(pattern
+1, patternLen
-1,
857 string
, stringLen
, nocase
))
858 return 1; /* match */
862 return 0; /* no match */
866 return 0; /* no match */
876 not = pattern
[0] == '^';
883 if (pattern
[0] == '\\') {
886 if (pattern
[0] == string
[0])
888 } else if (pattern
[0] == ']') {
890 } else if (patternLen
== 0) {
894 } else if (pattern
[1] == '-' && patternLen
>= 3) {
895 int start
= pattern
[0];
896 int end
= pattern
[2];
904 start
= tolower(start
);
910 if (c
>= start
&& c
<= end
)
914 if (pattern
[0] == string
[0])
917 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
927 return 0; /* no match */
933 if (patternLen
>= 2) {
940 if (pattern
[0] != string
[0])
941 return 0; /* no match */
943 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
944 return 0; /* no match */
952 if (stringLen
== 0) {
953 while(*pattern
== '*') {
960 if (patternLen
== 0 && stringLen
== 0)
965 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
966 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
969 static void redisLog(int level
, const char *fmt
, ...) {
973 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
977 if (level
>= server
.verbosity
) {
983 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
984 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
985 vfprintf(fp
, fmt
, ap
);
991 if (server
.logfile
) fclose(fp
);
994 /*====================== Hash table type implementation ==================== */
996 /* This is an hash table type that uses the SDS dynamic strings libary as
997 * keys and radis objects as values (objects can hold SDS strings,
1000 static void dictVanillaFree(void *privdata
, void *val
)
1002 DICT_NOTUSED(privdata
);
1006 static void dictListDestructor(void *privdata
, void *val
)
1008 DICT_NOTUSED(privdata
);
1009 listRelease((list
*)val
);
1012 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1016 DICT_NOTUSED(privdata
);
1018 l1
= sdslen((sds
)key1
);
1019 l2
= sdslen((sds
)key2
);
1020 if (l1
!= l2
) return 0;
1021 return memcmp(key1
, key2
, l1
) == 0;
1024 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1026 DICT_NOTUSED(privdata
);
1028 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1032 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1035 const robj
*o1
= key1
, *o2
= key2
;
1036 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1039 static unsigned int dictObjHash(const void *key
) {
1040 const robj
*o
= key
;
1041 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1044 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1047 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1050 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1051 o2
->encoding
== REDIS_ENCODING_INT
&&
1052 o1
->ptr
== o2
->ptr
) return 1;
1054 o1
= getDecodedObject(o1
);
1055 o2
= getDecodedObject(o2
);
1056 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1062 static unsigned int dictEncObjHash(const void *key
) {
1063 robj
*o
= (robj
*) key
;
1065 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1066 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1068 if (o
->encoding
== REDIS_ENCODING_INT
) {
1072 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1073 return dictGenHashFunction((unsigned char*)buf
, len
);
1077 o
= getDecodedObject(o
);
1078 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1085 /* Sets type and expires */
1086 static dictType setDictType
= {
1087 dictEncObjHash
, /* hash function */
1090 dictEncObjKeyCompare
, /* key compare */
1091 dictRedisObjectDestructor
, /* key destructor */
1092 NULL
/* val destructor */
1095 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1096 static dictType zsetDictType
= {
1097 dictEncObjHash
, /* hash function */
1100 dictEncObjKeyCompare
, /* key compare */
1101 dictRedisObjectDestructor
, /* key destructor */
1102 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1106 static dictType dbDictType
= {
1107 dictObjHash
, /* hash function */
1110 dictObjKeyCompare
, /* key compare */
1111 dictRedisObjectDestructor
, /* key destructor */
1112 dictRedisObjectDestructor
/* val destructor */
1116 static dictType keyptrDictType
= {
1117 dictObjHash
, /* hash function */
1120 dictObjKeyCompare
, /* key compare */
1121 dictRedisObjectDestructor
, /* key destructor */
1122 NULL
/* val destructor */
1125 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1126 static dictType hashDictType
= {
1127 dictEncObjHash
, /* hash function */
1130 dictEncObjKeyCompare
, /* key compare */
1131 dictRedisObjectDestructor
, /* key destructor */
1132 dictRedisObjectDestructor
/* val destructor */
1135 /* Keylist hash table type has unencoded redis objects as keys and
1136 * lists as values. It's used for blocking operations (BLPOP) and to
1137 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1138 static dictType keylistDictType
= {
1139 dictObjHash
, /* hash function */
1142 dictObjKeyCompare
, /* key compare */
1143 dictRedisObjectDestructor
, /* key destructor */
1144 dictListDestructor
/* val destructor */
1147 static void version();
1149 /* ========================= Random utility functions ======================= */
1151 /* Redis generally does not try to recover from out of memory conditions
1152 * when allocating objects or strings, it is not clear if it will be possible
1153 * to report this condition to the client since the networking layer itself
1154 * is based on heap allocation for send buffers, so we simply abort.
1155 * At least the code will be simpler to read... */
1156 static void oom(const char *msg
) {
1157 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1162 /* ====================== Redis server networking stuff ===================== */
1163 static void closeTimedoutClients(void) {
1166 time_t now
= time(NULL
);
1169 listRewind(server
.clients
,&li
);
1170 while ((ln
= listNext(&li
)) != NULL
) {
1171 c
= listNodeValue(ln
);
1172 if (server
.maxidletime
&&
1173 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1174 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1175 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1176 listLength(c
->pubsub_patterns
) == 0 &&
1177 (now
- c
->lastinteraction
> server
.maxidletime
))
1179 redisLog(REDIS_VERBOSE
,"Closing idle client");
1181 } else if (c
->flags
& REDIS_BLOCKED
) {
1182 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1183 addReply(c
,shared
.nullmultibulk
);
1184 unblockClientWaitingData(c
);
1190 static int htNeedsResize(dict
*dict
) {
1191 long long size
, used
;
1193 size
= dictSlots(dict
);
1194 used
= dictSize(dict
);
1195 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1196 (used
*100/size
< REDIS_HT_MINFILL
));
1199 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1200 * we resize the hash table to save memory */
1201 static void tryResizeHashTables(void) {
1204 for (j
= 0; j
< server
.dbnum
; j
++) {
1205 if (htNeedsResize(server
.db
[j
].dict
))
1206 dictResize(server
.db
[j
].dict
);
1207 if (htNeedsResize(server
.db
[j
].expires
))
1208 dictResize(server
.db
[j
].expires
);
1212 /* Our hash table implementation performs rehashing incrementally while
1213 * we write/read from the hash table. Still if the server is idle, the hash
1214 * table will use two tables for a long time. So we try to use 1 millisecond
1215 * of CPU time at every serverCron() loop in order to rehash some key. */
1216 static void incrementallyRehash(void) {
1219 for (j
= 0; j
< server
.dbnum
; j
++) {
1220 if (dictIsRehashing(server
.db
[j
].dict
)) {
1221 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1222 break; /* already used our millisecond for this loop... */
1227 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1228 void backgroundSaveDoneHandler(int statloc
) {
1229 int exitcode
= WEXITSTATUS(statloc
);
1230 int bysignal
= WIFSIGNALED(statloc
);
1232 if (!bysignal
&& exitcode
== 0) {
1233 redisLog(REDIS_NOTICE
,
1234 "Background saving terminated with success");
1236 server
.lastsave
= time(NULL
);
1237 } else if (!bysignal
&& exitcode
!= 0) {
1238 redisLog(REDIS_WARNING
, "Background saving error");
1240 redisLog(REDIS_WARNING
,
1241 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1242 rdbRemoveTempFile(server
.bgsavechildpid
);
1244 server
.bgsavechildpid
= -1;
1245 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1246 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1247 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1250 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1252 void backgroundRewriteDoneHandler(int statloc
) {
1253 int exitcode
= WEXITSTATUS(statloc
);
1254 int bysignal
= WIFSIGNALED(statloc
);
1256 if (!bysignal
&& exitcode
== 0) {
1260 redisLog(REDIS_NOTICE
,
1261 "Background append only file rewriting terminated with success");
1262 /* Now it's time to flush the differences accumulated by the parent */
1263 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1264 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1266 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1269 /* Flush our data... */
1270 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1271 (signed) sdslen(server
.bgrewritebuf
)) {
1272 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
));
1276 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1277 /* Now our work is to rename the temp file into the stable file. And
1278 * switch the file descriptor used by the server for append only. */
1279 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1280 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1284 /* Mission completed... almost */
1285 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1286 if (server
.appendfd
!= -1) {
1287 /* If append only is actually enabled... */
1288 close(server
.appendfd
);
1289 server
.appendfd
= fd
;
1291 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1292 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1294 /* If append only is disabled we just generate a dump in this
1295 * format. Why not? */
1298 } else if (!bysignal
&& exitcode
!= 0) {
1299 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1301 redisLog(REDIS_WARNING
,
1302 "Background append only file rewriting terminated by signal %d",
1306 sdsfree(server
.bgrewritebuf
);
1307 server
.bgrewritebuf
= sdsempty();
1308 aofRemoveTempFile(server
.bgrewritechildpid
);
1309 server
.bgrewritechildpid
= -1;
1312 /* This function is called once a background process of some kind terminates,
1313 * as we want to avoid resizing the hash tables when there is a child in order
1314 * to play well with copy-on-write (otherwise when a resize happens lots of
1315 * memory pages are copied). The goal of this function is to update the ability
1316 * for dict.c to resize the hash tables accordingly to the fact we have o not
1317 * running childs. */
1318 static void updateDictResizePolicy(void) {
1319 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1322 dictDisableResize();
1325 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1326 int j
, loops
= server
.cronloops
++;
1327 REDIS_NOTUSED(eventLoop
);
1329 REDIS_NOTUSED(clientData
);
1331 /* We take a cached value of the unix time in the global state because
1332 * with virtual memory and aging there is to store the current time
1333 * in objects at every object access, and accuracy is not needed.
1334 * To access a global var is faster than calling time(NULL) */
1335 server
.unixtime
= time(NULL
);
1337 /* Show some info about non-empty databases */
1338 for (j
= 0; j
< server
.dbnum
; j
++) {
1339 long long size
, used
, vkeys
;
1341 size
= dictSlots(server
.db
[j
].dict
);
1342 used
= dictSize(server
.db
[j
].dict
);
1343 vkeys
= dictSize(server
.db
[j
].expires
);
1344 if (!(loops
% 50) && (used
|| vkeys
)) {
1345 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1346 /* dictPrintStats(server.dict); */
1350 /* We don't want to resize the hash tables while a bacground saving
1351 * is in progress: the saving child is created using fork() that is
1352 * implemented with a copy-on-write semantic in most modern systems, so
1353 * if we resize the HT while there is the saving child at work actually
1354 * a lot of memory movements in the parent will cause a lot of pages
1356 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1357 if (!(loops
% 10)) tryResizeHashTables();
1358 if (server
.activerehashing
) incrementallyRehash();
1361 /* Show information about connected clients */
1362 if (!(loops
% 50)) {
1363 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1364 listLength(server
.clients
)-listLength(server
.slaves
),
1365 listLength(server
.slaves
),
1366 zmalloc_used_memory());
1369 /* Close connections of timedout clients */
1370 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1371 closeTimedoutClients();
1373 /* Check if a background saving or AOF rewrite in progress terminated */
1374 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1378 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1379 if (pid
== server
.bgsavechildpid
) {
1380 backgroundSaveDoneHandler(statloc
);
1382 backgroundRewriteDoneHandler(statloc
);
1384 updateDictResizePolicy();
1387 /* If there is not a background saving in progress check if
1388 * we have to save now */
1389 time_t now
= time(NULL
);
1390 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1391 struct saveparam
*sp
= server
.saveparams
+j
;
1393 if (server
.dirty
>= sp
->changes
&&
1394 now
-server
.lastsave
> sp
->seconds
) {
1395 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1396 sp
->changes
, sp
->seconds
);
1397 rdbSaveBackground(server
.dbfilename
);
1403 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1404 * will use few CPU cycles if there are few expiring keys, otherwise
1405 * it will get more aggressive to avoid that too much memory is used by
1406 * keys that can be removed from the keyspace. */
1407 for (j
= 0; j
< server
.dbnum
; j
++) {
1409 redisDb
*db
= server
.db
+j
;
1411 /* Continue to expire if at the end of the cycle more than 25%
1412 * of the keys were expired. */
1414 long num
= dictSize(db
->expires
);
1415 time_t now
= time(NULL
);
1418 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1419 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1424 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1425 t
= (time_t) dictGetEntryVal(de
);
1427 deleteKey(db
,dictGetEntryKey(de
));
1429 server
.stat_expiredkeys
++;
1432 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1435 /* Swap a few keys on disk if we are over the memory limit and VM
1436 * is enbled. Try to free objects from the free list first. */
1437 if (vmCanSwapOut()) {
1438 while (server
.vm_enabled
&& zmalloc_used_memory() >
1439 server
.vm_max_memory
)
1443 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1444 retval
= (server
.vm_max_threads
== 0) ?
1445 vmSwapOneObjectBlocking() :
1446 vmSwapOneObjectThreaded();
1447 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1448 zmalloc_used_memory() >
1449 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1451 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1453 /* Note that when using threade I/O we free just one object,
1454 * because anyway when the I/O thread in charge to swap this
1455 * object out will finish, the handler of completed jobs
1456 * will try to swap more objects if we are still out of memory. */
1457 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1461 /* Check if we should connect to a MASTER */
1462 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1463 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1464 if (syncWithMaster() == REDIS_OK
) {
1465 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1471 /* This function gets called every time Redis is entering the
1472 * main loop of the event driven library, that is, before to sleep
1473 * for ready file descriptors. */
1474 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1475 REDIS_NOTUSED(eventLoop
);
1477 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1481 listRewind(server
.io_ready_clients
,&li
);
1482 while((ln
= listNext(&li
))) {
1483 redisClient
*c
= ln
->value
;
1484 struct redisCommand
*cmd
;
1486 /* Resume the client. */
1487 listDelNode(server
.io_ready_clients
,ln
);
1488 c
->flags
&= (~REDIS_IO_WAIT
);
1489 server
.vm_blocked_clients
--;
1490 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1491 readQueryFromClient
, c
);
1492 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1493 assert(cmd
!= NULL
);
1496 /* There may be more data to process in the input buffer. */
1497 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1498 processInputBuffer(c
);
1503 static void createSharedObjects(void) {
1506 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1507 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1508 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1509 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1510 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1511 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1512 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1513 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1514 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1515 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1516 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1517 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1518 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1519 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1520 "-ERR no such key\r\n"));
1521 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1522 "-ERR syntax error\r\n"));
1523 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1524 "-ERR source and destination objects are the same\r\n"));
1525 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1526 "-ERR index out of range\r\n"));
1527 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1528 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1529 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1530 shared
.select0
= createStringObject("select 0\r\n",10);
1531 shared
.select1
= createStringObject("select 1\r\n",10);
1532 shared
.select2
= createStringObject("select 2\r\n",10);
1533 shared
.select3
= createStringObject("select 3\r\n",10);
1534 shared
.select4
= createStringObject("select 4\r\n",10);
1535 shared
.select5
= createStringObject("select 5\r\n",10);
1536 shared
.select6
= createStringObject("select 6\r\n",10);
1537 shared
.select7
= createStringObject("select 7\r\n",10);
1538 shared
.select8
= createStringObject("select 8\r\n",10);
1539 shared
.select9
= createStringObject("select 9\r\n",10);
1540 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1541 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1542 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1543 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1544 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1545 shared
.mbulk3
= createStringObject("*3\r\n",4);
1546 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1547 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1548 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1552 static void appendServerSaveParams(time_t seconds
, int changes
) {
1553 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1554 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1555 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1556 server
.saveparamslen
++;
1559 static void resetServerSaveParams() {
1560 zfree(server
.saveparams
);
1561 server
.saveparams
= NULL
;
1562 server
.saveparamslen
= 0;
1565 static void initServerConfig() {
1566 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1567 server
.port
= REDIS_SERVERPORT
;
1568 server
.verbosity
= REDIS_VERBOSE
;
1569 server
.maxidletime
= REDIS_MAXIDLETIME
;
1570 server
.saveparams
= NULL
;
1571 server
.logfile
= NULL
; /* NULL = log on standard output */
1572 server
.bindaddr
= NULL
;
1573 server
.glueoutputbuf
= 1;
1574 server
.daemonize
= 0;
1575 server
.appendonly
= 0;
1576 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1577 server
.lastfsync
= time(NULL
);
1578 server
.appendfd
= -1;
1579 server
.appendseldb
= -1; /* Make sure the first time will not match */
1580 server
.pidfile
= zstrdup("/var/run/redis.pid");
1581 server
.dbfilename
= zstrdup("dump.rdb");
1582 server
.appendfilename
= zstrdup("appendonly.aof");
1583 server
.requirepass
= NULL
;
1584 server
.shareobjects
= 0;
1585 server
.rdbcompression
= 1;
1586 server
.activerehashing
= 1;
1587 server
.maxclients
= 0;
1588 server
.blpop_blocked_clients
= 0;
1589 server
.maxmemory
= 0;
1590 server
.vm_enabled
= 0;
1591 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1592 server
.vm_page_size
= 256; /* 256 bytes per page */
1593 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1594 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1595 server
.vm_max_threads
= 4;
1596 server
.vm_blocked_clients
= 0;
1597 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1598 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1600 resetServerSaveParams();
1602 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1603 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1604 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1605 /* Replication related */
1607 server
.masterauth
= NULL
;
1608 server
.masterhost
= NULL
;
1609 server
.masterport
= 6379;
1610 server
.master
= NULL
;
1611 server
.replstate
= REDIS_REPL_NONE
;
1613 /* Double constants initialization */
1615 R_PosInf
= 1.0/R_Zero
;
1616 R_NegInf
= -1.0/R_Zero
;
1617 R_Nan
= R_Zero
/R_Zero
;
1620 static void initServer() {
1623 signal(SIGHUP
, SIG_IGN
);
1624 signal(SIGPIPE
, SIG_IGN
);
1625 setupSigSegvAction();
1627 server
.devnull
= fopen("/dev/null","w");
1628 if (server
.devnull
== NULL
) {
1629 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1632 server
.clients
= listCreate();
1633 server
.slaves
= listCreate();
1634 server
.monitors
= listCreate();
1635 server
.objfreelist
= listCreate();
1636 createSharedObjects();
1637 server
.el
= aeCreateEventLoop();
1638 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1639 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1640 if (server
.fd
== -1) {
1641 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1644 for (j
= 0; j
< server
.dbnum
; j
++) {
1645 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1646 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1647 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1648 if (server
.vm_enabled
)
1649 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1650 server
.db
[j
].id
= j
;
1652 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1653 server
.pubsub_patterns
= listCreate();
1654 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1655 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1656 server
.cronloops
= 0;
1657 server
.bgsavechildpid
= -1;
1658 server
.bgrewritechildpid
= -1;
1659 server
.bgrewritebuf
= sdsempty();
1660 server
.lastsave
= time(NULL
);
1662 server
.stat_numcommands
= 0;
1663 server
.stat_numconnections
= 0;
1664 server
.stat_expiredkeys
= 0;
1665 server
.stat_starttime
= time(NULL
);
1666 server
.unixtime
= time(NULL
);
1667 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1668 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1669 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1671 if (server
.appendonly
) {
1672 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1673 if (server
.appendfd
== -1) {
1674 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1680 if (server
.vm_enabled
) vmInit();
1683 /* Empty the whole database */
1684 static long long emptyDb() {
1686 long long removed
= 0;
1688 for (j
= 0; j
< server
.dbnum
; j
++) {
1689 removed
+= dictSize(server
.db
[j
].dict
);
1690 dictEmpty(server
.db
[j
].dict
);
1691 dictEmpty(server
.db
[j
].expires
);
1696 static int yesnotoi(char *s
) {
1697 if (!strcasecmp(s
,"yes")) return 1;
1698 else if (!strcasecmp(s
,"no")) return 0;
1702 /* I agree, this is a very rudimental way to load a configuration...
1703 will improve later if the config gets more complex */
1704 static void loadServerConfig(char *filename
) {
1706 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1710 if (filename
[0] == '-' && filename
[1] == '\0')
1713 if ((fp
= fopen(filename
,"r")) == NULL
) {
1714 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1719 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1725 line
= sdstrim(line
," \t\r\n");
1727 /* Skip comments and blank lines*/
1728 if (line
[0] == '#' || line
[0] == '\0') {
1733 /* Split into arguments */
1734 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1735 sdstolower(argv
[0]);
1737 /* Execute config directives */
1738 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1739 server
.maxidletime
= atoi(argv
[1]);
1740 if (server
.maxidletime
< 0) {
1741 err
= "Invalid timeout value"; goto loaderr
;
1743 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1744 server
.port
= atoi(argv
[1]);
1745 if (server
.port
< 1 || server
.port
> 65535) {
1746 err
= "Invalid port"; goto loaderr
;
1748 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1749 server
.bindaddr
= zstrdup(argv
[1]);
1750 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1751 int seconds
= atoi(argv
[1]);
1752 int changes
= atoi(argv
[2]);
1753 if (seconds
< 1 || changes
< 0) {
1754 err
= "Invalid save parameters"; goto loaderr
;
1756 appendServerSaveParams(seconds
,changes
);
1757 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1758 if (chdir(argv
[1]) == -1) {
1759 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1760 argv
[1], strerror(errno
));
1763 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1764 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1765 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1766 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1767 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1769 err
= "Invalid log level. Must be one of debug, notice, warning";
1772 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1775 server
.logfile
= zstrdup(argv
[1]);
1776 if (!strcasecmp(server
.logfile
,"stdout")) {
1777 zfree(server
.logfile
);
1778 server
.logfile
= NULL
;
1780 if (server
.logfile
) {
1781 /* Test if we are able to open the file. The server will not
1782 * be able to abort just for this problem later... */
1783 logfp
= fopen(server
.logfile
,"a");
1784 if (logfp
== NULL
) {
1785 err
= sdscatprintf(sdsempty(),
1786 "Can't open the log file: %s", strerror(errno
));
1791 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1792 server
.dbnum
= atoi(argv
[1]);
1793 if (server
.dbnum
< 1) {
1794 err
= "Invalid number of databases"; goto loaderr
;
1796 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1797 loadServerConfig(argv
[1]);
1798 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1799 server
.maxclients
= atoi(argv
[1]);
1800 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1801 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1802 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1803 server
.masterhost
= sdsnew(argv
[1]);
1804 server
.masterport
= atoi(argv
[2]);
1805 server
.replstate
= REDIS_REPL_CONNECT
;
1806 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1807 server
.masterauth
= zstrdup(argv
[1]);
1808 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1809 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1810 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1812 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1813 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1814 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1816 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1817 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1818 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1820 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1821 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1822 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1824 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1825 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1826 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1828 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1829 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1830 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1832 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1833 if (!strcasecmp(argv
[1],"no")) {
1834 server
.appendfsync
= APPENDFSYNC_NO
;
1835 } else if (!strcasecmp(argv
[1],"always")) {
1836 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1837 } else if (!strcasecmp(argv
[1],"everysec")) {
1838 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1840 err
= "argument must be 'no', 'always' or 'everysec'";
1843 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1844 server
.requirepass
= zstrdup(argv
[1]);
1845 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1846 zfree(server
.pidfile
);
1847 server
.pidfile
= zstrdup(argv
[1]);
1848 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1849 zfree(server
.dbfilename
);
1850 server
.dbfilename
= zstrdup(argv
[1]);
1851 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1852 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1853 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1855 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1856 zfree(server
.vm_swap_file
);
1857 server
.vm_swap_file
= zstrdup(argv
[1]);
1858 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1859 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1860 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1861 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1862 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1863 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1864 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1865 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1866 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1867 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1868 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1869 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1870 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1871 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1873 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1875 for (j
= 0; j
< argc
; j
++)
1880 if (fp
!= stdin
) fclose(fp
);
1884 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1885 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1886 fprintf(stderr
, ">>> '%s'\n", line
);
1887 fprintf(stderr
, "%s\n", err
);
1891 static void freeClientArgv(redisClient
*c
) {
1894 for (j
= 0; j
< c
->argc
; j
++)
1895 decrRefCount(c
->argv
[j
]);
1896 for (j
= 0; j
< c
->mbargc
; j
++)
1897 decrRefCount(c
->mbargv
[j
]);
1902 static void freeClient(redisClient
*c
) {
1905 /* Note that if the client we are freeing is blocked into a blocking
1906 * call, we have to set querybuf to NULL *before* to call
1907 * unblockClientWaitingData() to avoid processInputBuffer() will get
1908 * called. Also it is important to remove the file events after
1909 * this, because this call adds the READABLE event. */
1910 sdsfree(c
->querybuf
);
1912 if (c
->flags
& REDIS_BLOCKED
)
1913 unblockClientWaitingData(c
);
1915 /* Unsubscribe from all the pubsub channels */
1916 pubsubUnsubscribeAllChannels(c
,0);
1917 pubsubUnsubscribeAllPatterns(c
,0);
1918 dictRelease(c
->pubsub_channels
);
1919 listRelease(c
->pubsub_patterns
);
1920 /* Obvious cleanup */
1921 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1922 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1923 listRelease(c
->reply
);
1926 /* Remove from the list of clients */
1927 ln
= listSearchKey(server
.clients
,c
);
1928 redisAssert(ln
!= NULL
);
1929 listDelNode(server
.clients
,ln
);
1930 /* Remove from the list of clients waiting for swapped keys */
1931 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1932 ln
= listSearchKey(server
.io_ready_clients
,c
);
1934 listDelNode(server
.io_ready_clients
,ln
);
1935 server
.vm_blocked_clients
--;
1938 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1939 ln
= listFirst(c
->io_keys
);
1940 dontWaitForSwappedKey(c
,ln
->value
);
1942 listRelease(c
->io_keys
);
1943 /* Master/slave cleanup */
1944 if (c
->flags
& REDIS_SLAVE
) {
1945 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1947 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1948 ln
= listSearchKey(l
,c
);
1949 redisAssert(ln
!= NULL
);
1952 if (c
->flags
& REDIS_MASTER
) {
1953 server
.master
= NULL
;
1954 server
.replstate
= REDIS_REPL_CONNECT
;
1956 /* Release memory */
1959 freeClientMultiState(c
);
1963 #define GLUEREPLY_UP_TO (1024)
1964 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1966 char buf
[GLUEREPLY_UP_TO
];
1971 listRewind(c
->reply
,&li
);
1972 while((ln
= listNext(&li
))) {
1976 objlen
= sdslen(o
->ptr
);
1977 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1978 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1980 listDelNode(c
->reply
,ln
);
1982 if (copylen
== 0) return;
1986 /* Now the output buffer is empty, add the new single element */
1987 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1988 listAddNodeHead(c
->reply
,o
);
1991 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1992 redisClient
*c
= privdata
;
1993 int nwritten
= 0, totwritten
= 0, objlen
;
1996 REDIS_NOTUSED(mask
);
1998 /* Use writev() if we have enough buffers to send */
1999 if (!server
.glueoutputbuf
&&
2000 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2001 !(c
->flags
& REDIS_MASTER
))
2003 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2007 while(listLength(c
->reply
)) {
2008 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2009 glueReplyBuffersIfNeeded(c
);
2011 o
= listNodeValue(listFirst(c
->reply
));
2012 objlen
= sdslen(o
->ptr
);
2015 listDelNode(c
->reply
,listFirst(c
->reply
));
2019 if (c
->flags
& REDIS_MASTER
) {
2020 /* Don't reply to a master */
2021 nwritten
= objlen
- c
->sentlen
;
2023 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2024 if (nwritten
<= 0) break;
2026 c
->sentlen
+= nwritten
;
2027 totwritten
+= nwritten
;
2028 /* If we fully sent the object on head go to the next one */
2029 if (c
->sentlen
== objlen
) {
2030 listDelNode(c
->reply
,listFirst(c
->reply
));
2033 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2034 * bytes, in a single threaded server it's a good idea to serve
2035 * other clients as well, even if a very large request comes from
2036 * super fast link that is always able to accept data (in real world
2037 * scenario think about 'KEYS *' against the loopback interfae) */
2038 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2040 if (nwritten
== -1) {
2041 if (errno
== EAGAIN
) {
2044 redisLog(REDIS_VERBOSE
,
2045 "Error writing to client: %s", strerror(errno
));
2050 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2051 if (listLength(c
->reply
) == 0) {
2053 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2057 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2059 redisClient
*c
= privdata
;
2060 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2062 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2063 int offset
, ion
= 0;
2065 REDIS_NOTUSED(mask
);
2068 while (listLength(c
->reply
)) {
2069 offset
= c
->sentlen
;
2073 /* fill-in the iov[] array */
2074 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2075 o
= listNodeValue(node
);
2076 objlen
= sdslen(o
->ptr
);
2078 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2081 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2082 break; /* no more iovecs */
2084 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2085 iov
[ion
].iov_len
= objlen
- offset
;
2086 willwrite
+= objlen
- offset
;
2087 offset
= 0; /* just for the first item */
2094 /* write all collected blocks at once */
2095 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2096 if (errno
!= EAGAIN
) {
2097 redisLog(REDIS_VERBOSE
,
2098 "Error writing to client: %s", strerror(errno
));
2105 totwritten
+= nwritten
;
2106 offset
= c
->sentlen
;
2108 /* remove written robjs from c->reply */
2109 while (nwritten
&& listLength(c
->reply
)) {
2110 o
= listNodeValue(listFirst(c
->reply
));
2111 objlen
= sdslen(o
->ptr
);
2113 if(nwritten
>= objlen
- offset
) {
2114 listDelNode(c
->reply
, listFirst(c
->reply
));
2115 nwritten
-= objlen
- offset
;
2119 c
->sentlen
+= nwritten
;
2127 c
->lastinteraction
= time(NULL
);
2129 if (listLength(c
->reply
) == 0) {
2131 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2135 static struct redisCommand
*lookupCommand(char *name
) {
2137 while(cmdTable
[j
].name
!= NULL
) {
2138 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2144 /* resetClient prepare the client to process the next command */
2145 static void resetClient(redisClient
*c
) {
2151 /* Call() is the core of Redis execution of a command */
2152 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2155 dirty
= server
.dirty
;
2157 dirty
= server
.dirty
-dirty
;
2159 if (server
.appendonly
&& dirty
)
2160 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2161 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2162 listLength(server
.slaves
))
2163 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2164 if (listLength(server
.monitors
))
2165 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2166 server
.stat_numcommands
++;
2169 /* If this function gets called we already read a whole
2170 * command, argments are in the client argv/argc fields.
2171 * processCommand() execute the command or prepare the
2172 * server for a bulk read from the client.
2174 * If 1 is returned the client is still alive and valid and
2175 * and other operations can be performed by the caller. Otherwise
2176 * if 0 is returned the client was destroied (i.e. after QUIT). */
2177 static int processCommand(redisClient
*c
) {
2178 struct redisCommand
*cmd
;
2180 /* Free some memory if needed (maxmemory setting) */
2181 if (server
.maxmemory
) freeMemoryIfNeeded();
2183 /* Handle the multi bulk command type. This is an alternative protocol
2184 * supported by Redis in order to receive commands that are composed of
2185 * multiple binary-safe "bulk" arguments. The latency of processing is
2186 * a bit higher but this allows things like multi-sets, so if this
2187 * protocol is used only for MSET and similar commands this is a big win. */
2188 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2189 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2190 if (c
->multibulk
<= 0) {
2194 decrRefCount(c
->argv
[c
->argc
-1]);
2198 } else if (c
->multibulk
) {
2199 if (c
->bulklen
== -1) {
2200 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2201 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2205 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2206 decrRefCount(c
->argv
[0]);
2207 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2209 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2214 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2218 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2219 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2223 if (c
->multibulk
== 0) {
2227 /* Here we need to swap the multi-bulk argc/argv with the
2228 * normal argc/argv of the client structure. */
2230 c
->argv
= c
->mbargv
;
2231 c
->mbargv
= auxargv
;
2234 c
->argc
= c
->mbargc
;
2235 c
->mbargc
= auxargc
;
2237 /* We need to set bulklen to something different than -1
2238 * in order for the code below to process the command without
2239 * to try to read the last argument of a bulk command as
2240 * a special argument. */
2242 /* continue below and process the command */
2249 /* -- end of multi bulk commands processing -- */
2251 /* The QUIT command is handled as a special case. Normal command
2252 * procs are unable to close the client connection safely */
2253 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2258 /* Now lookup the command and check ASAP about trivial error conditions
2259 * such wrong arity, bad command name and so forth. */
2260 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2263 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2264 (char*)c
->argv
[0]->ptr
));
2267 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2268 (c
->argc
< -cmd
->arity
)) {
2270 sdscatprintf(sdsempty(),
2271 "-ERR wrong number of arguments for '%s' command\r\n",
2275 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2276 /* This is a bulk command, we have to read the last argument yet. */
2277 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2279 decrRefCount(c
->argv
[c
->argc
-1]);
2280 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2282 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2287 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2288 /* It is possible that the bulk read is already in the
2289 * buffer. Check this condition and handle it accordingly.
2290 * This is just a fast path, alternative to call processInputBuffer().
2291 * It's a good idea since the code is small and this condition
2292 * happens most of the times. */
2293 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2294 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2296 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2298 /* Otherwise return... there is to read the last argument
2299 * from the socket. */
2303 /* Let's try to encode the bulk object to save space. */
2304 if (cmd
->flags
& REDIS_CMD_BULK
)
2305 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2307 /* Check if the user is authenticated */
2308 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2309 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2314 /* Handle the maxmemory directive */
2315 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2316 zmalloc_used_memory() > server
.maxmemory
)
2318 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2323 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2324 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2326 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2327 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2328 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2333 /* Exec the command */
2334 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2335 queueMultiCommand(c
,cmd
);
2336 addReply(c
,shared
.queued
);
2338 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2339 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2343 /* Prepare the client for the next command */
2348 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2353 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2354 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2355 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2356 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2359 if (argc
<= REDIS_STATIC_ARGS
) {
2362 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2365 lenobj
= createObject(REDIS_STRING
,
2366 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2367 lenobj
->refcount
= 0;
2368 outv
[outc
++] = lenobj
;
2369 for (j
= 0; j
< argc
; j
++) {
2370 lenobj
= createObject(REDIS_STRING
,
2371 sdscatprintf(sdsempty(),"$%lu\r\n",
2372 (unsigned long) stringObjectLen(argv
[j
])));
2373 lenobj
->refcount
= 0;
2374 outv
[outc
++] = lenobj
;
2375 outv
[outc
++] = argv
[j
];
2376 outv
[outc
++] = shared
.crlf
;
2379 /* Increment all the refcounts at start and decrement at end in order to
2380 * be sure to free objects if there is no slave in a replication state
2381 * able to be feed with commands */
2382 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2383 listRewind(slaves
,&li
);
2384 while((ln
= listNext(&li
))) {
2385 redisClient
*slave
= ln
->value
;
2387 /* Don't feed slaves that are still waiting for BGSAVE to start */
2388 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2390 /* Feed all the other slaves, MONITORs and so on */
2391 if (slave
->slaveseldb
!= dictid
) {
2395 case 0: selectcmd
= shared
.select0
; break;
2396 case 1: selectcmd
= shared
.select1
; break;
2397 case 2: selectcmd
= shared
.select2
; break;
2398 case 3: selectcmd
= shared
.select3
; break;
2399 case 4: selectcmd
= shared
.select4
; break;
2400 case 5: selectcmd
= shared
.select5
; break;
2401 case 6: selectcmd
= shared
.select6
; break;
2402 case 7: selectcmd
= shared
.select7
; break;
2403 case 8: selectcmd
= shared
.select8
; break;
2404 case 9: selectcmd
= shared
.select9
; break;
2406 selectcmd
= createObject(REDIS_STRING
,
2407 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2408 selectcmd
->refcount
= 0;
2411 addReply(slave
,selectcmd
);
2412 slave
->slaveseldb
= dictid
;
2414 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2416 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2417 if (outv
!= static_outv
) zfree(outv
);
2420 static void processInputBuffer(redisClient
*c
) {
2422 /* Before to process the input buffer, make sure the client is not
2423 * waitig for a blocking operation such as BLPOP. Note that the first
2424 * iteration the client is never blocked, otherwise the processInputBuffer
2425 * would not be called at all, but after the execution of the first commands
2426 * in the input buffer the client may be blocked, and the "goto again"
2427 * will try to reiterate. The following line will make it return asap. */
2428 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2429 if (c
->bulklen
== -1) {
2430 /* Read the first line of the query */
2431 char *p
= strchr(c
->querybuf
,'\n');
2438 query
= c
->querybuf
;
2439 c
->querybuf
= sdsempty();
2440 querylen
= 1+(p
-(query
));
2441 if (sdslen(query
) > querylen
) {
2442 /* leave data after the first line of the query in the buffer */
2443 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2445 *p
= '\0'; /* remove "\n" */
2446 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2447 sdsupdatelen(query
);
2449 /* Now we can split the query in arguments */
2450 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2453 if (c
->argv
) zfree(c
->argv
);
2454 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2456 for (j
= 0; j
< argc
; j
++) {
2457 if (sdslen(argv
[j
])) {
2458 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2466 /* Execute the command. If the client is still valid
2467 * after processCommand() return and there is something
2468 * on the query buffer try to process the next command. */
2469 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2471 /* Nothing to process, argc == 0. Just process the query
2472 * buffer if it's not empty or return to the caller */
2473 if (sdslen(c
->querybuf
)) goto again
;
2476 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2477 redisLog(REDIS_VERBOSE
, "Client protocol error");
2482 /* Bulk read handling. Note that if we are at this point
2483 the client already sent a command terminated with a newline,
2484 we are reading the bulk data that is actually the last
2485 argument of the command. */
2486 int qbl
= sdslen(c
->querybuf
);
2488 if (c
->bulklen
<= qbl
) {
2489 /* Copy everything but the final CRLF as final argument */
2490 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2492 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2493 /* Process the command. If the client is still valid after
2494 * the processing and there is more data in the buffer
2495 * try to parse it. */
2496 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2502 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2503 redisClient
*c
= (redisClient
*) privdata
;
2504 char buf
[REDIS_IOBUF_LEN
];
2507 REDIS_NOTUSED(mask
);
2509 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2511 if (errno
== EAGAIN
) {
2514 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2518 } else if (nread
== 0) {
2519 redisLog(REDIS_VERBOSE
, "Client closed connection");
2524 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2525 c
->lastinteraction
= time(NULL
);
2529 processInputBuffer(c
);
2532 static int selectDb(redisClient
*c
, int id
) {
2533 if (id
< 0 || id
>= server
.dbnum
)
2535 c
->db
= &server
.db
[id
];
2539 static void *dupClientReplyValue(void *o
) {
2540 incrRefCount((robj
*)o
);
2544 static int listMatchObjects(void *a
, void *b
) {
2545 return compareStringObjects(a
,b
) == 0;
2548 static redisClient
*createClient(int fd
) {
2549 redisClient
*c
= zmalloc(sizeof(*c
));
2551 anetNonBlock(NULL
,fd
);
2552 anetTcpNoDelay(NULL
,fd
);
2553 if (!c
) return NULL
;
2556 c
->querybuf
= sdsempty();
2565 c
->lastinteraction
= time(NULL
);
2566 c
->authenticated
= 0;
2567 c
->replstate
= REDIS_REPL_NONE
;
2568 c
->reply
= listCreate();
2569 listSetFreeMethod(c
->reply
,decrRefCount
);
2570 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2571 c
->blockingkeys
= NULL
;
2572 c
->blockingkeysnum
= 0;
2573 c
->io_keys
= listCreate();
2574 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2575 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2576 c
->pubsub_patterns
= listCreate();
2577 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2578 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2579 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2580 readQueryFromClient
, c
) == AE_ERR
) {
2584 listAddNodeTail(server
.clients
,c
);
2585 initClientMultiState(c
);
2589 static void addReply(redisClient
*c
, robj
*obj
) {
2590 if (listLength(c
->reply
) == 0 &&
2591 (c
->replstate
== REDIS_REPL_NONE
||
2592 c
->replstate
== REDIS_REPL_ONLINE
) &&
2593 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2594 sendReplyToClient
, c
) == AE_ERR
) return;
2596 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2597 obj
= dupStringObject(obj
);
2598 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2600 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2603 static void addReplySds(redisClient
*c
, sds s
) {
2604 robj
*o
= createObject(REDIS_STRING
,s
);
2609 static void addReplyDouble(redisClient
*c
, double d
) {
2612 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2613 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2614 (unsigned long) strlen(buf
),buf
));
2617 static void addReplyLong(redisClient
*c
, long l
) {
2622 addReply(c
,shared
.czero
);
2624 } else if (l
== 1) {
2625 addReply(c
,shared
.cone
);
2628 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2629 addReplySds(c
,sdsnewlen(buf
,len
));
2632 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2637 addReply(c
,shared
.czero
);
2639 } else if (ll
== 1) {
2640 addReply(c
,shared
.cone
);
2643 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2644 addReplySds(c
,sdsnewlen(buf
,len
));
2647 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2652 addReply(c
,shared
.czero
);
2654 } else if (ul
== 1) {
2655 addReply(c
,shared
.cone
);
2658 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2659 addReplySds(c
,sdsnewlen(buf
,len
));
2662 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2665 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2666 len
= sdslen(obj
->ptr
);
2668 long n
= (long)obj
->ptr
;
2670 /* Compute how many bytes will take this integer as a radix 10 string */
2676 while((n
= n
/10) != 0) {
2680 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2683 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2684 addReplyBulkLen(c
,obj
);
2686 addReply(c
,shared
.crlf
);
2689 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2690 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2692 addReply(c
,shared
.nullbulk
);
2694 robj
*o
= createStringObject(s
,strlen(s
));
2700 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2705 REDIS_NOTUSED(mask
);
2706 REDIS_NOTUSED(privdata
);
2708 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2709 if (cfd
== AE_ERR
) {
2710 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2713 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2714 if ((c
= createClient(cfd
)) == NULL
) {
2715 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2716 close(cfd
); /* May be already closed, just ingore errors */
2719 /* If maxclient directive is set and this is one client more... close the
2720 * connection. Note that we create the client instead to check before
2721 * for this condition, since now the socket is already set in nonblocking
2722 * mode and we can send an error for free using the Kernel I/O */
2723 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2724 char *err
= "-ERR max number of clients reached\r\n";
2726 /* That's a best effort error message, don't check write errors */
2727 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2728 /* Nothing to do, Just to avoid the warning... */
2733 server
.stat_numconnections
++;
2736 /* ======================= Redis objects implementation ===================== */
2738 static robj
*createObject(int type
, void *ptr
) {
2741 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2742 if (listLength(server
.objfreelist
)) {
2743 listNode
*head
= listFirst(server
.objfreelist
);
2744 o
= listNodeValue(head
);
2745 listDelNode(server
.objfreelist
,head
);
2746 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2748 if (server
.vm_enabled
) {
2749 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2750 o
= zmalloc(sizeof(*o
));
2752 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2756 o
->encoding
= REDIS_ENCODING_RAW
;
2759 if (server
.vm_enabled
) {
2760 /* Note that this code may run in the context of an I/O thread
2761 * and accessing to server.unixtime in theory is an error
2762 * (no locks). But in practice this is safe, and even if we read
2763 * garbage Redis will not fail, as it's just a statistical info */
2764 o
->vm
.atime
= server
.unixtime
;
2765 o
->storage
= REDIS_VM_MEMORY
;
2770 static robj
*createStringObject(char *ptr
, size_t len
) {
2771 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2774 static robj
*dupStringObject(robj
*o
) {
2775 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2776 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2779 static robj
*createListObject(void) {
2780 list
*l
= listCreate();
2782 listSetFreeMethod(l
,decrRefCount
);
2783 return createObject(REDIS_LIST
,l
);
2786 static robj
*createSetObject(void) {
2787 dict
*d
= dictCreate(&setDictType
,NULL
);
2788 return createObject(REDIS_SET
,d
);
2791 static robj
*createHashObject(void) {
2792 /* All the Hashes start as zipmaps. Will be automatically converted
2793 * into hash tables if there are enough elements or big elements
2795 unsigned char *zm
= zipmapNew();
2796 robj
*o
= createObject(REDIS_HASH
,zm
);
2797 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2801 static robj
*createZsetObject(void) {
2802 zset
*zs
= zmalloc(sizeof(*zs
));
2804 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2805 zs
->zsl
= zslCreate();
2806 return createObject(REDIS_ZSET
,zs
);
2809 static void freeStringObject(robj
*o
) {
2810 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2815 static void freeListObject(robj
*o
) {
2816 listRelease((list
*) o
->ptr
);
2819 static void freeSetObject(robj
*o
) {
2820 dictRelease((dict
*) o
->ptr
);
2823 static void freeZsetObject(robj
*o
) {
2826 dictRelease(zs
->dict
);
2831 static void freeHashObject(robj
*o
) {
2832 switch (o
->encoding
) {
2833 case REDIS_ENCODING_HT
:
2834 dictRelease((dict
*) o
->ptr
);
2836 case REDIS_ENCODING_ZIPMAP
:
2845 static void incrRefCount(robj
*o
) {
2849 static void decrRefCount(void *obj
) {
2852 /* Object is a key of a swapped out value, or in the process of being
2854 if (server
.vm_enabled
&&
2855 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2857 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2858 redisAssert(o
->type
== REDIS_STRING
);
2859 freeStringObject(o
);
2860 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2861 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2862 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2863 !listAddNodeHead(server
.objfreelist
,o
))
2865 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2866 server
.vm_stats_swapped_objects
--;
2869 /* Object is in memory, or in the process of being swapped out. */
2870 if (--(o
->refcount
) == 0) {
2871 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2872 vmCancelThreadedIOJob(obj
);
2874 case REDIS_STRING
: freeStringObject(o
); break;
2875 case REDIS_LIST
: freeListObject(o
); break;
2876 case REDIS_SET
: freeSetObject(o
); break;
2877 case REDIS_ZSET
: freeZsetObject(o
); break;
2878 case REDIS_HASH
: freeHashObject(o
); break;
2879 default: redisAssert(0); break;
2881 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2882 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2883 !listAddNodeHead(server
.objfreelist
,o
))
2885 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2889 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2890 dictEntry
*de
= dictFind(db
->dict
,key
);
2892 robj
*key
= dictGetEntryKey(de
);
2893 robj
*val
= dictGetEntryVal(de
);
2895 if (server
.vm_enabled
) {
2896 if (key
->storage
== REDIS_VM_MEMORY
||
2897 key
->storage
== REDIS_VM_SWAPPING
)
2899 /* If we were swapping the object out, stop it, this key
2901 if (key
->storage
== REDIS_VM_SWAPPING
)
2902 vmCancelThreadedIOJob(key
);
2903 /* Update the access time of the key for the aging algorithm. */
2904 key
->vm
.atime
= server
.unixtime
;
2906 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2908 /* Our value was swapped on disk. Bring it at home. */
2909 redisAssert(val
== NULL
);
2910 val
= vmLoadObject(key
);
2911 dictGetEntryVal(de
) = val
;
2913 /* Clients blocked by the VM subsystem may be waiting for
2915 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2924 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2925 expireIfNeeded(db
,key
);
2926 return lookupKey(db
,key
);
2929 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2930 deleteIfVolatile(db
,key
);
2931 return lookupKey(db
,key
);
2934 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2935 robj
*o
= lookupKeyRead(c
->db
, key
);
2936 if (!o
) addReply(c
,reply
);
2940 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2941 robj
*o
= lookupKeyWrite(c
->db
, key
);
2942 if (!o
) addReply(c
,reply
);
2946 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2947 if (o
->type
!= type
) {
2948 addReply(c
,shared
.wrongtypeerr
);
2954 static int deleteKey(redisDb
*db
, robj
*key
) {
2957 /* We need to protect key from destruction: after the first dictDelete()
2958 * it may happen that 'key' is no longer valid if we don't increment
2959 * it's count. This may happen when we get the object reference directly
2960 * from the hash table with dictRandomKey() or dict iterators */
2962 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2963 retval
= dictDelete(db
->dict
,key
);
2966 return retval
== DICT_OK
;
2969 /* Check if the nul-terminated string 's' can be represented by a long
2970 * (that is, is a number that fits into long without any other space or
2971 * character before or after the digits).
2973 * If so, the function returns REDIS_OK and *longval is set to the value
2974 * of the number. Otherwise REDIS_ERR is returned */
2975 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2976 char buf
[32], *endptr
;
2980 value
= strtol(s
, &endptr
, 10);
2981 if (endptr
[0] != '\0') return REDIS_ERR
;
2982 slen
= snprintf(buf
,32,"%ld",value
);
2984 /* If the number converted back into a string is not identical
2985 * then it's not possible to encode the string as integer */
2986 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2987 if (longval
) *longval
= value
;
2991 /* Try to encode a string object in order to save space */
2992 static robj
*tryObjectEncoding(robj
*o
) {
2996 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2997 return o
; /* Already encoded */
2999 /* It's not safe to encode shared objects: shared objects can be shared
3000 * everywhere in the "object space" of Redis. Encoded objects can only
3001 * appear as "values" (and not, for instance, as keys) */
3002 if (o
->refcount
> 1) return o
;
3004 /* Currently we try to encode only strings */
3005 redisAssert(o
->type
== REDIS_STRING
);
3007 /* Check if we can represent this string as a long integer */
3008 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3010 /* Ok, this object can be encoded */
3011 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3013 incrRefCount(shared
.integers
[value
]);
3014 return shared
.integers
[value
];
3016 o
->encoding
= REDIS_ENCODING_INT
;
3018 o
->ptr
= (void*) value
;
3023 /* Get a decoded version of an encoded object (returned as a new object).
3024 * If the object is already raw-encoded just increment the ref count. */
3025 static robj
*getDecodedObject(robj
*o
) {
3028 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3032 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3035 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3036 dec
= createStringObject(buf
,strlen(buf
));
3039 redisAssert(1 != 1);
3043 /* Compare two string objects via strcmp() or alike.
3044 * Note that the objects may be integer-encoded. In such a case we
3045 * use snprintf() to get a string representation of the numbers on the stack
3046 * and compare the strings, it's much faster than calling getDecodedObject().
3048 * Important note: if objects are not integer encoded, but binary-safe strings,
3049 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3051 static int compareStringObjects(robj
*a
, robj
*b
) {
3052 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3053 char bufa
[128], bufb
[128], *astr
, *bstr
;
3056 if (a
== b
) return 0;
3057 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3058 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3064 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3065 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3071 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3074 static size_t stringObjectLen(robj
*o
) {
3075 redisAssert(o
->type
== REDIS_STRING
);
3076 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3077 return sdslen(o
->ptr
);
3081 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3085 static int getDoubleFromObject(redisClient
*c
, robj
*o
, double *value
) {
3089 if (o
&& o
->type
!= REDIS_STRING
) {
3090 addReplySds(c
,sdsnew("-ERR value is not a double\r\n"));
3096 else if (o
->encoding
== REDIS_ENCODING_RAW
)
3097 parsedValue
= strtod(o
->ptr
, &eptr
);
3098 else if (o
->encoding
== REDIS_ENCODING_INT
)
3099 parsedValue
= (long)o
->ptr
;
3101 redisAssert(1 != 1);
3103 if (eptr
!= NULL
&& *eptr
!= '\0') {
3104 addReplySds(c
,sdsnew("-ERR value is not a double\r\n"));
3108 *value
= parsedValue
;
3113 static int getLongLongFromObject(redisClient
*c
, robj
*o
, long long *value
) {
3114 long long parsedValue
;
3117 if (o
&& o
->type
!= REDIS_STRING
) {
3118 addReplySds(c
,sdsnew("-ERR value is not an integer\r\n"));
3124 else if (o
->encoding
== REDIS_ENCODING_RAW
)
3125 parsedValue
= strtoll(o
->ptr
, &eptr
, 10);
3126 else if (o
->encoding
== REDIS_ENCODING_INT
)
3127 parsedValue
= (long)o
->ptr
;
3129 redisAssert(1 != 1);
3131 if (eptr
!= NULL
&& *eptr
!= '\0') {
3132 addReplySds(c
,sdsnew("-ERR value is not an integer\r\n"));
3136 *value
= parsedValue
;
3141 static int getLongFromObject(redisClient
*c
, robj
*o
, long *value
) {
3142 long long actualValue
;
3144 if (getLongLongFromObject(c
, o
, &actualValue
) != REDIS_OK
) return REDIS_ERR
;
3146 if (actualValue
< LONG_MIN
|| actualValue
> LONG_MAX
) {
3147 addReplySds(c
,sdsnew("-ERR value is out of range\r\n"));
3151 *value
= actualValue
;
3156 /*============================ RDB saving/loading =========================== */
3158 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3159 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3163 static int rdbSaveTime(FILE *fp
, time_t t
) {
3164 int32_t t32
= (int32_t) t
;
3165 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3169 /* check rdbLoadLen() comments for more info */
3170 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3171 unsigned char buf
[2];
3174 /* Save a 6 bit len */
3175 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3176 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3177 } else if (len
< (1<<14)) {
3178 /* Save a 14 bit len */
3179 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3181 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3183 /* Save a 32 bit len */
3184 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3185 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3187 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3192 /* String objects in the form "2391" "-100" without any space and with a
3193 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3194 * encoded as integers to save space */
3195 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3197 char *endptr
, buf
[32];
3199 /* Check if it's possible to encode this value as a number */
3200 value
= strtoll(s
, &endptr
, 10);
3201 if (endptr
[0] != '\0') return 0;
3202 snprintf(buf
,32,"%lld",value
);
3204 /* If the number converted back into a string is not identical
3205 * then it's not possible to encode the string as integer */
3206 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3208 /* Finally check if it fits in our ranges */
3209 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3210 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3211 enc
[1] = value
&0xFF;
3213 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3214 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3215 enc
[1] = value
&0xFF;
3216 enc
[2] = (value
>>8)&0xFF;
3218 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3219 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3220 enc
[1] = value
&0xFF;
3221 enc
[2] = (value
>>8)&0xFF;
3222 enc
[3] = (value
>>16)&0xFF;
3223 enc
[4] = (value
>>24)&0xFF;
3230 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3231 size_t comprlen
, outlen
;
3235 /* We require at least four bytes compression for this to be worth it */
3236 if (len
<= 4) return 0;
3238 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3239 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3240 if (comprlen
== 0) {
3244 /* Data compressed! Let's save it on disk */
3245 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3246 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3247 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3248 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3249 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3258 /* Save a string objet as [len][data] on disk. If the object is a string
3259 * representation of an integer value we try to safe it in a special form */
3260 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3263 /* Try integer encoding */
3265 unsigned char buf
[5];
3266 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3267 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3272 /* Try LZF compression - under 20 bytes it's unable to compress even
3273 * aaaaaaaaaaaaaaaaaa so skip it */
3274 if (server
.rdbcompression
&& len
> 20) {
3277 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3278 if (retval
== -1) return -1;
3279 if (retval
> 0) return 0;
3280 /* retval == 0 means data can't be compressed, save the old way */
3283 /* Store verbatim */
3284 if (rdbSaveLen(fp
,len
) == -1) return -1;
3285 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3289 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3290 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3293 /* Avoid incr/decr ref count business when possible.
3294 * This plays well with copy-on-write given that we are probably
3295 * in a child process (BGSAVE). Also this makes sure key objects
3296 * of swapped objects are not incRefCount-ed (an assert does not allow
3297 * this in order to avoid bugs) */
3298 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3299 obj
= getDecodedObject(obj
);
3300 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3303 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3308 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3309 * 8 bit integer specifing the length of the representation.
3310 * This 8 bit integer has special values in order to specify the following
3316 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3317 unsigned char buf
[128];
3323 } else if (!isfinite(val
)) {
3325 buf
[0] = (val
< 0) ? 255 : 254;
3327 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3328 buf
[0] = strlen((char*)buf
+1);
3331 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3335 /* Save a Redis object. */
3336 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3337 if (o
->type
== REDIS_STRING
) {
3338 /* Save a string value */
3339 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3340 } else if (o
->type
== REDIS_LIST
) {
3341 /* Save a list value */
3342 list
*list
= o
->ptr
;
3346 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3347 listRewind(list
,&li
);
3348 while((ln
= listNext(&li
))) {
3349 robj
*eleobj
= listNodeValue(ln
);
3351 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3353 } else if (o
->type
== REDIS_SET
) {
3354 /* Save a set value */
3356 dictIterator
*di
= dictGetIterator(set
);
3359 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3360 while((de
= dictNext(di
)) != NULL
) {
3361 robj
*eleobj
= dictGetEntryKey(de
);
3363 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3365 dictReleaseIterator(di
);
3366 } else if (o
->type
== REDIS_ZSET
) {
3367 /* Save a set value */
3369 dictIterator
*di
= dictGetIterator(zs
->dict
);
3372 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3373 while((de
= dictNext(di
)) != NULL
) {
3374 robj
*eleobj
= dictGetEntryKey(de
);
3375 double *score
= dictGetEntryVal(de
);
3377 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3378 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3380 dictReleaseIterator(di
);
3381 } else if (o
->type
== REDIS_HASH
) {
3382 /* Save a hash value */
3383 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3384 unsigned char *p
= zipmapRewind(o
->ptr
);
3385 unsigned int count
= zipmapLen(o
->ptr
);
3386 unsigned char *key
, *val
;
3387 unsigned int klen
, vlen
;
3389 if (rdbSaveLen(fp
,count
) == -1) return -1;
3390 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3391 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3392 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3395 dictIterator
*di
= dictGetIterator(o
->ptr
);
3398 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3399 while((de
= dictNext(di
)) != NULL
) {
3400 robj
*key
= dictGetEntryKey(de
);
3401 robj
*val
= dictGetEntryVal(de
);
3403 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3404 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3406 dictReleaseIterator(di
);
3414 /* Return the length the object will have on disk if saved with
3415 * the rdbSaveObject() function. Currently we use a trick to get
3416 * this length with very little changes to the code. In the future
3417 * we could switch to a faster solution. */
3418 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3419 if (fp
== NULL
) fp
= server
.devnull
;
3421 assert(rdbSaveObject(fp
,o
) != 1);
3425 /* Return the number of pages required to save this object in the swap file */
3426 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3427 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3429 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3432 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3433 static int rdbSave(char *filename
) {
3434 dictIterator
*di
= NULL
;
3439 time_t now
= time(NULL
);
3441 /* Wait for I/O therads to terminate, just in case this is a
3442 * foreground-saving, to avoid seeking the swap file descriptor at the
3444 if (server
.vm_enabled
)
3445 waitEmptyIOJobsQueue();
3447 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3448 fp
= fopen(tmpfile
,"w");
3450 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3453 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3454 for (j
= 0; j
< server
.dbnum
; j
++) {
3455 redisDb
*db
= server
.db
+j
;
3457 if (dictSize(d
) == 0) continue;
3458 di
= dictGetIterator(d
);
3464 /* Write the SELECT DB opcode */
3465 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3466 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3468 /* Iterate this DB writing every entry */
3469 while((de
= dictNext(di
)) != NULL
) {
3470 robj
*key
= dictGetEntryKey(de
);
3471 robj
*o
= dictGetEntryVal(de
);
3472 time_t expiretime
= getExpire(db
,key
);
3474 /* Save the expire time */
3475 if (expiretime
!= -1) {
3476 /* If this key is already expired skip it */
3477 if (expiretime
< now
) continue;
3478 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3479 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3481 /* Save the key and associated value. This requires special
3482 * handling if the value is swapped out. */
3483 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3484 key
->storage
== REDIS_VM_SWAPPING
) {
3485 /* Save type, key, value */
3486 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3487 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3488 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3490 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3492 /* Get a preview of the object in memory */
3493 po
= vmPreviewObject(key
);
3494 /* Save type, key, value */
3495 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3496 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3497 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3498 /* Remove the loaded object from memory */
3502 dictReleaseIterator(di
);
3505 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3507 /* Make sure data will not remain on the OS's output buffers */
3512 /* Use RENAME to make sure the DB file is changed atomically only
3513 * if the generate DB file is ok. */
3514 if (rename(tmpfile
,filename
) == -1) {
3515 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3519 redisLog(REDIS_NOTICE
,"DB saved on disk");
3521 server
.lastsave
= time(NULL
);
3527 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3528 if (di
) dictReleaseIterator(di
);
3532 static int rdbSaveBackground(char *filename
) {
3535 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3536 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3537 if ((childpid
= fork()) == 0) {
3539 if (server
.vm_enabled
) vmReopenSwapFile();
3541 if (rdbSave(filename
) == REDIS_OK
) {
3548 if (childpid
== -1) {
3549 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3553 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3554 server
.bgsavechildpid
= childpid
;
3555 updateDictResizePolicy();
3558 return REDIS_OK
; /* unreached */
3561 static void rdbRemoveTempFile(pid_t childpid
) {
3564 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3568 static int rdbLoadType(FILE *fp
) {
3570 if (fread(&type
,1,1,fp
) == 0) return -1;
3574 static time_t rdbLoadTime(FILE *fp
) {
3576 if (fread(&t32
,4,1,fp
) == 0) return -1;
3577 return (time_t) t32
;
3580 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3581 * of this file for a description of how this are stored on disk.
3583 * isencoded is set to 1 if the readed length is not actually a length but
3584 * an "encoding type", check the above comments for more info */
3585 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3586 unsigned char buf
[2];
3590 if (isencoded
) *isencoded
= 0;
3591 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3592 type
= (buf
[0]&0xC0)>>6;
3593 if (type
== REDIS_RDB_6BITLEN
) {
3594 /* Read a 6 bit len */
3596 } else if (type
== REDIS_RDB_ENCVAL
) {
3597 /* Read a 6 bit len encoding type */
3598 if (isencoded
) *isencoded
= 1;
3600 } else if (type
== REDIS_RDB_14BITLEN
) {
3601 /* Read a 14 bit len */
3602 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3603 return ((buf
[0]&0x3F)<<8)|buf
[1];
3605 /* Read a 32 bit len */
3606 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3611 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3612 unsigned char enc
[4];
3615 if (enctype
== REDIS_RDB_ENC_INT8
) {
3616 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3617 val
= (signed char)enc
[0];
3618 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3620 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3621 v
= enc
[0]|(enc
[1]<<8);
3623 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3625 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3626 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3629 val
= 0; /* anti-warning */
3632 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3635 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3636 unsigned int len
, clen
;
3637 unsigned char *c
= NULL
;
3640 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3641 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3642 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3643 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3644 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3645 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3647 return createObject(REDIS_STRING
,val
);
3654 static robj
*rdbLoadStringObject(FILE*fp
) {
3659 len
= rdbLoadLen(fp
,&isencoded
);
3662 case REDIS_RDB_ENC_INT8
:
3663 case REDIS_RDB_ENC_INT16
:
3664 case REDIS_RDB_ENC_INT32
:
3665 return rdbLoadIntegerObject(fp
,len
);
3666 case REDIS_RDB_ENC_LZF
:
3667 return rdbLoadLzfStringObject(fp
);
3673 if (len
== REDIS_RDB_LENERR
) return NULL
;
3674 val
= sdsnewlen(NULL
,len
);
3675 if (len
&& fread(val
,len
,1,fp
) == 0) {
3679 return createObject(REDIS_STRING
,val
);
3682 /* For information about double serialization check rdbSaveDoubleValue() */
3683 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3687 if (fread(&len
,1,1,fp
) == 0) return -1;
3689 case 255: *val
= R_NegInf
; return 0;
3690 case 254: *val
= R_PosInf
; return 0;
3691 case 253: *val
= R_Nan
; return 0;
3693 if (fread(buf
,len
,1,fp
) == 0) return -1;
3695 sscanf(buf
, "%lg", val
);
3700 /* Load a Redis object of the specified type from the specified file.
3701 * On success a newly allocated object is returned, otherwise NULL. */
3702 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3705 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3706 if (type
== REDIS_STRING
) {
3707 /* Read string value */
3708 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3709 o
= tryObjectEncoding(o
);
3710 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3711 /* Read list/set value */
3714 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3715 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3716 /* It's faster to expand the dict to the right size asap in order
3717 * to avoid rehashing */
3718 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3719 dictExpand(o
->ptr
,listlen
);
3720 /* Load every single element of the list/set */
3724 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3725 ele
= tryObjectEncoding(ele
);
3726 if (type
== REDIS_LIST
) {
3727 listAddNodeTail((list
*)o
->ptr
,ele
);
3729 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3732 } else if (type
== REDIS_ZSET
) {
3733 /* Read list/set value */
3737 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3738 o
= createZsetObject();
3740 /* Load every single element of the list/set */
3743 double *score
= zmalloc(sizeof(double));
3745 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3746 ele
= tryObjectEncoding(ele
);
3747 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3748 dictAdd(zs
->dict
,ele
,score
);
3749 zslInsert(zs
->zsl
,*score
,ele
);
3750 incrRefCount(ele
); /* added to skiplist */
3752 } else if (type
== REDIS_HASH
) {
3755 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3756 o
= createHashObject();
3757 /* Too many entries? Use an hash table. */
3758 if (hashlen
> server
.hash_max_zipmap_entries
)
3759 convertToRealHash(o
);
3760 /* Load every key/value, then set it into the zipmap or hash
3761 * table, as needed. */
3765 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3766 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3767 /* If we are using a zipmap and there are too big values
3768 * the object is converted to real hash table encoding. */
3769 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3770 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3771 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3773 convertToRealHash(o
);
3776 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3777 unsigned char *zm
= o
->ptr
;
3779 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3780 val
->ptr
,sdslen(val
->ptr
),NULL
);
3785 key
= tryObjectEncoding(key
);
3786 val
= tryObjectEncoding(val
);
3787 dictAdd((dict
*)o
->ptr
,key
,val
);
3796 static int rdbLoad(char *filename
) {
3798 robj
*keyobj
= NULL
;
3800 int type
, retval
, rdbver
;
3801 dict
*d
= server
.db
[0].dict
;
3802 redisDb
*db
= server
.db
+0;
3804 time_t expiretime
= -1, now
= time(NULL
);
3805 long long loadedkeys
= 0;
3807 fp
= fopen(filename
,"r");
3808 if (!fp
) return REDIS_ERR
;
3809 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3811 if (memcmp(buf
,"REDIS",5) != 0) {
3813 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3816 rdbver
= atoi(buf
+5);
3819 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3826 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3827 if (type
== REDIS_EXPIRETIME
) {
3828 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3829 /* We read the time so we need to read the object type again */
3830 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3832 if (type
== REDIS_EOF
) break;
3833 /* Handle SELECT DB opcode as a special case */
3834 if (type
== REDIS_SELECTDB
) {
3835 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3837 if (dbid
>= (unsigned)server
.dbnum
) {
3838 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3841 db
= server
.db
+dbid
;
3846 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3848 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3849 /* Add the new object in the hash table */
3850 retval
= dictAdd(d
,keyobj
,o
);
3851 if (retval
== DICT_ERR
) {
3852 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3855 /* Set the expire time if needed */
3856 if (expiretime
!= -1) {
3857 setExpire(db
,keyobj
,expiretime
);
3858 /* Delete this key if already expired */
3859 if (expiretime
< now
) deleteKey(db
,keyobj
);
3863 /* Handle swapping while loading big datasets when VM is on */
3865 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3866 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3867 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3874 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3875 if (keyobj
) decrRefCount(keyobj
);
3876 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3878 return REDIS_ERR
; /* Just to avoid warning */
3881 /*================================== Commands =============================== */
3883 static void authCommand(redisClient
*c
) {
3884 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3885 c
->authenticated
= 1;
3886 addReply(c
,shared
.ok
);
3888 c
->authenticated
= 0;
3889 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3893 static void pingCommand(redisClient
*c
) {
3894 addReply(c
,shared
.pong
);
3897 static void echoCommand(redisClient
*c
) {
3898 addReplyBulk(c
,c
->argv
[1]);
3901 /*=================================== Strings =============================== */
3903 static void setGenericCommand(redisClient
*c
, int nx
) {
3906 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3907 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3908 if (retval
== DICT_ERR
) {
3910 /* If the key is about a swapped value, we want a new key object
3911 * to overwrite the old. So we delete the old key in the database.
3912 * This will also make sure that swap pages about the old object
3913 * will be marked as free. */
3914 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3915 incrRefCount(c
->argv
[1]);
3916 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3917 incrRefCount(c
->argv
[2]);
3919 addReply(c
,shared
.czero
);
3923 incrRefCount(c
->argv
[1]);
3924 incrRefCount(c
->argv
[2]);
3927 removeExpire(c
->db
,c
->argv
[1]);
3928 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3931 static void setCommand(redisClient
*c
) {
3932 setGenericCommand(c
,0);
3935 static void setnxCommand(redisClient
*c
) {
3936 setGenericCommand(c
,1);
3939 static int getGenericCommand(redisClient
*c
) {
3942 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3945 if (o
->type
!= REDIS_STRING
) {
3946 addReply(c
,shared
.wrongtypeerr
);
3954 static void getCommand(redisClient
*c
) {
3955 getGenericCommand(c
);
3958 static void getsetCommand(redisClient
*c
) {
3959 if (getGenericCommand(c
) == REDIS_ERR
) return;
3960 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3961 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3963 incrRefCount(c
->argv
[1]);
3965 incrRefCount(c
->argv
[2]);
3967 removeExpire(c
->db
,c
->argv
[1]);
3970 static void mgetCommand(redisClient
*c
) {
3973 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3974 for (j
= 1; j
< c
->argc
; j
++) {
3975 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3977 addReply(c
,shared
.nullbulk
);
3979 if (o
->type
!= REDIS_STRING
) {
3980 addReply(c
,shared
.nullbulk
);
3988 static void msetGenericCommand(redisClient
*c
, int nx
) {
3989 int j
, busykeys
= 0;
3991 if ((c
->argc
% 2) == 0) {
3992 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3995 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3996 * set nothing at all if at least one already key exists. */
3998 for (j
= 1; j
< c
->argc
; j
+= 2) {
3999 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4005 addReply(c
, shared
.czero
);
4009 for (j
= 1; j
< c
->argc
; j
+= 2) {
4012 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4013 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4014 if (retval
== DICT_ERR
) {
4015 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4016 incrRefCount(c
->argv
[j
+1]);
4018 incrRefCount(c
->argv
[j
]);
4019 incrRefCount(c
->argv
[j
+1]);
4021 removeExpire(c
->db
,c
->argv
[j
]);
4023 server
.dirty
+= (c
->argc
-1)/2;
4024 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4027 static void msetCommand(redisClient
*c
) {
4028 msetGenericCommand(c
,0);
4031 static void msetnxCommand(redisClient
*c
) {
4032 msetGenericCommand(c
,1);
4035 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4040 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4042 if (getLongLongFromObject(c
, o
, &value
) != REDIS_OK
) return;
4045 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4046 o
= tryObjectEncoding(o
);
4047 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4048 if (retval
== DICT_ERR
) {
4049 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4050 removeExpire(c
->db
,c
->argv
[1]);
4052 incrRefCount(c
->argv
[1]);
4055 addReply(c
,shared
.colon
);
4057 addReply(c
,shared
.crlf
);
4060 static void incrCommand(redisClient
*c
) {
4061 incrDecrCommand(c
,1);
4064 static void decrCommand(redisClient
*c
) {
4065 incrDecrCommand(c
,-1);
4068 static void incrbyCommand(redisClient
*c
) {
4071 if (getLongLongFromObject(c
, c
->argv
[2], &incr
) != REDIS_OK
) return;
4073 incrDecrCommand(c
,incr
);
4076 static void decrbyCommand(redisClient
*c
) {
4079 if (getLongLongFromObject(c
, c
->argv
[2], &incr
) != REDIS_OK
) return;
4081 incrDecrCommand(c
,-incr
);
4084 static void appendCommand(redisClient
*c
) {
4089 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4091 /* Create the key */
4092 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4093 incrRefCount(c
->argv
[1]);
4094 incrRefCount(c
->argv
[2]);
4095 totlen
= stringObjectLen(c
->argv
[2]);
4099 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4102 o
= dictGetEntryVal(de
);
4103 if (o
->type
!= REDIS_STRING
) {
4104 addReply(c
,shared
.wrongtypeerr
);
4107 /* If the object is specially encoded or shared we have to make
4109 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4110 robj
*decoded
= getDecodedObject(o
);
4112 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4113 decrRefCount(decoded
);
4114 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4117 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4118 o
->ptr
= sdscatlen(o
->ptr
,
4119 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4121 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4122 (unsigned long) c
->argv
[2]->ptr
);
4124 totlen
= sdslen(o
->ptr
);
4127 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4130 static void substrCommand(redisClient
*c
) {
4132 long start
= atoi(c
->argv
[2]->ptr
);
4133 long end
= atoi(c
->argv
[3]->ptr
);
4134 size_t rangelen
, strlen
;
4137 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4138 checkType(c
,o
,REDIS_STRING
)) return;
4140 o
= getDecodedObject(o
);
4141 strlen
= sdslen(o
->ptr
);
4143 /* convert negative indexes */
4144 if (start
< 0) start
= strlen
+start
;
4145 if (end
< 0) end
= strlen
+end
;
4146 if (start
< 0) start
= 0;
4147 if (end
< 0) end
= 0;
4149 /* indexes sanity checks */
4150 if (start
> end
|| (size_t)start
>= strlen
) {
4151 /* Out of range start or start > end result in null reply */
4152 addReply(c
,shared
.nullbulk
);
4156 if ((size_t)end
>= strlen
) end
= strlen
-1;
4157 rangelen
= (end
-start
)+1;
4159 /* Return the result */
4160 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4161 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4162 addReplySds(c
,range
);
4163 addReply(c
,shared
.crlf
);
4167 /* ========================= Type agnostic commands ========================= */
4169 static void delCommand(redisClient
*c
) {
4172 for (j
= 1; j
< c
->argc
; j
++) {
4173 if (deleteKey(c
->db
,c
->argv
[j
])) {
4178 addReplyLong(c
,deleted
);
4181 static void existsCommand(redisClient
*c
) {
4182 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4185 static void selectCommand(redisClient
*c
) {
4186 int id
= atoi(c
->argv
[1]->ptr
);
4188 if (selectDb(c
,id
) == REDIS_ERR
) {
4189 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4191 addReply(c
,shared
.ok
);
4195 static void randomkeyCommand(redisClient
*c
) {
4199 de
= dictGetRandomKey(c
->db
->dict
);
4200 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4203 addReply(c
,shared
.plus
);
4204 addReply(c
,shared
.crlf
);
4206 addReply(c
,shared
.plus
);
4207 addReply(c
,dictGetEntryKey(de
));
4208 addReply(c
,shared
.crlf
);
4212 static void keysCommand(redisClient
*c
) {
4215 sds pattern
= c
->argv
[1]->ptr
;
4216 int plen
= sdslen(pattern
);
4217 unsigned long numkeys
= 0;
4218 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4220 di
= dictGetIterator(c
->db
->dict
);
4222 decrRefCount(lenobj
);
4223 while((de
= dictNext(di
)) != NULL
) {
4224 robj
*keyobj
= dictGetEntryKey(de
);
4226 sds key
= keyobj
->ptr
;
4227 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4228 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4229 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4230 addReplyBulk(c
,keyobj
);
4235 dictReleaseIterator(di
);
4236 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4239 static void dbsizeCommand(redisClient
*c
) {
4241 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4244 static void lastsaveCommand(redisClient
*c
) {
4246 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4249 static void typeCommand(redisClient
*c
) {
4253 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4258 case REDIS_STRING
: type
= "+string"; break;
4259 case REDIS_LIST
: type
= "+list"; break;
4260 case REDIS_SET
: type
= "+set"; break;
4261 case REDIS_ZSET
: type
= "+zset"; break;
4262 case REDIS_HASH
: type
= "+hash"; break;
4263 default: type
= "+unknown"; break;
4266 addReplySds(c
,sdsnew(type
));
4267 addReply(c
,shared
.crlf
);
4270 static void saveCommand(redisClient
*c
) {
4271 if (server
.bgsavechildpid
!= -1) {
4272 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4275 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4276 addReply(c
,shared
.ok
);
4278 addReply(c
,shared
.err
);
4282 static void bgsaveCommand(redisClient
*c
) {
4283 if (server
.bgsavechildpid
!= -1) {
4284 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4287 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4288 char *status
= "+Background saving started\r\n";
4289 addReplySds(c
,sdsnew(status
));
4291 addReply(c
,shared
.err
);
4295 static void shutdownCommand(redisClient
*c
) {
4296 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4297 /* Kill the saving child if there is a background saving in progress.
4298 We want to avoid race conditions, for instance our saving child may
4299 overwrite the synchronous saving did by SHUTDOWN. */
4300 if (server
.bgsavechildpid
!= -1) {
4301 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4302 kill(server
.bgsavechildpid
,SIGKILL
);
4303 rdbRemoveTempFile(server
.bgsavechildpid
);
4305 if (server
.appendonly
) {
4306 /* Append only file: fsync() the AOF and exit */
4307 fsync(server
.appendfd
);
4308 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4311 /* Snapshotting. Perform a SYNC SAVE and exit */
4312 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4313 if (server
.daemonize
)
4314 unlink(server
.pidfile
);
4315 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4316 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4317 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4320 /* Ooops.. error saving! The best we can do is to continue
4321 * operating. Note that if there was a background saving process,
4322 * in the next cron() Redis will be notified that the background
4323 * saving aborted, handling special stuff like slaves pending for
4324 * synchronization... */
4325 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4327 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4332 static void renameGenericCommand(redisClient
*c
, int nx
) {
4335 /* To use the same key as src and dst is probably an error */
4336 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4337 addReply(c
,shared
.sameobjecterr
);
4341 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4345 deleteIfVolatile(c
->db
,c
->argv
[2]);
4346 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4349 addReply(c
,shared
.czero
);
4352 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4354 incrRefCount(c
->argv
[2]);
4356 deleteKey(c
->db
,c
->argv
[1]);
4358 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4361 static void renameCommand(redisClient
*c
) {
4362 renameGenericCommand(c
,0);
4365 static void renamenxCommand(redisClient
*c
) {
4366 renameGenericCommand(c
,1);
4369 static void moveCommand(redisClient
*c
) {
4374 /* Obtain source and target DB pointers */
4377 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4378 addReply(c
,shared
.outofrangeerr
);
4382 selectDb(c
,srcid
); /* Back to the source DB */
4384 /* If the user is moving using as target the same
4385 * DB as the source DB it is probably an error. */
4387 addReply(c
,shared
.sameobjecterr
);
4391 /* Check if the element exists and get a reference */
4392 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4394 addReply(c
,shared
.czero
);
4398 /* Try to add the element to the target DB */
4399 deleteIfVolatile(dst
,c
->argv
[1]);
4400 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4401 addReply(c
,shared
.czero
);
4404 incrRefCount(c
->argv
[1]);
4407 /* OK! key moved, free the entry in the source DB */
4408 deleteKey(src
,c
->argv
[1]);
4410 addReply(c
,shared
.cone
);
4413 /* =================================== Lists ================================ */
4414 static void pushGenericCommand(redisClient
*c
, int where
) {
4418 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4420 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4421 addReply(c
,shared
.cone
);
4424 lobj
= createListObject();
4426 if (where
== REDIS_HEAD
) {
4427 listAddNodeHead(list
,c
->argv
[2]);
4429 listAddNodeTail(list
,c
->argv
[2]);
4431 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4432 incrRefCount(c
->argv
[1]);
4433 incrRefCount(c
->argv
[2]);
4435 if (lobj
->type
!= REDIS_LIST
) {
4436 addReply(c
,shared
.wrongtypeerr
);
4439 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4440 addReply(c
,shared
.cone
);
4444 if (where
== REDIS_HEAD
) {
4445 listAddNodeHead(list
,c
->argv
[2]);
4447 listAddNodeTail(list
,c
->argv
[2]);
4449 incrRefCount(c
->argv
[2]);
4452 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4455 static void lpushCommand(redisClient
*c
) {
4456 pushGenericCommand(c
,REDIS_HEAD
);
4459 static void rpushCommand(redisClient
*c
) {
4460 pushGenericCommand(c
,REDIS_TAIL
);
4463 static void llenCommand(redisClient
*c
) {
4467 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4468 checkType(c
,o
,REDIS_LIST
)) return;
4471 addReplyUlong(c
,listLength(l
));
4474 static void lindexCommand(redisClient
*c
) {
4476 int index
= atoi(c
->argv
[2]->ptr
);
4480 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4481 checkType(c
,o
,REDIS_LIST
)) return;
4484 ln
= listIndex(list
, index
);
4486 addReply(c
,shared
.nullbulk
);
4488 robj
*ele
= listNodeValue(ln
);
4489 addReplyBulk(c
,ele
);
4493 static void lsetCommand(redisClient
*c
) {
4495 int index
= atoi(c
->argv
[2]->ptr
);
4499 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4500 checkType(c
,o
,REDIS_LIST
)) return;
4503 ln
= listIndex(list
, index
);
4505 addReply(c
,shared
.outofrangeerr
);
4507 robj
*ele
= listNodeValue(ln
);
4510 listNodeValue(ln
) = c
->argv
[3];
4511 incrRefCount(c
->argv
[3]);
4512 addReply(c
,shared
.ok
);
4517 static void popGenericCommand(redisClient
*c
, int where
) {
4522 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4523 checkType(c
,o
,REDIS_LIST
)) return;
4526 if (where
== REDIS_HEAD
)
4527 ln
= listFirst(list
);
4529 ln
= listLast(list
);
4532 addReply(c
,shared
.nullbulk
);
4534 robj
*ele
= listNodeValue(ln
);
4535 addReplyBulk(c
,ele
);
4536 listDelNode(list
,ln
);
4537 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4542 static void lpopCommand(redisClient
*c
) {
4543 popGenericCommand(c
,REDIS_HEAD
);
4546 static void rpopCommand(redisClient
*c
) {
4547 popGenericCommand(c
,REDIS_TAIL
);
4550 static void lrangeCommand(redisClient
*c
) {
4552 int start
= atoi(c
->argv
[2]->ptr
);
4553 int end
= atoi(c
->argv
[3]->ptr
);
4560 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4561 || checkType(c
,o
,REDIS_LIST
)) return;
4563 llen
= listLength(list
);
4565 /* convert negative indexes */
4566 if (start
< 0) start
= llen
+start
;
4567 if (end
< 0) end
= llen
+end
;
4568 if (start
< 0) start
= 0;
4569 if (end
< 0) end
= 0;
4571 /* indexes sanity checks */
4572 if (start
> end
|| start
>= llen
) {
4573 /* Out of range start or start > end result in empty list */
4574 addReply(c
,shared
.emptymultibulk
);
4577 if (end
>= llen
) end
= llen
-1;
4578 rangelen
= (end
-start
)+1;
4580 /* Return the result in form of a multi-bulk reply */
4581 ln
= listIndex(list
, start
);
4582 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4583 for (j
= 0; j
< rangelen
; j
++) {
4584 ele
= listNodeValue(ln
);
4585 addReplyBulk(c
,ele
);
4590 static void ltrimCommand(redisClient
*c
) {
4592 int start
= atoi(c
->argv
[2]->ptr
);
4593 int end
= atoi(c
->argv
[3]->ptr
);
4595 int j
, ltrim
, rtrim
;
4599 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4600 checkType(c
,o
,REDIS_LIST
)) return;
4602 llen
= listLength(list
);
4604 /* convert negative indexes */
4605 if (start
< 0) start
= llen
+start
;
4606 if (end
< 0) end
= llen
+end
;
4607 if (start
< 0) start
= 0;
4608 if (end
< 0) end
= 0;
4610 /* indexes sanity checks */
4611 if (start
> end
|| start
>= llen
) {
4612 /* Out of range start or start > end result in empty list */
4616 if (end
>= llen
) end
= llen
-1;
4621 /* Remove list elements to perform the trim */
4622 for (j
= 0; j
< ltrim
; j
++) {
4623 ln
= listFirst(list
);
4624 listDelNode(list
,ln
);
4626 for (j
= 0; j
< rtrim
; j
++) {
4627 ln
= listLast(list
);
4628 listDelNode(list
,ln
);
4630 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4632 addReply(c
,shared
.ok
);
4635 static void lremCommand(redisClient
*c
) {
4638 listNode
*ln
, *next
;
4639 int toremove
= atoi(c
->argv
[2]->ptr
);
4643 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4644 checkType(c
,o
,REDIS_LIST
)) return;
4648 toremove
= -toremove
;
4651 ln
= fromtail
? list
->tail
: list
->head
;
4653 robj
*ele
= listNodeValue(ln
);
4655 next
= fromtail
? ln
->prev
: ln
->next
;
4656 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4657 listDelNode(list
,ln
);
4660 if (toremove
&& removed
== toremove
) break;
4664 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4665 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4668 /* This is the semantic of this command:
4669 * RPOPLPUSH srclist dstlist:
4670 * IF LLEN(srclist) > 0
4671 * element = RPOP srclist
4672 * LPUSH dstlist element
4679 * The idea is to be able to get an element from a list in a reliable way
4680 * since the element is not just returned but pushed against another list
4681 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4683 static void rpoplpushcommand(redisClient
*c
) {
4688 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4689 checkType(c
,sobj
,REDIS_LIST
)) return;
4690 srclist
= sobj
->ptr
;
4691 ln
= listLast(srclist
);
4694 addReply(c
,shared
.nullbulk
);
4696 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4697 robj
*ele
= listNodeValue(ln
);
4700 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4701 addReply(c
,shared
.wrongtypeerr
);
4705 /* Add the element to the target list (unless it's directly
4706 * passed to some BLPOP-ing client */
4707 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4709 /* Create the list if the key does not exist */
4710 dobj
= createListObject();
4711 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4712 incrRefCount(c
->argv
[2]);
4714 dstlist
= dobj
->ptr
;
4715 listAddNodeHead(dstlist
,ele
);
4719 /* Send the element to the client as reply as well */
4720 addReplyBulk(c
,ele
);
4722 /* Finally remove the element from the source list */
4723 listDelNode(srclist
,ln
);
4724 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4729 /* ==================================== Sets ================================ */
4731 static void saddCommand(redisClient
*c
) {
4734 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4736 set
= createSetObject();
4737 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4738 incrRefCount(c
->argv
[1]);
4740 if (set
->type
!= REDIS_SET
) {
4741 addReply(c
,shared
.wrongtypeerr
);
4745 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4746 incrRefCount(c
->argv
[2]);
4748 addReply(c
,shared
.cone
);
4750 addReply(c
,shared
.czero
);
4754 static void sremCommand(redisClient
*c
) {
4757 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4758 checkType(c
,set
,REDIS_SET
)) return;
4760 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4762 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4763 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4764 addReply(c
,shared
.cone
);
4766 addReply(c
,shared
.czero
);
4770 static void smoveCommand(redisClient
*c
) {
4771 robj
*srcset
, *dstset
;
4773 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4774 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4776 /* If the source key does not exist return 0, if it's of the wrong type
4778 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4779 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4782 /* Error if the destination key is not a set as well */
4783 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4784 addReply(c
,shared
.wrongtypeerr
);
4787 /* Remove the element from the source set */
4788 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4789 /* Key not found in the src set! return zero */
4790 addReply(c
,shared
.czero
);
4793 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4794 deleteKey(c
->db
,c
->argv
[1]);
4796 /* Add the element to the destination set */
4798 dstset
= createSetObject();
4799 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4800 incrRefCount(c
->argv
[2]);
4802 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4803 incrRefCount(c
->argv
[3]);
4804 addReply(c
,shared
.cone
);
4807 static void sismemberCommand(redisClient
*c
) {
4810 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4811 checkType(c
,set
,REDIS_SET
)) return;
4813 if (dictFind(set
->ptr
,c
->argv
[2]))
4814 addReply(c
,shared
.cone
);
4816 addReply(c
,shared
.czero
);
4819 static void scardCommand(redisClient
*c
) {
4823 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4824 checkType(c
,o
,REDIS_SET
)) return;
4827 addReplyUlong(c
,dictSize(s
));
4830 static void spopCommand(redisClient
*c
) {
4834 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4835 checkType(c
,set
,REDIS_SET
)) return;
4837 de
= dictGetRandomKey(set
->ptr
);
4839 addReply(c
,shared
.nullbulk
);
4841 robj
*ele
= dictGetEntryKey(de
);
4843 addReplyBulk(c
,ele
);
4844 dictDelete(set
->ptr
,ele
);
4845 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4846 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4851 static void srandmemberCommand(redisClient
*c
) {
4855 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4856 checkType(c
,set
,REDIS_SET
)) return;
4858 de
= dictGetRandomKey(set
->ptr
);
4860 addReply(c
,shared
.nullbulk
);
4862 robj
*ele
= dictGetEntryKey(de
);
4864 addReplyBulk(c
,ele
);
4868 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4869 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4871 return dictSize(*d1
)-dictSize(*d2
);
4874 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4875 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4878 robj
*lenobj
= NULL
, *dstset
= NULL
;
4879 unsigned long j
, cardinality
= 0;
4881 for (j
= 0; j
< setsnum
; j
++) {
4885 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4886 lookupKeyRead(c
->db
,setskeys
[j
]);
4890 if (deleteKey(c
->db
,dstkey
))
4892 addReply(c
,shared
.czero
);
4894 addReply(c
,shared
.emptymultibulk
);
4898 if (setobj
->type
!= REDIS_SET
) {
4900 addReply(c
,shared
.wrongtypeerr
);
4903 dv
[j
] = setobj
->ptr
;
4905 /* Sort sets from the smallest to largest, this will improve our
4906 * algorithm's performace */
4907 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4909 /* The first thing we should output is the total number of elements...
4910 * since this is a multi-bulk write, but at this stage we don't know
4911 * the intersection set size, so we use a trick, append an empty object
4912 * to the output list and save the pointer to later modify it with the
4915 lenobj
= createObject(REDIS_STRING
,NULL
);
4917 decrRefCount(lenobj
);
4919 /* If we have a target key where to store the resulting set
4920 * create this key with an empty set inside */
4921 dstset
= createSetObject();
4924 /* Iterate all the elements of the first (smallest) set, and test
4925 * the element against all the other sets, if at least one set does
4926 * not include the element it is discarded */
4927 di
= dictGetIterator(dv
[0]);
4929 while((de
= dictNext(di
)) != NULL
) {
4932 for (j
= 1; j
< setsnum
; j
++)
4933 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4935 continue; /* at least one set does not contain the member */
4936 ele
= dictGetEntryKey(de
);
4938 addReplyBulk(c
,ele
);
4941 dictAdd(dstset
->ptr
,ele
,NULL
);
4945 dictReleaseIterator(di
);
4948 /* Store the resulting set into the target, if the intersection
4949 * is not an empty set. */
4950 deleteKey(c
->db
,dstkey
);
4951 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4952 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4953 incrRefCount(dstkey
);
4954 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4956 decrRefCount(dstset
);
4957 addReply(c
,shared
.czero
);
4961 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4966 static void sinterCommand(redisClient
*c
) {
4967 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4970 static void sinterstoreCommand(redisClient
*c
) {
4971 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4974 #define REDIS_OP_UNION 0
4975 #define REDIS_OP_DIFF 1
4976 #define REDIS_OP_INTER 2
4978 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4979 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4982 robj
*dstset
= NULL
;
4983 int j
, cardinality
= 0;
4985 for (j
= 0; j
< setsnum
; j
++) {
4989 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4990 lookupKeyRead(c
->db
,setskeys
[j
]);
4995 if (setobj
->type
!= REDIS_SET
) {
4997 addReply(c
,shared
.wrongtypeerr
);
5000 dv
[j
] = setobj
->ptr
;
5003 /* We need a temp set object to store our union. If the dstkey
5004 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5005 * this set object will be the resulting object to set into the target key*/
5006 dstset
= createSetObject();
5008 /* Iterate all the elements of all the sets, add every element a single
5009 * time to the result set */
5010 for (j
= 0; j
< setsnum
; j
++) {
5011 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5012 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5014 di
= dictGetIterator(dv
[j
]);
5016 while((de
= dictNext(di
)) != NULL
) {
5019 /* dictAdd will not add the same element multiple times */
5020 ele
= dictGetEntryKey(de
);
5021 if (op
== REDIS_OP_UNION
|| j
== 0) {
5022 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5026 } else if (op
== REDIS_OP_DIFF
) {
5027 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5032 dictReleaseIterator(di
);
5034 /* result set is empty? Exit asap. */
5035 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5038 /* Output the content of the resulting set, if not in STORE mode */
5040 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5041 di
= dictGetIterator(dstset
->ptr
);
5042 while((de
= dictNext(di
)) != NULL
) {
5045 ele
= dictGetEntryKey(de
);
5046 addReplyBulk(c
,ele
);
5048 dictReleaseIterator(di
);
5049 decrRefCount(dstset
);
5051 /* If we have a target key where to store the resulting set
5052 * create this key with the result set inside */
5053 deleteKey(c
->db
,dstkey
);
5054 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5055 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5056 incrRefCount(dstkey
);
5057 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5059 decrRefCount(dstset
);
5060 addReply(c
,shared
.czero
);
5067 static void sunionCommand(redisClient
*c
) {
5068 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5071 static void sunionstoreCommand(redisClient
*c
) {
5072 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5075 static void sdiffCommand(redisClient
*c
) {
5076 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5079 static void sdiffstoreCommand(redisClient
*c
) {
5080 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5083 /* ==================================== ZSets =============================== */
5085 /* ZSETs are ordered sets using two data structures to hold the same elements
5086 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5089 * The elements are added to an hash table mapping Redis objects to scores.
5090 * At the same time the elements are added to a skip list mapping scores
5091 * to Redis objects (so objects are sorted by scores in this "view"). */
5093 /* This skiplist implementation is almost a C translation of the original
5094 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5095 * Alternative to Balanced Trees", modified in three ways:
5096 * a) this implementation allows for repeated values.
5097 * b) the comparison is not just by key (our 'score') but by satellite data.
5098 * c) there is a back pointer, so it's a doubly linked list with the back
5099 * pointers being only at "level 1". This allows to traverse the list
5100 * from tail to head, useful for ZREVRANGE. */
5102 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5103 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5105 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5107 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5113 static zskiplist
*zslCreate(void) {
5117 zsl
= zmalloc(sizeof(*zsl
));
5120 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5121 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5122 zsl
->header
->forward
[j
] = NULL
;
5124 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5125 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5126 zsl
->header
->span
[j
] = 0;
5128 zsl
->header
->backward
= NULL
;
5133 static void zslFreeNode(zskiplistNode
*node
) {
5134 decrRefCount(node
->obj
);
5135 zfree(node
->forward
);
5140 static void zslFree(zskiplist
*zsl
) {
5141 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5143 zfree(zsl
->header
->forward
);
5144 zfree(zsl
->header
->span
);
5147 next
= node
->forward
[0];
5154 static int zslRandomLevel(void) {
5156 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5158 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5161 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5162 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5163 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5167 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5168 /* store rank that is crossed to reach the insert position */
5169 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5171 while (x
->forward
[i
] &&
5172 (x
->forward
[i
]->score
< score
||
5173 (x
->forward
[i
]->score
== score
&&
5174 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5175 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5180 /* we assume the key is not already inside, since we allow duplicated
5181 * scores, and the re-insertion of score and redis object should never
5182 * happpen since the caller of zslInsert() should test in the hash table
5183 * if the element is already inside or not. */
5184 level
= zslRandomLevel();
5185 if (level
> zsl
->level
) {
5186 for (i
= zsl
->level
; i
< level
; i
++) {
5188 update
[i
] = zsl
->header
;
5189 update
[i
]->span
[i
-1] = zsl
->length
;
5193 x
= zslCreateNode(level
,score
,obj
);
5194 for (i
= 0; i
< level
; i
++) {
5195 x
->forward
[i
] = update
[i
]->forward
[i
];
5196 update
[i
]->forward
[i
] = x
;
5198 /* update span covered by update[i] as x is inserted here */
5200 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5201 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5205 /* increment span for untouched levels */
5206 for (i
= level
; i
< zsl
->level
; i
++) {
5207 update
[i
]->span
[i
-1]++;
5210 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5212 x
->forward
[0]->backward
= x
;
5218 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5219 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5221 for (i
= 0; i
< zsl
->level
; i
++) {
5222 if (update
[i
]->forward
[i
] == x
) {
5224 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5226 update
[i
]->forward
[i
] = x
->forward
[i
];
5228 /* invariant: i > 0, because update[0]->forward[0]
5229 * is always equal to x */
5230 update
[i
]->span
[i
-1] -= 1;
5233 if (x
->forward
[0]) {
5234 x
->forward
[0]->backward
= x
->backward
;
5236 zsl
->tail
= x
->backward
;
5238 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5243 /* Delete an element with matching score/object from the skiplist. */
5244 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5245 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5249 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5250 while (x
->forward
[i
] &&
5251 (x
->forward
[i
]->score
< score
||
5252 (x
->forward
[i
]->score
== score
&&
5253 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5257 /* We may have multiple elements with the same score, what we need
5258 * is to find the element with both the right score and object. */
5260 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5261 zslDeleteNode(zsl
, x
, update
);
5265 return 0; /* not found */
5267 return 0; /* not found */
5270 /* Delete all the elements with score between min and max from the skiplist.
5271 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5272 * Note that this function takes the reference to the hash table view of the
5273 * sorted set, in order to remove the elements from the hash table too. */
5274 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5275 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5276 unsigned long removed
= 0;
5280 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5281 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5285 /* We may have multiple elements with the same score, what we need
5286 * is to find the element with both the right score and object. */
5288 while (x
&& x
->score
<= max
) {
5289 zskiplistNode
*next
= x
->forward
[0];
5290 zslDeleteNode(zsl
, x
, update
);
5291 dictDelete(dict
,x
->obj
);
5296 return removed
; /* not found */
5299 /* Delete all the elements with rank between start and end from the skiplist.
5300 * Start and end are inclusive. Note that start and end need to be 1-based */
5301 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5302 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5303 unsigned long traversed
= 0, removed
= 0;
5307 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5308 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5309 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5317 while (x
&& traversed
<= end
) {
5318 zskiplistNode
*next
= x
->forward
[0];
5319 zslDeleteNode(zsl
, x
, update
);
5320 dictDelete(dict
,x
->obj
);
5329 /* Find the first node having a score equal or greater than the specified one.
5330 * Returns NULL if there is no match. */
5331 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5336 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5337 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5340 /* We may have multiple elements with the same score, what we need
5341 * is to find the element with both the right score and object. */
5342 return x
->forward
[0];
5345 /* Find the rank for an element by both score and key.
5346 * Returns 0 when the element cannot be found, rank otherwise.
5347 * Note that the rank is 1-based due to the span of zsl->header to the
5349 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5351 unsigned long rank
= 0;
5355 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5356 while (x
->forward
[i
] &&
5357 (x
->forward
[i
]->score
< score
||
5358 (x
->forward
[i
]->score
== score
&&
5359 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5360 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5364 /* x might be equal to zsl->header, so test if obj is non-NULL */
5365 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5372 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5373 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5375 unsigned long traversed
= 0;
5379 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5380 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5382 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5385 if (traversed
== rank
) {
5392 /* The actual Z-commands implementations */
5394 /* This generic command implements both ZADD and ZINCRBY.
5395 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5396 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5397 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5402 zsetobj
= lookupKeyWrite(c
->db
,key
);
5403 if (zsetobj
== NULL
) {
5404 zsetobj
= createZsetObject();
5405 dictAdd(c
->db
->dict
,key
,zsetobj
);
5408 if (zsetobj
->type
!= REDIS_ZSET
) {
5409 addReply(c
,shared
.wrongtypeerr
);
5415 /* Ok now since we implement both ZADD and ZINCRBY here the code
5416 * needs to handle the two different conditions. It's all about setting
5417 * '*score', that is, the new score to set, to the right value. */
5418 score
= zmalloc(sizeof(double));
5422 /* Read the old score. If the element was not present starts from 0 */
5423 de
= dictFind(zs
->dict
,ele
);
5425 double *oldscore
= dictGetEntryVal(de
);
5426 *score
= *oldscore
+ scoreval
;
5434 /* What follows is a simple remove and re-insert operation that is common
5435 * to both ZADD and ZINCRBY... */
5436 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5437 /* case 1: New element */
5438 incrRefCount(ele
); /* added to hash */
5439 zslInsert(zs
->zsl
,*score
,ele
);
5440 incrRefCount(ele
); /* added to skiplist */
5443 addReplyDouble(c
,*score
);
5445 addReply(c
,shared
.cone
);
5450 /* case 2: Score update operation */
5451 de
= dictFind(zs
->dict
,ele
);
5452 redisAssert(de
!= NULL
);
5453 oldscore
= dictGetEntryVal(de
);
5454 if (*score
!= *oldscore
) {
5457 /* Remove and insert the element in the skip list with new score */
5458 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5459 redisAssert(deleted
!= 0);
5460 zslInsert(zs
->zsl
,*score
,ele
);
5462 /* Update the score in the hash table */
5463 dictReplace(zs
->dict
,ele
,score
);
5469 addReplyDouble(c
,*score
);
5471 addReply(c
,shared
.czero
);
5475 static void zaddCommand(redisClient
*c
) {
5478 if (getDoubleFromObject(c
, c
->argv
[2], &scoreval
) != REDIS_OK
) return;
5480 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5483 static void zincrbyCommand(redisClient
*c
) {
5486 if (getDoubleFromObject(c
, c
->argv
[2], &scoreval
) != REDIS_OK
) return;
5488 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5491 static void zremCommand(redisClient
*c
) {
5498 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5499 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5502 de
= dictFind(zs
->dict
,c
->argv
[2]);
5504 addReply(c
,shared
.czero
);
5507 /* Delete from the skiplist */
5508 oldscore
= dictGetEntryVal(de
);
5509 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5510 redisAssert(deleted
!= 0);
5512 /* Delete from the hash table */
5513 dictDelete(zs
->dict
,c
->argv
[2]);
5514 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5515 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5517 addReply(c
,shared
.cone
);
5520 static void zremrangebyscoreCommand(redisClient
*c
) {
5527 if ((getDoubleFromObject(c
, c
->argv
[2], &min
) != REDIS_OK
) ||
5528 (getDoubleFromObject(c
, c
->argv
[3], &max
) != REDIS_OK
)) return;
5530 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5531 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5534 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5535 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5536 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5537 server
.dirty
+= deleted
;
5538 addReplyLong(c
,deleted
);
5541 static void zremrangebyrankCommand(redisClient
*c
) {
5549 if ((getLongFromObject(c
, c
->argv
[2], &start
) != REDIS_OK
) ||
5550 (getLongFromObject(c
, c
->argv
[3], &end
) != REDIS_OK
)) return;
5552 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5553 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5555 llen
= zs
->zsl
->length
;
5557 /* convert negative indexes */
5558 if (start
< 0) start
= llen
+start
;
5559 if (end
< 0) end
= llen
+end
;
5560 if (start
< 0) start
= 0;
5561 if (end
< 0) end
= 0;
5563 /* indexes sanity checks */
5564 if (start
> end
|| start
>= llen
) {
5565 addReply(c
,shared
.czero
);
5568 if (end
>= llen
) end
= llen
-1;
5570 /* increment start and end because zsl*Rank functions
5571 * use 1-based rank */
5572 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5573 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5574 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5575 server
.dirty
+= deleted
;
5576 addReplyLong(c
, deleted
);
5584 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5585 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5586 unsigned long size1
, size2
;
5587 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5588 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5589 return size1
- size2
;
5592 #define REDIS_AGGR_SUM 1
5593 #define REDIS_AGGR_MIN 2
5594 #define REDIS_AGGR_MAX 3
5596 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5597 if (aggregate
== REDIS_AGGR_SUM
) {
5598 *target
= *target
+ val
;
5599 } else if (aggregate
== REDIS_AGGR_MIN
) {
5600 *target
= val
< *target
? val
: *target
;
5601 } else if (aggregate
== REDIS_AGGR_MAX
) {
5602 *target
= val
> *target
? val
: *target
;
5605 redisAssert(0 != 0);
5609 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5611 int aggregate
= REDIS_AGGR_SUM
;
5618 /* expect zsetnum input keys to be given */
5619 zsetnum
= atoi(c
->argv
[2]->ptr
);
5621 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5625 /* test if the expected number of keys would overflow */
5626 if (3+zsetnum
> c
->argc
) {
5627 addReply(c
,shared
.syntaxerr
);
5631 /* read keys to be used for input */
5632 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5633 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5634 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5638 if (zsetobj
->type
!= REDIS_ZSET
) {
5640 addReply(c
,shared
.wrongtypeerr
);
5643 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5646 /* default all weights to 1 */
5647 src
[i
].weight
= 1.0;
5650 /* parse optional extra arguments */
5652 int remaining
= c
->argc
- j
;
5655 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5657 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5658 if (getDoubleFromObject(c
, c
->argv
[j
], &src
[i
].weight
) != REDIS_OK
)
5661 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5663 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5664 aggregate
= REDIS_AGGR_SUM
;
5665 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5666 aggregate
= REDIS_AGGR_MIN
;
5667 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5668 aggregate
= REDIS_AGGR_MAX
;
5671 addReply(c
,shared
.syntaxerr
);
5677 addReply(c
,shared
.syntaxerr
);
5683 /* sort sets from the smallest to largest, this will improve our
5684 * algorithm's performance */
5685 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5687 dstobj
= createZsetObject();
5688 dstzset
= dstobj
->ptr
;
5690 if (op
== REDIS_OP_INTER
) {
5691 /* skip going over all entries if the smallest zset is NULL or empty */
5692 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5693 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5694 * from small to large, all src[i > 0].dict are non-empty too */
5695 di
= dictGetIterator(src
[0].dict
);
5696 while((de
= dictNext(di
)) != NULL
) {
5697 double *score
= zmalloc(sizeof(double)), value
;
5698 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5700 for (j
= 1; j
< zsetnum
; j
++) {
5701 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5703 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5704 zunionInterAggregate(score
, value
, aggregate
);
5710 /* skip entry when not present in every source dict */
5714 robj
*o
= dictGetEntryKey(de
);
5715 dictAdd(dstzset
->dict
,o
,score
);
5716 incrRefCount(o
); /* added to dictionary */
5717 zslInsert(dstzset
->zsl
,*score
,o
);
5718 incrRefCount(o
); /* added to skiplist */
5721 dictReleaseIterator(di
);
5723 } else if (op
== REDIS_OP_UNION
) {
5724 for (i
= 0; i
< zsetnum
; i
++) {
5725 if (!src
[i
].dict
) continue;
5727 di
= dictGetIterator(src
[i
].dict
);
5728 while((de
= dictNext(di
)) != NULL
) {
5729 /* skip key when already processed */
5730 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5732 double *score
= zmalloc(sizeof(double)), value
;
5733 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5735 /* because the zsets are sorted by size, its only possible
5736 * for sets at larger indices to hold this entry */
5737 for (j
= (i
+1); j
< zsetnum
; j
++) {
5738 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5740 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5741 zunionInterAggregate(score
, value
, aggregate
);
5745 robj
*o
= dictGetEntryKey(de
);
5746 dictAdd(dstzset
->dict
,o
,score
);
5747 incrRefCount(o
); /* added to dictionary */
5748 zslInsert(dstzset
->zsl
,*score
,o
);
5749 incrRefCount(o
); /* added to skiplist */
5751 dictReleaseIterator(di
);
5754 /* unknown operator */
5755 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5758 deleteKey(c
->db
,dstkey
);
5759 if (dstzset
->zsl
->length
) {
5760 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5761 incrRefCount(dstkey
);
5762 addReplyLong(c
, dstzset
->zsl
->length
);
5765 decrRefCount(dstobj
);
5766 addReply(c
, shared
.czero
);
5771 static void zunionCommand(redisClient
*c
) {
5772 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5775 static void zinterCommand(redisClient
*c
) {
5776 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5779 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5791 if ((getLongFromObject(c
, c
->argv
[2], &start
) != REDIS_OK
) ||
5792 (getLongFromObject(c
, c
->argv
[3], &end
) != REDIS_OK
)) return;
5794 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5796 } else if (c
->argc
>= 5) {
5797 addReply(c
,shared
.syntaxerr
);
5801 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5802 || checkType(c
,o
,REDIS_ZSET
)) return;
5807 /* convert negative indexes */
5808 if (start
< 0) start
= llen
+start
;
5809 if (end
< 0) end
= llen
+end
;
5810 if (start
< 0) start
= 0;
5811 if (end
< 0) end
= 0;
5813 /* indexes sanity checks */
5814 if (start
> end
|| start
>= llen
) {
5815 /* Out of range start or start > end result in empty list */
5816 addReply(c
,shared
.emptymultibulk
);
5819 if (end
>= llen
) end
= llen
-1;
5820 rangelen
= (end
-start
)+1;
5822 /* check if starting point is trivial, before searching
5823 * the element in log(N) time */
5825 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5828 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5831 /* Return the result in form of a multi-bulk reply */
5832 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5833 withscores
? (rangelen
*2) : rangelen
));
5834 for (j
= 0; j
< rangelen
; j
++) {
5836 addReplyBulk(c
,ele
);
5838 addReplyDouble(c
,ln
->score
);
5839 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5843 static void zrangeCommand(redisClient
*c
) {
5844 zrangeGenericCommand(c
,0);
5847 static void zrevrangeCommand(redisClient
*c
) {
5848 zrangeGenericCommand(c
,1);
5851 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5852 * If justcount is non-zero, just the count is returned. */
5853 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5856 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5857 int offset
= 0, limit
= -1;
5861 /* Parse the min-max interval. If one of the values is prefixed
5862 * by the "(" character, it's considered "open". For instance
5863 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5864 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5865 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5866 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5869 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5871 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5872 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5875 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5878 /* Parse "WITHSCORES": note that if the command was called with
5879 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5880 * enter the following paths to parse WITHSCORES and LIMIT. */
5881 if (c
->argc
== 5 || c
->argc
== 8) {
5882 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5887 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5891 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5896 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5897 addReply(c
,shared
.syntaxerr
);
5899 } else if (c
->argc
== (7 + withscores
)) {
5900 offset
= atoi(c
->argv
[5]->ptr
);
5901 limit
= atoi(c
->argv
[6]->ptr
);
5902 if (offset
< 0) offset
= 0;
5905 /* Ok, lookup the key and get the range */
5906 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5908 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5910 if (o
->type
!= REDIS_ZSET
) {
5911 addReply(c
,shared
.wrongtypeerr
);
5913 zset
*zsetobj
= o
->ptr
;
5914 zskiplist
*zsl
= zsetobj
->zsl
;
5916 robj
*ele
, *lenobj
= NULL
;
5917 unsigned long rangelen
= 0;
5919 /* Get the first node with the score >= min, or with
5920 * score > min if 'minex' is true. */
5921 ln
= zslFirstWithScore(zsl
,min
);
5922 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5925 /* No element matching the speciifed interval */
5926 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5930 /* We don't know in advance how many matching elements there
5931 * are in the list, so we push this object that will represent
5932 * the multi-bulk length in the output buffer, and will "fix"
5935 lenobj
= createObject(REDIS_STRING
,NULL
);
5937 decrRefCount(lenobj
);
5940 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5943 ln
= ln
->forward
[0];
5946 if (limit
== 0) break;
5949 addReplyBulk(c
,ele
);
5951 addReplyDouble(c
,ln
->score
);
5953 ln
= ln
->forward
[0];
5955 if (limit
> 0) limit
--;
5958 addReplyLong(c
,(long)rangelen
);
5960 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5961 withscores
? (rangelen
*2) : rangelen
);
5967 static void zrangebyscoreCommand(redisClient
*c
) {
5968 genericZrangebyscoreCommand(c
,0);
5971 static void zcountCommand(redisClient
*c
) {
5972 genericZrangebyscoreCommand(c
,1);
5975 static void zcardCommand(redisClient
*c
) {
5979 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5980 checkType(c
,o
,REDIS_ZSET
)) return;
5983 addReplyUlong(c
,zs
->zsl
->length
);
5986 static void zscoreCommand(redisClient
*c
) {
5991 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5992 checkType(c
,o
,REDIS_ZSET
)) return;
5995 de
= dictFind(zs
->dict
,c
->argv
[2]);
5997 addReply(c
,shared
.nullbulk
);
5999 double *score
= dictGetEntryVal(de
);
6001 addReplyDouble(c
,*score
);
6005 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6013 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6014 checkType(c
,o
,REDIS_ZSET
)) return;
6018 de
= dictFind(zs
->dict
,c
->argv
[2]);
6020 addReply(c
,shared
.nullbulk
);
6024 score
= dictGetEntryVal(de
);
6025 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6028 addReplyLong(c
, zsl
->length
- rank
);
6030 addReplyLong(c
, rank
-1);
6033 addReply(c
,shared
.nullbulk
);
6037 static void zrankCommand(redisClient
*c
) {
6038 zrankGenericCommand(c
, 0);
6041 static void zrevrankCommand(redisClient
*c
) {
6042 zrankGenericCommand(c
, 1);
6045 /* ========================= Hashes utility functions ======================= */
6046 #define REDIS_HASH_KEY 1
6047 #define REDIS_HASH_VALUE 2
6049 /* Check the length of a number of objects to see if we need to convert a
6050 * zipmap to a real hash. Note that we only check string encoded objects
6051 * as their string length can be queried in constant time. */
6052 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6054 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6056 for (i
= start
; i
<= end
; i
++) {
6057 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6058 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6060 convertToRealHash(subject
);
6066 /* Get the value from a hash identified by key. Returns either a string
6067 * object or NULL if the value cannot be found. The refcount of the object
6068 * is always increased by 1 when the value was found. */
6069 static robj
*hashGet(robj
*o
, robj
*key
) {
6071 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6074 key
= getDecodedObject(key
);
6075 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6076 value
= createStringObject((char*)v
,vlen
);
6080 dictEntry
*de
= dictFind(o
->ptr
,key
);
6082 value
= dictGetEntryVal(de
);
6083 incrRefCount(value
);
6089 /* Test if the key exists in the given hash. Returns 1 if the key
6090 * exists and 0 when it doesn't. */
6091 static int hashExists(robj
*o
, robj
*key
) {
6092 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6093 key
= getDecodedObject(key
);
6094 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6100 if (dictFind(o
->ptr
,key
) != NULL
) {
6107 /* Add an element, discard the old if the key already exists.
6108 * Return 0 on insert and 1 on update. */
6109 static int hashReplace(robj
*o
, robj
*key
, robj
*value
) {
6111 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6112 key
= getDecodedObject(key
);
6113 value
= getDecodedObject(value
);
6114 o
->ptr
= zipmapSet(o
->ptr
,
6115 key
->ptr
,sdslen(key
->ptr
),
6116 value
->ptr
,sdslen(value
->ptr
), &update
);
6118 decrRefCount(value
);
6120 /* Check if the zipmap needs to be upgraded to a real hash table */
6121 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6122 convertToRealHash(o
);
6124 value
= tryObjectEncoding(value
);
6125 if (dictReplace(o
->ptr
,key
,value
)) {
6132 incrRefCount(value
);
6137 /* Delete an element from a hash.
6138 * Return 1 on deleted and 0 on not found. */
6139 static int hashDelete(robj
*o
, robj
*key
) {
6141 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6142 key
= getDecodedObject(key
);
6143 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6146 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6147 /* Always check if the dictionary needs a resize after a delete. */
6148 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6153 /* Return the number of elements in a hash. */
6154 static inline unsigned long hashLength(robj
*o
) {
6155 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6156 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6159 /* Structure to hold hash iteration abstration. Note that iteration over
6160 * hashes involves both fields and values. Because it is possible that
6161 * not both are required, store pointers in the iterator to avoid
6162 * unnecessary memory allocation for fields/values. */
6166 unsigned char *zk
, *zv
;
6167 unsigned int zklen
, zvlen
;
6173 static void hashInitIterator(robj
*subject
, hashIterator
*hi
) {
6174 hi
->encoding
= subject
->encoding
;
6175 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6176 hi
->zi
= zipmapRewind(subject
->ptr
);
6177 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6178 hi
->di
= dictGetIterator(subject
->ptr
);
6184 static void hashReleaseIterator(hashIterator
*hi
) {
6185 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6186 dictReleaseIterator(hi
->di
);
6190 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6191 * could be found and REDIS_ERR when the iterator reaches the end. */
6192 static inline int hashNext(hashIterator
*hi
) {
6193 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6194 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6195 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6197 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6202 /* Get key or value object at current iteration position. This always
6203 * increases the refcount of the field object by 1. */
6204 static inline robj
*hashCurrent(hashIterator
*hi
, int what
) {
6206 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6207 if (what
& REDIS_HASH_KEY
) {
6208 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6210 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6213 if (what
& REDIS_HASH_KEY
) {
6214 o
= dictGetEntryKey(hi
->de
);
6216 o
= dictGetEntryVal(hi
->de
);
6223 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6224 robj
*o
= lookupKeyWrite(c
->db
,key
);
6226 o
= createHashObject();
6227 dictAdd(c
->db
->dict
,key
,o
);
6230 if (o
->type
!= REDIS_HASH
) {
6231 addReply(c
,shared
.wrongtypeerr
);
6238 /* ============================= Hash commands ============================== */
6239 static void hsetCommand(redisClient
*c
) {
6243 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6244 hashTryConversion(o
,c
->argv
,2,3);
6245 update
= hashReplace(o
,c
->argv
[2],c
->argv
[3]);
6246 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
6250 static void hmsetCommand(redisClient
*c
) {
6254 if ((c
->argc
% 2) == 1) {
6255 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6259 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6260 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6261 for (i
= 2; i
< c
->argc
; i
+= 2) {
6262 hashReplace(o
,c
->argv
[i
],c
->argv
[i
+1]);
6264 addReply(c
, shared
.ok
);
6267 static void hincrbyCommand(redisClient
*c
) {
6268 long long value
, incr
;
6269 robj
*o
, *current
, *new;
6271 if (getLongLongFromObject(c
,c
->argv
[3],&incr
) != REDIS_OK
) return;
6272 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6273 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6274 if (current
->encoding
== REDIS_ENCODING_RAW
)
6275 value
= strtoll(current
->ptr
,NULL
,10);
6276 else if (current
->encoding
== REDIS_ENCODING_INT
)
6277 value
= (long)current
->ptr
;
6279 redisAssert(1 != 1);
6280 decrRefCount(current
);
6286 new = createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
6287 hashReplace(o
,c
->argv
[2],new);
6289 addReplyLongLong(c
,value
);
6293 static void hgetCommand(redisClient
*c
) {
6295 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6296 checkType(c
,o
,REDIS_HASH
)) return;
6298 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6299 addReplyBulk(c
,value
);
6300 decrRefCount(value
);
6302 addReply(c
,shared
.nullbulk
);
6306 static void hmgetCommand(redisClient
*c
) {
6309 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6310 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6311 addReply(c
,shared
.wrongtypeerr
);
6314 /* Note the check for o != NULL happens inside the loop. This is
6315 * done because objects that cannot be found are considered to be
6316 * an empty hash. The reply should then be a series of NULLs. */
6317 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6318 for (i
= 2; i
< c
->argc
; i
++) {
6319 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6320 addReplyBulk(c
,value
);
6321 decrRefCount(value
);
6323 addReply(c
,shared
.nullbulk
);
6328 static void hdelCommand(redisClient
*c
) {
6330 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6331 checkType(c
,o
,REDIS_HASH
)) return;
6333 if (hashDelete(o
,c
->argv
[2])) {
6334 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6335 addReply(c
,shared
.cone
);
6338 addReply(c
,shared
.czero
);
6342 static void hlenCommand(redisClient
*c
) {
6344 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6345 checkType(c
,o
,REDIS_HASH
)) return;
6347 addReplyUlong(c
,hashLength(o
));
6350 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6351 robj
*o
, *lenobj
, *obj
;
6352 unsigned long count
= 0;
6355 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6356 || checkType(c
,o
,REDIS_HASH
)) return;
6358 lenobj
= createObject(REDIS_STRING
,NULL
);
6360 decrRefCount(lenobj
);
6362 hashInitIterator(o
, &hi
);
6363 while (hashNext(&hi
) != REDIS_ERR
) {
6364 if (flags
& REDIS_HASH_KEY
) {
6365 obj
= hashCurrent(&hi
,REDIS_HASH_KEY
);
6366 addReplyBulk(c
,obj
);
6370 if (flags
& REDIS_HASH_VALUE
) {
6371 obj
= hashCurrent(&hi
,REDIS_HASH_VALUE
);
6372 addReplyBulk(c
,obj
);
6377 hashReleaseIterator(&hi
);
6379 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6382 static void hkeysCommand(redisClient
*c
) {
6383 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6386 static void hvalsCommand(redisClient
*c
) {
6387 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6390 static void hgetallCommand(redisClient
*c
) {
6391 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6394 static void hexistsCommand(redisClient
*c
) {
6396 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6397 checkType(c
,o
,REDIS_HASH
)) return;
6399 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6402 static void convertToRealHash(robj
*o
) {
6403 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6404 unsigned int klen
, vlen
;
6405 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6407 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6408 p
= zipmapRewind(zm
);
6409 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6410 robj
*keyobj
, *valobj
;
6412 keyobj
= createStringObject((char*)key
,klen
);
6413 valobj
= createStringObject((char*)val
,vlen
);
6414 keyobj
= tryObjectEncoding(keyobj
);
6415 valobj
= tryObjectEncoding(valobj
);
6416 dictAdd(dict
,keyobj
,valobj
);
6418 o
->encoding
= REDIS_ENCODING_HT
;
6423 /* ========================= Non type-specific commands ==================== */
6425 static void flushdbCommand(redisClient
*c
) {
6426 server
.dirty
+= dictSize(c
->db
->dict
);
6427 dictEmpty(c
->db
->dict
);
6428 dictEmpty(c
->db
->expires
);
6429 addReply(c
,shared
.ok
);
6432 static void flushallCommand(redisClient
*c
) {
6433 server
.dirty
+= emptyDb();
6434 addReply(c
,shared
.ok
);
6435 if (server
.bgsavechildpid
!= -1) {
6436 kill(server
.bgsavechildpid
,SIGKILL
);
6437 rdbRemoveTempFile(server
.bgsavechildpid
);
6439 rdbSave(server
.dbfilename
);
6443 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6444 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6446 so
->pattern
= pattern
;
6450 /* Return the value associated to the key with a name obtained
6451 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6452 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6456 int prefixlen
, sublen
, postfixlen
;
6457 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6461 char buf
[REDIS_SORTKEY_MAX
+1];
6464 /* If the pattern is "#" return the substitution object itself in order
6465 * to implement the "SORT ... GET #" feature. */
6466 spat
= pattern
->ptr
;
6467 if (spat
[0] == '#' && spat
[1] == '\0') {
6471 /* The substitution object may be specially encoded. If so we create
6472 * a decoded object on the fly. Otherwise getDecodedObject will just
6473 * increment the ref count, that we'll decrement later. */
6474 subst
= getDecodedObject(subst
);
6477 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6478 p
= strchr(spat
,'*');
6480 decrRefCount(subst
);
6485 sublen
= sdslen(ssub
);
6486 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6487 memcpy(keyname
.buf
,spat
,prefixlen
);
6488 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6489 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6490 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6491 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6493 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6494 decrRefCount(subst
);
6496 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6497 return lookupKeyRead(db
,&keyobj
);
6500 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6501 * the additional parameter is not standard but a BSD-specific we have to
6502 * pass sorting parameters via the global 'server' structure */
6503 static int sortCompare(const void *s1
, const void *s2
) {
6504 const redisSortObject
*so1
= s1
, *so2
= s2
;
6507 if (!server
.sort_alpha
) {
6508 /* Numeric sorting. Here it's trivial as we precomputed scores */
6509 if (so1
->u
.score
> so2
->u
.score
) {
6511 } else if (so1
->u
.score
< so2
->u
.score
) {
6517 /* Alphanumeric sorting */
6518 if (server
.sort_bypattern
) {
6519 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6520 /* At least one compare object is NULL */
6521 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6523 else if (so1
->u
.cmpobj
== NULL
)
6528 /* We have both the objects, use strcoll */
6529 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6532 /* Compare elements directly */
6535 dec1
= getDecodedObject(so1
->obj
);
6536 dec2
= getDecodedObject(so2
->obj
);
6537 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6542 return server
.sort_desc
? -cmp
: cmp
;
6545 /* The SORT command is the most complex command in Redis. Warning: this code
6546 * is optimized for speed and a bit less for readability */
6547 static void sortCommand(redisClient
*c
) {
6550 int desc
= 0, alpha
= 0;
6551 int limit_start
= 0, limit_count
= -1, start
, end
;
6552 int j
, dontsort
= 0, vectorlen
;
6553 int getop
= 0; /* GET operation counter */
6554 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6555 redisSortObject
*vector
; /* Resulting vector to sort */
6557 /* Lookup the key to sort. It must be of the right types */
6558 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6559 if (sortval
== NULL
) {
6560 addReply(c
,shared
.emptymultibulk
);
6563 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6564 sortval
->type
!= REDIS_ZSET
)
6566 addReply(c
,shared
.wrongtypeerr
);
6570 /* Create a list of operations to perform for every sorted element.
6571 * Operations can be GET/DEL/INCR/DECR */
6572 operations
= listCreate();
6573 listSetFreeMethod(operations
,zfree
);
6576 /* Now we need to protect sortval incrementing its count, in the future
6577 * SORT may have options able to overwrite/delete keys during the sorting
6578 * and the sorted key itself may get destroied */
6579 incrRefCount(sortval
);
6581 /* The SORT command has an SQL-alike syntax, parse it */
6582 while(j
< c
->argc
) {
6583 int leftargs
= c
->argc
-j
-1;
6584 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6586 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6588 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6590 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6591 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6592 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6594 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6595 storekey
= c
->argv
[j
+1];
6597 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6598 sortby
= c
->argv
[j
+1];
6599 /* If the BY pattern does not contain '*', i.e. it is constant,
6600 * we don't need to sort nor to lookup the weight keys. */
6601 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6603 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6604 listAddNodeTail(operations
,createSortOperation(
6605 REDIS_SORT_GET
,c
->argv
[j
+1]));
6609 decrRefCount(sortval
);
6610 listRelease(operations
);
6611 addReply(c
,shared
.syntaxerr
);
6617 /* Load the sorting vector with all the objects to sort */
6618 switch(sortval
->type
) {
6619 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6620 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6621 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6622 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6624 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6627 if (sortval
->type
== REDIS_LIST
) {
6628 list
*list
= sortval
->ptr
;
6632 listRewind(list
,&li
);
6633 while((ln
= listNext(&li
))) {
6634 robj
*ele
= ln
->value
;
6635 vector
[j
].obj
= ele
;
6636 vector
[j
].u
.score
= 0;
6637 vector
[j
].u
.cmpobj
= NULL
;
6645 if (sortval
->type
== REDIS_SET
) {
6648 zset
*zs
= sortval
->ptr
;
6652 di
= dictGetIterator(set
);
6653 while((setele
= dictNext(di
)) != NULL
) {
6654 vector
[j
].obj
= dictGetEntryKey(setele
);
6655 vector
[j
].u
.score
= 0;
6656 vector
[j
].u
.cmpobj
= NULL
;
6659 dictReleaseIterator(di
);
6661 redisAssert(j
== vectorlen
);
6663 /* Now it's time to load the right scores in the sorting vector */
6664 if (dontsort
== 0) {
6665 for (j
= 0; j
< vectorlen
; j
++) {
6669 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6670 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6672 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6674 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6675 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6677 /* Don't need to decode the object if it's
6678 * integer-encoded (the only encoding supported) so
6679 * far. We can just cast it */
6680 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6681 vector
[j
].u
.score
= (long)byval
->ptr
;
6683 redisAssert(1 != 1);
6688 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6689 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6691 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6692 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6694 redisAssert(1 != 1);
6701 /* We are ready to sort the vector... perform a bit of sanity check
6702 * on the LIMIT option too. We'll use a partial version of quicksort. */
6703 start
= (limit_start
< 0) ? 0 : limit_start
;
6704 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6705 if (start
>= vectorlen
) {
6706 start
= vectorlen
-1;
6709 if (end
>= vectorlen
) end
= vectorlen
-1;
6711 if (dontsort
== 0) {
6712 server
.sort_desc
= desc
;
6713 server
.sort_alpha
= alpha
;
6714 server
.sort_bypattern
= sortby
? 1 : 0;
6715 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6716 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6718 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6721 /* Send command output to the output buffer, performing the specified
6722 * GET/DEL/INCR/DECR operations if any. */
6723 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6724 if (storekey
== NULL
) {
6725 /* STORE option not specified, sent the sorting result to client */
6726 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6727 for (j
= start
; j
<= end
; j
++) {
6731 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6732 listRewind(operations
,&li
);
6733 while((ln
= listNext(&li
))) {
6734 redisSortOperation
*sop
= ln
->value
;
6735 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6738 if (sop
->type
== REDIS_SORT_GET
) {
6739 if (!val
|| val
->type
!= REDIS_STRING
) {
6740 addReply(c
,shared
.nullbulk
);
6742 addReplyBulk(c
,val
);
6745 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6750 robj
*listObject
= createListObject();
6751 list
*listPtr
= (list
*) listObject
->ptr
;
6753 /* STORE option specified, set the sorting result as a List object */
6754 for (j
= start
; j
<= end
; j
++) {
6759 listAddNodeTail(listPtr
,vector
[j
].obj
);
6760 incrRefCount(vector
[j
].obj
);
6762 listRewind(operations
,&li
);
6763 while((ln
= listNext(&li
))) {
6764 redisSortOperation
*sop
= ln
->value
;
6765 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6768 if (sop
->type
== REDIS_SORT_GET
) {
6769 if (!val
|| val
->type
!= REDIS_STRING
) {
6770 listAddNodeTail(listPtr
,createStringObject("",0));
6772 listAddNodeTail(listPtr
,val
);
6776 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6780 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6781 incrRefCount(storekey
);
6783 /* Note: we add 1 because the DB is dirty anyway since even if the
6784 * SORT result is empty a new key is set and maybe the old content
6786 server
.dirty
+= 1+outputlen
;
6787 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6791 decrRefCount(sortval
);
6792 listRelease(operations
);
6793 for (j
= 0; j
< vectorlen
; j
++) {
6794 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6795 decrRefCount(vector
[j
].u
.cmpobj
);
6800 /* Convert an amount of bytes into a human readable string in the form
6801 * of 100B, 2G, 100M, 4K, and so forth. */
6802 static void bytesToHuman(char *s
, unsigned long long n
) {
6807 sprintf(s
,"%lluB",n
);
6809 } else if (n
< (1024*1024)) {
6810 d
= (double)n
/(1024);
6811 sprintf(s
,"%.2fK",d
);
6812 } else if (n
< (1024LL*1024*1024)) {
6813 d
= (double)n
/(1024*1024);
6814 sprintf(s
,"%.2fM",d
);
6815 } else if (n
< (1024LL*1024*1024*1024)) {
6816 d
= (double)n
/(1024LL*1024*1024);
6817 sprintf(s
,"%.2fG",d
);
6821 /* Create the string returned by the INFO command. This is decoupled
6822 * by the INFO command itself as we need to report the same information
6823 * on memory corruption problems. */
6824 static sds
genRedisInfoString(void) {
6826 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6830 bytesToHuman(hmem
,zmalloc_used_memory());
6831 info
= sdscatprintf(sdsempty(),
6832 "redis_version:%s\r\n"
6834 "multiplexing_api:%s\r\n"
6835 "process_id:%ld\r\n"
6836 "uptime_in_seconds:%ld\r\n"
6837 "uptime_in_days:%ld\r\n"
6838 "connected_clients:%d\r\n"
6839 "connected_slaves:%d\r\n"
6840 "blocked_clients:%d\r\n"
6841 "used_memory:%zu\r\n"
6842 "used_memory_human:%s\r\n"
6843 "changes_since_last_save:%lld\r\n"
6844 "bgsave_in_progress:%d\r\n"
6845 "last_save_time:%ld\r\n"
6846 "bgrewriteaof_in_progress:%d\r\n"
6847 "total_connections_received:%lld\r\n"
6848 "total_commands_processed:%lld\r\n"
6849 "expired_keys:%lld\r\n"
6850 "hash_max_zipmap_entries:%ld\r\n"
6851 "hash_max_zipmap_value:%ld\r\n"
6852 "pubsub_channels:%ld\r\n"
6853 "pubsub_patterns:%u\r\n"
6857 (sizeof(long) == 8) ? "64" : "32",
6862 listLength(server
.clients
)-listLength(server
.slaves
),
6863 listLength(server
.slaves
),
6864 server
.blpop_blocked_clients
,
6865 zmalloc_used_memory(),
6868 server
.bgsavechildpid
!= -1,
6870 server
.bgrewritechildpid
!= -1,
6871 server
.stat_numconnections
,
6872 server
.stat_numcommands
,
6873 server
.stat_expiredkeys
,
6874 server
.hash_max_zipmap_entries
,
6875 server
.hash_max_zipmap_value
,
6876 dictSize(server
.pubsub_channels
),
6877 listLength(server
.pubsub_patterns
),
6878 server
.vm_enabled
!= 0,
6879 server
.masterhost
== NULL
? "master" : "slave"
6881 if (server
.masterhost
) {
6882 info
= sdscatprintf(info
,
6883 "master_host:%s\r\n"
6884 "master_port:%d\r\n"
6885 "master_link_status:%s\r\n"
6886 "master_last_io_seconds_ago:%d\r\n"
6889 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6891 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6894 if (server
.vm_enabled
) {
6896 info
= sdscatprintf(info
,
6897 "vm_conf_max_memory:%llu\r\n"
6898 "vm_conf_page_size:%llu\r\n"
6899 "vm_conf_pages:%llu\r\n"
6900 "vm_stats_used_pages:%llu\r\n"
6901 "vm_stats_swapped_objects:%llu\r\n"
6902 "vm_stats_swappin_count:%llu\r\n"
6903 "vm_stats_swappout_count:%llu\r\n"
6904 "vm_stats_io_newjobs_len:%lu\r\n"
6905 "vm_stats_io_processing_len:%lu\r\n"
6906 "vm_stats_io_processed_len:%lu\r\n"
6907 "vm_stats_io_active_threads:%lu\r\n"
6908 "vm_stats_blocked_clients:%lu\r\n"
6909 ,(unsigned long long) server
.vm_max_memory
,
6910 (unsigned long long) server
.vm_page_size
,
6911 (unsigned long long) server
.vm_pages
,
6912 (unsigned long long) server
.vm_stats_used_pages
,
6913 (unsigned long long) server
.vm_stats_swapped_objects
,
6914 (unsigned long long) server
.vm_stats_swapins
,
6915 (unsigned long long) server
.vm_stats_swapouts
,
6916 (unsigned long) listLength(server
.io_newjobs
),
6917 (unsigned long) listLength(server
.io_processing
),
6918 (unsigned long) listLength(server
.io_processed
),
6919 (unsigned long) server
.io_active_threads
,
6920 (unsigned long) server
.vm_blocked_clients
6924 for (j
= 0; j
< server
.dbnum
; j
++) {
6925 long long keys
, vkeys
;
6927 keys
= dictSize(server
.db
[j
].dict
);
6928 vkeys
= dictSize(server
.db
[j
].expires
);
6929 if (keys
|| vkeys
) {
6930 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6937 static void infoCommand(redisClient
*c
) {
6938 sds info
= genRedisInfoString();
6939 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6940 (unsigned long)sdslen(info
)));
6941 addReplySds(c
,info
);
6942 addReply(c
,shared
.crlf
);
6945 static void monitorCommand(redisClient
*c
) {
6946 /* ignore MONITOR if aleady slave or in monitor mode */
6947 if (c
->flags
& REDIS_SLAVE
) return;
6949 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6951 listAddNodeTail(server
.monitors
,c
);
6952 addReply(c
,shared
.ok
);
6955 /* ================================= Expire ================================= */
6956 static int removeExpire(redisDb
*db
, robj
*key
) {
6957 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6964 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6965 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6973 /* Return the expire time of the specified key, or -1 if no expire
6974 * is associated with this key (i.e. the key is non volatile) */
6975 static time_t getExpire(redisDb
*db
, robj
*key
) {
6978 /* No expire? return ASAP */
6979 if (dictSize(db
->expires
) == 0 ||
6980 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6982 return (time_t) dictGetEntryVal(de
);
6985 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6989 /* No expire? return ASAP */
6990 if (dictSize(db
->expires
) == 0 ||
6991 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6993 /* Lookup the expire */
6994 when
= (time_t) dictGetEntryVal(de
);
6995 if (time(NULL
) <= when
) return 0;
6997 /* Delete the key */
6998 dictDelete(db
->expires
,key
);
6999 server
.stat_expiredkeys
++;
7000 return dictDelete(db
->dict
,key
) == DICT_OK
;
7003 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7006 /* No expire? return ASAP */
7007 if (dictSize(db
->expires
) == 0 ||
7008 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7010 /* Delete the key */
7012 server
.stat_expiredkeys
++;
7013 dictDelete(db
->expires
,key
);
7014 return dictDelete(db
->dict
,key
) == DICT_OK
;
7017 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7021 if (getLongFromObject(c
, param
, &seconds
) != REDIS_OK
) return;
7025 de
= dictFind(c
->db
->dict
,key
);
7027 addReply(c
,shared
.czero
);
7031 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7032 addReply(c
, shared
.cone
);
7035 time_t when
= time(NULL
)+seconds
;
7036 if (setExpire(c
->db
,key
,when
)) {
7037 addReply(c
,shared
.cone
);
7040 addReply(c
,shared
.czero
);
7046 static void expireCommand(redisClient
*c
) {
7047 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7050 static void expireatCommand(redisClient
*c
) {
7051 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7054 static void ttlCommand(redisClient
*c
) {
7058 expire
= getExpire(c
->db
,c
->argv
[1]);
7060 ttl
= (int) (expire
-time(NULL
));
7061 if (ttl
< 0) ttl
= -1;
7063 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7066 /* ================================ MULTI/EXEC ============================== */
7068 /* Client state initialization for MULTI/EXEC */
7069 static void initClientMultiState(redisClient
*c
) {
7070 c
->mstate
.commands
= NULL
;
7071 c
->mstate
.count
= 0;
7074 /* Release all the resources associated with MULTI/EXEC state */
7075 static void freeClientMultiState(redisClient
*c
) {
7078 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7080 multiCmd
*mc
= c
->mstate
.commands
+j
;
7082 for (i
= 0; i
< mc
->argc
; i
++)
7083 decrRefCount(mc
->argv
[i
]);
7086 zfree(c
->mstate
.commands
);
7089 /* Add a new command into the MULTI commands queue */
7090 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7094 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7095 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7096 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7099 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7100 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7101 for (j
= 0; j
< c
->argc
; j
++)
7102 incrRefCount(mc
->argv
[j
]);
7106 static void multiCommand(redisClient
*c
) {
7107 c
->flags
|= REDIS_MULTI
;
7108 addReply(c
,shared
.ok
);
7111 static void discardCommand(redisClient
*c
) {
7112 if (!(c
->flags
& REDIS_MULTI
)) {
7113 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7117 freeClientMultiState(c
);
7118 initClientMultiState(c
);
7119 c
->flags
&= (~REDIS_MULTI
);
7120 addReply(c
,shared
.ok
);
7123 static void execCommand(redisClient
*c
) {
7128 if (!(c
->flags
& REDIS_MULTI
)) {
7129 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7133 orig_argv
= c
->argv
;
7134 orig_argc
= c
->argc
;
7135 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7136 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7137 c
->argc
= c
->mstate
.commands
[j
].argc
;
7138 c
->argv
= c
->mstate
.commands
[j
].argv
;
7139 call(c
,c
->mstate
.commands
[j
].cmd
);
7141 c
->argv
= orig_argv
;
7142 c
->argc
= orig_argc
;
7143 freeClientMultiState(c
);
7144 initClientMultiState(c
);
7145 c
->flags
&= (~REDIS_MULTI
);
7148 /* =========================== Blocking Operations ========================= */
7150 /* Currently Redis blocking operations support is limited to list POP ops,
7151 * so the current implementation is not fully generic, but it is also not
7152 * completely specific so it will not require a rewrite to support new
7153 * kind of blocking operations in the future.
7155 * Still it's important to note that list blocking operations can be already
7156 * used as a notification mechanism in order to implement other blocking
7157 * operations at application level, so there must be a very strong evidence
7158 * of usefulness and generality before new blocking operations are implemented.
7160 * This is how the current blocking POP works, we use BLPOP as example:
7161 * - If the user calls BLPOP and the key exists and contains a non empty list
7162 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7163 * if there is not to block.
7164 * - If instead BLPOP is called and the key does not exists or the list is
7165 * empty we need to block. In order to do so we remove the notification for
7166 * new data to read in the client socket (so that we'll not serve new
7167 * requests if the blocking request is not served). Also we put the client
7168 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7169 * blocking for this keys.
7170 * - If a PUSH operation against a key with blocked clients waiting is
7171 * performed, we serve the first in the list: basically instead to push
7172 * the new element inside the list we return it to the (first / oldest)
7173 * blocking client, unblock the client, and remove it form the list.
7175 * The above comment and the source code should be enough in order to understand
7176 * the implementation and modify / fix it later.
7179 /* Set a client in blocking mode for the specified key, with the specified
7181 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7186 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7187 c
->blockingkeysnum
= numkeys
;
7188 c
->blockingto
= timeout
;
7189 for (j
= 0; j
< numkeys
; j
++) {
7190 /* Add the key in the client structure, to map clients -> keys */
7191 c
->blockingkeys
[j
] = keys
[j
];
7192 incrRefCount(keys
[j
]);
7194 /* And in the other "side", to map keys -> clients */
7195 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7199 /* For every key we take a list of clients blocked for it */
7201 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7202 incrRefCount(keys
[j
]);
7203 assert(retval
== DICT_OK
);
7205 l
= dictGetEntryVal(de
);
7207 listAddNodeTail(l
,c
);
7209 /* Mark the client as a blocked client */
7210 c
->flags
|= REDIS_BLOCKED
;
7211 server
.blpop_blocked_clients
++;
7214 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7215 static void unblockClientWaitingData(redisClient
*c
) {
7220 assert(c
->blockingkeys
!= NULL
);
7221 /* The client may wait for multiple keys, so unblock it for every key. */
7222 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7223 /* Remove this client from the list of clients waiting for this key. */
7224 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7226 l
= dictGetEntryVal(de
);
7227 listDelNode(l
,listSearchKey(l
,c
));
7228 /* If the list is empty we need to remove it to avoid wasting memory */
7229 if (listLength(l
) == 0)
7230 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7231 decrRefCount(c
->blockingkeys
[j
]);
7233 /* Cleanup the client structure */
7234 zfree(c
->blockingkeys
);
7235 c
->blockingkeys
= NULL
;
7236 c
->flags
&= (~REDIS_BLOCKED
);
7237 server
.blpop_blocked_clients
--;
7238 /* We want to process data if there is some command waiting
7239 * in the input buffer. Note that this is safe even if
7240 * unblockClientWaitingData() gets called from freeClient() because
7241 * freeClient() will be smart enough to call this function
7242 * *after* c->querybuf was set to NULL. */
7243 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7246 /* This should be called from any function PUSHing into lists.
7247 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7248 * 'ele' is the element pushed.
7250 * If the function returns 0 there was no client waiting for a list push
7253 * If the function returns 1 there was a client waiting for a list push
7254 * against this key, the element was passed to this client thus it's not
7255 * needed to actually add it to the list and the caller should return asap. */
7256 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7257 struct dictEntry
*de
;
7258 redisClient
*receiver
;
7262 de
= dictFind(c
->db
->blockingkeys
,key
);
7263 if (de
== NULL
) return 0;
7264 l
= dictGetEntryVal(de
);
7267 receiver
= ln
->value
;
7269 addReplySds(receiver
,sdsnew("*2\r\n"));
7270 addReplyBulk(receiver
,key
);
7271 addReplyBulk(receiver
,ele
);
7272 unblockClientWaitingData(receiver
);
7276 /* Blocking RPOP/LPOP */
7277 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7282 for (j
= 1; j
< c
->argc
-1; j
++) {
7283 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7285 if (o
->type
!= REDIS_LIST
) {
7286 addReply(c
,shared
.wrongtypeerr
);
7289 list
*list
= o
->ptr
;
7290 if (listLength(list
) != 0) {
7291 /* If the list contains elements fall back to the usual
7292 * non-blocking POP operation */
7293 robj
*argv
[2], **orig_argv
;
7296 /* We need to alter the command arguments before to call
7297 * popGenericCommand() as the command takes a single key. */
7298 orig_argv
= c
->argv
;
7299 orig_argc
= c
->argc
;
7300 argv
[1] = c
->argv
[j
];
7304 /* Also the return value is different, we need to output
7305 * the multi bulk reply header and the key name. The
7306 * "real" command will add the last element (the value)
7307 * for us. If this souds like an hack to you it's just
7308 * because it is... */
7309 addReplySds(c
,sdsnew("*2\r\n"));
7310 addReplyBulk(c
,argv
[1]);
7311 popGenericCommand(c
,where
);
7313 /* Fix the client structure with the original stuff */
7314 c
->argv
= orig_argv
;
7315 c
->argc
= orig_argc
;
7321 /* If the list is empty or the key does not exists we must block */
7322 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7323 if (timeout
> 0) timeout
+= time(NULL
);
7324 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7327 static void blpopCommand(redisClient
*c
) {
7328 blockingPopGenericCommand(c
,REDIS_HEAD
);
7331 static void brpopCommand(redisClient
*c
) {
7332 blockingPopGenericCommand(c
,REDIS_TAIL
);
7335 /* =============================== Replication ============================= */
7337 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7338 ssize_t nwritten
, ret
= size
;
7339 time_t start
= time(NULL
);
7343 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7344 nwritten
= write(fd
,ptr
,size
);
7345 if (nwritten
== -1) return -1;
7349 if ((time(NULL
)-start
) > timeout
) {
7357 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7358 ssize_t nread
, totread
= 0;
7359 time_t start
= time(NULL
);
7363 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7364 nread
= read(fd
,ptr
,size
);
7365 if (nread
== -1) return -1;
7370 if ((time(NULL
)-start
) > timeout
) {
7378 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7385 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7388 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7399 static void syncCommand(redisClient
*c
) {
7400 /* ignore SYNC if aleady slave or in monitor mode */
7401 if (c
->flags
& REDIS_SLAVE
) return;
7403 /* SYNC can't be issued when the server has pending data to send to
7404 * the client about already issued commands. We need a fresh reply
7405 * buffer registering the differences between the BGSAVE and the current
7406 * dataset, so that we can copy to other slaves if needed. */
7407 if (listLength(c
->reply
) != 0) {
7408 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7412 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7413 /* Here we need to check if there is a background saving operation
7414 * in progress, or if it is required to start one */
7415 if (server
.bgsavechildpid
!= -1) {
7416 /* Ok a background save is in progress. Let's check if it is a good
7417 * one for replication, i.e. if there is another slave that is
7418 * registering differences since the server forked to save */
7423 listRewind(server
.slaves
,&li
);
7424 while((ln
= listNext(&li
))) {
7426 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7429 /* Perfect, the server is already registering differences for
7430 * another slave. Set the right state, and copy the buffer. */
7431 listRelease(c
->reply
);
7432 c
->reply
= listDup(slave
->reply
);
7433 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7434 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7436 /* No way, we need to wait for the next BGSAVE in order to
7437 * register differences */
7438 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7439 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7442 /* Ok we don't have a BGSAVE in progress, let's start one */
7443 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7444 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7445 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7446 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7449 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7452 c
->flags
|= REDIS_SLAVE
;
7454 listAddNodeTail(server
.slaves
,c
);
7458 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7459 redisClient
*slave
= privdata
;
7461 REDIS_NOTUSED(mask
);
7462 char buf
[REDIS_IOBUF_LEN
];
7463 ssize_t nwritten
, buflen
;
7465 if (slave
->repldboff
== 0) {
7466 /* Write the bulk write count before to transfer the DB. In theory here
7467 * we don't know how much room there is in the output buffer of the
7468 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7469 * operations) will never be smaller than the few bytes we need. */
7472 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7474 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7482 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7483 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7485 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7486 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7490 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7491 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7496 slave
->repldboff
+= nwritten
;
7497 if (slave
->repldboff
== slave
->repldbsize
) {
7498 close(slave
->repldbfd
);
7499 slave
->repldbfd
= -1;
7500 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7501 slave
->replstate
= REDIS_REPL_ONLINE
;
7502 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7503 sendReplyToClient
, slave
) == AE_ERR
) {
7507 addReplySds(slave
,sdsempty());
7508 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7512 /* This function is called at the end of every backgrond saving.
7513 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7514 * otherwise REDIS_ERR is passed to the function.
7516 * The goal of this function is to handle slaves waiting for a successful
7517 * background saving in order to perform non-blocking synchronization. */
7518 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7520 int startbgsave
= 0;
7523 listRewind(server
.slaves
,&li
);
7524 while((ln
= listNext(&li
))) {
7525 redisClient
*slave
= ln
->value
;
7527 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7529 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7530 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7531 struct redis_stat buf
;
7533 if (bgsaveerr
!= REDIS_OK
) {
7535 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7538 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7539 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7541 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7544 slave
->repldboff
= 0;
7545 slave
->repldbsize
= buf
.st_size
;
7546 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7547 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7548 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7555 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7558 listRewind(server
.slaves
,&li
);
7559 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7560 while((ln
= listNext(&li
))) {
7561 redisClient
*slave
= ln
->value
;
7563 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7570 static int syncWithMaster(void) {
7571 char buf
[1024], tmpfile
[256], authcmd
[1024];
7573 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7574 int dfd
, maxtries
= 5;
7577 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7582 /* AUTH with the master if required. */
7583 if(server
.masterauth
) {
7584 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7585 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7587 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7591 /* Read the AUTH result. */
7592 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7594 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7598 if (buf
[0] != '+') {
7600 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7605 /* Issue the SYNC command */
7606 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7608 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7612 /* Read the bulk write count */
7613 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7615 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7619 if (buf
[0] != '$') {
7621 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7624 dumpsize
= strtol(buf
+1,NULL
,10);
7625 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7626 /* Read the bulk write data on a temp file */
7628 snprintf(tmpfile
,256,
7629 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7630 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7631 if (dfd
!= -1) break;
7636 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7640 int nread
, nwritten
;
7642 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7644 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7650 nwritten
= write(dfd
,buf
,nread
);
7651 if (nwritten
== -1) {
7652 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7660 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7661 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7667 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7668 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7672 server
.master
= createClient(fd
);
7673 server
.master
->flags
|= REDIS_MASTER
;
7674 server
.master
->authenticated
= 1;
7675 server
.replstate
= REDIS_REPL_CONNECTED
;
7679 static void slaveofCommand(redisClient
*c
) {
7680 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7681 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7682 if (server
.masterhost
) {
7683 sdsfree(server
.masterhost
);
7684 server
.masterhost
= NULL
;
7685 if (server
.master
) freeClient(server
.master
);
7686 server
.replstate
= REDIS_REPL_NONE
;
7687 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7690 sdsfree(server
.masterhost
);
7691 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7692 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7693 if (server
.master
) freeClient(server
.master
);
7694 server
.replstate
= REDIS_REPL_CONNECT
;
7695 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7696 server
.masterhost
, server
.masterport
);
7698 addReply(c
,shared
.ok
);
7701 /* ============================ Maxmemory directive ======================== */
7703 /* Try to free one object form the pre-allocated objects free list.
7704 * This is useful under low mem conditions as by default we take 1 million
7705 * free objects allocated. On success REDIS_OK is returned, otherwise
7707 static int tryFreeOneObjectFromFreelist(void) {
7710 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7711 if (listLength(server
.objfreelist
)) {
7712 listNode
*head
= listFirst(server
.objfreelist
);
7713 o
= listNodeValue(head
);
7714 listDelNode(server
.objfreelist
,head
);
7715 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7719 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7724 /* This function gets called when 'maxmemory' is set on the config file to limit
7725 * the max memory used by the server, and we are out of memory.
7726 * This function will try to, in order:
7728 * - Free objects from the free list
7729 * - Try to remove keys with an EXPIRE set
7731 * It is not possible to free enough memory to reach used-memory < maxmemory
7732 * the server will start refusing commands that will enlarge even more the
7735 static void freeMemoryIfNeeded(void) {
7736 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7737 int j
, k
, freed
= 0;
7739 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7740 for (j
= 0; j
< server
.dbnum
; j
++) {
7742 robj
*minkey
= NULL
;
7743 struct dictEntry
*de
;
7745 if (dictSize(server
.db
[j
].expires
)) {
7747 /* From a sample of three keys drop the one nearest to
7748 * the natural expire */
7749 for (k
= 0; k
< 3; k
++) {
7752 de
= dictGetRandomKey(server
.db
[j
].expires
);
7753 t
= (time_t) dictGetEntryVal(de
);
7754 if (minttl
== -1 || t
< minttl
) {
7755 minkey
= dictGetEntryKey(de
);
7759 deleteKey(server
.db
+j
,minkey
);
7762 if (!freed
) return; /* nothing to free... */
7766 /* ============================== Append Only file ========================== */
7768 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7769 sds buf
= sdsempty();
7775 /* The DB this command was targetting is not the same as the last command
7776 * we appendend. To issue a SELECT command is needed. */
7777 if (dictid
!= server
.appendseldb
) {
7780 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7781 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7782 (unsigned long)strlen(seldb
),seldb
);
7783 server
.appendseldb
= dictid
;
7786 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7787 * EXPIREs into EXPIREATs calls */
7788 if (cmd
->proc
== expireCommand
) {
7791 tmpargv
[0] = createStringObject("EXPIREAT",8);
7792 tmpargv
[1] = argv
[1];
7793 incrRefCount(argv
[1]);
7794 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7795 tmpargv
[2] = createObject(REDIS_STRING
,
7796 sdscatprintf(sdsempty(),"%ld",when
));
7800 /* Append the actual command */
7801 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7802 for (j
= 0; j
< argc
; j
++) {
7805 o
= getDecodedObject(o
);
7806 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7807 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7808 buf
= sdscatlen(buf
,"\r\n",2);
7812 /* Free the objects from the modified argv for EXPIREAT */
7813 if (cmd
->proc
== expireCommand
) {
7814 for (j
= 0; j
< 3; j
++)
7815 decrRefCount(argv
[j
]);
7818 /* We want to perform a single write. This should be guaranteed atomic
7819 * at least if the filesystem we are writing is a real physical one.
7820 * While this will save us against the server being killed I don't think
7821 * there is much to do about the whole server stopping for power problems
7823 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7824 if (nwritten
!= (signed)sdslen(buf
)) {
7825 /* Ooops, we are in troubles. The best thing to do for now is
7826 * to simply exit instead to give the illusion that everything is
7827 * working as expected. */
7828 if (nwritten
== -1) {
7829 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7831 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7835 /* If a background append only file rewriting is in progress we want to
7836 * accumulate the differences between the child DB and the current one
7837 * in a buffer, so that when the child process will do its work we
7838 * can append the differences to the new append only file. */
7839 if (server
.bgrewritechildpid
!= -1)
7840 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7844 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7845 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7846 now
-server
.lastfsync
> 1))
7848 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7849 server
.lastfsync
= now
;
7853 /* In Redis commands are always executed in the context of a client, so in
7854 * order to load the append only file we need to create a fake client. */
7855 static struct redisClient
*createFakeClient(void) {
7856 struct redisClient
*c
= zmalloc(sizeof(*c
));
7860 c
->querybuf
= sdsempty();
7864 /* We set the fake client as a slave waiting for the synchronization
7865 * so that Redis will not try to send replies to this client. */
7866 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7867 c
->reply
= listCreate();
7868 listSetFreeMethod(c
->reply
,decrRefCount
);
7869 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7873 static void freeFakeClient(struct redisClient
*c
) {
7874 sdsfree(c
->querybuf
);
7875 listRelease(c
->reply
);
7879 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7880 * error (the append only file is zero-length) REDIS_ERR is returned. On
7881 * fatal error an error message is logged and the program exists. */
7882 int loadAppendOnlyFile(char *filename
) {
7883 struct redisClient
*fakeClient
;
7884 FILE *fp
= fopen(filename
,"r");
7885 struct redis_stat sb
;
7886 unsigned long long loadedkeys
= 0;
7888 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7892 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7896 fakeClient
= createFakeClient();
7903 struct redisCommand
*cmd
;
7905 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7911 if (buf
[0] != '*') goto fmterr
;
7913 argv
= zmalloc(sizeof(robj
*)*argc
);
7914 for (j
= 0; j
< argc
; j
++) {
7915 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7916 if (buf
[0] != '$') goto fmterr
;
7917 len
= strtol(buf
+1,NULL
,10);
7918 argsds
= sdsnewlen(NULL
,len
);
7919 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7920 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7921 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7924 /* Command lookup */
7925 cmd
= lookupCommand(argv
[0]->ptr
);
7927 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7930 /* Try object encoding */
7931 if (cmd
->flags
& REDIS_CMD_BULK
)
7932 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
7933 /* Run the command in the context of a fake client */
7934 fakeClient
->argc
= argc
;
7935 fakeClient
->argv
= argv
;
7936 cmd
->proc(fakeClient
);
7937 /* Discard the reply objects list from the fake client */
7938 while(listLength(fakeClient
->reply
))
7939 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7940 /* Clean up, ready for the next command */
7941 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7943 /* Handle swapping while loading big datasets when VM is on */
7945 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7946 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7947 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7952 freeFakeClient(fakeClient
);
7957 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7959 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7963 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7967 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7968 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7972 /* Avoid the incr/decr ref count business if possible to help
7973 * copy-on-write (we are often in a child process when this function
7975 * Also makes sure that key objects don't get incrRefCount-ed when VM
7977 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7978 obj
= getDecodedObject(obj
);
7981 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7982 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7983 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7985 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7986 if (decrrc
) decrRefCount(obj
);
7989 if (decrrc
) decrRefCount(obj
);
7993 /* Write binary-safe string into a file in the bulkformat
7994 * $<count>\r\n<payload>\r\n */
7995 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7998 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7999 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8000 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8001 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8005 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8006 static int fwriteBulkDouble(FILE *fp
, double d
) {
8007 char buf
[128], dbuf
[128];
8009 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8010 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8011 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8012 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8016 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8017 static int fwriteBulkLong(FILE *fp
, long l
) {
8018 char buf
[128], lbuf
[128];
8020 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8021 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8022 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8023 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8027 /* Write a sequence of commands able to fully rebuild the dataset into
8028 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8029 static int rewriteAppendOnlyFile(char *filename
) {
8030 dictIterator
*di
= NULL
;
8035 time_t now
= time(NULL
);
8037 /* Note that we have to use a different temp name here compared to the
8038 * one used by rewriteAppendOnlyFileBackground() function. */
8039 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8040 fp
= fopen(tmpfile
,"w");
8042 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8045 for (j
= 0; j
< server
.dbnum
; j
++) {
8046 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8047 redisDb
*db
= server
.db
+j
;
8049 if (dictSize(d
) == 0) continue;
8050 di
= dictGetIterator(d
);
8056 /* SELECT the new DB */
8057 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8058 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8060 /* Iterate this DB writing every entry */
8061 while((de
= dictNext(di
)) != NULL
) {
8066 key
= dictGetEntryKey(de
);
8067 /* If the value for this key is swapped, load a preview in memory.
8068 * We use a "swapped" flag to remember if we need to free the
8069 * value object instead to just increment the ref count anyway
8070 * in order to avoid copy-on-write of pages if we are forked() */
8071 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8072 key
->storage
== REDIS_VM_SWAPPING
) {
8073 o
= dictGetEntryVal(de
);
8076 o
= vmPreviewObject(key
);
8079 expiretime
= getExpire(db
,key
);
8081 /* Save the key and associated value */
8082 if (o
->type
== REDIS_STRING
) {
8083 /* Emit a SET command */
8084 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8085 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8087 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8088 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8089 } else if (o
->type
== REDIS_LIST
) {
8090 /* Emit the RPUSHes needed to rebuild the list */
8091 list
*list
= o
->ptr
;
8095 listRewind(list
,&li
);
8096 while((ln
= listNext(&li
))) {
8097 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8098 robj
*eleobj
= listNodeValue(ln
);
8100 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8101 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8102 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8104 } else if (o
->type
== REDIS_SET
) {
8105 /* Emit the SADDs needed to rebuild the set */
8107 dictIterator
*di
= dictGetIterator(set
);
8110 while((de
= dictNext(di
)) != NULL
) {
8111 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8112 robj
*eleobj
= dictGetEntryKey(de
);
8114 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8115 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8116 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8118 dictReleaseIterator(di
);
8119 } else if (o
->type
== REDIS_ZSET
) {
8120 /* Emit the ZADDs needed to rebuild the sorted set */
8122 dictIterator
*di
= dictGetIterator(zs
->dict
);
8125 while((de
= dictNext(di
)) != NULL
) {
8126 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8127 robj
*eleobj
= dictGetEntryKey(de
);
8128 double *score
= dictGetEntryVal(de
);
8130 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8131 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8132 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8133 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8135 dictReleaseIterator(di
);
8136 } else if (o
->type
== REDIS_HASH
) {
8137 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8139 /* Emit the HSETs needed to rebuild the hash */
8140 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8141 unsigned char *p
= zipmapRewind(o
->ptr
);
8142 unsigned char *field
, *val
;
8143 unsigned int flen
, vlen
;
8145 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8146 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8147 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8148 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8150 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8154 dictIterator
*di
= dictGetIterator(o
->ptr
);
8157 while((de
= dictNext(di
)) != NULL
) {
8158 robj
*field
= dictGetEntryKey(de
);
8159 robj
*val
= dictGetEntryVal(de
);
8161 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8162 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8163 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8164 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8166 dictReleaseIterator(di
);
8171 /* Save the expire time */
8172 if (expiretime
!= -1) {
8173 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8174 /* If this key is already expired skip it */
8175 if (expiretime
< now
) continue;
8176 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8177 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8178 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8180 if (swapped
) decrRefCount(o
);
8182 dictReleaseIterator(di
);
8185 /* Make sure data will not remain on the OS's output buffers */
8190 /* Use RENAME to make sure the DB file is changed atomically only
8191 * if the generate DB file is ok. */
8192 if (rename(tmpfile
,filename
) == -1) {
8193 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8197 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8203 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8204 if (di
) dictReleaseIterator(di
);
8208 /* This is how rewriting of the append only file in background works:
8210 * 1) The user calls BGREWRITEAOF
8211 * 2) Redis calls this function, that forks():
8212 * 2a) the child rewrite the append only file in a temp file.
8213 * 2b) the parent accumulates differences in server.bgrewritebuf.
8214 * 3) When the child finished '2a' exists.
8215 * 4) The parent will trap the exit code, if it's OK, will append the
8216 * data accumulated into server.bgrewritebuf into the temp file, and
8217 * finally will rename(2) the temp file in the actual file name.
8218 * The the new file is reopened as the new append only file. Profit!
8220 static int rewriteAppendOnlyFileBackground(void) {
8223 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8224 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8225 if ((childpid
= fork()) == 0) {
8229 if (server
.vm_enabled
) vmReopenSwapFile();
8231 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8232 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8239 if (childpid
== -1) {
8240 redisLog(REDIS_WARNING
,
8241 "Can't rewrite append only file in background: fork: %s",
8245 redisLog(REDIS_NOTICE
,
8246 "Background append only file rewriting started by pid %d",childpid
);
8247 server
.bgrewritechildpid
= childpid
;
8248 updateDictResizePolicy();
8249 /* We set appendseldb to -1 in order to force the next call to the
8250 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8251 * accumulated by the parent into server.bgrewritebuf will start
8252 * with a SELECT statement and it will be safe to merge. */
8253 server
.appendseldb
= -1;
8256 return REDIS_OK
; /* unreached */
8259 static void bgrewriteaofCommand(redisClient
*c
) {
8260 if (server
.bgrewritechildpid
!= -1) {
8261 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8264 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8265 char *status
= "+Background append only file rewriting started\r\n";
8266 addReplySds(c
,sdsnew(status
));
8268 addReply(c
,shared
.err
);
8272 static void aofRemoveTempFile(pid_t childpid
) {
8275 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8279 /* Virtual Memory is composed mainly of two subsystems:
8280 * - Blocking Virutal Memory
8281 * - Threaded Virtual Memory I/O
8282 * The two parts are not fully decoupled, but functions are split among two
8283 * different sections of the source code (delimited by comments) in order to
8284 * make more clear what functionality is about the blocking VM and what about
8285 * the threaded (not blocking) VM.
8289 * Redis VM is a blocking VM (one that blocks reading swapped values from
8290 * disk into memory when a value swapped out is needed in memory) that is made
8291 * unblocking by trying to examine the command argument vector in order to
8292 * load in background values that will likely be needed in order to exec
8293 * the command. The command is executed only once all the relevant keys
8294 * are loaded into memory.
8296 * This basically is almost as simple of a blocking VM, but almost as parallel
8297 * as a fully non-blocking VM.
8300 /* =================== Virtual Memory - Blocking Side ====================== */
8302 /* substitute the first occurrence of '%p' with the process pid in the
8303 * swap file name. */
8304 static void expandVmSwapFilename(void) {
8305 char *p
= strstr(server
.vm_swap_file
,"%p");
8311 new = sdscat(new,server
.vm_swap_file
);
8312 new = sdscatprintf(new,"%ld",(long) getpid());
8313 new = sdscat(new,p
+2);
8314 zfree(server
.vm_swap_file
);
8315 server
.vm_swap_file
= new;
8318 static void vmInit(void) {
8323 if (server
.vm_max_threads
!= 0)
8324 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8326 expandVmSwapFilename();
8327 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8328 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8329 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8331 if (server
.vm_fp
== NULL
) {
8332 redisLog(REDIS_WARNING
,
8333 "Impossible to open the swap file: %s. Exiting.",
8337 server
.vm_fd
= fileno(server
.vm_fp
);
8338 server
.vm_next_page
= 0;
8339 server
.vm_near_pages
= 0;
8340 server
.vm_stats_used_pages
= 0;
8341 server
.vm_stats_swapped_objects
= 0;
8342 server
.vm_stats_swapouts
= 0;
8343 server
.vm_stats_swapins
= 0;
8344 totsize
= server
.vm_pages
*server
.vm_page_size
;
8345 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8346 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8347 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8351 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8353 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8354 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8355 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8356 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8358 /* Initialize threaded I/O (used by Virtual Memory) */
8359 server
.io_newjobs
= listCreate();
8360 server
.io_processing
= listCreate();
8361 server
.io_processed
= listCreate();
8362 server
.io_ready_clients
= listCreate();
8363 pthread_mutex_init(&server
.io_mutex
,NULL
);
8364 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8365 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8366 server
.io_active_threads
= 0;
8367 if (pipe(pipefds
) == -1) {
8368 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8372 server
.io_ready_pipe_read
= pipefds
[0];
8373 server
.io_ready_pipe_write
= pipefds
[1];
8374 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8375 /* LZF requires a lot of stack */
8376 pthread_attr_init(&server
.io_threads_attr
);
8377 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8378 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8379 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8380 /* Listen for events in the threaded I/O pipe */
8381 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8382 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8383 oom("creating file event");
8386 /* Mark the page as used */
8387 static void vmMarkPageUsed(off_t page
) {
8388 off_t byte
= page
/8;
8390 redisAssert(vmFreePage(page
) == 1);
8391 server
.vm_bitmap
[byte
] |= 1<<bit
;
8394 /* Mark N contiguous pages as used, with 'page' being the first. */
8395 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8398 for (j
= 0; j
< count
; j
++)
8399 vmMarkPageUsed(page
+j
);
8400 server
.vm_stats_used_pages
+= count
;
8401 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8402 (long long)count
, (long long)page
);
8405 /* Mark the page as free */
8406 static void vmMarkPageFree(off_t page
) {
8407 off_t byte
= page
/8;
8409 redisAssert(vmFreePage(page
) == 0);
8410 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8413 /* Mark N contiguous pages as free, with 'page' being the first. */
8414 static void vmMarkPagesFree(off_t page
, off_t count
) {
8417 for (j
= 0; j
< count
; j
++)
8418 vmMarkPageFree(page
+j
);
8419 server
.vm_stats_used_pages
-= count
;
8420 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8421 (long long)count
, (long long)page
);
8424 /* Test if the page is free */
8425 static int vmFreePage(off_t page
) {
8426 off_t byte
= page
/8;
8428 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8431 /* Find N contiguous free pages storing the first page of the cluster in *first.
8432 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8433 * REDIS_ERR is returned.
8435 * This function uses a simple algorithm: we try to allocate
8436 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8437 * again from the start of the swap file searching for free spaces.
8439 * If it looks pretty clear that there are no free pages near our offset
8440 * we try to find less populated places doing a forward jump of
8441 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8442 * without hurry, and then we jump again and so forth...
8444 * This function can be improved using a free list to avoid to guess
8445 * too much, since we could collect data about freed pages.
8447 * note: I implemented this function just after watching an episode of
8448 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8450 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8451 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8453 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8454 server
.vm_near_pages
= 0;
8455 server
.vm_next_page
= 0;
8457 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8458 base
= server
.vm_next_page
;
8460 while(offset
< server
.vm_pages
) {
8461 off_t
this = base
+offset
;
8463 /* If we overflow, restart from page zero */
8464 if (this >= server
.vm_pages
) {
8465 this -= server
.vm_pages
;
8467 /* Just overflowed, what we found on tail is no longer
8468 * interesting, as it's no longer contiguous. */
8472 if (vmFreePage(this)) {
8473 /* This is a free page */
8475 /* Already got N free pages? Return to the caller, with success */
8477 *first
= this-(n
-1);
8478 server
.vm_next_page
= this+1;
8479 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8483 /* The current one is not a free page */
8487 /* Fast-forward if the current page is not free and we already
8488 * searched enough near this place. */
8490 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8491 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8493 /* Note that even if we rewind after the jump, we are don't need
8494 * to make sure numfree is set to zero as we only jump *if* it
8495 * is set to zero. */
8497 /* Otherwise just check the next page */
8504 /* Write the specified object at the specified page of the swap file */
8505 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8506 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8507 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8508 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8509 redisLog(REDIS_WARNING
,
8510 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8514 rdbSaveObject(server
.vm_fp
,o
);
8515 fflush(server
.vm_fp
);
8516 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8520 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8521 * needed to later retrieve the object into the key object.
8522 * If we can't find enough contiguous empty pages to swap the object on disk
8523 * REDIS_ERR is returned. */
8524 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8525 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8528 assert(key
->storage
== REDIS_VM_MEMORY
);
8529 assert(key
->refcount
== 1);
8530 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8531 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8532 key
->vm
.page
= page
;
8533 key
->vm
.usedpages
= pages
;
8534 key
->storage
= REDIS_VM_SWAPPED
;
8535 key
->vtype
= val
->type
;
8536 decrRefCount(val
); /* Deallocate the object from memory. */
8537 vmMarkPagesUsed(page
,pages
);
8538 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8539 (unsigned char*) key
->ptr
,
8540 (unsigned long long) page
, (unsigned long long) pages
);
8541 server
.vm_stats_swapped_objects
++;
8542 server
.vm_stats_swapouts
++;
8546 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8549 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8550 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8551 redisLog(REDIS_WARNING
,
8552 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8556 o
= rdbLoadObject(type
,server
.vm_fp
);
8558 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8561 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8565 /* Load the value object relative to the 'key' object from swap to memory.
8566 * The newly allocated object is returned.
8568 * If preview is true the unserialized object is returned to the caller but
8569 * no changes are made to the key object, nor the pages are marked as freed */
8570 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8573 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8574 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8576 key
->storage
= REDIS_VM_MEMORY
;
8577 key
->vm
.atime
= server
.unixtime
;
8578 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8579 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8580 (unsigned char*) key
->ptr
);
8581 server
.vm_stats_swapped_objects
--;
8583 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8584 (unsigned char*) key
->ptr
);
8586 server
.vm_stats_swapins
++;
8590 /* Plain object loading, from swap to memory */
8591 static robj
*vmLoadObject(robj
*key
) {
8592 /* If we are loading the object in background, stop it, we
8593 * need to load this object synchronously ASAP. */
8594 if (key
->storage
== REDIS_VM_LOADING
)
8595 vmCancelThreadedIOJob(key
);
8596 return vmGenericLoadObject(key
,0);
8599 /* Just load the value on disk, without to modify the key.
8600 * This is useful when we want to perform some operation on the value
8601 * without to really bring it from swap to memory, like while saving the
8602 * dataset or rewriting the append only log. */
8603 static robj
*vmPreviewObject(robj
*key
) {
8604 return vmGenericLoadObject(key
,1);
8607 /* How a good candidate is this object for swapping?
8608 * The better candidate it is, the greater the returned value.
8610 * Currently we try to perform a fast estimation of the object size in
8611 * memory, and combine it with aging informations.
8613 * Basically swappability = idle-time * log(estimated size)
8615 * Bigger objects are preferred over smaller objects, but not
8616 * proportionally, this is why we use the logarithm. This algorithm is
8617 * just a first try and will probably be tuned later. */
8618 static double computeObjectSwappability(robj
*o
) {
8619 time_t age
= server
.unixtime
- o
->vm
.atime
;
8623 struct dictEntry
*de
;
8626 if (age
<= 0) return 0;
8629 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8632 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8637 listNode
*ln
= listFirst(l
);
8639 asize
= sizeof(list
);
8641 robj
*ele
= ln
->value
;
8644 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8645 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8647 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8652 z
= (o
->type
== REDIS_ZSET
);
8653 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8655 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8656 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8661 de
= dictGetRandomKey(d
);
8662 ele
= dictGetEntryKey(de
);
8663 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8664 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8666 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8667 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8671 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8672 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8673 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8674 unsigned int klen
, vlen
;
8675 unsigned char *key
, *val
;
8677 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8681 asize
= len
*(klen
+vlen
+3);
8682 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8684 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8689 de
= dictGetRandomKey(d
);
8690 ele
= dictGetEntryKey(de
);
8691 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8692 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8694 ele
= dictGetEntryVal(de
);
8695 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8696 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8698 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8703 return (double)age
*log(1+asize
);
8706 /* Try to swap an object that's a good candidate for swapping.
8707 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8708 * to swap any object at all.
8710 * If 'usethreaded' is true, Redis will try to swap the object in background
8711 * using I/O threads. */
8712 static int vmSwapOneObject(int usethreads
) {
8714 struct dictEntry
*best
= NULL
;
8715 double best_swappability
= 0;
8716 redisDb
*best_db
= NULL
;
8719 for (j
= 0; j
< server
.dbnum
; j
++) {
8720 redisDb
*db
= server
.db
+j
;
8721 /* Why maxtries is set to 100?
8722 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8723 * are swappable objects */
8726 if (dictSize(db
->dict
) == 0) continue;
8727 for (i
= 0; i
< 5; i
++) {
8729 double swappability
;
8731 if (maxtries
) maxtries
--;
8732 de
= dictGetRandomKey(db
->dict
);
8733 key
= dictGetEntryKey(de
);
8734 val
= dictGetEntryVal(de
);
8735 /* Only swap objects that are currently in memory.
8737 * Also don't swap shared objects if threaded VM is on, as we
8738 * try to ensure that the main thread does not touch the
8739 * object while the I/O thread is using it, but we can't
8740 * control other keys without adding additional mutex. */
8741 if (key
->storage
!= REDIS_VM_MEMORY
||
8742 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8743 if (maxtries
) i
--; /* don't count this try */
8746 swappability
= computeObjectSwappability(val
);
8747 if (!best
|| swappability
> best_swappability
) {
8749 best_swappability
= swappability
;
8754 if (best
== NULL
) return REDIS_ERR
;
8755 key
= dictGetEntryKey(best
);
8756 val
= dictGetEntryVal(best
);
8758 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8759 key
->ptr
, best_swappability
);
8761 /* Unshare the key if needed */
8762 if (key
->refcount
> 1) {
8763 robj
*newkey
= dupStringObject(key
);
8765 key
= dictGetEntryKey(best
) = newkey
;
8769 vmSwapObjectThreaded(key
,val
,best_db
);
8772 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8773 dictGetEntryVal(best
) = NULL
;
8781 static int vmSwapOneObjectBlocking() {
8782 return vmSwapOneObject(0);
8785 static int vmSwapOneObjectThreaded() {
8786 return vmSwapOneObject(1);
8789 /* Return true if it's safe to swap out objects in a given moment.
8790 * Basically we don't want to swap objects out while there is a BGSAVE
8791 * or a BGAEOREWRITE running in backgroud. */
8792 static int vmCanSwapOut(void) {
8793 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8796 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8797 * and was deleted. Otherwise 0 is returned. */
8798 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8802 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8803 foundkey
= dictGetEntryKey(de
);
8804 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8809 /* =================== Virtual Memory - Threaded I/O ======================= */
8811 static void freeIOJob(iojob
*j
) {
8812 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8813 j
->type
== REDIS_IOJOB_DO_SWAP
||
8814 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8815 decrRefCount(j
->val
);
8816 /* We don't decrRefCount the j->key field as we did't incremented
8817 * the count creating IO Jobs. This is because the key field here is
8818 * just used as an indentifier and if a key is removed the Job should
8819 * never be touched again. */
8823 /* Every time a thread finished a Job, it writes a byte into the write side
8824 * of an unix pipe in order to "awake" the main thread, and this function
8826 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8830 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8832 REDIS_NOTUSED(mask
);
8833 REDIS_NOTUSED(privdata
);
8835 /* For every byte we read in the read side of the pipe, there is one
8836 * I/O job completed to process. */
8837 while((retval
= read(fd
,buf
,1)) == 1) {
8841 struct dictEntry
*de
;
8843 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8845 /* Get the processed element (the oldest one) */
8847 assert(listLength(server
.io_processed
) != 0);
8848 if (toprocess
== -1) {
8849 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8850 if (toprocess
<= 0) toprocess
= 1;
8852 ln
= listFirst(server
.io_processed
);
8854 listDelNode(server
.io_processed
,ln
);
8856 /* If this job is marked as canceled, just ignore it */
8861 /* Post process it in the main thread, as there are things we
8862 * can do just here to avoid race conditions and/or invasive locks */
8863 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
);
8864 de
= dictFind(j
->db
->dict
,j
->key
);
8866 key
= dictGetEntryKey(de
);
8867 if (j
->type
== REDIS_IOJOB_LOAD
) {
8870 /* Key loaded, bring it at home */
8871 key
->storage
= REDIS_VM_MEMORY
;
8872 key
->vm
.atime
= server
.unixtime
;
8873 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8874 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8875 (unsigned char*) key
->ptr
);
8876 server
.vm_stats_swapped_objects
--;
8877 server
.vm_stats_swapins
++;
8878 dictGetEntryVal(de
) = j
->val
;
8879 incrRefCount(j
->val
);
8882 /* Handle clients waiting for this key to be loaded. */
8883 handleClientsBlockedOnSwappedKey(db
,key
);
8884 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8885 /* Now we know the amount of pages required to swap this object.
8886 * Let's find some space for it, and queue this task again
8887 * rebranded as REDIS_IOJOB_DO_SWAP. */
8888 if (!vmCanSwapOut() ||
8889 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8891 /* Ooops... no space or we can't swap as there is
8892 * a fork()ed Redis trying to save stuff on disk. */
8894 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8896 /* Note that we need to mark this pages as used now,
8897 * if the job will be canceled, we'll mark them as freed
8899 vmMarkPagesUsed(j
->page
,j
->pages
);
8900 j
->type
= REDIS_IOJOB_DO_SWAP
;
8905 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8908 /* Key swapped. We can finally free some memory. */
8909 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8910 printf("key->storage: %d\n",key
->storage
);
8911 printf("key->name: %s\n",(char*)key
->ptr
);
8912 printf("key->refcount: %d\n",key
->refcount
);
8913 printf("val: %p\n",(void*)j
->val
);
8914 printf("val->type: %d\n",j
->val
->type
);
8915 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8917 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8918 val
= dictGetEntryVal(de
);
8919 key
->vm
.page
= j
->page
;
8920 key
->vm
.usedpages
= j
->pages
;
8921 key
->storage
= REDIS_VM_SWAPPED
;
8922 key
->vtype
= j
->val
->type
;
8923 decrRefCount(val
); /* Deallocate the object from memory. */
8924 dictGetEntryVal(de
) = NULL
;
8925 redisLog(REDIS_DEBUG
,
8926 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8927 (unsigned char*) key
->ptr
,
8928 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8929 server
.vm_stats_swapped_objects
++;
8930 server
.vm_stats_swapouts
++;
8932 /* Put a few more swap requests in queue if we are still
8934 if (trytoswap
&& vmCanSwapOut() &&
8935 zmalloc_used_memory() > server
.vm_max_memory
)
8940 more
= listLength(server
.io_newjobs
) <
8941 (unsigned) server
.vm_max_threads
;
8943 /* Don't waste CPU time if swappable objects are rare. */
8944 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8952 if (processed
== toprocess
) return;
8954 if (retval
< 0 && errno
!= EAGAIN
) {
8955 redisLog(REDIS_WARNING
,
8956 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8961 static void lockThreadedIO(void) {
8962 pthread_mutex_lock(&server
.io_mutex
);
8965 static void unlockThreadedIO(void) {
8966 pthread_mutex_unlock(&server
.io_mutex
);
8969 /* Remove the specified object from the threaded I/O queue if still not
8970 * processed, otherwise make sure to flag it as canceled. */
8971 static void vmCancelThreadedIOJob(robj
*o
) {
8973 server
.io_newjobs
, /* 0 */
8974 server
.io_processing
, /* 1 */
8975 server
.io_processed
/* 2 */
8979 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8982 /* Search for a matching key in one of the queues */
8983 for (i
= 0; i
< 3; i
++) {
8987 listRewind(lists
[i
],&li
);
8988 while ((ln
= listNext(&li
)) != NULL
) {
8989 iojob
*job
= ln
->value
;
8991 if (job
->canceled
) continue; /* Skip this, already canceled. */
8992 if (job
->key
== o
) {
8993 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8994 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8995 /* Mark the pages as free since the swap didn't happened
8996 * or happened but is now discarded. */
8997 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8998 vmMarkPagesFree(job
->page
,job
->pages
);
8999 /* Cancel the job. It depends on the list the job is
9002 case 0: /* io_newjobs */
9003 /* If the job was yet not processed the best thing to do
9004 * is to remove it from the queue at all */
9006 listDelNode(lists
[i
],ln
);
9008 case 1: /* io_processing */
9009 /* Oh Shi- the thread is messing with the Job:
9011 * Probably it's accessing the object if this is a
9012 * PREPARE_SWAP or DO_SWAP job.
9013 * If it's a LOAD job it may be reading from disk and
9014 * if we don't wait for the job to terminate before to
9015 * cancel it, maybe in a few microseconds data can be
9016 * corrupted in this pages. So the short story is:
9018 * Better to wait for the job to move into the
9019 * next queue (processed)... */
9021 /* We try again and again until the job is completed. */
9023 /* But let's wait some time for the I/O thread
9024 * to finish with this job. After all this condition
9025 * should be very rare. */
9028 case 2: /* io_processed */
9029 /* The job was already processed, that's easy...
9030 * just mark it as canceled so that we'll ignore it
9031 * when processing completed jobs. */
9035 /* Finally we have to adjust the storage type of the object
9036 * in order to "UNDO" the operaiton. */
9037 if (o
->storage
== REDIS_VM_LOADING
)
9038 o
->storage
= REDIS_VM_SWAPPED
;
9039 else if (o
->storage
== REDIS_VM_SWAPPING
)
9040 o
->storage
= REDIS_VM_MEMORY
;
9047 assert(1 != 1); /* We should never reach this */
9050 static void *IOThreadEntryPoint(void *arg
) {
9055 pthread_detach(pthread_self());
9057 /* Get a new job to process */
9059 if (listLength(server
.io_newjobs
) == 0) {
9060 /* No new jobs in queue, exit. */
9061 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9062 (long) pthread_self());
9063 server
.io_active_threads
--;
9067 ln
= listFirst(server
.io_newjobs
);
9069 listDelNode(server
.io_newjobs
,ln
);
9070 /* Add the job in the processing queue */
9071 j
->thread
= pthread_self();
9072 listAddNodeTail(server
.io_processing
,j
);
9073 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9075 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9076 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9078 /* Process the Job */
9079 if (j
->type
== REDIS_IOJOB_LOAD
) {
9080 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9081 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9082 FILE *fp
= fopen("/dev/null","w+");
9083 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9085 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9086 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9090 /* Done: insert the job into the processed queue */
9091 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9092 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9094 listDelNode(server
.io_processing
,ln
);
9095 listAddNodeTail(server
.io_processed
,j
);
9098 /* Signal the main thread there is new stuff to process */
9099 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9101 return NULL
; /* never reached */
9104 static void spawnIOThread(void) {
9106 sigset_t mask
, omask
;
9110 sigaddset(&mask
,SIGCHLD
);
9111 sigaddset(&mask
,SIGHUP
);
9112 sigaddset(&mask
,SIGPIPE
);
9113 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9114 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9115 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9119 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9120 server
.io_active_threads
++;
9123 /* We need to wait for the last thread to exit before we are able to
9124 * fork() in order to BGSAVE or BGREWRITEAOF. */
9125 static void waitEmptyIOJobsQueue(void) {
9127 int io_processed_len
;
9130 if (listLength(server
.io_newjobs
) == 0 &&
9131 listLength(server
.io_processing
) == 0 &&
9132 server
.io_active_threads
== 0)
9137 /* While waiting for empty jobs queue condition we post-process some
9138 * finshed job, as I/O threads may be hanging trying to write against
9139 * the io_ready_pipe_write FD but there are so much pending jobs that
9141 io_processed_len
= listLength(server
.io_processed
);
9143 if (io_processed_len
) {
9144 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9145 usleep(1000); /* 1 millisecond */
9147 usleep(10000); /* 10 milliseconds */
9152 static void vmReopenSwapFile(void) {
9153 /* Note: we don't close the old one as we are in the child process
9154 * and don't want to mess at all with the original file object. */
9155 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9156 if (server
.vm_fp
== NULL
) {
9157 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9158 server
.vm_swap_file
);
9161 server
.vm_fd
= fileno(server
.vm_fp
);
9164 /* This function must be called while with threaded IO locked */
9165 static void queueIOJob(iojob
*j
) {
9166 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9167 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9168 listAddNodeTail(server
.io_newjobs
,j
);
9169 if (server
.io_active_threads
< server
.vm_max_threads
)
9173 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9176 assert(key
->storage
== REDIS_VM_MEMORY
);
9177 assert(key
->refcount
== 1);
9179 j
= zmalloc(sizeof(*j
));
9180 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9186 j
->thread
= (pthread_t
) -1;
9187 key
->storage
= REDIS_VM_SWAPPING
;
9195 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9197 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9198 * If there is not already a job loading the key, it is craeted.
9199 * The key is added to the io_keys list in the client structure, and also
9200 * in the hash table mapping swapped keys to waiting clients, that is,
9201 * server.io_waited_keys. */
9202 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9203 struct dictEntry
*de
;
9207 /* If the key does not exist or is already in RAM we don't need to
9208 * block the client at all. */
9209 de
= dictFind(c
->db
->dict
,key
);
9210 if (de
== NULL
) return 0;
9211 o
= dictGetEntryKey(de
);
9212 if (o
->storage
== REDIS_VM_MEMORY
) {
9214 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9215 /* We were swapping the key, undo it! */
9216 vmCancelThreadedIOJob(o
);
9220 /* OK: the key is either swapped, or being loaded just now. */
9222 /* Add the key to the list of keys this client is waiting for.
9223 * This maps clients to keys they are waiting for. */
9224 listAddNodeTail(c
->io_keys
,key
);
9227 /* Add the client to the swapped keys => clients waiting map. */
9228 de
= dictFind(c
->db
->io_keys
,key
);
9232 /* For every key we take a list of clients blocked for it */
9234 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9236 assert(retval
== DICT_OK
);
9238 l
= dictGetEntryVal(de
);
9240 listAddNodeTail(l
,c
);
9242 /* Are we already loading the key from disk? If not create a job */
9243 if (o
->storage
== REDIS_VM_SWAPPED
) {
9246 o
->storage
= REDIS_VM_LOADING
;
9247 j
= zmalloc(sizeof(*j
));
9248 j
->type
= REDIS_IOJOB_LOAD
;
9251 j
->key
->vtype
= o
->vtype
;
9252 j
->page
= o
->vm
.page
;
9255 j
->thread
= (pthread_t
) -1;
9263 /* Preload keys needed for the ZUNION and ZINTER commands. */
9264 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9266 num
= atoi(c
->argv
[2]->ptr
);
9267 for (i
= 0; i
< num
; i
++) {
9268 waitForSwappedKey(c
,c
->argv
[3+i
]);
9272 /* Is this client attempting to run a command against swapped keys?
9273 * If so, block it ASAP, load the keys in background, then resume it.
9275 * The important idea about this function is that it can fail! If keys will
9276 * still be swapped when the client is resumed, this key lookups will
9277 * just block loading keys from disk. In practical terms this should only
9278 * happen with SORT BY command or if there is a bug in this function.
9280 * Return 1 if the client is marked as blocked, 0 if the client can
9281 * continue as the keys it is going to access appear to be in memory. */
9282 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9285 if (cmd
->vm_preload_proc
!= NULL
) {
9286 cmd
->vm_preload_proc(c
);
9288 if (cmd
->vm_firstkey
== 0) return 0;
9289 last
= cmd
->vm_lastkey
;
9290 if (last
< 0) last
= c
->argc
+last
;
9291 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9292 waitForSwappedKey(c
,c
->argv
[j
]);
9295 /* If the client was blocked for at least one key, mark it as blocked. */
9296 if (listLength(c
->io_keys
)) {
9297 c
->flags
|= REDIS_IO_WAIT
;
9298 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9299 server
.vm_blocked_clients
++;
9306 /* Remove the 'key' from the list of blocked keys for a given client.
9308 * The function returns 1 when there are no longer blocking keys after
9309 * the current one was removed (and the client can be unblocked). */
9310 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9314 struct dictEntry
*de
;
9316 /* Remove the key from the list of keys this client is waiting for. */
9317 listRewind(c
->io_keys
,&li
);
9318 while ((ln
= listNext(&li
)) != NULL
) {
9319 if (compareStringObjects(ln
->value
,key
) == 0) {
9320 listDelNode(c
->io_keys
,ln
);
9326 /* Remove the client form the key => waiting clients map. */
9327 de
= dictFind(c
->db
->io_keys
,key
);
9329 l
= dictGetEntryVal(de
);
9330 ln
= listSearchKey(l
,c
);
9333 if (listLength(l
) == 0)
9334 dictDelete(c
->db
->io_keys
,key
);
9336 return listLength(c
->io_keys
) == 0;
9339 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9340 struct dictEntry
*de
;
9345 de
= dictFind(db
->io_keys
,key
);
9348 l
= dictGetEntryVal(de
);
9349 len
= listLength(l
);
9350 /* Note: we can't use something like while(listLength(l)) as the list
9351 * can be freed by the calling function when we remove the last element. */
9354 redisClient
*c
= ln
->value
;
9356 if (dontWaitForSwappedKey(c
,key
)) {
9357 /* Put the client in the list of clients ready to go as we
9358 * loaded all the keys about it. */
9359 listAddNodeTail(server
.io_ready_clients
,c
);
9364 /* =========================== Remote Configuration ========================= */
9366 static void configSetCommand(redisClient
*c
) {
9367 robj
*o
= getDecodedObject(c
->argv
[3]);
9368 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9369 zfree(server
.dbfilename
);
9370 server
.dbfilename
= zstrdup(o
->ptr
);
9371 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9372 zfree(server
.requirepass
);
9373 server
.requirepass
= zstrdup(o
->ptr
);
9374 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9375 zfree(server
.masterauth
);
9376 server
.masterauth
= zstrdup(o
->ptr
);
9377 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9378 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9380 addReplySds(c
,sdscatprintf(sdsempty(),
9381 "-ERR not supported CONFIG parameter %s\r\n",
9382 (char*)c
->argv
[2]->ptr
));
9387 addReply(c
,shared
.ok
);
9390 static void configGetCommand(redisClient
*c
) {
9391 robj
*o
= getDecodedObject(c
->argv
[2]);
9392 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9393 char *pattern
= o
->ptr
;
9397 decrRefCount(lenobj
);
9399 if (stringmatch(pattern
,"dbfilename",0)) {
9400 addReplyBulkCString(c
,"dbfilename");
9401 addReplyBulkCString(c
,server
.dbfilename
);
9404 if (stringmatch(pattern
,"requirepass",0)) {
9405 addReplyBulkCString(c
,"requirepass");
9406 addReplyBulkCString(c
,server
.requirepass
);
9409 if (stringmatch(pattern
,"masterauth",0)) {
9410 addReplyBulkCString(c
,"masterauth");
9411 addReplyBulkCString(c
,server
.masterauth
);
9414 if (stringmatch(pattern
,"maxmemory",0)) {
9417 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9418 addReplyBulkCString(c
,"maxmemory");
9419 addReplyBulkCString(c
,buf
);
9423 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9426 static void configCommand(redisClient
*c
) {
9427 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9428 if (c
->argc
!= 4) goto badarity
;
9429 configSetCommand(c
);
9430 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9431 if (c
->argc
!= 3) goto badarity
;
9432 configGetCommand(c
);
9433 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9434 if (c
->argc
!= 2) goto badarity
;
9435 server
.stat_numcommands
= 0;
9436 server
.stat_numconnections
= 0;
9437 server
.stat_expiredkeys
= 0;
9438 server
.stat_starttime
= time(NULL
);
9439 addReply(c
,shared
.ok
);
9441 addReplySds(c
,sdscatprintf(sdsempty(),
9442 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9447 addReplySds(c
,sdscatprintf(sdsempty(),
9448 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9449 (char*) c
->argv
[1]->ptr
));
9452 /* =========================== Pubsub implementation ======================== */
9454 static void freePubsubPattern(void *p
) {
9455 pubsubPattern
*pat
= p
;
9457 decrRefCount(pat
->pattern
);
9461 static int listMatchPubsubPattern(void *a
, void *b
) {
9462 pubsubPattern
*pa
= a
, *pb
= b
;
9464 return (pa
->client
== pb
->client
) &&
9465 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9468 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9469 * 0 if the client was already subscribed to that channel. */
9470 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9471 struct dictEntry
*de
;
9472 list
*clients
= NULL
;
9475 /* Add the channel to the client -> channels hash table */
9476 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9478 incrRefCount(channel
);
9479 /* Add the client to the channel -> list of clients hash table */
9480 de
= dictFind(server
.pubsub_channels
,channel
);
9482 clients
= listCreate();
9483 dictAdd(server
.pubsub_channels
,channel
,clients
);
9484 incrRefCount(channel
);
9486 clients
= dictGetEntryVal(de
);
9488 listAddNodeTail(clients
,c
);
9490 /* Notify the client */
9491 addReply(c
,shared
.mbulk3
);
9492 addReply(c
,shared
.subscribebulk
);
9493 addReplyBulk(c
,channel
);
9494 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9498 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9499 * 0 if the client was not subscribed to the specified channel. */
9500 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9501 struct dictEntry
*de
;
9506 /* Remove the channel from the client -> channels hash table */
9507 incrRefCount(channel
); /* channel may be just a pointer to the same object
9508 we have in the hash tables. Protect it... */
9509 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9511 /* Remove the client from the channel -> clients list hash table */
9512 de
= dictFind(server
.pubsub_channels
,channel
);
9514 clients
= dictGetEntryVal(de
);
9515 ln
= listSearchKey(clients
,c
);
9517 listDelNode(clients
,ln
);
9518 if (listLength(clients
) == 0) {
9519 /* Free the list and associated hash entry at all if this was
9520 * the latest client, so that it will be possible to abuse
9521 * Redis PUBSUB creating millions of channels. */
9522 dictDelete(server
.pubsub_channels
,channel
);
9525 /* Notify the client */
9527 addReply(c
,shared
.mbulk3
);
9528 addReply(c
,shared
.unsubscribebulk
);
9529 addReplyBulk(c
,channel
);
9530 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9531 listLength(c
->pubsub_patterns
));
9534 decrRefCount(channel
); /* it is finally safe to release it */
9538 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9539 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9542 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9545 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9546 incrRefCount(pattern
);
9547 pat
= zmalloc(sizeof(*pat
));
9548 pat
->pattern
= getDecodedObject(pattern
);
9550 listAddNodeTail(server
.pubsub_patterns
,pat
);
9552 /* Notify the client */
9553 addReply(c
,shared
.mbulk3
);
9554 addReply(c
,shared
.psubscribebulk
);
9555 addReplyBulk(c
,pattern
);
9556 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9560 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9561 * 0 if the client was not subscribed to the specified channel. */
9562 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9567 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9568 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9570 listDelNode(c
->pubsub_patterns
,ln
);
9572 pat
.pattern
= pattern
;
9573 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9574 listDelNode(server
.pubsub_patterns
,ln
);
9576 /* Notify the client */
9578 addReply(c
,shared
.mbulk3
);
9579 addReply(c
,shared
.punsubscribebulk
);
9580 addReplyBulk(c
,pattern
);
9581 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9582 listLength(c
->pubsub_patterns
));
9584 decrRefCount(pattern
);
9588 /* Unsubscribe from all the channels. Return the number of channels the
9589 * client was subscribed from. */
9590 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9591 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9595 while((de
= dictNext(di
)) != NULL
) {
9596 robj
*channel
= dictGetEntryKey(de
);
9598 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9600 dictReleaseIterator(di
);
9604 /* Unsubscribe from all the patterns. Return the number of patterns the
9605 * client was subscribed from. */
9606 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9611 listRewind(c
->pubsub_patterns
,&li
);
9612 while ((ln
= listNext(&li
)) != NULL
) {
9613 robj
*pattern
= ln
->value
;
9615 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9620 /* Publish a message */
9621 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9623 struct dictEntry
*de
;
9627 /* Send to clients listening for that channel */
9628 de
= dictFind(server
.pubsub_channels
,channel
);
9630 list
*list
= dictGetEntryVal(de
);
9634 listRewind(list
,&li
);
9635 while ((ln
= listNext(&li
)) != NULL
) {
9636 redisClient
*c
= ln
->value
;
9638 addReply(c
,shared
.mbulk3
);
9639 addReply(c
,shared
.messagebulk
);
9640 addReplyBulk(c
,channel
);
9641 addReplyBulk(c
,message
);
9645 /* Send to clients listening to matching channels */
9646 if (listLength(server
.pubsub_patterns
)) {
9647 listRewind(server
.pubsub_patterns
,&li
);
9648 channel
= getDecodedObject(channel
);
9649 while ((ln
= listNext(&li
)) != NULL
) {
9650 pubsubPattern
*pat
= ln
->value
;
9652 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9653 sdslen(pat
->pattern
->ptr
),
9654 (char*)channel
->ptr
,
9655 sdslen(channel
->ptr
),0)) {
9656 addReply(pat
->client
,shared
.mbulk3
);
9657 addReply(pat
->client
,shared
.messagebulk
);
9658 addReplyBulk(pat
->client
,channel
);
9659 addReplyBulk(pat
->client
,message
);
9663 decrRefCount(channel
);
9668 static void subscribeCommand(redisClient
*c
) {
9671 for (j
= 1; j
< c
->argc
; j
++)
9672 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9675 static void unsubscribeCommand(redisClient
*c
) {
9677 pubsubUnsubscribeAllChannels(c
,1);
9682 for (j
= 1; j
< c
->argc
; j
++)
9683 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9687 static void psubscribeCommand(redisClient
*c
) {
9690 for (j
= 1; j
< c
->argc
; j
++)
9691 pubsubSubscribePattern(c
,c
->argv
[j
]);
9694 static void punsubscribeCommand(redisClient
*c
) {
9696 pubsubUnsubscribeAllPatterns(c
,1);
9701 for (j
= 1; j
< c
->argc
; j
++)
9702 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9706 static void publishCommand(redisClient
*c
) {
9707 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9708 addReplyLong(c
,receivers
);
9711 /* ================================= Debugging ============================== */
9713 static void debugCommand(redisClient
*c
) {
9714 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9716 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9717 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9718 addReply(c
,shared
.err
);
9722 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9723 addReply(c
,shared
.err
);
9726 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9727 addReply(c
,shared
.ok
);
9728 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9730 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9731 addReply(c
,shared
.err
);
9734 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9735 addReply(c
,shared
.ok
);
9736 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9737 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9741 addReply(c
,shared
.nokeyerr
);
9744 key
= dictGetEntryKey(de
);
9745 val
= dictGetEntryVal(de
);
9746 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9747 key
->storage
== REDIS_VM_SWAPPING
)) {
9751 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9752 strenc
= strencoding
[val
->encoding
];
9754 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9757 addReplySds(c
,sdscatprintf(sdsempty(),
9758 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9759 "encoding:%s serializedlength:%lld\r\n",
9760 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9761 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9763 addReplySds(c
,sdscatprintf(sdsempty(),
9764 "+Key at:%p refcount:%d, value swapped at: page %llu "
9765 "using %llu pages\r\n",
9766 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9767 (unsigned long long) key
->vm
.usedpages
));
9769 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9770 lookupKeyRead(c
->db
,c
->argv
[2]);
9771 addReply(c
,shared
.ok
);
9772 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9773 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9776 if (!server
.vm_enabled
) {
9777 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9781 addReply(c
,shared
.nokeyerr
);
9784 key
= dictGetEntryKey(de
);
9785 val
= dictGetEntryVal(de
);
9786 /* If the key is shared we want to create a copy */
9787 if (key
->refcount
> 1) {
9788 robj
*newkey
= dupStringObject(key
);
9790 key
= dictGetEntryKey(de
) = newkey
;
9793 if (key
->storage
!= REDIS_VM_MEMORY
) {
9794 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9795 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9796 dictGetEntryVal(de
) = NULL
;
9797 addReply(c
,shared
.ok
);
9799 addReply(c
,shared
.err
);
9802 addReplySds(c
,sdsnew(
9803 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9807 static void _redisAssert(char *estr
, char *file
, int line
) {
9808 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9809 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9810 #ifdef HAVE_BACKTRACE
9811 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9816 /* =================================== Main! ================================ */
9819 int linuxOvercommitMemoryValue(void) {
9820 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9824 if (fgets(buf
,64,fp
) == NULL
) {
9833 void linuxOvercommitMemoryWarning(void) {
9834 if (linuxOvercommitMemoryValue() == 0) {
9835 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low condition memory. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
9838 #endif /* __linux__ */
9840 static void daemonize(void) {
9844 if (fork() != 0) exit(0); /* parent exits */
9845 setsid(); /* create a new session */
9847 /* Every output goes to /dev/null. If Redis is daemonized but
9848 * the 'logfile' is set to 'stdout' in the configuration file
9849 * it will not log at all. */
9850 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9851 dup2(fd
, STDIN_FILENO
);
9852 dup2(fd
, STDOUT_FILENO
);
9853 dup2(fd
, STDERR_FILENO
);
9854 if (fd
> STDERR_FILENO
) close(fd
);
9856 /* Try to write the pid file */
9857 fp
= fopen(server
.pidfile
,"w");
9859 fprintf(fp
,"%d\n",getpid());
9864 static void version() {
9865 printf("Redis server version %s\n", REDIS_VERSION
);
9869 static void usage() {
9870 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9871 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9875 int main(int argc
, char **argv
) {
9880 if (strcmp(argv
[1], "-v") == 0 ||
9881 strcmp(argv
[1], "--version") == 0) version();
9882 if (strcmp(argv
[1], "--help") == 0) usage();
9883 resetServerSaveParams();
9884 loadServerConfig(argv
[1]);
9885 } else if ((argc
> 2)) {
9888 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'");
9890 if (server
.daemonize
) daemonize();
9892 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9894 linuxOvercommitMemoryWarning();
9897 if (server
.appendonly
) {
9898 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9899 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9901 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9902 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9904 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9905 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9907 aeDeleteEventLoop(server
.el
);
9911 /* ============================= Backtrace support ========================= */
9913 #ifdef HAVE_BACKTRACE
9914 static char *findFuncName(void *pointer
, unsigned long *offset
);
9916 static void *getMcontextEip(ucontext_t
*uc
) {
9917 #if defined(__FreeBSD__)
9918 return (void*) uc
->uc_mcontext
.mc_eip
;
9919 #elif defined(__dietlibc__)
9920 return (void*) uc
->uc_mcontext
.eip
;
9921 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9923 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9925 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9927 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9928 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9929 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9931 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9933 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9934 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9935 #elif defined(__ia64__) /* Linux IA64 */
9936 return (void*) uc
->uc_mcontext
.sc_ip
;
9942 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9944 char **messages
= NULL
;
9945 int i
, trace_size
= 0;
9946 unsigned long offset
=0;
9947 ucontext_t
*uc
= (ucontext_t
*) secret
;
9949 REDIS_NOTUSED(info
);
9951 redisLog(REDIS_WARNING
,
9952 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9953 infostring
= genRedisInfoString();
9954 redisLog(REDIS_WARNING
, "%s",infostring
);
9955 /* It's not safe to sdsfree() the returned string under memory
9956 * corruption conditions. Let it leak as we are going to abort */
9958 trace_size
= backtrace(trace
, 100);
9959 /* overwrite sigaction with caller's address */
9960 if (getMcontextEip(uc
) != NULL
) {
9961 trace
[1] = getMcontextEip(uc
);
9963 messages
= backtrace_symbols(trace
, trace_size
);
9965 for (i
=1; i
<trace_size
; ++i
) {
9966 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9968 p
= strchr(messages
[i
],'+');
9969 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9970 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9972 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9975 /* free(messages); Don't call free() with possibly corrupted memory. */
9979 static void setupSigSegvAction(void) {
9980 struct sigaction act
;
9982 sigemptyset (&act
.sa_mask
);
9983 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9984 * is used. Otherwise, sa_handler is used */
9985 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9986 act
.sa_sigaction
= segvHandler
;
9987 sigaction (SIGSEGV
, &act
, NULL
);
9988 sigaction (SIGBUS
, &act
, NULL
);
9989 sigaction (SIGFPE
, &act
, NULL
);
9990 sigaction (SIGILL
, &act
, NULL
);
9991 sigaction (SIGBUS
, &act
, NULL
);
9995 #include "staticsymbols.h"
9996 /* This function try to convert a pointer into a function name. It's used in
9997 * oreder to provide a backtrace under segmentation fault that's able to
9998 * display functions declared as static (otherwise the backtrace is useless). */
9999 static char *findFuncName(void *pointer
, unsigned long *offset
){
10001 unsigned long off
, minoff
= 0;
10003 /* Try to match against the Symbol with the smallest offset */
10004 for (i
=0; symsTable
[i
].pointer
; i
++) {
10005 unsigned long lp
= (unsigned long) pointer
;
10007 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10008 off
=lp
-symsTable
[i
].pointer
;
10009 if (ret
< 0 || off
< minoff
) {
10015 if (ret
== -1) return NULL
;
10017 return symsTable
[ret
].name
;
10019 #else /* HAVE_BACKTRACE */
10020 static void setupSigSegvAction(void) {
10022 #endif /* HAVE_BACKTRACE */