2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.10"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
65 #include "solarisfixes.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
83 /* Static server configuration */
84 #define REDIS_SERVERPORT 6379 /* TCP port */
85 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
86 #define REDIS_IOBUF_LEN 1024
87 #define REDIS_LOADBUF_LEN 1024
88 #define REDIS_STATIC_ARGS 8
89 #define REDIS_DEFAULT_DBNUM 16
90 #define REDIS_CONFIGLINE_MAX 1024
91 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
92 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
93 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
94 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
95 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
97 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
98 #define REDIS_WRITEV_THRESHOLD 3
99 /* Max number of iovecs used for each writev call */
100 #define REDIS_WRITEV_IOVEC_COUNT 256
102 /* Hash table parameters */
103 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
106 #define REDIS_CMD_BULK 1 /* Bulk write command */
107 #define REDIS_CMD_INLINE 2 /* Inline command */
108 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
109 this flags will return an error when the 'maxmemory' option is set in the
110 config file and the server is using more than maxmemory bytes of memory.
111 In short this commands are denied on low memory conditions. */
112 #define REDIS_CMD_DENYOOM 4
113 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
116 #define REDIS_STRING 0
122 /* Objects encoding. Some kind of objects like Strings and Hashes can be
123 * internally represented in multiple ways. The 'encoding' field of the object
124 * is set to one of this fields for this object. */
125 #define REDIS_ENCODING_RAW 0 /* Raw representation */
126 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
127 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
128 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
130 static char* strencoding
[] = {
131 "raw", "int", "zipmap", "hashtable"
134 /* Object types only used for dumping to disk */
135 #define REDIS_EXPIRETIME 253
136 #define REDIS_SELECTDB 254
137 #define REDIS_EOF 255
139 /* Defines related to the dump file format. To store 32 bits lengths for short
140 * keys requires a lot of space, so we check the most significant 2 bits of
141 * the first byte to interpreter the length:
143 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
144 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
145 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
146 * 11|000000 this means: specially encoded object will follow. The six bits
147 * number specify the kind of object that follows.
148 * See the REDIS_RDB_ENC_* defines.
150 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
151 * values, will fit inside. */
152 #define REDIS_RDB_6BITLEN 0
153 #define REDIS_RDB_14BITLEN 1
154 #define REDIS_RDB_32BITLEN 2
155 #define REDIS_RDB_ENCVAL 3
156 #define REDIS_RDB_LENERR UINT_MAX
158 /* When a length of a string object stored on disk has the first two bits
159 * set, the remaining two bits specify a special encoding for the object
160 * accordingly to the following defines: */
161 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
162 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
163 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
164 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
166 /* Virtual memory object->where field. */
167 #define REDIS_VM_MEMORY 0 /* The object is on memory */
168 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
169 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
170 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
172 /* Virtual memory static configuration stuff.
173 * Check vmFindContiguousPages() to know more about this magic numbers. */
174 #define REDIS_VM_MAX_NEAR_PAGES 65536
175 #define REDIS_VM_MAX_RANDOM_JUMP 4096
176 #define REDIS_VM_MAX_THREADS 32
177 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
178 /* The following is the *percentage* of completed I/O jobs to process when the
179 * handelr is called. While Virtual Memory I/O operations are performed by
180 * threads, this operations must be processed by the main thread when completed
181 * in order to take effect. */
182 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
185 #define REDIS_SLAVE 1 /* This client is a slave server */
186 #define REDIS_MASTER 2 /* This client is a master server */
187 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
188 #define REDIS_MULTI 8 /* This client is in a MULTI context */
189 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
190 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
192 /* Slave replication state - slave side */
193 #define REDIS_REPL_NONE 0 /* No active replication */
194 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
195 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
197 /* Slave replication state - from the point of view of master
198 * Note that in SEND_BULK and ONLINE state the slave receives new updates
199 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
200 * to start the next background saving in order to send updates to it. */
201 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
202 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
203 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
204 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
206 /* List related stuff */
210 /* Sort operations */
211 #define REDIS_SORT_GET 0
212 #define REDIS_SORT_ASC 1
213 #define REDIS_SORT_DESC 2
214 #define REDIS_SORTKEY_MAX 1024
217 #define REDIS_DEBUG 0
218 #define REDIS_VERBOSE 1
219 #define REDIS_NOTICE 2
220 #define REDIS_WARNING 3
222 /* Anti-warning macro... */
223 #define REDIS_NOTUSED(V) ((void) V)
225 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
226 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
228 /* Append only defines */
229 #define APPENDFSYNC_NO 0
230 #define APPENDFSYNC_ALWAYS 1
231 #define APPENDFSYNC_EVERYSEC 2
233 /* Hashes related defaults */
234 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
235 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
237 /* We can print the stacktrace, so our assert is defined this way: */
238 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
239 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
240 static void _redisAssert(char *estr
, char *file
, int line
);
241 static void _redisPanic(char *msg
, char *file
, int line
);
243 /*================================= Data types ============================== */
245 /* A redis object, that is a type able to hold a string / list / set */
247 /* The VM object structure */
248 struct redisObjectVM
{
249 off_t page
; /* the page at witch the object is stored on disk */
250 off_t usedpages
; /* number of pages used on disk */
251 time_t atime
; /* Last access time */
254 /* The actual Redis Object */
255 typedef struct redisObject
{
258 unsigned char encoding
;
259 unsigned char storage
; /* If this object is a key, where is the value?
260 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
261 unsigned char vtype
; /* If this object is a key, and value is swapped out,
262 * this is the type of the swapped out object. */
264 /* VM fields, this are only allocated if VM is active, otherwise the
265 * object allocation function will just allocate
266 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
267 * Redis without VM active will not have any overhead. */
268 struct redisObjectVM vm
;
271 /* Macro used to initalize a Redis object allocated on the stack.
272 * Note that this macro is taken near the structure definition to make sure
273 * we'll update it when the structure is changed, to avoid bugs like
274 * bug #85 introduced exactly in this way. */
275 #define initStaticStringObject(_var,_ptr) do { \
277 _var.type = REDIS_STRING; \
278 _var.encoding = REDIS_ENCODING_RAW; \
280 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
283 typedef struct redisDb
{
284 dict
*dict
; /* The keyspace for this DB */
285 dict
*expires
; /* Timeout of keys with a timeout set */
286 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
287 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
291 /* Client MULTI/EXEC state */
292 typedef struct multiCmd
{
295 struct redisCommand
*cmd
;
298 typedef struct multiState
{
299 multiCmd
*commands
; /* Array of MULTI commands */
300 int count
; /* Total number of MULTI commands */
303 /* With multiplexing we need to take per-clinet state.
304 * Clients are taken in a liked list. */
305 typedef struct redisClient
{
310 robj
**argv
, **mbargv
;
312 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
313 int multibulk
; /* multi bulk command format active */
316 time_t lastinteraction
; /* time of the last interaction, used for timeout */
317 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
318 int slaveseldb
; /* slave selected db, if this client is a slave */
319 int authenticated
; /* when requirepass is non-NULL */
320 int replstate
; /* replication state if this is a slave */
321 int repldbfd
; /* replication DB file descriptor */
322 long repldboff
; /* replication DB file offset */
323 off_t repldbsize
; /* replication DB file size */
324 multiState mstate
; /* MULTI/EXEC state */
325 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
326 * operation such as BLPOP. Otherwise NULL. */
327 int blockingkeysnum
; /* Number of blocking keys */
328 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
329 * is >= blockingto then the operation timed out. */
330 list
*io_keys
; /* Keys this client is waiting to be loaded from the
331 * swap file in order to continue. */
332 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
333 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
341 /* Global server state structure */
346 long long dirty
; /* changes to DB from the last save */
348 list
*slaves
, *monitors
;
349 char neterr
[ANET_ERR_LEN
];
351 int cronloops
; /* number of times the cron function run */
352 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
353 time_t lastsave
; /* Unix time of last save succeeede */
354 /* Fields used only for stats */
355 time_t stat_starttime
; /* server start time */
356 long long stat_numcommands
; /* number of processed commands */
357 long long stat_numconnections
; /* number of connections received */
358 long long stat_expiredkeys
; /* number of expired keys */
371 pid_t bgsavechildpid
;
372 pid_t bgrewritechildpid
;
373 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
374 sds aofbuf
; /* AOF buffer, written before entering the event loop */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
384 /* Replication related */
389 redisClient
*master
; /* client that is master for this slave */
391 unsigned int maxclients
;
392 unsigned long long maxmemory
;
393 unsigned int blpop_blocked_clients
;
394 unsigned int vm_blocked_clients
;
395 /* Sort parameters - qsort_r() is only available under BSD so we
396 * have to take this state global, in order to pass it to sortCompare() */
400 /* Virtual memory configuration */
405 unsigned long long vm_max_memory
;
407 size_t hash_max_zipmap_entries
;
408 size_t hash_max_zipmap_value
;
409 /* Virtual memory state */
412 off_t vm_next_page
; /* Next probably empty page */
413 off_t vm_near_pages
; /* Number of pages allocated sequentially */
414 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
415 time_t unixtime
; /* Unix time sampled every second. */
416 /* Virtual memory I/O threads stuff */
417 /* An I/O thread process an element taken from the io_jobs queue and
418 * put the result of the operation in the io_done list. While the
419 * job is being processed, it's put on io_processing queue. */
420 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
421 list
*io_processing
; /* List of VM I/O jobs being processed */
422 list
*io_processed
; /* List of VM I/O jobs already processed */
423 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
424 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
425 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
426 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
427 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
428 int io_active_threads
; /* Number of running I/O threads */
429 int vm_max_threads
; /* Max number of I/O threads running at the same time */
430 /* Our main thread is blocked on the event loop, locking for sockets ready
431 * to be read or written, so when a threaded I/O operation is ready to be
432 * processed by the main thread, the I/O thread will use a unix pipe to
433 * awake the main thread. The followings are the two pipe FDs. */
434 int io_ready_pipe_read
;
435 int io_ready_pipe_write
;
436 /* Virtual memory stats */
437 unsigned long long vm_stats_used_pages
;
438 unsigned long long vm_stats_swapped_objects
;
439 unsigned long long vm_stats_swapouts
;
440 unsigned long long vm_stats_swapins
;
442 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
443 list
*pubsub_patterns
; /* A list of pubsub_patterns */
448 typedef struct pubsubPattern
{
453 typedef void redisCommandProc(redisClient
*c
);
454 struct redisCommand
{
456 redisCommandProc
*proc
;
459 /* Use a function to determine which keys need to be loaded
460 * in the background prior to executing this command. Takes precedence
461 * over vm_firstkey and others, ignored when NULL */
462 redisCommandProc
*vm_preload_proc
;
463 /* What keys should be loaded in background when calling this command? */
464 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
465 int vm_lastkey
; /* THe last argument that's a key */
466 int vm_keystep
; /* The step between first and last key */
469 struct redisFunctionSym
{
471 unsigned long pointer
;
474 typedef struct _redisSortObject
{
482 typedef struct _redisSortOperation
{
485 } redisSortOperation
;
487 /* ZSETs use a specialized version of Skiplists */
489 typedef struct zskiplistNode
{
490 struct zskiplistNode
**forward
;
491 struct zskiplistNode
*backward
;
497 typedef struct zskiplist
{
498 struct zskiplistNode
*header
, *tail
;
499 unsigned long length
;
503 typedef struct zset
{
508 /* Our shared "common" objects */
510 #define REDIS_SHARED_INTEGERS 10000
511 struct sharedObjectsStruct
{
512 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
513 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
514 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
515 *outofrangeerr
, *plus
,
516 *select0
, *select1
, *select2
, *select3
, *select4
,
517 *select5
, *select6
, *select7
, *select8
, *select9
,
518 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
519 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
520 *integers
[REDIS_SHARED_INTEGERS
];
523 /* Global vars that are actally used as constants. The following double
524 * values are used for double on-disk serialization, and are initialized
525 * at runtime to avoid strange compiler optimizations. */
527 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
529 /* VM threaded I/O request message */
530 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
531 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
532 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
533 typedef struct iojob
{
534 int type
; /* Request type, REDIS_IOJOB_* */
535 redisDb
*db
;/* Redis database */
536 robj
*key
; /* This I/O request is about swapping this key */
537 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
538 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
539 off_t page
; /* Swap page where to read/write the object */
540 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
541 int canceled
; /* True if this command was canceled by blocking side of VM */
542 pthread_t thread
; /* ID of the thread processing this entry */
545 /*================================ Prototypes =============================== */
547 static void freeStringObject(robj
*o
);
548 static void freeListObject(robj
*o
);
549 static void freeSetObject(robj
*o
);
550 static void decrRefCount(void *o
);
551 static robj
*createObject(int type
, void *ptr
);
552 static void freeClient(redisClient
*c
);
553 static int rdbLoad(char *filename
);
554 static void addReply(redisClient
*c
, robj
*obj
);
555 static void addReplySds(redisClient
*c
, sds s
);
556 static void incrRefCount(robj
*o
);
557 static int rdbSaveBackground(char *filename
);
558 static robj
*createStringObject(char *ptr
, size_t len
);
559 static robj
*dupStringObject(robj
*o
);
560 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
561 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
562 static void flushAppendOnlyFile(void);
563 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
564 static int syncWithMaster(void);
565 static robj
*tryObjectEncoding(robj
*o
);
566 static robj
*getDecodedObject(robj
*o
);
567 static int removeExpire(redisDb
*db
, robj
*key
);
568 static int expireIfNeeded(redisDb
*db
, robj
*key
);
569 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
570 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
571 static int deleteKey(redisDb
*db
, robj
*key
);
572 static time_t getExpire(redisDb
*db
, robj
*key
);
573 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
574 static void updateSlavesWaitingBgsave(int bgsaveerr
);
575 static void freeMemoryIfNeeded(void);
576 static int processCommand(redisClient
*c
);
577 static void setupSigSegvAction(void);
578 static void rdbRemoveTempFile(pid_t childpid
);
579 static void aofRemoveTempFile(pid_t childpid
);
580 static size_t stringObjectLen(robj
*o
);
581 static void processInputBuffer(redisClient
*c
);
582 static zskiplist
*zslCreate(void);
583 static void zslFree(zskiplist
*zsl
);
584 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
585 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
586 static void initClientMultiState(redisClient
*c
);
587 static void freeClientMultiState(redisClient
*c
);
588 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
589 static void unblockClientWaitingData(redisClient
*c
);
590 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
591 static void vmInit(void);
592 static void vmMarkPagesFree(off_t page
, off_t count
);
593 static robj
*vmLoadObject(robj
*key
);
594 static robj
*vmPreviewObject(robj
*key
);
595 static int vmSwapOneObjectBlocking(void);
596 static int vmSwapOneObjectThreaded(void);
597 static int vmCanSwapOut(void);
598 static int tryFreeOneObjectFromFreelist(void);
599 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
600 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
601 static void vmCancelThreadedIOJob(robj
*o
);
602 static void lockThreadedIO(void);
603 static void unlockThreadedIO(void);
604 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
605 static void freeIOJob(iojob
*j
);
606 static void queueIOJob(iojob
*j
);
607 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
608 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
609 static void waitEmptyIOJobsQueue(void);
610 static void vmReopenSwapFile(void);
611 static int vmFreePage(off_t page
);
612 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
613 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
614 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
615 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
616 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
617 static struct redisCommand
*lookupCommand(char *name
);
618 static void call(redisClient
*c
, struct redisCommand
*cmd
);
619 static void resetClient(redisClient
*c
);
620 static void convertToRealHash(robj
*o
);
621 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
622 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
623 static void freePubsubPattern(void *p
);
624 static int listMatchPubsubPattern(void *a
, void *b
);
625 static int compareStringObjects(robj
*a
, robj
*b
);
626 static int equalStringObjects(robj
*a
, robj
*b
);
628 static int rewriteAppendOnlyFileBackground(void);
629 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
631 static void authCommand(redisClient
*c
);
632 static void pingCommand(redisClient
*c
);
633 static void echoCommand(redisClient
*c
);
634 static void setCommand(redisClient
*c
);
635 static void setnxCommand(redisClient
*c
);
636 static void setexCommand(redisClient
*c
);
637 static void getCommand(redisClient
*c
);
638 static void delCommand(redisClient
*c
);
639 static void existsCommand(redisClient
*c
);
640 static void incrCommand(redisClient
*c
);
641 static void decrCommand(redisClient
*c
);
642 static void incrbyCommand(redisClient
*c
);
643 static void decrbyCommand(redisClient
*c
);
644 static void selectCommand(redisClient
*c
);
645 static void randomkeyCommand(redisClient
*c
);
646 static void keysCommand(redisClient
*c
);
647 static void dbsizeCommand(redisClient
*c
);
648 static void lastsaveCommand(redisClient
*c
);
649 static void saveCommand(redisClient
*c
);
650 static void bgsaveCommand(redisClient
*c
);
651 static void bgrewriteaofCommand(redisClient
*c
);
652 static void shutdownCommand(redisClient
*c
);
653 static void moveCommand(redisClient
*c
);
654 static void renameCommand(redisClient
*c
);
655 static void renamenxCommand(redisClient
*c
);
656 static void lpushCommand(redisClient
*c
);
657 static void rpushCommand(redisClient
*c
);
658 static void lpopCommand(redisClient
*c
);
659 static void rpopCommand(redisClient
*c
);
660 static void llenCommand(redisClient
*c
);
661 static void lindexCommand(redisClient
*c
);
662 static void lrangeCommand(redisClient
*c
);
663 static void ltrimCommand(redisClient
*c
);
664 static void typeCommand(redisClient
*c
);
665 static void lsetCommand(redisClient
*c
);
666 static void saddCommand(redisClient
*c
);
667 static void sremCommand(redisClient
*c
);
668 static void smoveCommand(redisClient
*c
);
669 static void sismemberCommand(redisClient
*c
);
670 static void scardCommand(redisClient
*c
);
671 static void spopCommand(redisClient
*c
);
672 static void srandmemberCommand(redisClient
*c
);
673 static void sinterCommand(redisClient
*c
);
674 static void sinterstoreCommand(redisClient
*c
);
675 static void sunionCommand(redisClient
*c
);
676 static void sunionstoreCommand(redisClient
*c
);
677 static void sdiffCommand(redisClient
*c
);
678 static void sdiffstoreCommand(redisClient
*c
);
679 static void syncCommand(redisClient
*c
);
680 static void flushdbCommand(redisClient
*c
);
681 static void flushallCommand(redisClient
*c
);
682 static void sortCommand(redisClient
*c
);
683 static void lremCommand(redisClient
*c
);
684 static void rpoplpushcommand(redisClient
*c
);
685 static void infoCommand(redisClient
*c
);
686 static void mgetCommand(redisClient
*c
);
687 static void monitorCommand(redisClient
*c
);
688 static void expireCommand(redisClient
*c
);
689 static void expireatCommand(redisClient
*c
);
690 static void getsetCommand(redisClient
*c
);
691 static void ttlCommand(redisClient
*c
);
692 static void slaveofCommand(redisClient
*c
);
693 static void debugCommand(redisClient
*c
);
694 static void msetCommand(redisClient
*c
);
695 static void msetnxCommand(redisClient
*c
);
696 static void zaddCommand(redisClient
*c
);
697 static void zincrbyCommand(redisClient
*c
);
698 static void zrangeCommand(redisClient
*c
);
699 static void zrangebyscoreCommand(redisClient
*c
);
700 static void zcountCommand(redisClient
*c
);
701 static void zrevrangeCommand(redisClient
*c
);
702 static void zcardCommand(redisClient
*c
);
703 static void zremCommand(redisClient
*c
);
704 static void zscoreCommand(redisClient
*c
);
705 static void zremrangebyscoreCommand(redisClient
*c
);
706 static void multiCommand(redisClient
*c
);
707 static void execCommand(redisClient
*c
);
708 static void discardCommand(redisClient
*c
);
709 static void blpopCommand(redisClient
*c
);
710 static void brpopCommand(redisClient
*c
);
711 static void appendCommand(redisClient
*c
);
712 static void substrCommand(redisClient
*c
);
713 static void zrankCommand(redisClient
*c
);
714 static void zrevrankCommand(redisClient
*c
);
715 static void hsetCommand(redisClient
*c
);
716 static void hsetnxCommand(redisClient
*c
);
717 static void hgetCommand(redisClient
*c
);
718 static void hmsetCommand(redisClient
*c
);
719 static void hmgetCommand(redisClient
*c
);
720 static void hdelCommand(redisClient
*c
);
721 static void hlenCommand(redisClient
*c
);
722 static void zremrangebyrankCommand(redisClient
*c
);
723 static void zunionCommand(redisClient
*c
);
724 static void zinterCommand(redisClient
*c
);
725 static void hkeysCommand(redisClient
*c
);
726 static void hvalsCommand(redisClient
*c
);
727 static void hgetallCommand(redisClient
*c
);
728 static void hexistsCommand(redisClient
*c
);
729 static void configCommand(redisClient
*c
);
730 static void hincrbyCommand(redisClient
*c
);
731 static void subscribeCommand(redisClient
*c
);
732 static void unsubscribeCommand(redisClient
*c
);
733 static void psubscribeCommand(redisClient
*c
);
734 static void punsubscribeCommand(redisClient
*c
);
735 static void publishCommand(redisClient
*c
);
737 /*================================= Globals ================================= */
740 static struct redisServer server
; /* server global state */
741 static struct redisCommand cmdTable
[] = {
742 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
743 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
744 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
745 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
746 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
747 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
749 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
751 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
752 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
753 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
754 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
755 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
762 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
764 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
765 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
766 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
767 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
768 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
769 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
770 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
771 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
772 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
774 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
775 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
776 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
777 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
778 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
779 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
780 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
781 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
782 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
783 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
784 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
785 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
786 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
787 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
792 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
793 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
794 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
795 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
796 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
797 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
798 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
802 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
805 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
807 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
808 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
809 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
810 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
811 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
812 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
815 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
816 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
817 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
824 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
830 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
832 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
837 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
840 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
842 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
843 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
846 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
847 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
848 {NULL
,NULL
,0,0,NULL
,0,0,0}
851 /*============================ Utility functions ============================ */
853 /* Glob-style pattern matching. */
854 static int stringmatchlen(const char *pattern
, int patternLen
,
855 const char *string
, int stringLen
, int nocase
)
860 while (pattern
[1] == '*') {
865 return 1; /* match */
867 if (stringmatchlen(pattern
+1, patternLen
-1,
868 string
, stringLen
, nocase
))
869 return 1; /* match */
873 return 0; /* no match */
877 return 0; /* no match */
887 not = pattern
[0] == '^';
894 if (pattern
[0] == '\\') {
897 if (pattern
[0] == string
[0])
899 } else if (pattern
[0] == ']') {
901 } else if (patternLen
== 0) {
905 } else if (pattern
[1] == '-' && patternLen
>= 3) {
906 int start
= pattern
[0];
907 int end
= pattern
[2];
915 start
= tolower(start
);
921 if (c
>= start
&& c
<= end
)
925 if (pattern
[0] == string
[0])
928 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
938 return 0; /* no match */
944 if (patternLen
>= 2) {
951 if (pattern
[0] != string
[0])
952 return 0; /* no match */
954 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
955 return 0; /* no match */
963 if (stringLen
== 0) {
964 while(*pattern
== '*') {
971 if (patternLen
== 0 && stringLen
== 0)
976 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
977 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
980 /* Convert a string representing an amount of memory into the number of
981 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
984 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
986 static long long memtoll(const char *p
, int *err
) {
989 long mul
; /* unit multiplier */
994 /* Search the first non digit character. */
997 while(*u
&& isdigit(*u
)) u
++;
998 if (*u
== '\0' || !strcasecmp(u
,"b")) {
1000 } else if (!strcasecmp(u
,"k")) {
1002 } else if (!strcasecmp(u
,"kb")) {
1004 } else if (!strcasecmp(u
,"m")) {
1006 } else if (!strcasecmp(u
,"mb")) {
1008 } else if (!strcasecmp(u
,"g")) {
1009 mul
= 1000L*1000*1000;
1010 } else if (!strcasecmp(u
,"gb")) {
1011 mul
= 1024L*1024*1024;
1017 if (digits
>= sizeof(buf
)) {
1021 memcpy(buf
,p
,digits
);
1023 val
= strtoll(buf
,NULL
,10);
1027 /* Convert a long long into a string. Returns the number of
1028 * characters needed to represent the number, that can be shorter if passed
1029 * buffer length is not enough to store the whole number. */
1030 static int ll2string(char *s
, size_t len
, long long value
) {
1032 unsigned long long v
;
1035 if (len
== 0) return 0;
1036 v
= (value
< 0) ? -value
: value
;
1037 p
= buf
+31; /* point to the last character */
1042 if (value
< 0) *p
-- = '-';
1045 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1051 static void redisLog(int level
, const char *fmt
, ...) {
1055 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1059 if (level
>= server
.verbosity
) {
1065 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1066 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1067 vfprintf(fp
, fmt
, ap
);
1073 if (server
.logfile
) fclose(fp
);
1076 /*====================== Hash table type implementation ==================== */
1078 /* This is an hash table type that uses the SDS dynamic strings libary as
1079 * keys and radis objects as values (objects can hold SDS strings,
1082 static void dictVanillaFree(void *privdata
, void *val
)
1084 DICT_NOTUSED(privdata
);
1088 static void dictListDestructor(void *privdata
, void *val
)
1090 DICT_NOTUSED(privdata
);
1091 listRelease((list
*)val
);
1094 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1098 DICT_NOTUSED(privdata
);
1100 l1
= sdslen((sds
)key1
);
1101 l2
= sdslen((sds
)key2
);
1102 if (l1
!= l2
) return 0;
1103 return memcmp(key1
, key2
, l1
) == 0;
1106 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1108 DICT_NOTUSED(privdata
);
1110 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1114 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1117 const robj
*o1
= key1
, *o2
= key2
;
1118 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1121 static unsigned int dictObjHash(const void *key
) {
1122 const robj
*o
= key
;
1123 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1126 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1129 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1132 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1133 o2
->encoding
== REDIS_ENCODING_INT
)
1134 return o1
->ptr
== o2
->ptr
;
1136 o1
= getDecodedObject(o1
);
1137 o2
= getDecodedObject(o2
);
1138 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1144 static unsigned int dictEncObjHash(const void *key
) {
1145 robj
*o
= (robj
*) key
;
1147 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1148 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1150 if (o
->encoding
== REDIS_ENCODING_INT
) {
1154 len
= ll2string(buf
,32,(long)o
->ptr
);
1155 return dictGenHashFunction((unsigned char*)buf
, len
);
1159 o
= getDecodedObject(o
);
1160 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1167 /* Sets type and expires */
1168 static dictType setDictType
= {
1169 dictEncObjHash
, /* hash function */
1172 dictEncObjKeyCompare
, /* key compare */
1173 dictRedisObjectDestructor
, /* key destructor */
1174 NULL
/* val destructor */
1177 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1178 static dictType zsetDictType
= {
1179 dictEncObjHash
, /* hash function */
1182 dictEncObjKeyCompare
, /* key compare */
1183 dictRedisObjectDestructor
, /* key destructor */
1184 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1188 static dictType dbDictType
= {
1189 dictObjHash
, /* hash function */
1192 dictObjKeyCompare
, /* key compare */
1193 dictRedisObjectDestructor
, /* key destructor */
1194 dictRedisObjectDestructor
/* val destructor */
1198 static dictType keyptrDictType
= {
1199 dictObjHash
, /* hash function */
1202 dictObjKeyCompare
, /* key compare */
1203 dictRedisObjectDestructor
, /* key destructor */
1204 NULL
/* val destructor */
1207 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1208 static dictType hashDictType
= {
1209 dictEncObjHash
, /* hash function */
1212 dictEncObjKeyCompare
, /* key compare */
1213 dictRedisObjectDestructor
, /* key destructor */
1214 dictRedisObjectDestructor
/* val destructor */
1217 /* Keylist hash table type has unencoded redis objects as keys and
1218 * lists as values. It's used for blocking operations (BLPOP) and to
1219 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1220 static dictType keylistDictType
= {
1221 dictObjHash
, /* hash function */
1224 dictObjKeyCompare
, /* key compare */
1225 dictRedisObjectDestructor
, /* key destructor */
1226 dictListDestructor
/* val destructor */
1229 static void version();
1231 /* ========================= Random utility functions ======================= */
1233 /* Redis generally does not try to recover from out of memory conditions
1234 * when allocating objects or strings, it is not clear if it will be possible
1235 * to report this condition to the client since the networking layer itself
1236 * is based on heap allocation for send buffers, so we simply abort.
1237 * At least the code will be simpler to read... */
1238 static void oom(const char *msg
) {
1239 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1244 /* ====================== Redis server networking stuff ===================== */
1245 static void closeTimedoutClients(void) {
1248 time_t now
= time(NULL
);
1251 listRewind(server
.clients
,&li
);
1252 while ((ln
= listNext(&li
)) != NULL
) {
1253 c
= listNodeValue(ln
);
1254 if (server
.maxidletime
&&
1255 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1256 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1257 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1258 listLength(c
->pubsub_patterns
) == 0 &&
1259 (now
- c
->lastinteraction
> server
.maxidletime
))
1261 redisLog(REDIS_VERBOSE
,"Closing idle client");
1263 } else if (c
->flags
& REDIS_BLOCKED
) {
1264 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1265 addReply(c
,shared
.nullmultibulk
);
1266 unblockClientWaitingData(c
);
1272 static int htNeedsResize(dict
*dict
) {
1273 long long size
, used
;
1275 size
= dictSlots(dict
);
1276 used
= dictSize(dict
);
1277 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1278 (used
*100/size
< REDIS_HT_MINFILL
));
1281 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1282 * we resize the hash table to save memory */
1283 static void tryResizeHashTables(void) {
1286 for (j
= 0; j
< server
.dbnum
; j
++) {
1287 if (htNeedsResize(server
.db
[j
].dict
))
1288 dictResize(server
.db
[j
].dict
);
1289 if (htNeedsResize(server
.db
[j
].expires
))
1290 dictResize(server
.db
[j
].expires
);
1294 /* Our hash table implementation performs rehashing incrementally while
1295 * we write/read from the hash table. Still if the server is idle, the hash
1296 * table will use two tables for a long time. So we try to use 1 millisecond
1297 * of CPU time at every serverCron() loop in order to rehash some key. */
1298 static void incrementallyRehash(void) {
1301 for (j
= 0; j
< server
.dbnum
; j
++) {
1302 if (dictIsRehashing(server
.db
[j
].dict
)) {
1303 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1304 break; /* already used our millisecond for this loop... */
1309 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1310 void backgroundSaveDoneHandler(int statloc
) {
1311 int exitcode
= WEXITSTATUS(statloc
);
1312 int bysignal
= WIFSIGNALED(statloc
);
1314 if (!bysignal
&& exitcode
== 0) {
1315 redisLog(REDIS_NOTICE
,
1316 "Background saving terminated with success");
1318 server
.lastsave
= time(NULL
);
1319 } else if (!bysignal
&& exitcode
!= 0) {
1320 redisLog(REDIS_WARNING
, "Background saving error");
1322 redisLog(REDIS_WARNING
,
1323 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1324 rdbRemoveTempFile(server
.bgsavechildpid
);
1326 server
.bgsavechildpid
= -1;
1327 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1328 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1329 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1332 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1334 void backgroundRewriteDoneHandler(int statloc
) {
1335 int exitcode
= WEXITSTATUS(statloc
);
1336 int bysignal
= WIFSIGNALED(statloc
);
1338 if (!bysignal
&& exitcode
== 0) {
1342 redisLog(REDIS_NOTICE
,
1343 "Background append only file rewriting terminated with success");
1344 /* Now it's time to flush the differences accumulated by the parent */
1345 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1346 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1348 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1351 /* Flush our data... */
1352 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1353 (signed) sdslen(server
.bgrewritebuf
)) {
1354 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
));
1358 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1359 /* Now our work is to rename the temp file into the stable file. And
1360 * switch the file descriptor used by the server for append only. */
1361 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1362 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1366 /* Mission completed... almost */
1367 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1368 if (server
.appendfd
!= -1) {
1369 /* If append only is actually enabled... */
1370 close(server
.appendfd
);
1371 server
.appendfd
= fd
;
1373 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1374 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1376 /* If append only is disabled we just generate a dump in this
1377 * format. Why not? */
1380 } else if (!bysignal
&& exitcode
!= 0) {
1381 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1383 redisLog(REDIS_WARNING
,
1384 "Background append only file rewriting terminated by signal %d",
1388 sdsfree(server
.bgrewritebuf
);
1389 server
.bgrewritebuf
= sdsempty();
1390 aofRemoveTempFile(server
.bgrewritechildpid
);
1391 server
.bgrewritechildpid
= -1;
1394 /* This function is called once a background process of some kind terminates,
1395 * as we want to avoid resizing the hash tables when there is a child in order
1396 * to play well with copy-on-write (otherwise when a resize happens lots of
1397 * memory pages are copied). The goal of this function is to update the ability
1398 * for dict.c to resize the hash tables accordingly to the fact we have o not
1399 * running childs. */
1400 static void updateDictResizePolicy(void) {
1401 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1404 dictDisableResize();
1407 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1408 int j
, loops
= server
.cronloops
++;
1409 REDIS_NOTUSED(eventLoop
);
1411 REDIS_NOTUSED(clientData
);
1413 /* We take a cached value of the unix time in the global state because
1414 * with virtual memory and aging there is to store the current time
1415 * in objects at every object access, and accuracy is not needed.
1416 * To access a global var is faster than calling time(NULL) */
1417 server
.unixtime
= time(NULL
);
1419 /* Show some info about non-empty databases */
1420 for (j
= 0; j
< server
.dbnum
; j
++) {
1421 long long size
, used
, vkeys
;
1423 size
= dictSlots(server
.db
[j
].dict
);
1424 used
= dictSize(server
.db
[j
].dict
);
1425 vkeys
= dictSize(server
.db
[j
].expires
);
1426 if (!(loops
% 50) && (used
|| vkeys
)) {
1427 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1428 /* dictPrintStats(server.dict); */
1432 /* We don't want to resize the hash tables while a bacground saving
1433 * is in progress: the saving child is created using fork() that is
1434 * implemented with a copy-on-write semantic in most modern systems, so
1435 * if we resize the HT while there is the saving child at work actually
1436 * a lot of memory movements in the parent will cause a lot of pages
1438 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1439 if (!(loops
% 10)) tryResizeHashTables();
1440 if (server
.activerehashing
) incrementallyRehash();
1443 /* Show information about connected clients */
1444 if (!(loops
% 50)) {
1445 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1446 listLength(server
.clients
)-listLength(server
.slaves
),
1447 listLength(server
.slaves
),
1448 zmalloc_used_memory());
1451 /* Close connections of timedout clients */
1452 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1453 closeTimedoutClients();
1455 /* Check if a background saving or AOF rewrite in progress terminated */
1456 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1460 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1461 if (pid
== server
.bgsavechildpid
) {
1462 backgroundSaveDoneHandler(statloc
);
1464 backgroundRewriteDoneHandler(statloc
);
1466 updateDictResizePolicy();
1469 /* If there is not a background saving in progress check if
1470 * we have to save now */
1471 time_t now
= time(NULL
);
1472 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1473 struct saveparam
*sp
= server
.saveparams
+j
;
1475 if (server
.dirty
>= sp
->changes
&&
1476 now
-server
.lastsave
> sp
->seconds
) {
1477 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1478 sp
->changes
, sp
->seconds
);
1479 rdbSaveBackground(server
.dbfilename
);
1485 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1486 * will use few CPU cycles if there are few expiring keys, otherwise
1487 * it will get more aggressive to avoid that too much memory is used by
1488 * keys that can be removed from the keyspace. */
1489 for (j
= 0; j
< server
.dbnum
; j
++) {
1491 redisDb
*db
= server
.db
+j
;
1493 /* Continue to expire if at the end of the cycle more than 25%
1494 * of the keys were expired. */
1496 long num
= dictSize(db
->expires
);
1497 time_t now
= time(NULL
);
1500 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1501 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1506 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1507 t
= (time_t) dictGetEntryVal(de
);
1509 deleteKey(db
,dictGetEntryKey(de
));
1511 server
.stat_expiredkeys
++;
1514 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1517 /* Swap a few keys on disk if we are over the memory limit and VM
1518 * is enbled. Try to free objects from the free list first. */
1519 if (vmCanSwapOut()) {
1520 while (server
.vm_enabled
&& zmalloc_used_memory() >
1521 server
.vm_max_memory
)
1525 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1526 retval
= (server
.vm_max_threads
== 0) ?
1527 vmSwapOneObjectBlocking() :
1528 vmSwapOneObjectThreaded();
1529 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1530 zmalloc_used_memory() >
1531 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1533 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1535 /* Note that when using threade I/O we free just one object,
1536 * because anyway when the I/O thread in charge to swap this
1537 * object out will finish, the handler of completed jobs
1538 * will try to swap more objects if we are still out of memory. */
1539 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1543 /* Check if we should connect to a MASTER */
1544 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1545 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1546 if (syncWithMaster() == REDIS_OK
) {
1547 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1548 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1554 /* This function gets called every time Redis is entering the
1555 * main loop of the event driven library, that is, before to sleep
1556 * for ready file descriptors. */
1557 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1558 REDIS_NOTUSED(eventLoop
);
1560 /* Awake clients that got all the swapped keys they requested */
1561 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1565 listRewind(server
.io_ready_clients
,&li
);
1566 while((ln
= listNext(&li
))) {
1567 redisClient
*c
= ln
->value
;
1568 struct redisCommand
*cmd
;
1570 /* Resume the client. */
1571 listDelNode(server
.io_ready_clients
,ln
);
1572 c
->flags
&= (~REDIS_IO_WAIT
);
1573 server
.vm_blocked_clients
--;
1574 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1575 readQueryFromClient
, c
);
1576 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1577 assert(cmd
!= NULL
);
1580 /* There may be more data to process in the input buffer. */
1581 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1582 processInputBuffer(c
);
1585 /* Write the AOF buffer on disk */
1586 flushAppendOnlyFile();
1589 static void createSharedObjects(void) {
1592 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1593 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1594 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1595 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1596 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1597 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1598 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1599 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1600 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1601 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1602 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1603 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1604 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1605 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1606 "-ERR no such key\r\n"));
1607 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1608 "-ERR syntax error\r\n"));
1609 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1610 "-ERR source and destination objects are the same\r\n"));
1611 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1612 "-ERR index out of range\r\n"));
1613 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1614 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1615 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1616 shared
.select0
= createStringObject("select 0\r\n",10);
1617 shared
.select1
= createStringObject("select 1\r\n",10);
1618 shared
.select2
= createStringObject("select 2\r\n",10);
1619 shared
.select3
= createStringObject("select 3\r\n",10);
1620 shared
.select4
= createStringObject("select 4\r\n",10);
1621 shared
.select5
= createStringObject("select 5\r\n",10);
1622 shared
.select6
= createStringObject("select 6\r\n",10);
1623 shared
.select7
= createStringObject("select 7\r\n",10);
1624 shared
.select8
= createStringObject("select 8\r\n",10);
1625 shared
.select9
= createStringObject("select 9\r\n",10);
1626 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1627 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1628 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1629 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1630 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1631 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1632 shared
.mbulk3
= createStringObject("*3\r\n",4);
1633 shared
.mbulk4
= createStringObject("*4\r\n",4);
1634 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1635 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1636 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1640 static void appendServerSaveParams(time_t seconds
, int changes
) {
1641 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1642 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1643 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1644 server
.saveparamslen
++;
1647 static void resetServerSaveParams() {
1648 zfree(server
.saveparams
);
1649 server
.saveparams
= NULL
;
1650 server
.saveparamslen
= 0;
1653 static void initServerConfig() {
1654 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1655 server
.port
= REDIS_SERVERPORT
;
1656 server
.verbosity
= REDIS_VERBOSE
;
1657 server
.maxidletime
= REDIS_MAXIDLETIME
;
1658 server
.saveparams
= NULL
;
1659 server
.logfile
= NULL
; /* NULL = log on standard output */
1660 server
.bindaddr
= NULL
;
1661 server
.glueoutputbuf
= 1;
1662 server
.daemonize
= 0;
1663 server
.appendonly
= 0;
1664 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1665 server
.lastfsync
= time(NULL
);
1666 server
.appendfd
= -1;
1667 server
.appendseldb
= -1; /* Make sure the first time will not match */
1668 server
.pidfile
= zstrdup("/var/run/redis.pid");
1669 server
.dbfilename
= zstrdup("dump.rdb");
1670 server
.appendfilename
= zstrdup("appendonly.aof");
1671 server
.requirepass
= NULL
;
1672 server
.rdbcompression
= 1;
1673 server
.activerehashing
= 1;
1674 server
.maxclients
= 0;
1675 server
.blpop_blocked_clients
= 0;
1676 server
.maxmemory
= 0;
1677 server
.vm_enabled
= 0;
1678 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1679 server
.vm_page_size
= 256; /* 256 bytes per page */
1680 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1681 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1682 server
.vm_max_threads
= 4;
1683 server
.vm_blocked_clients
= 0;
1684 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1685 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1687 resetServerSaveParams();
1689 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1690 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1691 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1692 /* Replication related */
1694 server
.masterauth
= NULL
;
1695 server
.masterhost
= NULL
;
1696 server
.masterport
= 6379;
1697 server
.master
= NULL
;
1698 server
.replstate
= REDIS_REPL_NONE
;
1700 /* Double constants initialization */
1702 R_PosInf
= 1.0/R_Zero
;
1703 R_NegInf
= -1.0/R_Zero
;
1704 R_Nan
= R_Zero
/R_Zero
;
1707 static void initServer() {
1710 signal(SIGHUP
, SIG_IGN
);
1711 signal(SIGPIPE
, SIG_IGN
);
1712 setupSigSegvAction();
1714 server
.devnull
= fopen("/dev/null","w");
1715 if (server
.devnull
== NULL
) {
1716 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1719 server
.clients
= listCreate();
1720 server
.slaves
= listCreate();
1721 server
.monitors
= listCreate();
1722 server
.objfreelist
= listCreate();
1723 createSharedObjects();
1724 server
.el
= aeCreateEventLoop();
1725 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1726 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1727 if (server
.fd
== -1) {
1728 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1731 for (j
= 0; j
< server
.dbnum
; j
++) {
1732 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1733 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1734 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1735 if (server
.vm_enabled
)
1736 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1737 server
.db
[j
].id
= j
;
1739 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1740 server
.pubsub_patterns
= listCreate();
1741 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1742 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1743 server
.cronloops
= 0;
1744 server
.bgsavechildpid
= -1;
1745 server
.bgrewritechildpid
= -1;
1746 server
.bgrewritebuf
= sdsempty();
1747 server
.aofbuf
= sdsempty();
1748 server
.lastsave
= time(NULL
);
1750 server
.stat_numcommands
= 0;
1751 server
.stat_numconnections
= 0;
1752 server
.stat_expiredkeys
= 0;
1753 server
.stat_starttime
= time(NULL
);
1754 server
.unixtime
= time(NULL
);
1755 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1756 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1757 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1759 if (server
.appendonly
) {
1760 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1761 if (server
.appendfd
== -1) {
1762 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1768 if (server
.vm_enabled
) vmInit();
1771 /* Empty the whole database */
1772 static long long emptyDb() {
1774 long long removed
= 0;
1776 for (j
= 0; j
< server
.dbnum
; j
++) {
1777 removed
+= dictSize(server
.db
[j
].dict
);
1778 dictEmpty(server
.db
[j
].dict
);
1779 dictEmpty(server
.db
[j
].expires
);
1784 static int yesnotoi(char *s
) {
1785 if (!strcasecmp(s
,"yes")) return 1;
1786 else if (!strcasecmp(s
,"no")) return 0;
1790 /* I agree, this is a very rudimental way to load a configuration...
1791 will improve later if the config gets more complex */
1792 static void loadServerConfig(char *filename
) {
1794 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1798 if (filename
[0] == '-' && filename
[1] == '\0')
1801 if ((fp
= fopen(filename
,"r")) == NULL
) {
1802 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1807 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1813 line
= sdstrim(line
," \t\r\n");
1815 /* Skip comments and blank lines*/
1816 if (line
[0] == '#' || line
[0] == '\0') {
1821 /* Split into arguments */
1822 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1823 sdstolower(argv
[0]);
1825 /* Execute config directives */
1826 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1827 server
.maxidletime
= atoi(argv
[1]);
1828 if (server
.maxidletime
< 0) {
1829 err
= "Invalid timeout value"; goto loaderr
;
1831 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1832 server
.port
= atoi(argv
[1]);
1833 if (server
.port
< 1 || server
.port
> 65535) {
1834 err
= "Invalid port"; goto loaderr
;
1836 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1837 server
.bindaddr
= zstrdup(argv
[1]);
1838 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1839 int seconds
= atoi(argv
[1]);
1840 int changes
= atoi(argv
[2]);
1841 if (seconds
< 1 || changes
< 0) {
1842 err
= "Invalid save parameters"; goto loaderr
;
1844 appendServerSaveParams(seconds
,changes
);
1845 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1846 if (chdir(argv
[1]) == -1) {
1847 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1848 argv
[1], strerror(errno
));
1851 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1852 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1853 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1854 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1855 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1857 err
= "Invalid log level. Must be one of debug, notice, warning";
1860 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1863 server
.logfile
= zstrdup(argv
[1]);
1864 if (!strcasecmp(server
.logfile
,"stdout")) {
1865 zfree(server
.logfile
);
1866 server
.logfile
= NULL
;
1868 if (server
.logfile
) {
1869 /* Test if we are able to open the file. The server will not
1870 * be able to abort just for this problem later... */
1871 logfp
= fopen(server
.logfile
,"a");
1872 if (logfp
== NULL
) {
1873 err
= sdscatprintf(sdsempty(),
1874 "Can't open the log file: %s", strerror(errno
));
1879 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1880 server
.dbnum
= atoi(argv
[1]);
1881 if (server
.dbnum
< 1) {
1882 err
= "Invalid number of databases"; goto loaderr
;
1884 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1885 loadServerConfig(argv
[1]);
1886 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1887 server
.maxclients
= atoi(argv
[1]);
1888 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1889 server
.maxmemory
= memtoll(argv
[1],NULL
);
1890 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1891 server
.masterhost
= sdsnew(argv
[1]);
1892 server
.masterport
= atoi(argv
[2]);
1893 server
.replstate
= REDIS_REPL_CONNECT
;
1894 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1895 server
.masterauth
= zstrdup(argv
[1]);
1896 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1897 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1898 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1900 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1901 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1902 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1904 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1905 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1906 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1908 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1909 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1910 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1912 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1913 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1914 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1916 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1917 if (!strcasecmp(argv
[1],"no")) {
1918 server
.appendfsync
= APPENDFSYNC_NO
;
1919 } else if (!strcasecmp(argv
[1],"always")) {
1920 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1921 } else if (!strcasecmp(argv
[1],"everysec")) {
1922 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1924 err
= "argument must be 'no', 'always' or 'everysec'";
1927 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1928 server
.requirepass
= zstrdup(argv
[1]);
1929 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1930 zfree(server
.pidfile
);
1931 server
.pidfile
= zstrdup(argv
[1]);
1932 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1933 zfree(server
.dbfilename
);
1934 server
.dbfilename
= zstrdup(argv
[1]);
1935 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1936 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1937 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1939 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1940 zfree(server
.vm_swap_file
);
1941 server
.vm_swap_file
= zstrdup(argv
[1]);
1942 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1943 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1944 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1945 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1946 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1947 server
.vm_pages
= memtoll(argv
[1], NULL
);
1948 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1949 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1950 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1951 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1952 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1953 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1955 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1957 for (j
= 0; j
< argc
; j
++)
1962 if (fp
!= stdin
) fclose(fp
);
1966 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1967 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1968 fprintf(stderr
, ">>> '%s'\n", line
);
1969 fprintf(stderr
, "%s\n", err
);
1973 static void freeClientArgv(redisClient
*c
) {
1976 for (j
= 0; j
< c
->argc
; j
++)
1977 decrRefCount(c
->argv
[j
]);
1978 for (j
= 0; j
< c
->mbargc
; j
++)
1979 decrRefCount(c
->mbargv
[j
]);
1984 static void freeClient(redisClient
*c
) {
1987 /* Note that if the client we are freeing is blocked into a blocking
1988 * call, we have to set querybuf to NULL *before* to call
1989 * unblockClientWaitingData() to avoid processInputBuffer() will get
1990 * called. Also it is important to remove the file events after
1991 * this, because this call adds the READABLE event. */
1992 sdsfree(c
->querybuf
);
1994 if (c
->flags
& REDIS_BLOCKED
)
1995 unblockClientWaitingData(c
);
1997 /* Unsubscribe from all the pubsub channels */
1998 pubsubUnsubscribeAllChannels(c
,0);
1999 pubsubUnsubscribeAllPatterns(c
,0);
2000 dictRelease(c
->pubsub_channels
);
2001 listRelease(c
->pubsub_patterns
);
2002 /* Obvious cleanup */
2003 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2004 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2005 listRelease(c
->reply
);
2008 /* Remove from the list of clients */
2009 ln
= listSearchKey(server
.clients
,c
);
2010 redisAssert(ln
!= NULL
);
2011 listDelNode(server
.clients
,ln
);
2012 /* Remove from the list of clients waiting for swapped keys */
2013 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2014 ln
= listSearchKey(server
.io_ready_clients
,c
);
2016 listDelNode(server
.io_ready_clients
,ln
);
2017 server
.vm_blocked_clients
--;
2020 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2021 ln
= listFirst(c
->io_keys
);
2022 dontWaitForSwappedKey(c
,ln
->value
);
2024 listRelease(c
->io_keys
);
2025 /* Master/slave cleanup */
2026 if (c
->flags
& REDIS_SLAVE
) {
2027 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2029 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2030 ln
= listSearchKey(l
,c
);
2031 redisAssert(ln
!= NULL
);
2034 if (c
->flags
& REDIS_MASTER
) {
2035 server
.master
= NULL
;
2036 server
.replstate
= REDIS_REPL_CONNECT
;
2038 /* Release memory */
2041 freeClientMultiState(c
);
2045 #define GLUEREPLY_UP_TO (1024)
2046 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2048 char buf
[GLUEREPLY_UP_TO
];
2053 listRewind(c
->reply
,&li
);
2054 while((ln
= listNext(&li
))) {
2058 objlen
= sdslen(o
->ptr
);
2059 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2060 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2062 listDelNode(c
->reply
,ln
);
2064 if (copylen
== 0) return;
2068 /* Now the output buffer is empty, add the new single element */
2069 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2070 listAddNodeHead(c
->reply
,o
);
2073 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2074 redisClient
*c
= privdata
;
2075 int nwritten
= 0, totwritten
= 0, objlen
;
2078 REDIS_NOTUSED(mask
);
2080 /* Use writev() if we have enough buffers to send */
2081 if (!server
.glueoutputbuf
&&
2082 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2083 !(c
->flags
& REDIS_MASTER
))
2085 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2089 while(listLength(c
->reply
)) {
2090 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2091 glueReplyBuffersIfNeeded(c
);
2093 o
= listNodeValue(listFirst(c
->reply
));
2094 objlen
= sdslen(o
->ptr
);
2097 listDelNode(c
->reply
,listFirst(c
->reply
));
2101 if (c
->flags
& REDIS_MASTER
) {
2102 /* Don't reply to a master */
2103 nwritten
= objlen
- c
->sentlen
;
2105 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2106 if (nwritten
<= 0) break;
2108 c
->sentlen
+= nwritten
;
2109 totwritten
+= nwritten
;
2110 /* If we fully sent the object on head go to the next one */
2111 if (c
->sentlen
== objlen
) {
2112 listDelNode(c
->reply
,listFirst(c
->reply
));
2115 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2116 * bytes, in a single threaded server it's a good idea to serve
2117 * other clients as well, even if a very large request comes from
2118 * super fast link that is always able to accept data (in real world
2119 * scenario think about 'KEYS *' against the loopback interfae) */
2120 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2122 if (nwritten
== -1) {
2123 if (errno
== EAGAIN
) {
2126 redisLog(REDIS_VERBOSE
,
2127 "Error writing to client: %s", strerror(errno
));
2132 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2133 if (listLength(c
->reply
) == 0) {
2135 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2139 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2141 redisClient
*c
= privdata
;
2142 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2144 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2145 int offset
, ion
= 0;
2147 REDIS_NOTUSED(mask
);
2150 while (listLength(c
->reply
)) {
2151 offset
= c
->sentlen
;
2155 /* fill-in the iov[] array */
2156 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2157 o
= listNodeValue(node
);
2158 objlen
= sdslen(o
->ptr
);
2160 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2163 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2164 break; /* no more iovecs */
2166 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2167 iov
[ion
].iov_len
= objlen
- offset
;
2168 willwrite
+= objlen
- offset
;
2169 offset
= 0; /* just for the first item */
2176 /* write all collected blocks at once */
2177 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2178 if (errno
!= EAGAIN
) {
2179 redisLog(REDIS_VERBOSE
,
2180 "Error writing to client: %s", strerror(errno
));
2187 totwritten
+= nwritten
;
2188 offset
= c
->sentlen
;
2190 /* remove written robjs from c->reply */
2191 while (nwritten
&& listLength(c
->reply
)) {
2192 o
= listNodeValue(listFirst(c
->reply
));
2193 objlen
= sdslen(o
->ptr
);
2195 if(nwritten
>= objlen
- offset
) {
2196 listDelNode(c
->reply
, listFirst(c
->reply
));
2197 nwritten
-= objlen
- offset
;
2201 c
->sentlen
+= nwritten
;
2209 c
->lastinteraction
= time(NULL
);
2211 if (listLength(c
->reply
) == 0) {
2213 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2217 static struct redisCommand
*lookupCommand(char *name
) {
2219 while(cmdTable
[j
].name
!= NULL
) {
2220 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2226 /* resetClient prepare the client to process the next command */
2227 static void resetClient(redisClient
*c
) {
2233 /* Call() is the core of Redis execution of a command */
2234 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2237 dirty
= server
.dirty
;
2239 dirty
= server
.dirty
-dirty
;
2241 if (server
.appendonly
&& dirty
)
2242 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2243 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2244 listLength(server
.slaves
))
2245 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2246 if (listLength(server
.monitors
))
2247 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2248 server
.stat_numcommands
++;
2251 /* If this function gets called we already read a whole
2252 * command, argments are in the client argv/argc fields.
2253 * processCommand() execute the command or prepare the
2254 * server for a bulk read from the client.
2256 * If 1 is returned the client is still alive and valid and
2257 * and other operations can be performed by the caller. Otherwise
2258 * if 0 is returned the client was destroied (i.e. after QUIT). */
2259 static int processCommand(redisClient
*c
) {
2260 struct redisCommand
*cmd
;
2262 /* Free some memory if needed (maxmemory setting) */
2263 if (server
.maxmemory
) freeMemoryIfNeeded();
2265 /* Handle the multi bulk command type. This is an alternative protocol
2266 * supported by Redis in order to receive commands that are composed of
2267 * multiple binary-safe "bulk" arguments. The latency of processing is
2268 * a bit higher but this allows things like multi-sets, so if this
2269 * protocol is used only for MSET and similar commands this is a big win. */
2270 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2271 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2272 if (c
->multibulk
<= 0) {
2276 decrRefCount(c
->argv
[c
->argc
-1]);
2280 } else if (c
->multibulk
) {
2281 if (c
->bulklen
== -1) {
2282 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2283 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2287 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2288 decrRefCount(c
->argv
[0]);
2289 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2291 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2296 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2300 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2301 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2305 if (c
->multibulk
== 0) {
2309 /* Here we need to swap the multi-bulk argc/argv with the
2310 * normal argc/argv of the client structure. */
2312 c
->argv
= c
->mbargv
;
2313 c
->mbargv
= auxargv
;
2316 c
->argc
= c
->mbargc
;
2317 c
->mbargc
= auxargc
;
2319 /* We need to set bulklen to something different than -1
2320 * in order for the code below to process the command without
2321 * to try to read the last argument of a bulk command as
2322 * a special argument. */
2324 /* continue below and process the command */
2331 /* -- end of multi bulk commands processing -- */
2333 /* The QUIT command is handled as a special case. Normal command
2334 * procs are unable to close the client connection safely */
2335 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2340 /* Now lookup the command and check ASAP about trivial error conditions
2341 * such wrong arity, bad command name and so forth. */
2342 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2345 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2346 (char*)c
->argv
[0]->ptr
));
2349 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2350 (c
->argc
< -cmd
->arity
)) {
2352 sdscatprintf(sdsempty(),
2353 "-ERR wrong number of arguments for '%s' command\r\n",
2357 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2358 /* This is a bulk command, we have to read the last argument yet. */
2359 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2361 decrRefCount(c
->argv
[c
->argc
-1]);
2362 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2364 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2369 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2370 /* It is possible that the bulk read is already in the
2371 * buffer. Check this condition and handle it accordingly.
2372 * This is just a fast path, alternative to call processInputBuffer().
2373 * It's a good idea since the code is small and this condition
2374 * happens most of the times. */
2375 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2376 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2378 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2380 /* Otherwise return... there is to read the last argument
2381 * from the socket. */
2385 /* Let's try to encode the bulk object to save space. */
2386 if (cmd
->flags
& REDIS_CMD_BULK
)
2387 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2389 /* Check if the user is authenticated */
2390 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2391 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2396 /* Handle the maxmemory directive */
2397 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2398 zmalloc_used_memory() > server
.maxmemory
)
2400 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2405 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2406 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2408 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2409 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2410 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2415 /* Exec the command */
2416 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2417 queueMultiCommand(c
,cmd
);
2418 addReply(c
,shared
.queued
);
2420 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2421 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2425 /* Prepare the client for the next command */
2430 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2435 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2436 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2437 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2438 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2441 if (argc
<= REDIS_STATIC_ARGS
) {
2444 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2447 lenobj
= createObject(REDIS_STRING
,
2448 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2449 lenobj
->refcount
= 0;
2450 outv
[outc
++] = lenobj
;
2451 for (j
= 0; j
< argc
; j
++) {
2452 lenobj
= createObject(REDIS_STRING
,
2453 sdscatprintf(sdsempty(),"$%lu\r\n",
2454 (unsigned long) stringObjectLen(argv
[j
])));
2455 lenobj
->refcount
= 0;
2456 outv
[outc
++] = lenobj
;
2457 outv
[outc
++] = argv
[j
];
2458 outv
[outc
++] = shared
.crlf
;
2461 /* Increment all the refcounts at start and decrement at end in order to
2462 * be sure to free objects if there is no slave in a replication state
2463 * able to be feed with commands */
2464 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2465 listRewind(slaves
,&li
);
2466 while((ln
= listNext(&li
))) {
2467 redisClient
*slave
= ln
->value
;
2469 /* Don't feed slaves that are still waiting for BGSAVE to start */
2470 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2472 /* Feed all the other slaves, MONITORs and so on */
2473 if (slave
->slaveseldb
!= dictid
) {
2477 case 0: selectcmd
= shared
.select0
; break;
2478 case 1: selectcmd
= shared
.select1
; break;
2479 case 2: selectcmd
= shared
.select2
; break;
2480 case 3: selectcmd
= shared
.select3
; break;
2481 case 4: selectcmd
= shared
.select4
; break;
2482 case 5: selectcmd
= shared
.select5
; break;
2483 case 6: selectcmd
= shared
.select6
; break;
2484 case 7: selectcmd
= shared
.select7
; break;
2485 case 8: selectcmd
= shared
.select8
; break;
2486 case 9: selectcmd
= shared
.select9
; break;
2488 selectcmd
= createObject(REDIS_STRING
,
2489 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2490 selectcmd
->refcount
= 0;
2493 addReply(slave
,selectcmd
);
2494 slave
->slaveseldb
= dictid
;
2496 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2498 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2499 if (outv
!= static_outv
) zfree(outv
);
2502 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2503 s
= sdscatlen(s
,"\"",1);
2508 s
= sdscatprintf(s
,"\\%c",*p
);
2510 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2511 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2512 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2513 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2514 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2517 s
= sdscatprintf(s
,"%c",*p
);
2519 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2524 return sdscatlen(s
,"\"",1);
2527 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2531 sds cmdrepr
= sdsnew("+");
2535 gettimeofday(&tv
,NULL
);
2536 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2537 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2539 for (j
= 0; j
< argc
; j
++) {
2540 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2541 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2543 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2544 sdslen(argv
[j
]->ptr
));
2547 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2549 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2550 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2552 listRewind(monitors
,&li
);
2553 while((ln
= listNext(&li
))) {
2554 redisClient
*monitor
= ln
->value
;
2555 addReply(monitor
,cmdobj
);
2557 decrRefCount(cmdobj
);
2560 static void processInputBuffer(redisClient
*c
) {
2562 /* Before to process the input buffer, make sure the client is not
2563 * waitig for a blocking operation such as BLPOP. Note that the first
2564 * iteration the client is never blocked, otherwise the processInputBuffer
2565 * would not be called at all, but after the execution of the first commands
2566 * in the input buffer the client may be blocked, and the "goto again"
2567 * will try to reiterate. The following line will make it return asap. */
2568 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2569 if (c
->bulklen
== -1) {
2570 /* Read the first line of the query */
2571 char *p
= strchr(c
->querybuf
,'\n');
2578 query
= c
->querybuf
;
2579 c
->querybuf
= sdsempty();
2580 querylen
= 1+(p
-(query
));
2581 if (sdslen(query
) > querylen
) {
2582 /* leave data after the first line of the query in the buffer */
2583 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2585 *p
= '\0'; /* remove "\n" */
2586 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2587 sdsupdatelen(query
);
2589 /* Now we can split the query in arguments */
2590 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2593 if (c
->argv
) zfree(c
->argv
);
2594 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2596 for (j
= 0; j
< argc
; j
++) {
2597 if (sdslen(argv
[j
])) {
2598 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2606 /* Execute the command. If the client is still valid
2607 * after processCommand() return and there is something
2608 * on the query buffer try to process the next command. */
2609 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2611 /* Nothing to process, argc == 0. Just process the query
2612 * buffer if it's not empty or return to the caller */
2613 if (sdslen(c
->querybuf
)) goto again
;
2616 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2617 redisLog(REDIS_VERBOSE
, "Client protocol error");
2622 /* Bulk read handling. Note that if we are at this point
2623 the client already sent a command terminated with a newline,
2624 we are reading the bulk data that is actually the last
2625 argument of the command. */
2626 int qbl
= sdslen(c
->querybuf
);
2628 if (c
->bulklen
<= qbl
) {
2629 /* Copy everything but the final CRLF as final argument */
2630 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2632 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2633 /* Process the command. If the client is still valid after
2634 * the processing and there is more data in the buffer
2635 * try to parse it. */
2636 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2642 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2643 redisClient
*c
= (redisClient
*) privdata
;
2644 char buf
[REDIS_IOBUF_LEN
];
2647 REDIS_NOTUSED(mask
);
2649 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2651 if (errno
== EAGAIN
) {
2654 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2658 } else if (nread
== 0) {
2659 redisLog(REDIS_VERBOSE
, "Client closed connection");
2664 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2665 c
->lastinteraction
= time(NULL
);
2669 processInputBuffer(c
);
2672 static int selectDb(redisClient
*c
, int id
) {
2673 if (id
< 0 || id
>= server
.dbnum
)
2675 c
->db
= &server
.db
[id
];
2679 static void *dupClientReplyValue(void *o
) {
2680 incrRefCount((robj
*)o
);
2684 static int listMatchObjects(void *a
, void *b
) {
2685 return equalStringObjects(a
,b
);
2688 static redisClient
*createClient(int fd
) {
2689 redisClient
*c
= zmalloc(sizeof(*c
));
2691 anetNonBlock(NULL
,fd
);
2692 anetTcpNoDelay(NULL
,fd
);
2693 if (!c
) return NULL
;
2696 c
->querybuf
= sdsempty();
2705 c
->lastinteraction
= time(NULL
);
2706 c
->authenticated
= 0;
2707 c
->replstate
= REDIS_REPL_NONE
;
2708 c
->reply
= listCreate();
2709 listSetFreeMethod(c
->reply
,decrRefCount
);
2710 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2711 c
->blockingkeys
= NULL
;
2712 c
->blockingkeysnum
= 0;
2713 c
->io_keys
= listCreate();
2714 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2715 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2716 c
->pubsub_patterns
= listCreate();
2717 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2718 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2719 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2720 readQueryFromClient
, c
) == AE_ERR
) {
2724 listAddNodeTail(server
.clients
,c
);
2725 initClientMultiState(c
);
2729 static void addReply(redisClient
*c
, robj
*obj
) {
2730 if (listLength(c
->reply
) == 0 &&
2731 (c
->replstate
== REDIS_REPL_NONE
||
2732 c
->replstate
== REDIS_REPL_ONLINE
) &&
2733 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2734 sendReplyToClient
, c
) == AE_ERR
) return;
2736 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2737 obj
= dupStringObject(obj
);
2738 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2740 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2743 static void addReplySds(redisClient
*c
, sds s
) {
2744 robj
*o
= createObject(REDIS_STRING
,s
);
2749 static void addReplyDouble(redisClient
*c
, double d
) {
2752 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2753 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2754 (unsigned long) strlen(buf
),buf
));
2757 static void addReplyLong(redisClient
*c
, long l
) {
2762 addReply(c
,shared
.czero
);
2764 } else if (l
== 1) {
2765 addReply(c
,shared
.cone
);
2768 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2769 addReplySds(c
,sdsnewlen(buf
,len
));
2772 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2777 addReply(c
,shared
.czero
);
2779 } else if (ll
== 1) {
2780 addReply(c
,shared
.cone
);
2783 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2784 addReplySds(c
,sdsnewlen(buf
,len
));
2787 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2792 addReply(c
,shared
.czero
);
2794 } else if (ul
== 1) {
2795 addReply(c
,shared
.cone
);
2798 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2799 addReplySds(c
,sdsnewlen(buf
,len
));
2802 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2805 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2806 len
= sdslen(obj
->ptr
);
2808 long n
= (long)obj
->ptr
;
2810 /* Compute how many bytes will take this integer as a radix 10 string */
2816 while((n
= n
/10) != 0) {
2820 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2823 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2824 addReplyBulkLen(c
,obj
);
2826 addReply(c
,shared
.crlf
);
2829 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2830 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2832 addReply(c
,shared
.nullbulk
);
2834 robj
*o
= createStringObject(s
,strlen(s
));
2840 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2845 REDIS_NOTUSED(mask
);
2846 REDIS_NOTUSED(privdata
);
2848 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2849 if (cfd
== AE_ERR
) {
2850 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2853 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2854 if ((c
= createClient(cfd
)) == NULL
) {
2855 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2856 close(cfd
); /* May be already closed, just ingore errors */
2859 /* If maxclient directive is set and this is one client more... close the
2860 * connection. Note that we create the client instead to check before
2861 * for this condition, since now the socket is already set in nonblocking
2862 * mode and we can send an error for free using the Kernel I/O */
2863 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2864 char *err
= "-ERR max number of clients reached\r\n";
2866 /* That's a best effort error message, don't check write errors */
2867 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2868 /* Nothing to do, Just to avoid the warning... */
2873 server
.stat_numconnections
++;
2876 /* ======================= Redis objects implementation ===================== */
2878 static robj
*createObject(int type
, void *ptr
) {
2881 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2882 if (listLength(server
.objfreelist
)) {
2883 listNode
*head
= listFirst(server
.objfreelist
);
2884 o
= listNodeValue(head
);
2885 listDelNode(server
.objfreelist
,head
);
2886 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2888 if (server
.vm_enabled
) {
2889 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2890 o
= zmalloc(sizeof(*o
));
2892 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2896 o
->encoding
= REDIS_ENCODING_RAW
;
2899 if (server
.vm_enabled
) {
2900 /* Note that this code may run in the context of an I/O thread
2901 * and accessing to server.unixtime in theory is an error
2902 * (no locks). But in practice this is safe, and even if we read
2903 * garbage Redis will not fail, as it's just a statistical info */
2904 o
->vm
.atime
= server
.unixtime
;
2905 o
->storage
= REDIS_VM_MEMORY
;
2910 static robj
*createStringObject(char *ptr
, size_t len
) {
2911 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2914 static robj
*createStringObjectFromLongLong(long long value
) {
2916 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2917 incrRefCount(shared
.integers
[value
]);
2918 o
= shared
.integers
[value
];
2920 o
= createObject(REDIS_STRING
, NULL
);
2921 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2922 o
->encoding
= REDIS_ENCODING_INT
;
2923 o
->ptr
= (void*)((long)value
);
2925 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
2931 static robj
*dupStringObject(robj
*o
) {
2932 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2933 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2936 static robj
*createListObject(void) {
2937 list
*l
= listCreate();
2939 listSetFreeMethod(l
,decrRefCount
);
2940 return createObject(REDIS_LIST
,l
);
2943 static robj
*createSetObject(void) {
2944 dict
*d
= dictCreate(&setDictType
,NULL
);
2945 return createObject(REDIS_SET
,d
);
2948 static robj
*createHashObject(void) {
2949 /* All the Hashes start as zipmaps. Will be automatically converted
2950 * into hash tables if there are enough elements or big elements
2952 unsigned char *zm
= zipmapNew();
2953 robj
*o
= createObject(REDIS_HASH
,zm
);
2954 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2958 static robj
*createZsetObject(void) {
2959 zset
*zs
= zmalloc(sizeof(*zs
));
2961 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2962 zs
->zsl
= zslCreate();
2963 return createObject(REDIS_ZSET
,zs
);
2966 static void freeStringObject(robj
*o
) {
2967 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2972 static void freeListObject(robj
*o
) {
2973 listRelease((list
*) o
->ptr
);
2976 static void freeSetObject(robj
*o
) {
2977 dictRelease((dict
*) o
->ptr
);
2980 static void freeZsetObject(robj
*o
) {
2983 dictRelease(zs
->dict
);
2988 static void freeHashObject(robj
*o
) {
2989 switch (o
->encoding
) {
2990 case REDIS_ENCODING_HT
:
2991 dictRelease((dict
*) o
->ptr
);
2993 case REDIS_ENCODING_ZIPMAP
:
2997 redisPanic("Unknown hash encoding type");
3002 static void incrRefCount(robj
*o
) {
3006 static void decrRefCount(void *obj
) {
3009 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3010 /* Object is a key of a swapped out value, or in the process of being
3012 if (server
.vm_enabled
&&
3013 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3015 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3016 redisAssert(o
->type
== REDIS_STRING
);
3017 freeStringObject(o
);
3018 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3019 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3020 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3021 !listAddNodeHead(server
.objfreelist
,o
))
3023 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3024 server
.vm_stats_swapped_objects
--;
3027 /* Object is in memory, or in the process of being swapped out. */
3028 if (--(o
->refcount
) == 0) {
3029 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3030 vmCancelThreadedIOJob(obj
);
3032 case REDIS_STRING
: freeStringObject(o
); break;
3033 case REDIS_LIST
: freeListObject(o
); break;
3034 case REDIS_SET
: freeSetObject(o
); break;
3035 case REDIS_ZSET
: freeZsetObject(o
); break;
3036 case REDIS_HASH
: freeHashObject(o
); break;
3037 default: redisPanic("Unknown object type"); break;
3039 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3040 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3041 !listAddNodeHead(server
.objfreelist
,o
))
3043 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3047 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3048 dictEntry
*de
= dictFind(db
->dict
,key
);
3050 robj
*key
= dictGetEntryKey(de
);
3051 robj
*val
= dictGetEntryVal(de
);
3053 if (server
.vm_enabled
) {
3054 if (key
->storage
== REDIS_VM_MEMORY
||
3055 key
->storage
== REDIS_VM_SWAPPING
)
3057 /* If we were swapping the object out, stop it, this key
3059 if (key
->storage
== REDIS_VM_SWAPPING
)
3060 vmCancelThreadedIOJob(key
);
3061 /* Update the access time of the key for the aging algorithm. */
3062 key
->vm
.atime
= server
.unixtime
;
3064 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3066 /* Our value was swapped on disk. Bring it at home. */
3067 redisAssert(val
== NULL
);
3068 val
= vmLoadObject(key
);
3069 dictGetEntryVal(de
) = val
;
3071 /* Clients blocked by the VM subsystem may be waiting for
3073 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3082 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3083 expireIfNeeded(db
,key
);
3084 return lookupKey(db
,key
);
3087 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3088 deleteIfVolatile(db
,key
);
3089 return lookupKey(db
,key
);
3092 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3093 robj
*o
= lookupKeyRead(c
->db
, key
);
3094 if (!o
) addReply(c
,reply
);
3098 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3099 robj
*o
= lookupKeyWrite(c
->db
, key
);
3100 if (!o
) addReply(c
,reply
);
3104 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3105 if (o
->type
!= type
) {
3106 addReply(c
,shared
.wrongtypeerr
);
3112 static int deleteKey(redisDb
*db
, robj
*key
) {
3115 /* We need to protect key from destruction: after the first dictDelete()
3116 * it may happen that 'key' is no longer valid if we don't increment
3117 * it's count. This may happen when we get the object reference directly
3118 * from the hash table with dictRandomKey() or dict iterators */
3120 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3121 retval
= dictDelete(db
->dict
,key
);
3124 return retval
== DICT_OK
;
3127 /* Check if the nul-terminated string 's' can be represented by a long
3128 * (that is, is a number that fits into long without any other space or
3129 * character before or after the digits).
3131 * If so, the function returns REDIS_OK and *longval is set to the value
3132 * of the number. Otherwise REDIS_ERR is returned */
3133 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3134 char buf
[32], *endptr
;
3138 value
= strtol(s
, &endptr
, 10);
3139 if (endptr
[0] != '\0') return REDIS_ERR
;
3140 slen
= ll2string(buf
,32,value
);
3142 /* If the number converted back into a string is not identical
3143 * then it's not possible to encode the string as integer */
3144 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3145 if (longval
) *longval
= value
;
3149 /* Try to encode a string object in order to save space */
3150 static robj
*tryObjectEncoding(robj
*o
) {
3154 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3155 return o
; /* Already encoded */
3157 /* It's not safe to encode shared objects: shared objects can be shared
3158 * everywhere in the "object space" of Redis. Encoded objects can only
3159 * appear as "values" (and not, for instance, as keys) */
3160 if (o
->refcount
> 1) return o
;
3162 /* Currently we try to encode only strings */
3163 redisAssert(o
->type
== REDIS_STRING
);
3165 /* Check if we can represent this string as a long integer */
3166 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3168 /* Ok, this object can be encoded */
3169 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3171 incrRefCount(shared
.integers
[value
]);
3172 return shared
.integers
[value
];
3174 o
->encoding
= REDIS_ENCODING_INT
;
3176 o
->ptr
= (void*) value
;
3181 /* Get a decoded version of an encoded object (returned as a new object).
3182 * If the object is already raw-encoded just increment the ref count. */
3183 static robj
*getDecodedObject(robj
*o
) {
3186 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3190 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3193 ll2string(buf
,32,(long)o
->ptr
);
3194 dec
= createStringObject(buf
,strlen(buf
));
3197 redisPanic("Unknown encoding type");
3201 /* Compare two string objects via strcmp() or alike.
3202 * Note that the objects may be integer-encoded. In such a case we
3203 * use ll2string() to get a string representation of the numbers on the stack
3204 * and compare the strings, it's much faster than calling getDecodedObject().
3206 * Important note: if objects are not integer encoded, but binary-safe strings,
3207 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3209 static int compareStringObjects(robj
*a
, robj
*b
) {
3210 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3211 char bufa
[128], bufb
[128], *astr
, *bstr
;
3214 if (a
== b
) return 0;
3215 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3216 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3222 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3223 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3229 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3232 /* Equal string objects return 1 if the two objects are the same from the
3233 * point of view of a string comparison, otherwise 0 is returned. Note that
3234 * this function is faster then checking for (compareStringObject(a,b) == 0)
3235 * because it can perform some more optimization. */
3236 static int equalStringObjects(robj
*a
, robj
*b
) {
3237 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3238 return a
->ptr
== b
->ptr
;
3240 return compareStringObjects(a
,b
) == 0;
3244 static size_t stringObjectLen(robj
*o
) {
3245 redisAssert(o
->type
== REDIS_STRING
);
3246 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3247 return sdslen(o
->ptr
);
3251 return ll2string(buf
,32,(long)o
->ptr
);
3255 static int getDoubleFromObject(robj
*o
, double *target
) {
3262 redisAssert(o
->type
== REDIS_STRING
);
3263 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3264 value
= strtod(o
->ptr
, &eptr
);
3265 if (eptr
[0] != '\0') return REDIS_ERR
;
3266 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3267 value
= (long)o
->ptr
;
3269 redisPanic("Unknown string encoding");
3277 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3279 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3281 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3283 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3292 static int getLongLongFromObject(robj
*o
, long long *target
) {
3299 redisAssert(o
->type
== REDIS_STRING
);
3300 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3301 value
= strtoll(o
->ptr
, &eptr
, 10);
3302 if (eptr
[0] != '\0') return REDIS_ERR
;
3303 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3304 value
= (long)o
->ptr
;
3306 redisPanic("Unknown string encoding");
3314 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3316 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3318 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3320 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3329 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3332 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3333 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3335 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3337 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3346 /*============================ RDB saving/loading =========================== */
3348 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3349 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3353 static int rdbSaveTime(FILE *fp
, time_t t
) {
3354 int32_t t32
= (int32_t) t
;
3355 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3359 /* check rdbLoadLen() comments for more info */
3360 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3361 unsigned char buf
[2];
3364 /* Save a 6 bit len */
3365 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3366 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3367 } else if (len
< (1<<14)) {
3368 /* Save a 14 bit len */
3369 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3371 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3373 /* Save a 32 bit len */
3374 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3375 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3377 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3382 /* String objects in the form "2391" "-100" without any space and with a
3383 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3384 * encoded as integers to save space */
3385 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3387 char *endptr
, buf
[32];
3389 /* Check if it's possible to encode this value as a number */
3390 value
= strtoll(s
, &endptr
, 10);
3391 if (endptr
[0] != '\0') return 0;
3392 ll2string(buf
,32,value
);
3394 /* If the number converted back into a string is not identical
3395 * then it's not possible to encode the string as integer */
3396 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3398 /* Finally check if it fits in our ranges */
3399 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3400 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3401 enc
[1] = value
&0xFF;
3403 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3404 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3405 enc
[1] = value
&0xFF;
3406 enc
[2] = (value
>>8)&0xFF;
3408 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3409 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3410 enc
[1] = value
&0xFF;
3411 enc
[2] = (value
>>8)&0xFF;
3412 enc
[3] = (value
>>16)&0xFF;
3413 enc
[4] = (value
>>24)&0xFF;
3420 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3421 size_t comprlen
, outlen
;
3425 /* We require at least four bytes compression for this to be worth it */
3426 if (len
<= 4) return 0;
3428 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3429 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3430 if (comprlen
== 0) {
3434 /* Data compressed! Let's save it on disk */
3435 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3436 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3437 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3438 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3439 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3448 /* Save a string objet as [len][data] on disk. If the object is a string
3449 * representation of an integer value we try to safe it in a special form */
3450 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3453 /* Try integer encoding */
3455 unsigned char buf
[5];
3456 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3457 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3462 /* Try LZF compression - under 20 bytes it's unable to compress even
3463 * aaaaaaaaaaaaaaaaaa so skip it */
3464 if (server
.rdbcompression
&& len
> 20) {
3467 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3468 if (retval
== -1) return -1;
3469 if (retval
> 0) return 0;
3470 /* retval == 0 means data can't be compressed, save the old way */
3473 /* Store verbatim */
3474 if (rdbSaveLen(fp
,len
) == -1) return -1;
3475 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3479 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3480 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3483 /* Avoid incr/decr ref count business when possible.
3484 * This plays well with copy-on-write given that we are probably
3485 * in a child process (BGSAVE). Also this makes sure key objects
3486 * of swapped objects are not incRefCount-ed (an assert does not allow
3487 * this in order to avoid bugs) */
3488 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3489 obj
= getDecodedObject(obj
);
3490 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3493 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3498 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3499 * 8 bit integer specifing the length of the representation.
3500 * This 8 bit integer has special values in order to specify the following
3506 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3507 unsigned char buf
[128];
3513 } else if (!isfinite(val
)) {
3515 buf
[0] = (val
< 0) ? 255 : 254;
3517 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3518 /* Check if the float is in a safe range to be casted into a
3519 * long long. We are assuming that long long is 64 bit here.
3520 * Also we are assuming that there are no implementations around where
3521 * double has precision < 52 bit.
3523 * Under this assumptions we test if a double is inside an interval
3524 * where casting to long long is safe. Then using two castings we
3525 * make sure the decimal part is zero. If all this is true we use
3526 * integer printing function that is much faster. */
3527 double min
= -4503599627370495; /* (2^52)-1 */
3528 double max
= 4503599627370496; /* -(2^52) */
3529 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3530 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3533 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3534 buf
[0] = strlen((char*)buf
+1);
3537 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3541 /* Save a Redis object. */
3542 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3543 if (o
->type
== REDIS_STRING
) {
3544 /* Save a string value */
3545 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3546 } else if (o
->type
== REDIS_LIST
) {
3547 /* Save a list value */
3548 list
*list
= o
->ptr
;
3552 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3553 listRewind(list
,&li
);
3554 while((ln
= listNext(&li
))) {
3555 robj
*eleobj
= listNodeValue(ln
);
3557 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3559 } else if (o
->type
== REDIS_SET
) {
3560 /* Save a set value */
3562 dictIterator
*di
= dictGetIterator(set
);
3565 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3566 while((de
= dictNext(di
)) != NULL
) {
3567 robj
*eleobj
= dictGetEntryKey(de
);
3569 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3571 dictReleaseIterator(di
);
3572 } else if (o
->type
== REDIS_ZSET
) {
3573 /* Save a set value */
3575 dictIterator
*di
= dictGetIterator(zs
->dict
);
3578 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3579 while((de
= dictNext(di
)) != NULL
) {
3580 robj
*eleobj
= dictGetEntryKey(de
);
3581 double *score
= dictGetEntryVal(de
);
3583 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3584 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3586 dictReleaseIterator(di
);
3587 } else if (o
->type
== REDIS_HASH
) {
3588 /* Save a hash value */
3589 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3590 unsigned char *p
= zipmapRewind(o
->ptr
);
3591 unsigned int count
= zipmapLen(o
->ptr
);
3592 unsigned char *key
, *val
;
3593 unsigned int klen
, vlen
;
3595 if (rdbSaveLen(fp
,count
) == -1) return -1;
3596 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3597 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3598 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3601 dictIterator
*di
= dictGetIterator(o
->ptr
);
3604 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3605 while((de
= dictNext(di
)) != NULL
) {
3606 robj
*key
= dictGetEntryKey(de
);
3607 robj
*val
= dictGetEntryVal(de
);
3609 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3610 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3612 dictReleaseIterator(di
);
3615 redisPanic("Unknown object type");
3620 /* Return the length the object will have on disk if saved with
3621 * the rdbSaveObject() function. Currently we use a trick to get
3622 * this length with very little changes to the code. In the future
3623 * we could switch to a faster solution. */
3624 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3625 if (fp
== NULL
) fp
= server
.devnull
;
3627 assert(rdbSaveObject(fp
,o
) != 1);
3631 /* Return the number of pages required to save this object in the swap file */
3632 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3633 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3635 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3638 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3639 static int rdbSave(char *filename
) {
3640 dictIterator
*di
= NULL
;
3645 time_t now
= time(NULL
);
3647 /* Wait for I/O therads to terminate, just in case this is a
3648 * foreground-saving, to avoid seeking the swap file descriptor at the
3650 if (server
.vm_enabled
)
3651 waitEmptyIOJobsQueue();
3653 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3654 fp
= fopen(tmpfile
,"w");
3656 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3659 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3660 for (j
= 0; j
< server
.dbnum
; j
++) {
3661 redisDb
*db
= server
.db
+j
;
3663 if (dictSize(d
) == 0) continue;
3664 di
= dictGetIterator(d
);
3670 /* Write the SELECT DB opcode */
3671 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3672 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3674 /* Iterate this DB writing every entry */
3675 while((de
= dictNext(di
)) != NULL
) {
3676 robj
*key
= dictGetEntryKey(de
);
3677 robj
*o
= dictGetEntryVal(de
);
3678 time_t expiretime
= getExpire(db
,key
);
3680 /* Save the expire time */
3681 if (expiretime
!= -1) {
3682 /* If this key is already expired skip it */
3683 if (expiretime
< now
) continue;
3684 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3685 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3687 /* Save the key and associated value. This requires special
3688 * handling if the value is swapped out. */
3689 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3690 key
->storage
== REDIS_VM_SWAPPING
) {
3691 /* Save type, key, value */
3692 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3693 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3694 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3696 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3698 /* Get a preview of the object in memory */
3699 po
= vmPreviewObject(key
);
3700 /* Save type, key, value */
3701 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3702 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3703 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3704 /* Remove the loaded object from memory */
3708 dictReleaseIterator(di
);
3711 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3713 /* Make sure data will not remain on the OS's output buffers */
3718 /* Use RENAME to make sure the DB file is changed atomically only
3719 * if the generate DB file is ok. */
3720 if (rename(tmpfile
,filename
) == -1) {
3721 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3725 redisLog(REDIS_NOTICE
,"DB saved on disk");
3727 server
.lastsave
= time(NULL
);
3733 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3734 if (di
) dictReleaseIterator(di
);
3738 static int rdbSaveBackground(char *filename
) {
3741 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3742 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3743 if ((childpid
= fork()) == 0) {
3745 if (server
.vm_enabled
) vmReopenSwapFile();
3747 if (rdbSave(filename
) == REDIS_OK
) {
3754 if (childpid
== -1) {
3755 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3759 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3760 server
.bgsavechildpid
= childpid
;
3761 updateDictResizePolicy();
3764 return REDIS_OK
; /* unreached */
3767 static void rdbRemoveTempFile(pid_t childpid
) {
3770 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3774 static int rdbLoadType(FILE *fp
) {
3776 if (fread(&type
,1,1,fp
) == 0) return -1;
3780 static time_t rdbLoadTime(FILE *fp
) {
3782 if (fread(&t32
,4,1,fp
) == 0) return -1;
3783 return (time_t) t32
;
3786 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3787 * of this file for a description of how this are stored on disk.
3789 * isencoded is set to 1 if the readed length is not actually a length but
3790 * an "encoding type", check the above comments for more info */
3791 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3792 unsigned char buf
[2];
3796 if (isencoded
) *isencoded
= 0;
3797 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3798 type
= (buf
[0]&0xC0)>>6;
3799 if (type
== REDIS_RDB_6BITLEN
) {
3800 /* Read a 6 bit len */
3802 } else if (type
== REDIS_RDB_ENCVAL
) {
3803 /* Read a 6 bit len encoding type */
3804 if (isencoded
) *isencoded
= 1;
3806 } else if (type
== REDIS_RDB_14BITLEN
) {
3807 /* Read a 14 bit len */
3808 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3809 return ((buf
[0]&0x3F)<<8)|buf
[1];
3811 /* Read a 32 bit len */
3812 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3817 /* Load an integer-encoded object from file 'fp', with the specified
3818 * encoding type 'enctype'. If encode is true the function may return
3819 * an integer-encoded object as reply, otherwise the returned object
3820 * will always be encoded as a raw string. */
3821 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3822 unsigned char enc
[4];
3825 if (enctype
== REDIS_RDB_ENC_INT8
) {
3826 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3827 val
= (signed char)enc
[0];
3828 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3830 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3831 v
= enc
[0]|(enc
[1]<<8);
3833 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3835 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3836 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3839 val
= 0; /* anti-warning */
3840 redisPanic("Unknown RDB integer encoding type");
3843 return createStringObjectFromLongLong(val
);
3845 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3848 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3849 unsigned int len
, clen
;
3850 unsigned char *c
= NULL
;
3853 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3854 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3855 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3856 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3857 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3858 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3860 return createObject(REDIS_STRING
,val
);
3867 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3872 len
= rdbLoadLen(fp
,&isencoded
);
3875 case REDIS_RDB_ENC_INT8
:
3876 case REDIS_RDB_ENC_INT16
:
3877 case REDIS_RDB_ENC_INT32
:
3878 return rdbLoadIntegerObject(fp
,len
,encode
);
3879 case REDIS_RDB_ENC_LZF
:
3880 return rdbLoadLzfStringObject(fp
);
3882 redisPanic("Unknown RDB encoding type");
3886 if (len
== REDIS_RDB_LENERR
) return NULL
;
3887 val
= sdsnewlen(NULL
,len
);
3888 if (len
&& fread(val
,len
,1,fp
) == 0) {
3892 return createObject(REDIS_STRING
,val
);
3895 static robj
*rdbLoadStringObject(FILE *fp
) {
3896 return rdbGenericLoadStringObject(fp
,0);
3899 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3900 return rdbGenericLoadStringObject(fp
,1);
3903 /* For information about double serialization check rdbSaveDoubleValue() */
3904 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3908 if (fread(&len
,1,1,fp
) == 0) return -1;
3910 case 255: *val
= R_NegInf
; return 0;
3911 case 254: *val
= R_PosInf
; return 0;
3912 case 253: *val
= R_Nan
; return 0;
3914 if (fread(buf
,len
,1,fp
) == 0) return -1;
3916 sscanf(buf
, "%lg", val
);
3921 /* Load a Redis object of the specified type from the specified file.
3922 * On success a newly allocated object is returned, otherwise NULL. */
3923 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3926 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3927 if (type
== REDIS_STRING
) {
3928 /* Read string value */
3929 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3930 o
= tryObjectEncoding(o
);
3931 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3932 /* Read list/set value */
3935 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3936 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3937 /* It's faster to expand the dict to the right size asap in order
3938 * to avoid rehashing */
3939 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3940 dictExpand(o
->ptr
,listlen
);
3941 /* Load every single element of the list/set */
3945 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3946 ele
= tryObjectEncoding(ele
);
3947 if (type
== REDIS_LIST
) {
3948 listAddNodeTail((list
*)o
->ptr
,ele
);
3950 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3953 } else if (type
== REDIS_ZSET
) {
3954 /* Read list/set value */
3958 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3959 o
= createZsetObject();
3961 /* Load every single element of the list/set */
3964 double *score
= zmalloc(sizeof(double));
3966 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3967 ele
= tryObjectEncoding(ele
);
3968 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3969 dictAdd(zs
->dict
,ele
,score
);
3970 zslInsert(zs
->zsl
,*score
,ele
);
3971 incrRefCount(ele
); /* added to skiplist */
3973 } else if (type
== REDIS_HASH
) {
3976 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3977 o
= createHashObject();
3978 /* Too many entries? Use an hash table. */
3979 if (hashlen
> server
.hash_max_zipmap_entries
)
3980 convertToRealHash(o
);
3981 /* Load every key/value, then set it into the zipmap or hash
3982 * table, as needed. */
3986 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3987 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3988 /* If we are using a zipmap and there are too big values
3989 * the object is converted to real hash table encoding. */
3990 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3991 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3992 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3994 convertToRealHash(o
);
3997 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3998 unsigned char *zm
= o
->ptr
;
4000 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4001 val
->ptr
,sdslen(val
->ptr
),NULL
);
4006 key
= tryObjectEncoding(key
);
4007 val
= tryObjectEncoding(val
);
4008 dictAdd((dict
*)o
->ptr
,key
,val
);
4012 redisPanic("Unknown object type");
4017 static int rdbLoad(char *filename
) {
4020 int type
, retval
, rdbver
;
4021 int swap_all_values
= 0;
4022 dict
*d
= server
.db
[0].dict
;
4023 redisDb
*db
= server
.db
+0;
4025 time_t expiretime
, now
= time(NULL
);
4026 long long loadedkeys
= 0;
4028 fp
= fopen(filename
,"r");
4029 if (!fp
) return REDIS_ERR
;
4030 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4032 if (memcmp(buf
,"REDIS",5) != 0) {
4034 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4037 rdbver
= atoi(buf
+5);
4040 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4048 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4049 if (type
== REDIS_EXPIRETIME
) {
4050 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4051 /* We read the time so we need to read the object type again */
4052 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4054 if (type
== REDIS_EOF
) break;
4055 /* Handle SELECT DB opcode as a special case */
4056 if (type
== REDIS_SELECTDB
) {
4057 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4059 if (dbid
>= (unsigned)server
.dbnum
) {
4060 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4063 db
= server
.db
+dbid
;
4068 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4070 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4071 /* Check if the key already expired */
4072 if (expiretime
!= -1 && expiretime
< now
) {
4077 /* Add the new object in the hash table */
4078 retval
= dictAdd(d
,key
,val
);
4079 if (retval
== DICT_ERR
) {
4080 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4084 /* Set the expire time if needed */
4085 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4087 /* Handle swapping while loading big datasets when VM is on */
4089 /* If we detecter we are hopeless about fitting something in memory
4090 * we just swap every new key on disk. Directly...
4091 * Note that's important to check for this condition before resorting
4092 * to random sampling, otherwise we may try to swap already
4094 if (swap_all_values
) {
4095 dictEntry
*de
= dictFind(d
,key
);
4097 /* de may be NULL since the key already expired */
4099 key
= dictGetEntryKey(de
);
4100 val
= dictGetEntryVal(de
);
4102 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4103 dictGetEntryVal(de
) = NULL
;
4109 /* If we have still some hope of having some value fitting memory
4110 * then we try random sampling. */
4111 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4112 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4113 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4115 if (zmalloc_used_memory() > server
.vm_max_memory
)
4116 swap_all_values
= 1; /* We are already using too much mem */
4122 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4123 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4125 return REDIS_ERR
; /* Just to avoid warning */
4128 /*================================== Commands =============================== */
4130 static void authCommand(redisClient
*c
) {
4131 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4132 c
->authenticated
= 1;
4133 addReply(c
,shared
.ok
);
4135 c
->authenticated
= 0;
4136 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4140 static void pingCommand(redisClient
*c
) {
4141 addReply(c
,shared
.pong
);
4144 static void echoCommand(redisClient
*c
) {
4145 addReplyBulk(c
,c
->argv
[1]);
4148 /*=================================== Strings =============================== */
4150 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4152 long seconds
= 0; /* initialized to avoid an harmness warning */
4155 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4158 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4163 if (nx
) deleteIfVolatile(c
->db
,key
);
4164 retval
= dictAdd(c
->db
->dict
,key
,val
);
4165 if (retval
== DICT_ERR
) {
4167 /* If the key is about a swapped value, we want a new key object
4168 * to overwrite the old. So we delete the old key in the database.
4169 * This will also make sure that swap pages about the old object
4170 * will be marked as free. */
4171 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4173 dictReplace(c
->db
->dict
,key
,val
);
4176 addReply(c
,shared
.czero
);
4184 removeExpire(c
->db
,key
);
4185 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4186 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4189 static void setCommand(redisClient
*c
) {
4190 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4193 static void setnxCommand(redisClient
*c
) {
4194 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4197 static void setexCommand(redisClient
*c
) {
4198 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4201 static int getGenericCommand(redisClient
*c
) {
4204 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4207 if (o
->type
!= REDIS_STRING
) {
4208 addReply(c
,shared
.wrongtypeerr
);
4216 static void getCommand(redisClient
*c
) {
4217 getGenericCommand(c
);
4220 static void getsetCommand(redisClient
*c
) {
4221 if (getGenericCommand(c
) == REDIS_ERR
) return;
4222 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4223 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4225 incrRefCount(c
->argv
[1]);
4227 incrRefCount(c
->argv
[2]);
4229 removeExpire(c
->db
,c
->argv
[1]);
4232 static void mgetCommand(redisClient
*c
) {
4235 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4236 for (j
= 1; j
< c
->argc
; j
++) {
4237 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4239 addReply(c
,shared
.nullbulk
);
4241 if (o
->type
!= REDIS_STRING
) {
4242 addReply(c
,shared
.nullbulk
);
4250 static void msetGenericCommand(redisClient
*c
, int nx
) {
4251 int j
, busykeys
= 0;
4253 if ((c
->argc
% 2) == 0) {
4254 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4257 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4258 * set nothing at all if at least one already key exists. */
4260 for (j
= 1; j
< c
->argc
; j
+= 2) {
4261 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4267 addReply(c
, shared
.czero
);
4271 for (j
= 1; j
< c
->argc
; j
+= 2) {
4274 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4275 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4276 if (retval
== DICT_ERR
) {
4277 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4278 incrRefCount(c
->argv
[j
+1]);
4280 incrRefCount(c
->argv
[j
]);
4281 incrRefCount(c
->argv
[j
+1]);
4283 removeExpire(c
->db
,c
->argv
[j
]);
4285 server
.dirty
+= (c
->argc
-1)/2;
4286 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4289 static void msetCommand(redisClient
*c
) {
4290 msetGenericCommand(c
,0);
4293 static void msetnxCommand(redisClient
*c
) {
4294 msetGenericCommand(c
,1);
4297 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4302 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4303 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4304 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4307 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4308 o
= tryObjectEncoding(o
);
4309 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4310 if (retval
== DICT_ERR
) {
4311 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4312 removeExpire(c
->db
,c
->argv
[1]);
4314 incrRefCount(c
->argv
[1]);
4317 addReply(c
,shared
.colon
);
4319 addReply(c
,shared
.crlf
);
4322 static void incrCommand(redisClient
*c
) {
4323 incrDecrCommand(c
,1);
4326 static void decrCommand(redisClient
*c
) {
4327 incrDecrCommand(c
,-1);
4330 static void incrbyCommand(redisClient
*c
) {
4333 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4334 incrDecrCommand(c
,incr
);
4337 static void decrbyCommand(redisClient
*c
) {
4340 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4341 incrDecrCommand(c
,-incr
);
4344 static void appendCommand(redisClient
*c
) {
4349 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4351 /* Create the key */
4352 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4353 incrRefCount(c
->argv
[1]);
4354 incrRefCount(c
->argv
[2]);
4355 totlen
= stringObjectLen(c
->argv
[2]);
4359 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4362 o
= dictGetEntryVal(de
);
4363 if (o
->type
!= REDIS_STRING
) {
4364 addReply(c
,shared
.wrongtypeerr
);
4367 /* If the object is specially encoded or shared we have to make
4369 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4370 robj
*decoded
= getDecodedObject(o
);
4372 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4373 decrRefCount(decoded
);
4374 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4377 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4378 o
->ptr
= sdscatlen(o
->ptr
,
4379 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4381 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4382 (unsigned long) c
->argv
[2]->ptr
);
4384 totlen
= sdslen(o
->ptr
);
4387 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4390 static void substrCommand(redisClient
*c
) {
4392 long start
= atoi(c
->argv
[2]->ptr
);
4393 long end
= atoi(c
->argv
[3]->ptr
);
4394 size_t rangelen
, strlen
;
4397 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4398 checkType(c
,o
,REDIS_STRING
)) return;
4400 o
= getDecodedObject(o
);
4401 strlen
= sdslen(o
->ptr
);
4403 /* convert negative indexes */
4404 if (start
< 0) start
= strlen
+start
;
4405 if (end
< 0) end
= strlen
+end
;
4406 if (start
< 0) start
= 0;
4407 if (end
< 0) end
= 0;
4409 /* indexes sanity checks */
4410 if (start
> end
|| (size_t)start
>= strlen
) {
4411 /* Out of range start or start > end result in null reply */
4412 addReply(c
,shared
.nullbulk
);
4416 if ((size_t)end
>= strlen
) end
= strlen
-1;
4417 rangelen
= (end
-start
)+1;
4419 /* Return the result */
4420 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4421 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4422 addReplySds(c
,range
);
4423 addReply(c
,shared
.crlf
);
4427 /* ========================= Type agnostic commands ========================= */
4429 static void delCommand(redisClient
*c
) {
4432 for (j
= 1; j
< c
->argc
; j
++) {
4433 if (deleteKey(c
->db
,c
->argv
[j
])) {
4438 addReplyLong(c
,deleted
);
4441 static void existsCommand(redisClient
*c
) {
4442 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4445 static void selectCommand(redisClient
*c
) {
4446 int id
= atoi(c
->argv
[1]->ptr
);
4448 if (selectDb(c
,id
) == REDIS_ERR
) {
4449 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4451 addReply(c
,shared
.ok
);
4455 static void randomkeyCommand(redisClient
*c
) {
4460 de
= dictGetRandomKey(c
->db
->dict
);
4461 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4465 addReply(c
,shared
.nullbulk
);
4469 key
= dictGetEntryKey(de
);
4470 if (server
.vm_enabled
) {
4471 key
= dupStringObject(key
);
4472 addReplyBulk(c
,key
);
4475 addReplyBulk(c
,key
);
4479 static void keysCommand(redisClient
*c
) {
4482 sds pattern
= c
->argv
[1]->ptr
;
4483 int plen
= sdslen(pattern
);
4484 unsigned long numkeys
= 0;
4485 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4487 di
= dictGetIterator(c
->db
->dict
);
4489 decrRefCount(lenobj
);
4490 while((de
= dictNext(di
)) != NULL
) {
4491 robj
*keyobj
= dictGetEntryKey(de
);
4493 sds key
= keyobj
->ptr
;
4494 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4495 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4496 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4497 addReplyBulk(c
,keyobj
);
4502 dictReleaseIterator(di
);
4503 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4506 static void dbsizeCommand(redisClient
*c
) {
4508 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4511 static void lastsaveCommand(redisClient
*c
) {
4513 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4516 static void typeCommand(redisClient
*c
) {
4520 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4525 case REDIS_STRING
: type
= "+string"; break;
4526 case REDIS_LIST
: type
= "+list"; break;
4527 case REDIS_SET
: type
= "+set"; break;
4528 case REDIS_ZSET
: type
= "+zset"; break;
4529 case REDIS_HASH
: type
= "+hash"; break;
4530 default: type
= "+unknown"; break;
4533 addReplySds(c
,sdsnew(type
));
4534 addReply(c
,shared
.crlf
);
4537 static void saveCommand(redisClient
*c
) {
4538 if (server
.bgsavechildpid
!= -1) {
4539 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4542 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4543 addReply(c
,shared
.ok
);
4545 addReply(c
,shared
.err
);
4549 static void bgsaveCommand(redisClient
*c
) {
4550 if (server
.bgsavechildpid
!= -1) {
4551 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4554 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4555 char *status
= "+Background saving started\r\n";
4556 addReplySds(c
,sdsnew(status
));
4558 addReply(c
,shared
.err
);
4562 static void shutdownCommand(redisClient
*c
) {
4563 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4564 /* Kill the saving child if there is a background saving in progress.
4565 We want to avoid race conditions, for instance our saving child may
4566 overwrite the synchronous saving did by SHUTDOWN. */
4567 if (server
.bgsavechildpid
!= -1) {
4568 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4569 kill(server
.bgsavechildpid
,SIGKILL
);
4570 rdbRemoveTempFile(server
.bgsavechildpid
);
4572 if (server
.appendonly
) {
4573 /* Append only file: fsync() the AOF and exit */
4574 fsync(server
.appendfd
);
4575 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4578 /* Snapshotting. Perform a SYNC SAVE and exit */
4579 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4580 if (server
.daemonize
)
4581 unlink(server
.pidfile
);
4582 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4583 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4586 /* Ooops.. error saving! The best we can do is to continue
4587 * operating. Note that if there was a background saving process,
4588 * in the next cron() Redis will be notified that the background
4589 * saving aborted, handling special stuff like slaves pending for
4590 * synchronization... */
4591 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4593 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4598 static void renameGenericCommand(redisClient
*c
, int nx
) {
4601 /* To use the same key as src and dst is probably an error */
4602 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4603 addReply(c
,shared
.sameobjecterr
);
4607 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4611 deleteIfVolatile(c
->db
,c
->argv
[2]);
4612 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4615 addReply(c
,shared
.czero
);
4618 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4620 incrRefCount(c
->argv
[2]);
4622 deleteKey(c
->db
,c
->argv
[1]);
4624 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4627 static void renameCommand(redisClient
*c
) {
4628 renameGenericCommand(c
,0);
4631 static void renamenxCommand(redisClient
*c
) {
4632 renameGenericCommand(c
,1);
4635 static void moveCommand(redisClient
*c
) {
4640 /* Obtain source and target DB pointers */
4643 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4644 addReply(c
,shared
.outofrangeerr
);
4648 selectDb(c
,srcid
); /* Back to the source DB */
4650 /* If the user is moving using as target the same
4651 * DB as the source DB it is probably an error. */
4653 addReply(c
,shared
.sameobjecterr
);
4657 /* Check if the element exists and get a reference */
4658 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4660 addReply(c
,shared
.czero
);
4664 /* Try to add the element to the target DB */
4665 deleteIfVolatile(dst
,c
->argv
[1]);
4666 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4667 addReply(c
,shared
.czero
);
4670 incrRefCount(c
->argv
[1]);
4673 /* OK! key moved, free the entry in the source DB */
4674 deleteKey(src
,c
->argv
[1]);
4676 addReply(c
,shared
.cone
);
4679 /* =================================== Lists ================================ */
4680 static void pushGenericCommand(redisClient
*c
, int where
) {
4684 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4686 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4687 addReply(c
,shared
.cone
);
4690 lobj
= createListObject();
4692 if (where
== REDIS_HEAD
) {
4693 listAddNodeHead(list
,c
->argv
[2]);
4695 listAddNodeTail(list
,c
->argv
[2]);
4697 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4698 incrRefCount(c
->argv
[1]);
4699 incrRefCount(c
->argv
[2]);
4701 if (lobj
->type
!= REDIS_LIST
) {
4702 addReply(c
,shared
.wrongtypeerr
);
4705 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4706 addReply(c
,shared
.cone
);
4710 if (where
== REDIS_HEAD
) {
4711 listAddNodeHead(list
,c
->argv
[2]);
4713 listAddNodeTail(list
,c
->argv
[2]);
4715 incrRefCount(c
->argv
[2]);
4718 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4721 static void lpushCommand(redisClient
*c
) {
4722 pushGenericCommand(c
,REDIS_HEAD
);
4725 static void rpushCommand(redisClient
*c
) {
4726 pushGenericCommand(c
,REDIS_TAIL
);
4729 static void llenCommand(redisClient
*c
) {
4733 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4734 checkType(c
,o
,REDIS_LIST
)) return;
4737 addReplyUlong(c
,listLength(l
));
4740 static void lindexCommand(redisClient
*c
) {
4742 int index
= atoi(c
->argv
[2]->ptr
);
4746 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4747 checkType(c
,o
,REDIS_LIST
)) return;
4750 ln
= listIndex(list
, index
);
4752 addReply(c
,shared
.nullbulk
);
4754 robj
*ele
= listNodeValue(ln
);
4755 addReplyBulk(c
,ele
);
4759 static void lsetCommand(redisClient
*c
) {
4761 int index
= atoi(c
->argv
[2]->ptr
);
4765 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4766 checkType(c
,o
,REDIS_LIST
)) return;
4769 ln
= listIndex(list
, index
);
4771 addReply(c
,shared
.outofrangeerr
);
4773 robj
*ele
= listNodeValue(ln
);
4776 listNodeValue(ln
) = c
->argv
[3];
4777 incrRefCount(c
->argv
[3]);
4778 addReply(c
,shared
.ok
);
4783 static void popGenericCommand(redisClient
*c
, int where
) {
4788 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4789 checkType(c
,o
,REDIS_LIST
)) return;
4792 if (where
== REDIS_HEAD
)
4793 ln
= listFirst(list
);
4795 ln
= listLast(list
);
4798 addReply(c
,shared
.nullbulk
);
4800 robj
*ele
= listNodeValue(ln
);
4801 addReplyBulk(c
,ele
);
4802 listDelNode(list
,ln
);
4803 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4808 static void lpopCommand(redisClient
*c
) {
4809 popGenericCommand(c
,REDIS_HEAD
);
4812 static void rpopCommand(redisClient
*c
) {
4813 popGenericCommand(c
,REDIS_TAIL
);
4816 static void lrangeCommand(redisClient
*c
) {
4818 int start
= atoi(c
->argv
[2]->ptr
);
4819 int end
= atoi(c
->argv
[3]->ptr
);
4826 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4827 || checkType(c
,o
,REDIS_LIST
)) return;
4829 llen
= listLength(list
);
4831 /* convert negative indexes */
4832 if (start
< 0) start
= llen
+start
;
4833 if (end
< 0) end
= llen
+end
;
4834 if (start
< 0) start
= 0;
4835 if (end
< 0) end
= 0;
4837 /* indexes sanity checks */
4838 if (start
> end
|| start
>= llen
) {
4839 /* Out of range start or start > end result in empty list */
4840 addReply(c
,shared
.emptymultibulk
);
4843 if (end
>= llen
) end
= llen
-1;
4844 rangelen
= (end
-start
)+1;
4846 /* Return the result in form of a multi-bulk reply */
4847 ln
= listIndex(list
, start
);
4848 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4849 for (j
= 0; j
< rangelen
; j
++) {
4850 ele
= listNodeValue(ln
);
4851 addReplyBulk(c
,ele
);
4856 static void ltrimCommand(redisClient
*c
) {
4858 int start
= atoi(c
->argv
[2]->ptr
);
4859 int end
= atoi(c
->argv
[3]->ptr
);
4861 int j
, ltrim
, rtrim
;
4865 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4866 checkType(c
,o
,REDIS_LIST
)) return;
4868 llen
= listLength(list
);
4870 /* convert negative indexes */
4871 if (start
< 0) start
= llen
+start
;
4872 if (end
< 0) end
= llen
+end
;
4873 if (start
< 0) start
= 0;
4874 if (end
< 0) end
= 0;
4876 /* indexes sanity checks */
4877 if (start
> end
|| start
>= llen
) {
4878 /* Out of range start or start > end result in empty list */
4882 if (end
>= llen
) end
= llen
-1;
4887 /* Remove list elements to perform the trim */
4888 for (j
= 0; j
< ltrim
; j
++) {
4889 ln
= listFirst(list
);
4890 listDelNode(list
,ln
);
4892 for (j
= 0; j
< rtrim
; j
++) {
4893 ln
= listLast(list
);
4894 listDelNode(list
,ln
);
4896 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4898 addReply(c
,shared
.ok
);
4901 static void lremCommand(redisClient
*c
) {
4904 listNode
*ln
, *next
;
4905 int toremove
= atoi(c
->argv
[2]->ptr
);
4909 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4910 checkType(c
,o
,REDIS_LIST
)) return;
4914 toremove
= -toremove
;
4917 ln
= fromtail
? list
->tail
: list
->head
;
4919 robj
*ele
= listNodeValue(ln
);
4921 next
= fromtail
? ln
->prev
: ln
->next
;
4922 if (equalStringObjects(ele
,c
->argv
[3])) {
4923 listDelNode(list
,ln
);
4926 if (toremove
&& removed
== toremove
) break;
4930 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4931 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4934 /* This is the semantic of this command:
4935 * RPOPLPUSH srclist dstlist:
4936 * IF LLEN(srclist) > 0
4937 * element = RPOP srclist
4938 * LPUSH dstlist element
4945 * The idea is to be able to get an element from a list in a reliable way
4946 * since the element is not just returned but pushed against another list
4947 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4949 static void rpoplpushcommand(redisClient
*c
) {
4954 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4955 checkType(c
,sobj
,REDIS_LIST
)) return;
4956 srclist
= sobj
->ptr
;
4957 ln
= listLast(srclist
);
4960 addReply(c
,shared
.nullbulk
);
4962 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4963 robj
*ele
= listNodeValue(ln
);
4966 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4967 addReply(c
,shared
.wrongtypeerr
);
4971 /* Add the element to the target list (unless it's directly
4972 * passed to some BLPOP-ing client */
4973 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4975 /* Create the list if the key does not exist */
4976 dobj
= createListObject();
4977 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4978 incrRefCount(c
->argv
[2]);
4980 dstlist
= dobj
->ptr
;
4981 listAddNodeHead(dstlist
,ele
);
4985 /* Send the element to the client as reply as well */
4986 addReplyBulk(c
,ele
);
4988 /* Finally remove the element from the source list */
4989 listDelNode(srclist
,ln
);
4990 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4995 /* ==================================== Sets ================================ */
4997 static void saddCommand(redisClient
*c
) {
5000 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5002 set
= createSetObject();
5003 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5004 incrRefCount(c
->argv
[1]);
5006 if (set
->type
!= REDIS_SET
) {
5007 addReply(c
,shared
.wrongtypeerr
);
5011 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5012 incrRefCount(c
->argv
[2]);
5014 addReply(c
,shared
.cone
);
5016 addReply(c
,shared
.czero
);
5020 static void sremCommand(redisClient
*c
) {
5023 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5024 checkType(c
,set
,REDIS_SET
)) return;
5026 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5028 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5029 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5030 addReply(c
,shared
.cone
);
5032 addReply(c
,shared
.czero
);
5036 static void smoveCommand(redisClient
*c
) {
5037 robj
*srcset
, *dstset
;
5039 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5040 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5042 /* If the source key does not exist return 0, if it's of the wrong type
5044 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5045 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5048 /* Error if the destination key is not a set as well */
5049 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5050 addReply(c
,shared
.wrongtypeerr
);
5053 /* Remove the element from the source set */
5054 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5055 /* Key not found in the src set! return zero */
5056 addReply(c
,shared
.czero
);
5059 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5060 deleteKey(c
->db
,c
->argv
[1]);
5062 /* Add the element to the destination set */
5064 dstset
= createSetObject();
5065 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5066 incrRefCount(c
->argv
[2]);
5068 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5069 incrRefCount(c
->argv
[3]);
5070 addReply(c
,shared
.cone
);
5073 static void sismemberCommand(redisClient
*c
) {
5076 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5077 checkType(c
,set
,REDIS_SET
)) return;
5079 if (dictFind(set
->ptr
,c
->argv
[2]))
5080 addReply(c
,shared
.cone
);
5082 addReply(c
,shared
.czero
);
5085 static void scardCommand(redisClient
*c
) {
5089 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5090 checkType(c
,o
,REDIS_SET
)) return;
5093 addReplyUlong(c
,dictSize(s
));
5096 static void spopCommand(redisClient
*c
) {
5100 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5101 checkType(c
,set
,REDIS_SET
)) return;
5103 de
= dictGetRandomKey(set
->ptr
);
5105 addReply(c
,shared
.nullbulk
);
5107 robj
*ele
= dictGetEntryKey(de
);
5109 addReplyBulk(c
,ele
);
5110 dictDelete(set
->ptr
,ele
);
5111 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5112 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5117 static void srandmemberCommand(redisClient
*c
) {
5121 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5122 checkType(c
,set
,REDIS_SET
)) return;
5124 de
= dictGetRandomKey(set
->ptr
);
5126 addReply(c
,shared
.nullbulk
);
5128 robj
*ele
= dictGetEntryKey(de
);
5130 addReplyBulk(c
,ele
);
5134 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5135 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5137 return dictSize(*d1
)-dictSize(*d2
);
5140 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5141 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5144 robj
*lenobj
= NULL
, *dstset
= NULL
;
5145 unsigned long j
, cardinality
= 0;
5147 for (j
= 0; j
< setsnum
; j
++) {
5151 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5152 lookupKeyRead(c
->db
,setskeys
[j
]);
5156 if (deleteKey(c
->db
,dstkey
))
5158 addReply(c
,shared
.czero
);
5160 addReply(c
,shared
.emptymultibulk
);
5164 if (setobj
->type
!= REDIS_SET
) {
5166 addReply(c
,shared
.wrongtypeerr
);
5169 dv
[j
] = setobj
->ptr
;
5171 /* Sort sets from the smallest to largest, this will improve our
5172 * algorithm's performace */
5173 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5175 /* The first thing we should output is the total number of elements...
5176 * since this is a multi-bulk write, but at this stage we don't know
5177 * the intersection set size, so we use a trick, append an empty object
5178 * to the output list and save the pointer to later modify it with the
5181 lenobj
= createObject(REDIS_STRING
,NULL
);
5183 decrRefCount(lenobj
);
5185 /* If we have a target key where to store the resulting set
5186 * create this key with an empty set inside */
5187 dstset
= createSetObject();
5190 /* Iterate all the elements of the first (smallest) set, and test
5191 * the element against all the other sets, if at least one set does
5192 * not include the element it is discarded */
5193 di
= dictGetIterator(dv
[0]);
5195 while((de
= dictNext(di
)) != NULL
) {
5198 for (j
= 1; j
< setsnum
; j
++)
5199 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5201 continue; /* at least one set does not contain the member */
5202 ele
= dictGetEntryKey(de
);
5204 addReplyBulk(c
,ele
);
5207 dictAdd(dstset
->ptr
,ele
,NULL
);
5211 dictReleaseIterator(di
);
5214 /* Store the resulting set into the target, if the intersection
5215 * is not an empty set. */
5216 deleteKey(c
->db
,dstkey
);
5217 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5218 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5219 incrRefCount(dstkey
);
5220 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5222 decrRefCount(dstset
);
5223 addReply(c
,shared
.czero
);
5227 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5232 static void sinterCommand(redisClient
*c
) {
5233 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5236 static void sinterstoreCommand(redisClient
*c
) {
5237 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5240 #define REDIS_OP_UNION 0
5241 #define REDIS_OP_DIFF 1
5242 #define REDIS_OP_INTER 2
5244 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5245 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5248 robj
*dstset
= NULL
;
5249 int j
, cardinality
= 0;
5251 for (j
= 0; j
< setsnum
; j
++) {
5255 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5256 lookupKeyRead(c
->db
,setskeys
[j
]);
5261 if (setobj
->type
!= REDIS_SET
) {
5263 addReply(c
,shared
.wrongtypeerr
);
5266 dv
[j
] = setobj
->ptr
;
5269 /* We need a temp set object to store our union. If the dstkey
5270 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5271 * this set object will be the resulting object to set into the target key*/
5272 dstset
= createSetObject();
5274 /* Iterate all the elements of all the sets, add every element a single
5275 * time to the result set */
5276 for (j
= 0; j
< setsnum
; j
++) {
5277 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5278 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5280 di
= dictGetIterator(dv
[j
]);
5282 while((de
= dictNext(di
)) != NULL
) {
5285 /* dictAdd will not add the same element multiple times */
5286 ele
= dictGetEntryKey(de
);
5287 if (op
== REDIS_OP_UNION
|| j
== 0) {
5288 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5292 } else if (op
== REDIS_OP_DIFF
) {
5293 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5298 dictReleaseIterator(di
);
5300 /* result set is empty? Exit asap. */
5301 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5304 /* Output the content of the resulting set, if not in STORE mode */
5306 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5307 di
= dictGetIterator(dstset
->ptr
);
5308 while((de
= dictNext(di
)) != NULL
) {
5311 ele
= dictGetEntryKey(de
);
5312 addReplyBulk(c
,ele
);
5314 dictReleaseIterator(di
);
5315 decrRefCount(dstset
);
5317 /* If we have a target key where to store the resulting set
5318 * create this key with the result set inside */
5319 deleteKey(c
->db
,dstkey
);
5320 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5321 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5322 incrRefCount(dstkey
);
5323 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5325 decrRefCount(dstset
);
5326 addReply(c
,shared
.czero
);
5333 static void sunionCommand(redisClient
*c
) {
5334 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5337 static void sunionstoreCommand(redisClient
*c
) {
5338 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5341 static void sdiffCommand(redisClient
*c
) {
5342 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5345 static void sdiffstoreCommand(redisClient
*c
) {
5346 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5349 /* ==================================== ZSets =============================== */
5351 /* ZSETs are ordered sets using two data structures to hold the same elements
5352 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5355 * The elements are added to an hash table mapping Redis objects to scores.
5356 * At the same time the elements are added to a skip list mapping scores
5357 * to Redis objects (so objects are sorted by scores in this "view"). */
5359 /* This skiplist implementation is almost a C translation of the original
5360 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5361 * Alternative to Balanced Trees", modified in three ways:
5362 * a) this implementation allows for repeated values.
5363 * b) the comparison is not just by key (our 'score') but by satellite data.
5364 * c) there is a back pointer, so it's a doubly linked list with the back
5365 * pointers being only at "level 1". This allows to traverse the list
5366 * from tail to head, useful for ZREVRANGE. */
5368 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5369 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5371 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5373 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5379 static zskiplist
*zslCreate(void) {
5383 zsl
= zmalloc(sizeof(*zsl
));
5386 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5387 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5388 zsl
->header
->forward
[j
] = NULL
;
5390 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5391 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5392 zsl
->header
->span
[j
] = 0;
5394 zsl
->header
->backward
= NULL
;
5399 static void zslFreeNode(zskiplistNode
*node
) {
5400 decrRefCount(node
->obj
);
5401 zfree(node
->forward
);
5406 static void zslFree(zskiplist
*zsl
) {
5407 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5409 zfree(zsl
->header
->forward
);
5410 zfree(zsl
->header
->span
);
5413 next
= node
->forward
[0];
5420 static int zslRandomLevel(void) {
5422 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5424 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5427 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5428 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5429 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5433 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5434 /* store rank that is crossed to reach the insert position */
5435 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5437 while (x
->forward
[i
] &&
5438 (x
->forward
[i
]->score
< score
||
5439 (x
->forward
[i
]->score
== score
&&
5440 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5441 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5446 /* we assume the key is not already inside, since we allow duplicated
5447 * scores, and the re-insertion of score and redis object should never
5448 * happpen since the caller of zslInsert() should test in the hash table
5449 * if the element is already inside or not. */
5450 level
= zslRandomLevel();
5451 if (level
> zsl
->level
) {
5452 for (i
= zsl
->level
; i
< level
; i
++) {
5454 update
[i
] = zsl
->header
;
5455 update
[i
]->span
[i
-1] = zsl
->length
;
5459 x
= zslCreateNode(level
,score
,obj
);
5460 for (i
= 0; i
< level
; i
++) {
5461 x
->forward
[i
] = update
[i
]->forward
[i
];
5462 update
[i
]->forward
[i
] = x
;
5464 /* update span covered by update[i] as x is inserted here */
5466 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5467 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5471 /* increment span for untouched levels */
5472 for (i
= level
; i
< zsl
->level
; i
++) {
5473 update
[i
]->span
[i
-1]++;
5476 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5478 x
->forward
[0]->backward
= x
;
5484 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5485 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5487 for (i
= 0; i
< zsl
->level
; i
++) {
5488 if (update
[i
]->forward
[i
] == x
) {
5490 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5492 update
[i
]->forward
[i
] = x
->forward
[i
];
5494 /* invariant: i > 0, because update[0]->forward[0]
5495 * is always equal to x */
5496 update
[i
]->span
[i
-1] -= 1;
5499 if (x
->forward
[0]) {
5500 x
->forward
[0]->backward
= x
->backward
;
5502 zsl
->tail
= x
->backward
;
5504 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5509 /* Delete an element with matching score/object from the skiplist. */
5510 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5511 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5515 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5516 while (x
->forward
[i
] &&
5517 (x
->forward
[i
]->score
< score
||
5518 (x
->forward
[i
]->score
== score
&&
5519 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5523 /* We may have multiple elements with the same score, what we need
5524 * is to find the element with both the right score and object. */
5526 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5527 zslDeleteNode(zsl
, x
, update
);
5531 return 0; /* not found */
5533 return 0; /* not found */
5536 /* Delete all the elements with score between min and max from the skiplist.
5537 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5538 * Note that this function takes the reference to the hash table view of the
5539 * sorted set, in order to remove the elements from the hash table too. */
5540 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5541 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5542 unsigned long removed
= 0;
5546 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5547 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5551 /* We may have multiple elements with the same score, what we need
5552 * is to find the element with both the right score and object. */
5554 while (x
&& x
->score
<= max
) {
5555 zskiplistNode
*next
= x
->forward
[0];
5556 zslDeleteNode(zsl
, x
, update
);
5557 dictDelete(dict
,x
->obj
);
5562 return removed
; /* not found */
5565 /* Delete all the elements with rank between start and end from the skiplist.
5566 * Start and end are inclusive. Note that start and end need to be 1-based */
5567 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5568 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5569 unsigned long traversed
= 0, removed
= 0;
5573 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5574 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5575 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5583 while (x
&& traversed
<= end
) {
5584 zskiplistNode
*next
= x
->forward
[0];
5585 zslDeleteNode(zsl
, x
, update
);
5586 dictDelete(dict
,x
->obj
);
5595 /* Find the first node having a score equal or greater than the specified one.
5596 * Returns NULL if there is no match. */
5597 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5602 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5603 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5606 /* We may have multiple elements with the same score, what we need
5607 * is to find the element with both the right score and object. */
5608 return x
->forward
[0];
5611 /* Find the rank for an element by both score and key.
5612 * Returns 0 when the element cannot be found, rank otherwise.
5613 * Note that the rank is 1-based due to the span of zsl->header to the
5615 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5617 unsigned long rank
= 0;
5621 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5622 while (x
->forward
[i
] &&
5623 (x
->forward
[i
]->score
< score
||
5624 (x
->forward
[i
]->score
== score
&&
5625 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5626 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5630 /* x might be equal to zsl->header, so test if obj is non-NULL */
5631 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5638 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5639 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5641 unsigned long traversed
= 0;
5645 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5646 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5648 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5651 if (traversed
== rank
) {
5658 /* The actual Z-commands implementations */
5660 /* This generic command implements both ZADD and ZINCRBY.
5661 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5662 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5663 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5668 zsetobj
= lookupKeyWrite(c
->db
,key
);
5669 if (zsetobj
== NULL
) {
5670 zsetobj
= createZsetObject();
5671 dictAdd(c
->db
->dict
,key
,zsetobj
);
5674 if (zsetobj
->type
!= REDIS_ZSET
) {
5675 addReply(c
,shared
.wrongtypeerr
);
5681 /* Ok now since we implement both ZADD and ZINCRBY here the code
5682 * needs to handle the two different conditions. It's all about setting
5683 * '*score', that is, the new score to set, to the right value. */
5684 score
= zmalloc(sizeof(double));
5688 /* Read the old score. If the element was not present starts from 0 */
5689 de
= dictFind(zs
->dict
,ele
);
5691 double *oldscore
= dictGetEntryVal(de
);
5692 *score
= *oldscore
+ scoreval
;
5700 /* What follows is a simple remove and re-insert operation that is common
5701 * to both ZADD and ZINCRBY... */
5702 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5703 /* case 1: New element */
5704 incrRefCount(ele
); /* added to hash */
5705 zslInsert(zs
->zsl
,*score
,ele
);
5706 incrRefCount(ele
); /* added to skiplist */
5709 addReplyDouble(c
,*score
);
5711 addReply(c
,shared
.cone
);
5716 /* case 2: Score update operation */
5717 de
= dictFind(zs
->dict
,ele
);
5718 redisAssert(de
!= NULL
);
5719 oldscore
= dictGetEntryVal(de
);
5720 if (*score
!= *oldscore
) {
5723 /* Remove and insert the element in the skip list with new score */
5724 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5725 redisAssert(deleted
!= 0);
5726 zslInsert(zs
->zsl
,*score
,ele
);
5728 /* Update the score in the hash table */
5729 dictReplace(zs
->dict
,ele
,score
);
5735 addReplyDouble(c
,*score
);
5737 addReply(c
,shared
.czero
);
5741 static void zaddCommand(redisClient
*c
) {
5744 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5745 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5748 static void zincrbyCommand(redisClient
*c
) {
5751 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5752 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5755 static void zremCommand(redisClient
*c
) {
5762 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5763 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5766 de
= dictFind(zs
->dict
,c
->argv
[2]);
5768 addReply(c
,shared
.czero
);
5771 /* Delete from the skiplist */
5772 oldscore
= dictGetEntryVal(de
);
5773 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5774 redisAssert(deleted
!= 0);
5776 /* Delete from the hash table */
5777 dictDelete(zs
->dict
,c
->argv
[2]);
5778 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5779 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5781 addReply(c
,shared
.cone
);
5784 static void zremrangebyscoreCommand(redisClient
*c
) {
5791 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5792 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5794 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5795 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5798 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5799 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5800 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5801 server
.dirty
+= deleted
;
5802 addReplyLong(c
,deleted
);
5805 static void zremrangebyrankCommand(redisClient
*c
) {
5813 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5814 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5816 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5817 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5819 llen
= zs
->zsl
->length
;
5821 /* convert negative indexes */
5822 if (start
< 0) start
= llen
+start
;
5823 if (end
< 0) end
= llen
+end
;
5824 if (start
< 0) start
= 0;
5825 if (end
< 0) end
= 0;
5827 /* indexes sanity checks */
5828 if (start
> end
|| start
>= llen
) {
5829 addReply(c
,shared
.czero
);
5832 if (end
>= llen
) end
= llen
-1;
5834 /* increment start and end because zsl*Rank functions
5835 * use 1-based rank */
5836 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5837 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5838 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5839 server
.dirty
+= deleted
;
5840 addReplyLong(c
, deleted
);
5848 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5849 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5850 unsigned long size1
, size2
;
5851 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5852 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5853 return size1
- size2
;
5856 #define REDIS_AGGR_SUM 1
5857 #define REDIS_AGGR_MIN 2
5858 #define REDIS_AGGR_MAX 3
5860 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5861 if (aggregate
== REDIS_AGGR_SUM
) {
5862 *target
= *target
+ val
;
5863 } else if (aggregate
== REDIS_AGGR_MIN
) {
5864 *target
= val
< *target
? val
: *target
;
5865 } else if (aggregate
== REDIS_AGGR_MAX
) {
5866 *target
= val
> *target
? val
: *target
;
5869 redisPanic("Unknown ZUNION/INTER aggregate type");
5873 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5875 int aggregate
= REDIS_AGGR_SUM
;
5882 /* expect zsetnum input keys to be given */
5883 zsetnum
= atoi(c
->argv
[2]->ptr
);
5885 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5889 /* test if the expected number of keys would overflow */
5890 if (3+zsetnum
> c
->argc
) {
5891 addReply(c
,shared
.syntaxerr
);
5895 /* read keys to be used for input */
5896 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5897 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5898 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5902 if (zsetobj
->type
!= REDIS_ZSET
) {
5904 addReply(c
,shared
.wrongtypeerr
);
5907 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5910 /* default all weights to 1 */
5911 src
[i
].weight
= 1.0;
5914 /* parse optional extra arguments */
5916 int remaining
= c
->argc
- j
;
5919 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5921 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5922 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5925 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5927 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5928 aggregate
= REDIS_AGGR_SUM
;
5929 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5930 aggregate
= REDIS_AGGR_MIN
;
5931 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5932 aggregate
= REDIS_AGGR_MAX
;
5935 addReply(c
,shared
.syntaxerr
);
5941 addReply(c
,shared
.syntaxerr
);
5947 /* sort sets from the smallest to largest, this will improve our
5948 * algorithm's performance */
5949 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5951 dstobj
= createZsetObject();
5952 dstzset
= dstobj
->ptr
;
5954 if (op
== REDIS_OP_INTER
) {
5955 /* skip going over all entries if the smallest zset is NULL or empty */
5956 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5957 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5958 * from small to large, all src[i > 0].dict are non-empty too */
5959 di
= dictGetIterator(src
[0].dict
);
5960 while((de
= dictNext(di
)) != NULL
) {
5961 double *score
= zmalloc(sizeof(double)), value
;
5962 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5964 for (j
= 1; j
< zsetnum
; j
++) {
5965 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5967 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5968 zunionInterAggregate(score
, value
, aggregate
);
5974 /* skip entry when not present in every source dict */
5978 robj
*o
= dictGetEntryKey(de
);
5979 dictAdd(dstzset
->dict
,o
,score
);
5980 incrRefCount(o
); /* added to dictionary */
5981 zslInsert(dstzset
->zsl
,*score
,o
);
5982 incrRefCount(o
); /* added to skiplist */
5985 dictReleaseIterator(di
);
5987 } else if (op
== REDIS_OP_UNION
) {
5988 for (i
= 0; i
< zsetnum
; i
++) {
5989 if (!src
[i
].dict
) continue;
5991 di
= dictGetIterator(src
[i
].dict
);
5992 while((de
= dictNext(di
)) != NULL
) {
5993 /* skip key when already processed */
5994 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5996 double *score
= zmalloc(sizeof(double)), value
;
5997 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5999 /* because the zsets are sorted by size, its only possible
6000 * for sets at larger indices to hold this entry */
6001 for (j
= (i
+1); j
< zsetnum
; j
++) {
6002 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6004 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
6005 zunionInterAggregate(score
, value
, aggregate
);
6009 robj
*o
= dictGetEntryKey(de
);
6010 dictAdd(dstzset
->dict
,o
,score
);
6011 incrRefCount(o
); /* added to dictionary */
6012 zslInsert(dstzset
->zsl
,*score
,o
);
6013 incrRefCount(o
); /* added to skiplist */
6015 dictReleaseIterator(di
);
6018 /* unknown operator */
6019 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6022 deleteKey(c
->db
,dstkey
);
6023 if (dstzset
->zsl
->length
) {
6024 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6025 incrRefCount(dstkey
);
6026 addReplyLong(c
, dstzset
->zsl
->length
);
6029 decrRefCount(dstobj
);
6030 addReply(c
, shared
.czero
);
6035 static void zunionCommand(redisClient
*c
) {
6036 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6039 static void zinterCommand(redisClient
*c
) {
6040 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6043 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6055 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6056 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6058 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6060 } else if (c
->argc
>= 5) {
6061 addReply(c
,shared
.syntaxerr
);
6065 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6066 || checkType(c
,o
,REDIS_ZSET
)) return;
6071 /* convert negative indexes */
6072 if (start
< 0) start
= llen
+start
;
6073 if (end
< 0) end
= llen
+end
;
6074 if (start
< 0) start
= 0;
6075 if (end
< 0) end
= 0;
6077 /* indexes sanity checks */
6078 if (start
> end
|| start
>= llen
) {
6079 /* Out of range start or start > end result in empty list */
6080 addReply(c
,shared
.emptymultibulk
);
6083 if (end
>= llen
) end
= llen
-1;
6084 rangelen
= (end
-start
)+1;
6086 /* check if starting point is trivial, before searching
6087 * the element in log(N) time */
6089 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6092 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6095 /* Return the result in form of a multi-bulk reply */
6096 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6097 withscores
? (rangelen
*2) : rangelen
));
6098 for (j
= 0; j
< rangelen
; j
++) {
6100 addReplyBulk(c
,ele
);
6102 addReplyDouble(c
,ln
->score
);
6103 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6107 static void zrangeCommand(redisClient
*c
) {
6108 zrangeGenericCommand(c
,0);
6111 static void zrevrangeCommand(redisClient
*c
) {
6112 zrangeGenericCommand(c
,1);
6115 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6116 * If justcount is non-zero, just the count is returned. */
6117 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6120 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6121 int offset
= 0, limit
= -1;
6125 /* Parse the min-max interval. If one of the values is prefixed
6126 * by the "(" character, it's considered "open". For instance
6127 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6128 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6129 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6130 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6133 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6135 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6136 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6139 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6142 /* Parse "WITHSCORES": note that if the command was called with
6143 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6144 * enter the following paths to parse WITHSCORES and LIMIT. */
6145 if (c
->argc
== 5 || c
->argc
== 8) {
6146 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6151 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6155 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6160 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6161 addReply(c
,shared
.syntaxerr
);
6163 } else if (c
->argc
== (7 + withscores
)) {
6164 offset
= atoi(c
->argv
[5]->ptr
);
6165 limit
= atoi(c
->argv
[6]->ptr
);
6166 if (offset
< 0) offset
= 0;
6169 /* Ok, lookup the key and get the range */
6170 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6172 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6174 if (o
->type
!= REDIS_ZSET
) {
6175 addReply(c
,shared
.wrongtypeerr
);
6177 zset
*zsetobj
= o
->ptr
;
6178 zskiplist
*zsl
= zsetobj
->zsl
;
6180 robj
*ele
, *lenobj
= NULL
;
6181 unsigned long rangelen
= 0;
6183 /* Get the first node with the score >= min, or with
6184 * score > min if 'minex' is true. */
6185 ln
= zslFirstWithScore(zsl
,min
);
6186 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6189 /* No element matching the speciifed interval */
6190 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6194 /* We don't know in advance how many matching elements there
6195 * are in the list, so we push this object that will represent
6196 * the multi-bulk length in the output buffer, and will "fix"
6199 lenobj
= createObject(REDIS_STRING
,NULL
);
6201 decrRefCount(lenobj
);
6204 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6207 ln
= ln
->forward
[0];
6210 if (limit
== 0) break;
6213 addReplyBulk(c
,ele
);
6215 addReplyDouble(c
,ln
->score
);
6217 ln
= ln
->forward
[0];
6219 if (limit
> 0) limit
--;
6222 addReplyLong(c
,(long)rangelen
);
6224 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6225 withscores
? (rangelen
*2) : rangelen
);
6231 static void zrangebyscoreCommand(redisClient
*c
) {
6232 genericZrangebyscoreCommand(c
,0);
6235 static void zcountCommand(redisClient
*c
) {
6236 genericZrangebyscoreCommand(c
,1);
6239 static void zcardCommand(redisClient
*c
) {
6243 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6244 checkType(c
,o
,REDIS_ZSET
)) return;
6247 addReplyUlong(c
,zs
->zsl
->length
);
6250 static void zscoreCommand(redisClient
*c
) {
6255 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6256 checkType(c
,o
,REDIS_ZSET
)) return;
6259 de
= dictFind(zs
->dict
,c
->argv
[2]);
6261 addReply(c
,shared
.nullbulk
);
6263 double *score
= dictGetEntryVal(de
);
6265 addReplyDouble(c
,*score
);
6269 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6277 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6278 checkType(c
,o
,REDIS_ZSET
)) return;
6282 de
= dictFind(zs
->dict
,c
->argv
[2]);
6284 addReply(c
,shared
.nullbulk
);
6288 score
= dictGetEntryVal(de
);
6289 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6292 addReplyLong(c
, zsl
->length
- rank
);
6294 addReplyLong(c
, rank
-1);
6297 addReply(c
,shared
.nullbulk
);
6301 static void zrankCommand(redisClient
*c
) {
6302 zrankGenericCommand(c
, 0);
6305 static void zrevrankCommand(redisClient
*c
) {
6306 zrankGenericCommand(c
, 1);
6309 /* ========================= Hashes utility functions ======================= */
6310 #define REDIS_HASH_KEY 1
6311 #define REDIS_HASH_VALUE 2
6313 /* Check the length of a number of objects to see if we need to convert a
6314 * zipmap to a real hash. Note that we only check string encoded objects
6315 * as their string length can be queried in constant time. */
6316 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6318 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6320 for (i
= start
; i
<= end
; i
++) {
6321 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6322 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6324 convertToRealHash(subject
);
6330 /* Encode given objects in-place when the hash uses a dict. */
6331 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6332 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6333 if (o1
) *o1
= tryObjectEncoding(*o1
);
6334 if (o2
) *o2
= tryObjectEncoding(*o2
);
6338 /* Get the value from a hash identified by key. Returns either a string
6339 * object or NULL if the value cannot be found. The refcount of the object
6340 * is always increased by 1 when the value was found. */
6341 static robj
*hashGet(robj
*o
, robj
*key
) {
6343 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6346 key
= getDecodedObject(key
);
6347 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6348 value
= createStringObject((char*)v
,vlen
);
6352 dictEntry
*de
= dictFind(o
->ptr
,key
);
6354 value
= dictGetEntryVal(de
);
6355 incrRefCount(value
);
6361 /* Test if the key exists in the given hash. Returns 1 if the key
6362 * exists and 0 when it doesn't. */
6363 static int hashExists(robj
*o
, robj
*key
) {
6364 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6365 key
= getDecodedObject(key
);
6366 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6372 if (dictFind(o
->ptr
,key
) != NULL
) {
6379 /* Add an element, discard the old if the key already exists.
6380 * Return 0 on insert and 1 on update. */
6381 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6383 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6384 key
= getDecodedObject(key
);
6385 value
= getDecodedObject(value
);
6386 o
->ptr
= zipmapSet(o
->ptr
,
6387 key
->ptr
,sdslen(key
->ptr
),
6388 value
->ptr
,sdslen(value
->ptr
), &update
);
6390 decrRefCount(value
);
6392 /* Check if the zipmap needs to be upgraded to a real hash table */
6393 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6394 convertToRealHash(o
);
6396 if (dictReplace(o
->ptr
,key
,value
)) {
6403 incrRefCount(value
);
6408 /* Delete an element from a hash.
6409 * Return 1 on deleted and 0 on not found. */
6410 static int hashDelete(robj
*o
, robj
*key
) {
6412 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6413 key
= getDecodedObject(key
);
6414 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6417 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6418 /* Always check if the dictionary needs a resize after a delete. */
6419 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6424 /* Return the number of elements in a hash. */
6425 static unsigned long hashLength(robj
*o
) {
6426 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6427 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6430 /* Structure to hold hash iteration abstration. Note that iteration over
6431 * hashes involves both fields and values. Because it is possible that
6432 * not both are required, store pointers in the iterator to avoid
6433 * unnecessary memory allocation for fields/values. */
6437 unsigned char *zk
, *zv
;
6438 unsigned int zklen
, zvlen
;
6444 static hashIterator
*hashInitIterator(robj
*subject
) {
6445 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6446 hi
->encoding
= subject
->encoding
;
6447 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6448 hi
->zi
= zipmapRewind(subject
->ptr
);
6449 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6450 hi
->di
= dictGetIterator(subject
->ptr
);
6457 static void hashReleaseIterator(hashIterator
*hi
) {
6458 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6459 dictReleaseIterator(hi
->di
);
6464 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6465 * could be found and REDIS_ERR when the iterator reaches the end. */
6466 static int hashNext(hashIterator
*hi
) {
6467 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6468 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6469 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6471 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6476 /* Get key or value object at current iteration position.
6477 * This increases the refcount of the field object by 1. */
6478 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6480 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6481 if (what
& REDIS_HASH_KEY
) {
6482 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6484 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6487 if (what
& REDIS_HASH_KEY
) {
6488 o
= dictGetEntryKey(hi
->de
);
6490 o
= dictGetEntryVal(hi
->de
);
6497 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6498 robj
*o
= lookupKeyWrite(c
->db
,key
);
6500 o
= createHashObject();
6501 dictAdd(c
->db
->dict
,key
,o
);
6504 if (o
->type
!= REDIS_HASH
) {
6505 addReply(c
,shared
.wrongtypeerr
);
6512 /* ============================= Hash commands ============================== */
6513 static void hsetCommand(redisClient
*c
) {
6517 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6518 hashTryConversion(o
,c
->argv
,2,3);
6519 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6520 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6521 addReply(c
, update
? shared
.czero
: shared
.cone
);
6525 static void hsetnxCommand(redisClient
*c
) {
6527 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6528 hashTryConversion(o
,c
->argv
,2,3);
6530 if (hashExists(o
, c
->argv
[2])) {
6531 addReply(c
, shared
.czero
);
6533 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6534 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6535 addReply(c
, shared
.cone
);
6540 static void hmsetCommand(redisClient
*c
) {
6544 if ((c
->argc
% 2) == 1) {
6545 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6549 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6550 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6551 for (i
= 2; i
< c
->argc
; i
+= 2) {
6552 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6553 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6555 addReply(c
, shared
.ok
);
6559 static void hincrbyCommand(redisClient
*c
) {
6560 long long value
, incr
;
6561 robj
*o
, *current
, *new;
6563 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6564 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6565 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6566 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6567 "hash value is not an integer") != REDIS_OK
) {
6568 decrRefCount(current
);
6571 decrRefCount(current
);
6577 new = createStringObjectFromLongLong(value
);
6578 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6579 hashSet(o
,c
->argv
[2],new);
6581 addReplyLongLong(c
,value
);
6585 static void hgetCommand(redisClient
*c
) {
6587 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6588 checkType(c
,o
,REDIS_HASH
)) return;
6590 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6591 addReplyBulk(c
,value
);
6592 decrRefCount(value
);
6594 addReply(c
,shared
.nullbulk
);
6598 static void hmgetCommand(redisClient
*c
) {
6601 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6602 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6603 addReply(c
,shared
.wrongtypeerr
);
6606 /* Note the check for o != NULL happens inside the loop. This is
6607 * done because objects that cannot be found are considered to be
6608 * an empty hash. The reply should then be a series of NULLs. */
6609 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6610 for (i
= 2; i
< c
->argc
; i
++) {
6611 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6612 addReplyBulk(c
,value
);
6613 decrRefCount(value
);
6615 addReply(c
,shared
.nullbulk
);
6620 static void hdelCommand(redisClient
*c
) {
6622 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6623 checkType(c
,o
,REDIS_HASH
)) return;
6625 if (hashDelete(o
,c
->argv
[2])) {
6626 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6627 addReply(c
,shared
.cone
);
6630 addReply(c
,shared
.czero
);
6634 static void hlenCommand(redisClient
*c
) {
6636 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6637 checkType(c
,o
,REDIS_HASH
)) return;
6639 addReplyUlong(c
,hashLength(o
));
6642 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6643 robj
*o
, *lenobj
, *obj
;
6644 unsigned long count
= 0;
6647 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6648 || checkType(c
,o
,REDIS_HASH
)) return;
6650 lenobj
= createObject(REDIS_STRING
,NULL
);
6652 decrRefCount(lenobj
);
6654 hi
= hashInitIterator(o
);
6655 while (hashNext(hi
) != REDIS_ERR
) {
6656 if (flags
& REDIS_HASH_KEY
) {
6657 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6658 addReplyBulk(c
,obj
);
6662 if (flags
& REDIS_HASH_VALUE
) {
6663 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6664 addReplyBulk(c
,obj
);
6669 hashReleaseIterator(hi
);
6671 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6674 static void hkeysCommand(redisClient
*c
) {
6675 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6678 static void hvalsCommand(redisClient
*c
) {
6679 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6682 static void hgetallCommand(redisClient
*c
) {
6683 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6686 static void hexistsCommand(redisClient
*c
) {
6688 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6689 checkType(c
,o
,REDIS_HASH
)) return;
6691 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6694 static void convertToRealHash(robj
*o
) {
6695 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6696 unsigned int klen
, vlen
;
6697 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6699 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6700 p
= zipmapRewind(zm
);
6701 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6702 robj
*keyobj
, *valobj
;
6704 keyobj
= createStringObject((char*)key
,klen
);
6705 valobj
= createStringObject((char*)val
,vlen
);
6706 keyobj
= tryObjectEncoding(keyobj
);
6707 valobj
= tryObjectEncoding(valobj
);
6708 dictAdd(dict
,keyobj
,valobj
);
6710 o
->encoding
= REDIS_ENCODING_HT
;
6715 /* ========================= Non type-specific commands ==================== */
6717 static void flushdbCommand(redisClient
*c
) {
6718 server
.dirty
+= dictSize(c
->db
->dict
);
6719 dictEmpty(c
->db
->dict
);
6720 dictEmpty(c
->db
->expires
);
6721 addReply(c
,shared
.ok
);
6724 static void flushallCommand(redisClient
*c
) {
6725 server
.dirty
+= emptyDb();
6726 addReply(c
,shared
.ok
);
6727 if (server
.bgsavechildpid
!= -1) {
6728 kill(server
.bgsavechildpid
,SIGKILL
);
6729 rdbRemoveTempFile(server
.bgsavechildpid
);
6731 rdbSave(server
.dbfilename
);
6735 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6736 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6738 so
->pattern
= pattern
;
6742 /* Return the value associated to the key with a name obtained
6743 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6744 * The returned object will always have its refcount increased by 1
6745 * when it is non-NULL. */
6746 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6749 robj keyobj
, fieldobj
, *o
;
6750 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6751 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6755 char buf
[REDIS_SORTKEY_MAX
+1];
6756 } keyname
, fieldname
;
6758 /* If the pattern is "#" return the substitution object itself in order
6759 * to implement the "SORT ... GET #" feature. */
6760 spat
= pattern
->ptr
;
6761 if (spat
[0] == '#' && spat
[1] == '\0') {
6762 incrRefCount(subst
);
6766 /* The substitution object may be specially encoded. If so we create
6767 * a decoded object on the fly. Otherwise getDecodedObject will just
6768 * increment the ref count, that we'll decrement later. */
6769 subst
= getDecodedObject(subst
);
6772 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6773 p
= strchr(spat
,'*');
6775 decrRefCount(subst
);
6779 /* Find out if we're dealing with a hash dereference. */
6780 if ((f
= strstr(p
+1, "->")) != NULL
) {
6781 fieldlen
= sdslen(spat
)-(f
-spat
);
6782 /* this also copies \0 character */
6783 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6784 fieldname
.len
= fieldlen
-2;
6790 sublen
= sdslen(ssub
);
6791 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6792 memcpy(keyname
.buf
,spat
,prefixlen
);
6793 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6794 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6795 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6796 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6797 decrRefCount(subst
);
6799 /* Lookup substituted key */
6800 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6801 o
= lookupKeyRead(db
,&keyobj
);
6802 if (o
== NULL
) return NULL
;
6805 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6807 /* Retrieve value from hash by the field name. This operation
6808 * already increases the refcount of the returned object. */
6809 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6810 o
= hashGet(o
, &fieldobj
);
6812 if (o
->type
!= REDIS_STRING
) return NULL
;
6814 /* Every object that this function returns needs to have its refcount
6815 * increased. sortCommand decreases it again. */
6822 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6823 * the additional parameter is not standard but a BSD-specific we have to
6824 * pass sorting parameters via the global 'server' structure */
6825 static int sortCompare(const void *s1
, const void *s2
) {
6826 const redisSortObject
*so1
= s1
, *so2
= s2
;
6829 if (!server
.sort_alpha
) {
6830 /* Numeric sorting. Here it's trivial as we precomputed scores */
6831 if (so1
->u
.score
> so2
->u
.score
) {
6833 } else if (so1
->u
.score
< so2
->u
.score
) {
6839 /* Alphanumeric sorting */
6840 if (server
.sort_bypattern
) {
6841 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6842 /* At least one compare object is NULL */
6843 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6845 else if (so1
->u
.cmpobj
== NULL
)
6850 /* We have both the objects, use strcoll */
6851 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6854 /* Compare elements directly. */
6855 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6858 return server
.sort_desc
? -cmp
: cmp
;
6861 /* The SORT command is the most complex command in Redis. Warning: this code
6862 * is optimized for speed and a bit less for readability */
6863 static void sortCommand(redisClient
*c
) {
6866 int desc
= 0, alpha
= 0;
6867 int limit_start
= 0, limit_count
= -1, start
, end
;
6868 int j
, dontsort
= 0, vectorlen
;
6869 int getop
= 0; /* GET operation counter */
6870 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6871 redisSortObject
*vector
; /* Resulting vector to sort */
6873 /* Lookup the key to sort. It must be of the right types */
6874 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6875 if (sortval
== NULL
) {
6876 addReply(c
,shared
.emptymultibulk
);
6879 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6880 sortval
->type
!= REDIS_ZSET
)
6882 addReply(c
,shared
.wrongtypeerr
);
6886 /* Create a list of operations to perform for every sorted element.
6887 * Operations can be GET/DEL/INCR/DECR */
6888 operations
= listCreate();
6889 listSetFreeMethod(operations
,zfree
);
6892 /* Now we need to protect sortval incrementing its count, in the future
6893 * SORT may have options able to overwrite/delete keys during the sorting
6894 * and the sorted key itself may get destroied */
6895 incrRefCount(sortval
);
6897 /* The SORT command has an SQL-alike syntax, parse it */
6898 while(j
< c
->argc
) {
6899 int leftargs
= c
->argc
-j
-1;
6900 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6902 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6904 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6906 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6907 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6908 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6910 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6911 storekey
= c
->argv
[j
+1];
6913 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6914 sortby
= c
->argv
[j
+1];
6915 /* If the BY pattern does not contain '*', i.e. it is constant,
6916 * we don't need to sort nor to lookup the weight keys. */
6917 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6919 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6920 listAddNodeTail(operations
,createSortOperation(
6921 REDIS_SORT_GET
,c
->argv
[j
+1]));
6925 decrRefCount(sortval
);
6926 listRelease(operations
);
6927 addReply(c
,shared
.syntaxerr
);
6933 /* Load the sorting vector with all the objects to sort */
6934 switch(sortval
->type
) {
6935 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6936 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6937 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6938 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6940 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6943 if (sortval
->type
== REDIS_LIST
) {
6944 list
*list
= sortval
->ptr
;
6948 listRewind(list
,&li
);
6949 while((ln
= listNext(&li
))) {
6950 robj
*ele
= ln
->value
;
6951 vector
[j
].obj
= ele
;
6952 vector
[j
].u
.score
= 0;
6953 vector
[j
].u
.cmpobj
= NULL
;
6961 if (sortval
->type
== REDIS_SET
) {
6964 zset
*zs
= sortval
->ptr
;
6968 di
= dictGetIterator(set
);
6969 while((setele
= dictNext(di
)) != NULL
) {
6970 vector
[j
].obj
= dictGetEntryKey(setele
);
6971 vector
[j
].u
.score
= 0;
6972 vector
[j
].u
.cmpobj
= NULL
;
6975 dictReleaseIterator(di
);
6977 redisAssert(j
== vectorlen
);
6979 /* Now it's time to load the right scores in the sorting vector */
6980 if (dontsort
== 0) {
6981 for (j
= 0; j
< vectorlen
; j
++) {
6984 /* lookup value to sort by */
6985 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6986 if (!byval
) continue;
6988 /* use object itself to sort by */
6989 byval
= vector
[j
].obj
;
6993 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6995 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6996 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6997 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6998 /* Don't need to decode the object if it's
6999 * integer-encoded (the only encoding supported) so
7000 * far. We can just cast it */
7001 vector
[j
].u
.score
= (long)byval
->ptr
;
7003 redisAssert(1 != 1);
7007 /* when the object was retrieved using lookupKeyByPattern,
7008 * its refcount needs to be decreased. */
7010 decrRefCount(byval
);
7015 /* We are ready to sort the vector... perform a bit of sanity check
7016 * on the LIMIT option too. We'll use a partial version of quicksort. */
7017 start
= (limit_start
< 0) ? 0 : limit_start
;
7018 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7019 if (start
>= vectorlen
) {
7020 start
= vectorlen
-1;
7023 if (end
>= vectorlen
) end
= vectorlen
-1;
7025 if (dontsort
== 0) {
7026 server
.sort_desc
= desc
;
7027 server
.sort_alpha
= alpha
;
7028 server
.sort_bypattern
= sortby
? 1 : 0;
7029 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7030 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7032 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7035 /* Send command output to the output buffer, performing the specified
7036 * GET/DEL/INCR/DECR operations if any. */
7037 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7038 if (storekey
== NULL
) {
7039 /* STORE option not specified, sent the sorting result to client */
7040 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7041 for (j
= start
; j
<= end
; j
++) {
7045 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7046 listRewind(operations
,&li
);
7047 while((ln
= listNext(&li
))) {
7048 redisSortOperation
*sop
= ln
->value
;
7049 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7052 if (sop
->type
== REDIS_SORT_GET
) {
7054 addReply(c
,shared
.nullbulk
);
7056 addReplyBulk(c
,val
);
7060 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7065 robj
*listObject
= createListObject();
7066 list
*listPtr
= (list
*) listObject
->ptr
;
7068 /* STORE option specified, set the sorting result as a List object */
7069 for (j
= start
; j
<= end
; j
++) {
7074 listAddNodeTail(listPtr
,vector
[j
].obj
);
7075 incrRefCount(vector
[j
].obj
);
7077 listRewind(operations
,&li
);
7078 while((ln
= listNext(&li
))) {
7079 redisSortOperation
*sop
= ln
->value
;
7080 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7083 if (sop
->type
== REDIS_SORT_GET
) {
7085 listAddNodeTail(listPtr
,createStringObject("",0));
7087 /* We should do a incrRefCount on val because it is
7088 * added to the list, but also a decrRefCount because
7089 * it is returned by lookupKeyByPattern. This results
7090 * in doing nothing at all. */
7091 listAddNodeTail(listPtr
,val
);
7094 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7098 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7099 incrRefCount(storekey
);
7101 /* Note: we add 1 because the DB is dirty anyway since even if the
7102 * SORT result is empty a new key is set and maybe the old content
7104 server
.dirty
+= 1+outputlen
;
7105 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7109 decrRefCount(sortval
);
7110 listRelease(operations
);
7111 for (j
= 0; j
< vectorlen
; j
++) {
7112 if (alpha
&& vector
[j
].u
.cmpobj
)
7113 decrRefCount(vector
[j
].u
.cmpobj
);
7118 /* Convert an amount of bytes into a human readable string in the form
7119 * of 100B, 2G, 100M, 4K, and so forth. */
7120 static void bytesToHuman(char *s
, unsigned long long n
) {
7125 sprintf(s
,"%lluB",n
);
7127 } else if (n
< (1024*1024)) {
7128 d
= (double)n
/(1024);
7129 sprintf(s
,"%.2fK",d
);
7130 } else if (n
< (1024LL*1024*1024)) {
7131 d
= (double)n
/(1024*1024);
7132 sprintf(s
,"%.2fM",d
);
7133 } else if (n
< (1024LL*1024*1024*1024)) {
7134 d
= (double)n
/(1024LL*1024*1024);
7135 sprintf(s
,"%.2fG",d
);
7139 /* Create the string returned by the INFO command. This is decoupled
7140 * by the INFO command itself as we need to report the same information
7141 * on memory corruption problems. */
7142 static sds
genRedisInfoString(void) {
7144 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7148 bytesToHuman(hmem
,zmalloc_used_memory());
7149 info
= sdscatprintf(sdsempty(),
7150 "redis_version:%s\r\n"
7152 "multiplexing_api:%s\r\n"
7153 "process_id:%ld\r\n"
7154 "uptime_in_seconds:%ld\r\n"
7155 "uptime_in_days:%ld\r\n"
7156 "connected_clients:%d\r\n"
7157 "connected_slaves:%d\r\n"
7158 "blocked_clients:%d\r\n"
7159 "used_memory:%zu\r\n"
7160 "used_memory_human:%s\r\n"
7161 "changes_since_last_save:%lld\r\n"
7162 "bgsave_in_progress:%d\r\n"
7163 "last_save_time:%ld\r\n"
7164 "bgrewriteaof_in_progress:%d\r\n"
7165 "total_connections_received:%lld\r\n"
7166 "total_commands_processed:%lld\r\n"
7167 "expired_keys:%lld\r\n"
7168 "hash_max_zipmap_entries:%ld\r\n"
7169 "hash_max_zipmap_value:%ld\r\n"
7170 "pubsub_channels:%ld\r\n"
7171 "pubsub_patterns:%u\r\n"
7175 (sizeof(long) == 8) ? "64" : "32",
7180 listLength(server
.clients
)-listLength(server
.slaves
),
7181 listLength(server
.slaves
),
7182 server
.blpop_blocked_clients
,
7183 zmalloc_used_memory(),
7186 server
.bgsavechildpid
!= -1,
7188 server
.bgrewritechildpid
!= -1,
7189 server
.stat_numconnections
,
7190 server
.stat_numcommands
,
7191 server
.stat_expiredkeys
,
7192 server
.hash_max_zipmap_entries
,
7193 server
.hash_max_zipmap_value
,
7194 dictSize(server
.pubsub_channels
),
7195 listLength(server
.pubsub_patterns
),
7196 server
.vm_enabled
!= 0,
7197 server
.masterhost
== NULL
? "master" : "slave"
7199 if (server
.masterhost
) {
7200 info
= sdscatprintf(info
,
7201 "master_host:%s\r\n"
7202 "master_port:%d\r\n"
7203 "master_link_status:%s\r\n"
7204 "master_last_io_seconds_ago:%d\r\n"
7207 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7209 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7212 if (server
.vm_enabled
) {
7214 info
= sdscatprintf(info
,
7215 "vm_conf_max_memory:%llu\r\n"
7216 "vm_conf_page_size:%llu\r\n"
7217 "vm_conf_pages:%llu\r\n"
7218 "vm_stats_used_pages:%llu\r\n"
7219 "vm_stats_swapped_objects:%llu\r\n"
7220 "vm_stats_swappin_count:%llu\r\n"
7221 "vm_stats_swappout_count:%llu\r\n"
7222 "vm_stats_io_newjobs_len:%lu\r\n"
7223 "vm_stats_io_processing_len:%lu\r\n"
7224 "vm_stats_io_processed_len:%lu\r\n"
7225 "vm_stats_io_active_threads:%lu\r\n"
7226 "vm_stats_blocked_clients:%lu\r\n"
7227 ,(unsigned long long) server
.vm_max_memory
,
7228 (unsigned long long) server
.vm_page_size
,
7229 (unsigned long long) server
.vm_pages
,
7230 (unsigned long long) server
.vm_stats_used_pages
,
7231 (unsigned long long) server
.vm_stats_swapped_objects
,
7232 (unsigned long long) server
.vm_stats_swapins
,
7233 (unsigned long long) server
.vm_stats_swapouts
,
7234 (unsigned long) listLength(server
.io_newjobs
),
7235 (unsigned long) listLength(server
.io_processing
),
7236 (unsigned long) listLength(server
.io_processed
),
7237 (unsigned long) server
.io_active_threads
,
7238 (unsigned long) server
.vm_blocked_clients
7242 for (j
= 0; j
< server
.dbnum
; j
++) {
7243 long long keys
, vkeys
;
7245 keys
= dictSize(server
.db
[j
].dict
);
7246 vkeys
= dictSize(server
.db
[j
].expires
);
7247 if (keys
|| vkeys
) {
7248 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7255 static void infoCommand(redisClient
*c
) {
7256 sds info
= genRedisInfoString();
7257 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7258 (unsigned long)sdslen(info
)));
7259 addReplySds(c
,info
);
7260 addReply(c
,shared
.crlf
);
7263 static void monitorCommand(redisClient
*c
) {
7264 /* ignore MONITOR if aleady slave or in monitor mode */
7265 if (c
->flags
& REDIS_SLAVE
) return;
7267 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7269 listAddNodeTail(server
.monitors
,c
);
7270 addReply(c
,shared
.ok
);
7273 /* ================================= Expire ================================= */
7274 static int removeExpire(redisDb
*db
, robj
*key
) {
7275 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7282 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7283 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7291 /* Return the expire time of the specified key, or -1 if no expire
7292 * is associated with this key (i.e. the key is non volatile) */
7293 static time_t getExpire(redisDb
*db
, robj
*key
) {
7296 /* No expire? return ASAP */
7297 if (dictSize(db
->expires
) == 0 ||
7298 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7300 return (time_t) dictGetEntryVal(de
);
7303 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7307 /* No expire? return ASAP */
7308 if (dictSize(db
->expires
) == 0 ||
7309 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7311 /* Lookup the expire */
7312 when
= (time_t) dictGetEntryVal(de
);
7313 if (time(NULL
) <= when
) return 0;
7315 /* Delete the key */
7316 dictDelete(db
->expires
,key
);
7317 server
.stat_expiredkeys
++;
7318 return dictDelete(db
->dict
,key
) == DICT_OK
;
7321 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7324 /* No expire? return ASAP */
7325 if (dictSize(db
->expires
) == 0 ||
7326 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7328 /* Delete the key */
7330 server
.stat_expiredkeys
++;
7331 dictDelete(db
->expires
,key
);
7332 return dictDelete(db
->dict
,key
) == DICT_OK
;
7335 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7339 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7343 de
= dictFind(c
->db
->dict
,key
);
7345 addReply(c
,shared
.czero
);
7349 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7350 addReply(c
, shared
.cone
);
7353 time_t when
= time(NULL
)+seconds
;
7354 if (setExpire(c
->db
,key
,when
)) {
7355 addReply(c
,shared
.cone
);
7358 addReply(c
,shared
.czero
);
7364 static void expireCommand(redisClient
*c
) {
7365 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7368 static void expireatCommand(redisClient
*c
) {
7369 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7372 static void ttlCommand(redisClient
*c
) {
7376 expire
= getExpire(c
->db
,c
->argv
[1]);
7378 ttl
= (int) (expire
-time(NULL
));
7379 if (ttl
< 0) ttl
= -1;
7381 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7384 /* ================================ MULTI/EXEC ============================== */
7386 /* Client state initialization for MULTI/EXEC */
7387 static void initClientMultiState(redisClient
*c
) {
7388 c
->mstate
.commands
= NULL
;
7389 c
->mstate
.count
= 0;
7392 /* Release all the resources associated with MULTI/EXEC state */
7393 static void freeClientMultiState(redisClient
*c
) {
7396 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7398 multiCmd
*mc
= c
->mstate
.commands
+j
;
7400 for (i
= 0; i
< mc
->argc
; i
++)
7401 decrRefCount(mc
->argv
[i
]);
7404 zfree(c
->mstate
.commands
);
7407 /* Add a new command into the MULTI commands queue */
7408 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7412 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7413 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7414 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7417 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7418 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7419 for (j
= 0; j
< c
->argc
; j
++)
7420 incrRefCount(mc
->argv
[j
]);
7424 static void multiCommand(redisClient
*c
) {
7425 c
->flags
|= REDIS_MULTI
;
7426 addReply(c
,shared
.ok
);
7429 static void discardCommand(redisClient
*c
) {
7430 if (!(c
->flags
& REDIS_MULTI
)) {
7431 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7435 freeClientMultiState(c
);
7436 initClientMultiState(c
);
7437 c
->flags
&= (~REDIS_MULTI
);
7438 addReply(c
,shared
.ok
);
7441 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7442 * implememntation for more information. */
7443 static void execCommandReplicateMulti(redisClient
*c
) {
7444 struct redisCommand
*cmd
;
7445 robj
*multistring
= createStringObject("MULTI",5);
7447 cmd
= lookupCommand("multi");
7448 if (server
.appendonly
)
7449 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7450 if (listLength(server
.slaves
))
7451 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7452 decrRefCount(multistring
);
7455 static void execCommand(redisClient
*c
) {
7460 if (!(c
->flags
& REDIS_MULTI
)) {
7461 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7465 /* Replicate a MULTI request now that we are sure the block is executed.
7466 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7467 * both the AOF and the replication link will have the same consistency
7468 * and atomicity guarantees. */
7469 execCommandReplicateMulti(c
);
7471 /* Exec all the queued commands */
7472 orig_argv
= c
->argv
;
7473 orig_argc
= c
->argc
;
7474 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7475 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7476 c
->argc
= c
->mstate
.commands
[j
].argc
;
7477 c
->argv
= c
->mstate
.commands
[j
].argv
;
7478 call(c
,c
->mstate
.commands
[j
].cmd
);
7480 c
->argv
= orig_argv
;
7481 c
->argc
= orig_argc
;
7482 freeClientMultiState(c
);
7483 initClientMultiState(c
);
7484 c
->flags
&= (~REDIS_MULTI
);
7485 /* Make sure the EXEC command is always replicated / AOF, since we
7486 * always send the MULTI command (we can't know beforehand if the
7487 * next operations will contain at least a modification to the DB). */
7491 /* =========================== Blocking Operations ========================= */
7493 /* Currently Redis blocking operations support is limited to list POP ops,
7494 * so the current implementation is not fully generic, but it is also not
7495 * completely specific so it will not require a rewrite to support new
7496 * kind of blocking operations in the future.
7498 * Still it's important to note that list blocking operations can be already
7499 * used as a notification mechanism in order to implement other blocking
7500 * operations at application level, so there must be a very strong evidence
7501 * of usefulness and generality before new blocking operations are implemented.
7503 * This is how the current blocking POP works, we use BLPOP as example:
7504 * - If the user calls BLPOP and the key exists and contains a non empty list
7505 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7506 * if there is not to block.
7507 * - If instead BLPOP is called and the key does not exists or the list is
7508 * empty we need to block. In order to do so we remove the notification for
7509 * new data to read in the client socket (so that we'll not serve new
7510 * requests if the blocking request is not served). Also we put the client
7511 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7512 * blocking for this keys.
7513 * - If a PUSH operation against a key with blocked clients waiting is
7514 * performed, we serve the first in the list: basically instead to push
7515 * the new element inside the list we return it to the (first / oldest)
7516 * blocking client, unblock the client, and remove it form the list.
7518 * The above comment and the source code should be enough in order to understand
7519 * the implementation and modify / fix it later.
7522 /* Set a client in blocking mode for the specified key, with the specified
7524 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7529 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7530 c
->blockingkeysnum
= numkeys
;
7531 c
->blockingto
= timeout
;
7532 for (j
= 0; j
< numkeys
; j
++) {
7533 /* Add the key in the client structure, to map clients -> keys */
7534 c
->blockingkeys
[j
] = keys
[j
];
7535 incrRefCount(keys
[j
]);
7537 /* And in the other "side", to map keys -> clients */
7538 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7542 /* For every key we take a list of clients blocked for it */
7544 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7545 incrRefCount(keys
[j
]);
7546 assert(retval
== DICT_OK
);
7548 l
= dictGetEntryVal(de
);
7550 listAddNodeTail(l
,c
);
7552 /* Mark the client as a blocked client */
7553 c
->flags
|= REDIS_BLOCKED
;
7554 server
.blpop_blocked_clients
++;
7557 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7558 static void unblockClientWaitingData(redisClient
*c
) {
7563 assert(c
->blockingkeys
!= NULL
);
7564 /* The client may wait for multiple keys, so unblock it for every key. */
7565 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7566 /* Remove this client from the list of clients waiting for this key. */
7567 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7569 l
= dictGetEntryVal(de
);
7570 listDelNode(l
,listSearchKey(l
,c
));
7571 /* If the list is empty we need to remove it to avoid wasting memory */
7572 if (listLength(l
) == 0)
7573 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7574 decrRefCount(c
->blockingkeys
[j
]);
7576 /* Cleanup the client structure */
7577 zfree(c
->blockingkeys
);
7578 c
->blockingkeys
= NULL
;
7579 c
->flags
&= (~REDIS_BLOCKED
);
7580 server
.blpop_blocked_clients
--;
7581 /* We want to process data if there is some command waiting
7582 * in the input buffer. Note that this is safe even if
7583 * unblockClientWaitingData() gets called from freeClient() because
7584 * freeClient() will be smart enough to call this function
7585 * *after* c->querybuf was set to NULL. */
7586 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7589 /* This should be called from any function PUSHing into lists.
7590 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7591 * 'ele' is the element pushed.
7593 * If the function returns 0 there was no client waiting for a list push
7596 * If the function returns 1 there was a client waiting for a list push
7597 * against this key, the element was passed to this client thus it's not
7598 * needed to actually add it to the list and the caller should return asap. */
7599 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7600 struct dictEntry
*de
;
7601 redisClient
*receiver
;
7605 de
= dictFind(c
->db
->blockingkeys
,key
);
7606 if (de
== NULL
) return 0;
7607 l
= dictGetEntryVal(de
);
7610 receiver
= ln
->value
;
7612 addReplySds(receiver
,sdsnew("*2\r\n"));
7613 addReplyBulk(receiver
,key
);
7614 addReplyBulk(receiver
,ele
);
7615 unblockClientWaitingData(receiver
);
7619 /* Blocking RPOP/LPOP */
7620 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7625 for (j
= 1; j
< c
->argc
-1; j
++) {
7626 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7628 if (o
->type
!= REDIS_LIST
) {
7629 addReply(c
,shared
.wrongtypeerr
);
7632 list
*list
= o
->ptr
;
7633 if (listLength(list
) != 0) {
7634 /* If the list contains elements fall back to the usual
7635 * non-blocking POP operation */
7636 robj
*argv
[2], **orig_argv
;
7639 /* We need to alter the command arguments before to call
7640 * popGenericCommand() as the command takes a single key. */
7641 orig_argv
= c
->argv
;
7642 orig_argc
= c
->argc
;
7643 argv
[1] = c
->argv
[j
];
7647 /* Also the return value is different, we need to output
7648 * the multi bulk reply header and the key name. The
7649 * "real" command will add the last element (the value)
7650 * for us. If this souds like an hack to you it's just
7651 * because it is... */
7652 addReplySds(c
,sdsnew("*2\r\n"));
7653 addReplyBulk(c
,argv
[1]);
7654 popGenericCommand(c
,where
);
7656 /* Fix the client structure with the original stuff */
7657 c
->argv
= orig_argv
;
7658 c
->argc
= orig_argc
;
7664 /* If the list is empty or the key does not exists we must block */
7665 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7666 if (timeout
> 0) timeout
+= time(NULL
);
7667 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7670 static void blpopCommand(redisClient
*c
) {
7671 blockingPopGenericCommand(c
,REDIS_HEAD
);
7674 static void brpopCommand(redisClient
*c
) {
7675 blockingPopGenericCommand(c
,REDIS_TAIL
);
7678 /* =============================== Replication ============================= */
7680 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7681 ssize_t nwritten
, ret
= size
;
7682 time_t start
= time(NULL
);
7686 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7687 nwritten
= write(fd
,ptr
,size
);
7688 if (nwritten
== -1) return -1;
7692 if ((time(NULL
)-start
) > timeout
) {
7700 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7701 ssize_t nread
, totread
= 0;
7702 time_t start
= time(NULL
);
7706 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7707 nread
= read(fd
,ptr
,size
);
7708 if (nread
== -1) return -1;
7713 if ((time(NULL
)-start
) > timeout
) {
7721 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7728 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7731 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7742 static void syncCommand(redisClient
*c
) {
7743 /* ignore SYNC if aleady slave or in monitor mode */
7744 if (c
->flags
& REDIS_SLAVE
) return;
7746 /* SYNC can't be issued when the server has pending data to send to
7747 * the client about already issued commands. We need a fresh reply
7748 * buffer registering the differences between the BGSAVE and the current
7749 * dataset, so that we can copy to other slaves if needed. */
7750 if (listLength(c
->reply
) != 0) {
7751 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7755 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7756 /* Here we need to check if there is a background saving operation
7757 * in progress, or if it is required to start one */
7758 if (server
.bgsavechildpid
!= -1) {
7759 /* Ok a background save is in progress. Let's check if it is a good
7760 * one for replication, i.e. if there is another slave that is
7761 * registering differences since the server forked to save */
7766 listRewind(server
.slaves
,&li
);
7767 while((ln
= listNext(&li
))) {
7769 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7772 /* Perfect, the server is already registering differences for
7773 * another slave. Set the right state, and copy the buffer. */
7774 listRelease(c
->reply
);
7775 c
->reply
= listDup(slave
->reply
);
7776 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7777 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7779 /* No way, we need to wait for the next BGSAVE in order to
7780 * register differences */
7781 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7782 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7785 /* Ok we don't have a BGSAVE in progress, let's start one */
7786 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7787 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7788 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7789 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7792 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7795 c
->flags
|= REDIS_SLAVE
;
7797 listAddNodeTail(server
.slaves
,c
);
7801 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7802 redisClient
*slave
= privdata
;
7804 REDIS_NOTUSED(mask
);
7805 char buf
[REDIS_IOBUF_LEN
];
7806 ssize_t nwritten
, buflen
;
7808 if (slave
->repldboff
== 0) {
7809 /* Write the bulk write count before to transfer the DB. In theory here
7810 * we don't know how much room there is in the output buffer of the
7811 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7812 * operations) will never be smaller than the few bytes we need. */
7815 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7817 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7825 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7826 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7828 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7829 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7833 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7834 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7839 slave
->repldboff
+= nwritten
;
7840 if (slave
->repldboff
== slave
->repldbsize
) {
7841 close(slave
->repldbfd
);
7842 slave
->repldbfd
= -1;
7843 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7844 slave
->replstate
= REDIS_REPL_ONLINE
;
7845 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7846 sendReplyToClient
, slave
) == AE_ERR
) {
7850 addReplySds(slave
,sdsempty());
7851 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7855 /* This function is called at the end of every backgrond saving.
7856 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7857 * otherwise REDIS_ERR is passed to the function.
7859 * The goal of this function is to handle slaves waiting for a successful
7860 * background saving in order to perform non-blocking synchronization. */
7861 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7863 int startbgsave
= 0;
7866 listRewind(server
.slaves
,&li
);
7867 while((ln
= listNext(&li
))) {
7868 redisClient
*slave
= ln
->value
;
7870 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7872 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7873 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7874 struct redis_stat buf
;
7876 if (bgsaveerr
!= REDIS_OK
) {
7878 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7881 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7882 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7884 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7887 slave
->repldboff
= 0;
7888 slave
->repldbsize
= buf
.st_size
;
7889 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7890 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7891 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7898 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7901 listRewind(server
.slaves
,&li
);
7902 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7903 while((ln
= listNext(&li
))) {
7904 redisClient
*slave
= ln
->value
;
7906 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7913 static int syncWithMaster(void) {
7914 char buf
[1024], tmpfile
[256], authcmd
[1024];
7916 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7917 int dfd
, maxtries
= 5;
7920 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7925 /* AUTH with the master if required. */
7926 if(server
.masterauth
) {
7927 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7928 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7930 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7934 /* Read the AUTH result. */
7935 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7937 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7941 if (buf
[0] != '+') {
7943 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7948 /* Issue the SYNC command */
7949 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7951 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7955 /* Read the bulk write count */
7956 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7958 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7962 if (buf
[0] != '$') {
7964 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7967 dumpsize
= strtol(buf
+1,NULL
,10);
7968 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7969 /* Read the bulk write data on a temp file */
7971 snprintf(tmpfile
,256,
7972 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7973 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7974 if (dfd
!= -1) break;
7979 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7983 int nread
, nwritten
;
7985 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7987 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7993 nwritten
= write(dfd
,buf
,nread
);
7994 if (nwritten
== -1) {
7995 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8003 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8004 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8010 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8011 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8015 server
.master
= createClient(fd
);
8016 server
.master
->flags
|= REDIS_MASTER
;
8017 server
.master
->authenticated
= 1;
8018 server
.replstate
= REDIS_REPL_CONNECTED
;
8022 static void slaveofCommand(redisClient
*c
) {
8023 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8024 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8025 if (server
.masterhost
) {
8026 sdsfree(server
.masterhost
);
8027 server
.masterhost
= NULL
;
8028 if (server
.master
) freeClient(server
.master
);
8029 server
.replstate
= REDIS_REPL_NONE
;
8030 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8033 sdsfree(server
.masterhost
);
8034 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8035 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8036 if (server
.master
) freeClient(server
.master
);
8037 server
.replstate
= REDIS_REPL_CONNECT
;
8038 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8039 server
.masterhost
, server
.masterport
);
8041 addReply(c
,shared
.ok
);
8044 /* ============================ Maxmemory directive ======================== */
8046 /* Try to free one object form the pre-allocated objects free list.
8047 * This is useful under low mem conditions as by default we take 1 million
8048 * free objects allocated. On success REDIS_OK is returned, otherwise
8050 static int tryFreeOneObjectFromFreelist(void) {
8053 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8054 if (listLength(server
.objfreelist
)) {
8055 listNode
*head
= listFirst(server
.objfreelist
);
8056 o
= listNodeValue(head
);
8057 listDelNode(server
.objfreelist
,head
);
8058 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8062 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8067 /* This function gets called when 'maxmemory' is set on the config file to limit
8068 * the max memory used by the server, and we are out of memory.
8069 * This function will try to, in order:
8071 * - Free objects from the free list
8072 * - Try to remove keys with an EXPIRE set
8074 * It is not possible to free enough memory to reach used-memory < maxmemory
8075 * the server will start refusing commands that will enlarge even more the
8078 static void freeMemoryIfNeeded(void) {
8079 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8080 int j
, k
, freed
= 0;
8082 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8083 for (j
= 0; j
< server
.dbnum
; j
++) {
8085 robj
*minkey
= NULL
;
8086 struct dictEntry
*de
;
8088 if (dictSize(server
.db
[j
].expires
)) {
8090 /* From a sample of three keys drop the one nearest to
8091 * the natural expire */
8092 for (k
= 0; k
< 3; k
++) {
8095 de
= dictGetRandomKey(server
.db
[j
].expires
);
8096 t
= (time_t) dictGetEntryVal(de
);
8097 if (minttl
== -1 || t
< minttl
) {
8098 minkey
= dictGetEntryKey(de
);
8102 deleteKey(server
.db
+j
,minkey
);
8105 if (!freed
) return; /* nothing to free... */
8109 /* ============================== Append Only file ========================== */
8111 /* Write the append only file buffer on disk.
8113 * Since we are required to write the AOF before replying to the client,
8114 * and the only way the client socket can get a write is entering when the
8115 * the event loop, we accumulate all the AOF writes in a memory
8116 * buffer and write it on disk using this function just before entering
8117 * the event loop again. */
8118 static void flushAppendOnlyFile(void) {
8122 if (sdslen(server
.aofbuf
) == 0) return;
8124 /* We want to perform a single write. This should be guaranteed atomic
8125 * at least if the filesystem we are writing is a real physical one.
8126 * While this will save us against the server being killed I don't think
8127 * there is much to do about the whole server stopping for power problems
8129 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8130 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8131 /* Ooops, we are in troubles. The best thing to do for now is
8132 * aborting instead of giving the illusion that everything is
8133 * working as expected. */
8134 if (nwritten
== -1) {
8135 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8137 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8141 sdsfree(server
.aofbuf
);
8142 server
.aofbuf
= sdsempty();
8144 /* Fsync if needed */
8146 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8147 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8148 now
-server
.lastfsync
> 1))
8150 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8151 * flushing metadata. */
8152 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8153 server
.lastfsync
= now
;
8157 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8158 sds buf
= sdsempty();
8162 /* The DB this command was targetting is not the same as the last command
8163 * we appendend. To issue a SELECT command is needed. */
8164 if (dictid
!= server
.appendseldb
) {
8167 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8168 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8169 (unsigned long)strlen(seldb
),seldb
);
8170 server
.appendseldb
= dictid
;
8173 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8174 * EXPIREs into EXPIREATs calls */
8175 if (cmd
->proc
== expireCommand
) {
8178 tmpargv
[0] = createStringObject("EXPIREAT",8);
8179 tmpargv
[1] = argv
[1];
8180 incrRefCount(argv
[1]);
8181 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8182 tmpargv
[2] = createObject(REDIS_STRING
,
8183 sdscatprintf(sdsempty(),"%ld",when
));
8187 /* Append the actual command */
8188 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8189 for (j
= 0; j
< argc
; j
++) {
8192 o
= getDecodedObject(o
);
8193 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8194 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8195 buf
= sdscatlen(buf
,"\r\n",2);
8199 /* Free the objects from the modified argv for EXPIREAT */
8200 if (cmd
->proc
== expireCommand
) {
8201 for (j
= 0; j
< 3; j
++)
8202 decrRefCount(argv
[j
]);
8205 /* Append to the AOF buffer. This will be flushed on disk just before
8206 * of re-entering the event loop, so before the client will get a
8207 * positive reply about the operation performed. */
8208 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8210 /* If a background append only file rewriting is in progress we want to
8211 * accumulate the differences between the child DB and the current one
8212 * in a buffer, so that when the child process will do its work we
8213 * can append the differences to the new append only file. */
8214 if (server
.bgrewritechildpid
!= -1)
8215 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8220 /* In Redis commands are always executed in the context of a client, so in
8221 * order to load the append only file we need to create a fake client. */
8222 static struct redisClient
*createFakeClient(void) {
8223 struct redisClient
*c
= zmalloc(sizeof(*c
));
8227 c
->querybuf
= sdsempty();
8231 /* We set the fake client as a slave waiting for the synchronization
8232 * so that Redis will not try to send replies to this client. */
8233 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8234 c
->reply
= listCreate();
8235 listSetFreeMethod(c
->reply
,decrRefCount
);
8236 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8237 initClientMultiState(c
);
8241 static void freeFakeClient(struct redisClient
*c
) {
8242 sdsfree(c
->querybuf
);
8243 listRelease(c
->reply
);
8244 freeClientMultiState(c
);
8248 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8249 * error (the append only file is zero-length) REDIS_ERR is returned. On
8250 * fatal error an error message is logged and the program exists. */
8251 int loadAppendOnlyFile(char *filename
) {
8252 struct redisClient
*fakeClient
;
8253 FILE *fp
= fopen(filename
,"r");
8254 struct redis_stat sb
;
8255 unsigned long long loadedkeys
= 0;
8256 int appendonly
= server
.appendonly
;
8258 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8262 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8266 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8267 * to the same file we're about to read. */
8268 server
.appendonly
= 0;
8270 fakeClient
= createFakeClient();
8277 struct redisCommand
*cmd
;
8279 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8285 if (buf
[0] != '*') goto fmterr
;
8287 argv
= zmalloc(sizeof(robj
*)*argc
);
8288 for (j
= 0; j
< argc
; j
++) {
8289 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8290 if (buf
[0] != '$') goto fmterr
;
8291 len
= strtol(buf
+1,NULL
,10);
8292 argsds
= sdsnewlen(NULL
,len
);
8293 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8294 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8295 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8298 /* Command lookup */
8299 cmd
= lookupCommand(argv
[0]->ptr
);
8301 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8304 /* Try object encoding */
8305 if (cmd
->flags
& REDIS_CMD_BULK
)
8306 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8307 /* Run the command in the context of a fake client */
8308 fakeClient
->argc
= argc
;
8309 fakeClient
->argv
= argv
;
8310 cmd
->proc(fakeClient
);
8311 /* Discard the reply objects list from the fake client */
8312 while(listLength(fakeClient
->reply
))
8313 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8314 /* Clean up, ready for the next command */
8315 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8317 /* Handle swapping while loading big datasets when VM is on */
8319 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8320 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8321 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8326 /* This point can only be reached when EOF is reached without errors.
8327 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8328 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8331 freeFakeClient(fakeClient
);
8332 server
.appendonly
= appendonly
;
8337 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8339 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8343 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8347 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8348 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8352 /* Avoid the incr/decr ref count business if possible to help
8353 * copy-on-write (we are often in a child process when this function
8355 * Also makes sure that key objects don't get incrRefCount-ed when VM
8357 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8358 obj
= getDecodedObject(obj
);
8361 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8362 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8363 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8365 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8366 if (decrrc
) decrRefCount(obj
);
8369 if (decrrc
) decrRefCount(obj
);
8373 /* Write binary-safe string into a file in the bulkformat
8374 * $<count>\r\n<payload>\r\n */
8375 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8378 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8379 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8380 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8381 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8385 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8386 static int fwriteBulkDouble(FILE *fp
, double d
) {
8387 char buf
[128], dbuf
[128];
8389 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8390 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8391 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8392 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8396 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8397 static int fwriteBulkLong(FILE *fp
, long l
) {
8398 char buf
[128], lbuf
[128];
8400 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8401 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8402 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8403 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8407 /* Write a sequence of commands able to fully rebuild the dataset into
8408 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8409 static int rewriteAppendOnlyFile(char *filename
) {
8410 dictIterator
*di
= NULL
;
8415 time_t now
= time(NULL
);
8417 /* Note that we have to use a different temp name here compared to the
8418 * one used by rewriteAppendOnlyFileBackground() function. */
8419 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8420 fp
= fopen(tmpfile
,"w");
8422 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8425 for (j
= 0; j
< server
.dbnum
; j
++) {
8426 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8427 redisDb
*db
= server
.db
+j
;
8429 if (dictSize(d
) == 0) continue;
8430 di
= dictGetIterator(d
);
8436 /* SELECT the new DB */
8437 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8438 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8440 /* Iterate this DB writing every entry */
8441 while((de
= dictNext(di
)) != NULL
) {
8446 key
= dictGetEntryKey(de
);
8447 /* If the value for this key is swapped, load a preview in memory.
8448 * We use a "swapped" flag to remember if we need to free the
8449 * value object instead to just increment the ref count anyway
8450 * in order to avoid copy-on-write of pages if we are forked() */
8451 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8452 key
->storage
== REDIS_VM_SWAPPING
) {
8453 o
= dictGetEntryVal(de
);
8456 o
= vmPreviewObject(key
);
8459 expiretime
= getExpire(db
,key
);
8461 /* Save the key and associated value */
8462 if (o
->type
== REDIS_STRING
) {
8463 /* Emit a SET command */
8464 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8465 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8467 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8468 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8469 } else if (o
->type
== REDIS_LIST
) {
8470 /* Emit the RPUSHes needed to rebuild the list */
8471 list
*list
= o
->ptr
;
8475 listRewind(list
,&li
);
8476 while((ln
= listNext(&li
))) {
8477 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8478 robj
*eleobj
= listNodeValue(ln
);
8480 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8481 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8482 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8484 } else if (o
->type
== REDIS_SET
) {
8485 /* Emit the SADDs needed to rebuild the set */
8487 dictIterator
*di
= dictGetIterator(set
);
8490 while((de
= dictNext(di
)) != NULL
) {
8491 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8492 robj
*eleobj
= dictGetEntryKey(de
);
8494 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8495 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8496 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8498 dictReleaseIterator(di
);
8499 } else if (o
->type
== REDIS_ZSET
) {
8500 /* Emit the ZADDs needed to rebuild the sorted set */
8502 dictIterator
*di
= dictGetIterator(zs
->dict
);
8505 while((de
= dictNext(di
)) != NULL
) {
8506 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8507 robj
*eleobj
= dictGetEntryKey(de
);
8508 double *score
= dictGetEntryVal(de
);
8510 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8511 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8512 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8513 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8515 dictReleaseIterator(di
);
8516 } else if (o
->type
== REDIS_HASH
) {
8517 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8519 /* Emit the HSETs needed to rebuild the hash */
8520 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8521 unsigned char *p
= zipmapRewind(o
->ptr
);
8522 unsigned char *field
, *val
;
8523 unsigned int flen
, vlen
;
8525 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8526 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8527 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8528 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8530 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8534 dictIterator
*di
= dictGetIterator(o
->ptr
);
8537 while((de
= dictNext(di
)) != NULL
) {
8538 robj
*field
= dictGetEntryKey(de
);
8539 robj
*val
= dictGetEntryVal(de
);
8541 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8542 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8543 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8544 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8546 dictReleaseIterator(di
);
8549 redisPanic("Unknown object type");
8551 /* Save the expire time */
8552 if (expiretime
!= -1) {
8553 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8554 /* If this key is already expired skip it */
8555 if (expiretime
< now
) continue;
8556 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8557 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8558 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8560 if (swapped
) decrRefCount(o
);
8562 dictReleaseIterator(di
);
8565 /* Make sure data will not remain on the OS's output buffers */
8570 /* Use RENAME to make sure the DB file is changed atomically only
8571 * if the generate DB file is ok. */
8572 if (rename(tmpfile
,filename
) == -1) {
8573 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8577 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8583 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8584 if (di
) dictReleaseIterator(di
);
8588 /* This is how rewriting of the append only file in background works:
8590 * 1) The user calls BGREWRITEAOF
8591 * 2) Redis calls this function, that forks():
8592 * 2a) the child rewrite the append only file in a temp file.
8593 * 2b) the parent accumulates differences in server.bgrewritebuf.
8594 * 3) When the child finished '2a' exists.
8595 * 4) The parent will trap the exit code, if it's OK, will append the
8596 * data accumulated into server.bgrewritebuf into the temp file, and
8597 * finally will rename(2) the temp file in the actual file name.
8598 * The the new file is reopened as the new append only file. Profit!
8600 static int rewriteAppendOnlyFileBackground(void) {
8603 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8604 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8605 if ((childpid
= fork()) == 0) {
8609 if (server
.vm_enabled
) vmReopenSwapFile();
8611 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8612 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8619 if (childpid
== -1) {
8620 redisLog(REDIS_WARNING
,
8621 "Can't rewrite append only file in background: fork: %s",
8625 redisLog(REDIS_NOTICE
,
8626 "Background append only file rewriting started by pid %d",childpid
);
8627 server
.bgrewritechildpid
= childpid
;
8628 updateDictResizePolicy();
8629 /* We set appendseldb to -1 in order to force the next call to the
8630 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8631 * accumulated by the parent into server.bgrewritebuf will start
8632 * with a SELECT statement and it will be safe to merge. */
8633 server
.appendseldb
= -1;
8636 return REDIS_OK
; /* unreached */
8639 static void bgrewriteaofCommand(redisClient
*c
) {
8640 if (server
.bgrewritechildpid
!= -1) {
8641 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8644 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8645 char *status
= "+Background append only file rewriting started\r\n";
8646 addReplySds(c
,sdsnew(status
));
8648 addReply(c
,shared
.err
);
8652 static void aofRemoveTempFile(pid_t childpid
) {
8655 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8659 /* Virtual Memory is composed mainly of two subsystems:
8660 * - Blocking Virutal Memory
8661 * - Threaded Virtual Memory I/O
8662 * The two parts are not fully decoupled, but functions are split among two
8663 * different sections of the source code (delimited by comments) in order to
8664 * make more clear what functionality is about the blocking VM and what about
8665 * the threaded (not blocking) VM.
8669 * Redis VM is a blocking VM (one that blocks reading swapped values from
8670 * disk into memory when a value swapped out is needed in memory) that is made
8671 * unblocking by trying to examine the command argument vector in order to
8672 * load in background values that will likely be needed in order to exec
8673 * the command. The command is executed only once all the relevant keys
8674 * are loaded into memory.
8676 * This basically is almost as simple of a blocking VM, but almost as parallel
8677 * as a fully non-blocking VM.
8680 /* =================== Virtual Memory - Blocking Side ====================== */
8682 static void vmInit(void) {
8688 if (server
.vm_max_threads
!= 0)
8689 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8691 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8692 /* Try to open the old swap file, otherwise create it */
8693 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8694 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8696 if (server
.vm_fp
== NULL
) {
8697 redisLog(REDIS_WARNING
,
8698 "Can't open the swap file: %s. Exiting.",
8702 server
.vm_fd
= fileno(server
.vm_fp
);
8703 /* Lock the swap file for writing, this is useful in order to avoid
8704 * another instance to use the same swap file for a config error. */
8705 fl
.l_type
= F_WRLCK
;
8706 fl
.l_whence
= SEEK_SET
;
8707 fl
.l_start
= fl
.l_len
= 0;
8708 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8709 redisLog(REDIS_WARNING
,
8710 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server
.vm_swap_file
, strerror(errno
));
8714 server
.vm_next_page
= 0;
8715 server
.vm_near_pages
= 0;
8716 server
.vm_stats_used_pages
= 0;
8717 server
.vm_stats_swapped_objects
= 0;
8718 server
.vm_stats_swapouts
= 0;
8719 server
.vm_stats_swapins
= 0;
8720 totsize
= server
.vm_pages
*server
.vm_page_size
;
8721 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8722 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8723 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8727 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8729 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8730 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8731 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8732 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8734 /* Initialize threaded I/O (used by Virtual Memory) */
8735 server
.io_newjobs
= listCreate();
8736 server
.io_processing
= listCreate();
8737 server
.io_processed
= listCreate();
8738 server
.io_ready_clients
= listCreate();
8739 pthread_mutex_init(&server
.io_mutex
,NULL
);
8740 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8741 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8742 server
.io_active_threads
= 0;
8743 if (pipe(pipefds
) == -1) {
8744 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8748 server
.io_ready_pipe_read
= pipefds
[0];
8749 server
.io_ready_pipe_write
= pipefds
[1];
8750 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8751 /* LZF requires a lot of stack */
8752 pthread_attr_init(&server
.io_threads_attr
);
8753 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8754 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8755 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8756 /* Listen for events in the threaded I/O pipe */
8757 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8758 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8759 oom("creating file event");
8762 /* Mark the page as used */
8763 static void vmMarkPageUsed(off_t page
) {
8764 off_t byte
= page
/8;
8766 redisAssert(vmFreePage(page
) == 1);
8767 server
.vm_bitmap
[byte
] |= 1<<bit
;
8770 /* Mark N contiguous pages as used, with 'page' being the first. */
8771 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8774 for (j
= 0; j
< count
; j
++)
8775 vmMarkPageUsed(page
+j
);
8776 server
.vm_stats_used_pages
+= count
;
8777 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8778 (long long)count
, (long long)page
);
8781 /* Mark the page as free */
8782 static void vmMarkPageFree(off_t page
) {
8783 off_t byte
= page
/8;
8785 redisAssert(vmFreePage(page
) == 0);
8786 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8789 /* Mark N contiguous pages as free, with 'page' being the first. */
8790 static void vmMarkPagesFree(off_t page
, off_t count
) {
8793 for (j
= 0; j
< count
; j
++)
8794 vmMarkPageFree(page
+j
);
8795 server
.vm_stats_used_pages
-= count
;
8796 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8797 (long long)count
, (long long)page
);
8800 /* Test if the page is free */
8801 static int vmFreePage(off_t page
) {
8802 off_t byte
= page
/8;
8804 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8807 /* Find N contiguous free pages storing the first page of the cluster in *first.
8808 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8809 * REDIS_ERR is returned.
8811 * This function uses a simple algorithm: we try to allocate
8812 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8813 * again from the start of the swap file searching for free spaces.
8815 * If it looks pretty clear that there are no free pages near our offset
8816 * we try to find less populated places doing a forward jump of
8817 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8818 * without hurry, and then we jump again and so forth...
8820 * This function can be improved using a free list to avoid to guess
8821 * too much, since we could collect data about freed pages.
8823 * note: I implemented this function just after watching an episode of
8824 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8826 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8827 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8829 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8830 server
.vm_near_pages
= 0;
8831 server
.vm_next_page
= 0;
8833 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8834 base
= server
.vm_next_page
;
8836 while(offset
< server
.vm_pages
) {
8837 off_t
this = base
+offset
;
8839 /* If we overflow, restart from page zero */
8840 if (this >= server
.vm_pages
) {
8841 this -= server
.vm_pages
;
8843 /* Just overflowed, what we found on tail is no longer
8844 * interesting, as it's no longer contiguous. */
8848 if (vmFreePage(this)) {
8849 /* This is a free page */
8851 /* Already got N free pages? Return to the caller, with success */
8853 *first
= this-(n
-1);
8854 server
.vm_next_page
= this+1;
8855 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8859 /* The current one is not a free page */
8863 /* Fast-forward if the current page is not free and we already
8864 * searched enough near this place. */
8866 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8867 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8869 /* Note that even if we rewind after the jump, we are don't need
8870 * to make sure numfree is set to zero as we only jump *if* it
8871 * is set to zero. */
8873 /* Otherwise just check the next page */
8880 /* Write the specified object at the specified page of the swap file */
8881 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8882 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8883 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8884 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8885 redisLog(REDIS_WARNING
,
8886 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8890 rdbSaveObject(server
.vm_fp
,o
);
8891 fflush(server
.vm_fp
);
8892 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8896 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8897 * needed to later retrieve the object into the key object.
8898 * If we can't find enough contiguous empty pages to swap the object on disk
8899 * REDIS_ERR is returned. */
8900 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8901 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8904 assert(key
->storage
== REDIS_VM_MEMORY
);
8905 assert(key
->refcount
== 1);
8906 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8907 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8908 key
->vm
.page
= page
;
8909 key
->vm
.usedpages
= pages
;
8910 key
->storage
= REDIS_VM_SWAPPED
;
8911 key
->vtype
= val
->type
;
8912 decrRefCount(val
); /* Deallocate the object from memory. */
8913 vmMarkPagesUsed(page
,pages
);
8914 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8915 (unsigned char*) key
->ptr
,
8916 (unsigned long long) page
, (unsigned long long) pages
);
8917 server
.vm_stats_swapped_objects
++;
8918 server
.vm_stats_swapouts
++;
8922 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8925 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8926 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8927 redisLog(REDIS_WARNING
,
8928 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8932 o
= rdbLoadObject(type
,server
.vm_fp
);
8934 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8937 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8941 /* Load the value object relative to the 'key' object from swap to memory.
8942 * The newly allocated object is returned.
8944 * If preview is true the unserialized object is returned to the caller but
8945 * no changes are made to the key object, nor the pages are marked as freed */
8946 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8949 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8950 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8952 key
->storage
= REDIS_VM_MEMORY
;
8953 key
->vm
.atime
= server
.unixtime
;
8954 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8955 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8956 (unsigned char*) key
->ptr
);
8957 server
.vm_stats_swapped_objects
--;
8959 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8960 (unsigned char*) key
->ptr
);
8962 server
.vm_stats_swapins
++;
8966 /* Plain object loading, from swap to memory */
8967 static robj
*vmLoadObject(robj
*key
) {
8968 /* If we are loading the object in background, stop it, we
8969 * need to load this object synchronously ASAP. */
8970 if (key
->storage
== REDIS_VM_LOADING
)
8971 vmCancelThreadedIOJob(key
);
8972 return vmGenericLoadObject(key
,0);
8975 /* Just load the value on disk, without to modify the key.
8976 * This is useful when we want to perform some operation on the value
8977 * without to really bring it from swap to memory, like while saving the
8978 * dataset or rewriting the append only log. */
8979 static robj
*vmPreviewObject(robj
*key
) {
8980 return vmGenericLoadObject(key
,1);
8983 /* How a good candidate is this object for swapping?
8984 * The better candidate it is, the greater the returned value.
8986 * Currently we try to perform a fast estimation of the object size in
8987 * memory, and combine it with aging informations.
8989 * Basically swappability = idle-time * log(estimated size)
8991 * Bigger objects are preferred over smaller objects, but not
8992 * proportionally, this is why we use the logarithm. This algorithm is
8993 * just a first try and will probably be tuned later. */
8994 static double computeObjectSwappability(robj
*o
) {
8995 time_t age
= server
.unixtime
- o
->vm
.atime
;
8999 struct dictEntry
*de
;
9002 if (age
<= 0) return 0;
9005 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9008 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9013 listNode
*ln
= listFirst(l
);
9015 asize
= sizeof(list
);
9017 robj
*ele
= ln
->value
;
9020 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9021 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9023 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9028 z
= (o
->type
== REDIS_ZSET
);
9029 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9031 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9032 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9037 de
= dictGetRandomKey(d
);
9038 ele
= dictGetEntryKey(de
);
9039 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9040 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9042 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9043 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9047 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9048 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9049 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9050 unsigned int klen
, vlen
;
9051 unsigned char *key
, *val
;
9053 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9057 asize
= len
*(klen
+vlen
+3);
9058 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9060 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9065 de
= dictGetRandomKey(d
);
9066 ele
= dictGetEntryKey(de
);
9067 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9068 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9070 ele
= dictGetEntryVal(de
);
9071 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9072 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9074 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9079 return (double)age
*log(1+asize
);
9082 /* Try to swap an object that's a good candidate for swapping.
9083 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9084 * to swap any object at all.
9086 * If 'usethreaded' is true, Redis will try to swap the object in background
9087 * using I/O threads. */
9088 static int vmSwapOneObject(int usethreads
) {
9090 struct dictEntry
*best
= NULL
;
9091 double best_swappability
= 0;
9092 redisDb
*best_db
= NULL
;
9095 for (j
= 0; j
< server
.dbnum
; j
++) {
9096 redisDb
*db
= server
.db
+j
;
9097 /* Why maxtries is set to 100?
9098 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9099 * are swappable objects */
9102 if (dictSize(db
->dict
) == 0) continue;
9103 for (i
= 0; i
< 5; i
++) {
9105 double swappability
;
9107 if (maxtries
) maxtries
--;
9108 de
= dictGetRandomKey(db
->dict
);
9109 key
= dictGetEntryKey(de
);
9110 val
= dictGetEntryVal(de
);
9111 /* Only swap objects that are currently in memory.
9113 * Also don't swap shared objects if threaded VM is on, as we
9114 * try to ensure that the main thread does not touch the
9115 * object while the I/O thread is using it, but we can't
9116 * control other keys without adding additional mutex. */
9117 if (key
->storage
!= REDIS_VM_MEMORY
||
9118 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9119 if (maxtries
) i
--; /* don't count this try */
9122 swappability
= computeObjectSwappability(val
);
9123 if (!best
|| swappability
> best_swappability
) {
9125 best_swappability
= swappability
;
9130 if (best
== NULL
) return REDIS_ERR
;
9131 key
= dictGetEntryKey(best
);
9132 val
= dictGetEntryVal(best
);
9134 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9135 key
->ptr
, best_swappability
);
9137 /* Unshare the key if needed */
9138 if (key
->refcount
> 1) {
9139 robj
*newkey
= dupStringObject(key
);
9141 key
= dictGetEntryKey(best
) = newkey
;
9145 vmSwapObjectThreaded(key
,val
,best_db
);
9148 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9149 dictGetEntryVal(best
) = NULL
;
9157 static int vmSwapOneObjectBlocking() {
9158 return vmSwapOneObject(0);
9161 static int vmSwapOneObjectThreaded() {
9162 return vmSwapOneObject(1);
9165 /* Return true if it's safe to swap out objects in a given moment.
9166 * Basically we don't want to swap objects out while there is a BGSAVE
9167 * or a BGAEOREWRITE running in backgroud. */
9168 static int vmCanSwapOut(void) {
9169 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9172 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9173 * and was deleted. Otherwise 0 is returned. */
9174 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9178 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9179 foundkey
= dictGetEntryKey(de
);
9180 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9185 /* =================== Virtual Memory - Threaded I/O ======================= */
9187 static void freeIOJob(iojob
*j
) {
9188 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9189 j
->type
== REDIS_IOJOB_DO_SWAP
||
9190 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9191 decrRefCount(j
->val
);
9192 /* We don't decrRefCount the j->key field as we did't incremented
9193 * the count creating IO Jobs. This is because the key field here is
9194 * just used as an indentifier and if a key is removed the Job should
9195 * never be touched again. */
9199 /* Every time a thread finished a Job, it writes a byte into the write side
9200 * of an unix pipe in order to "awake" the main thread, and this function
9202 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9206 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9208 REDIS_NOTUSED(mask
);
9209 REDIS_NOTUSED(privdata
);
9211 /* For every byte we read in the read side of the pipe, there is one
9212 * I/O job completed to process. */
9213 while((retval
= read(fd
,buf
,1)) == 1) {
9217 struct dictEntry
*de
;
9219 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9221 /* Get the processed element (the oldest one) */
9223 assert(listLength(server
.io_processed
) != 0);
9224 if (toprocess
== -1) {
9225 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9226 if (toprocess
<= 0) toprocess
= 1;
9228 ln
= listFirst(server
.io_processed
);
9230 listDelNode(server
.io_processed
,ln
);
9232 /* If this job is marked as canceled, just ignore it */
9237 /* Post process it in the main thread, as there are things we
9238 * can do just here to avoid race conditions and/or invasive locks */
9239 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
);
9240 de
= dictFind(j
->db
->dict
,j
->key
);
9242 key
= dictGetEntryKey(de
);
9243 if (j
->type
== REDIS_IOJOB_LOAD
) {
9246 /* Key loaded, bring it at home */
9247 key
->storage
= REDIS_VM_MEMORY
;
9248 key
->vm
.atime
= server
.unixtime
;
9249 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9250 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9251 (unsigned char*) key
->ptr
);
9252 server
.vm_stats_swapped_objects
--;
9253 server
.vm_stats_swapins
++;
9254 dictGetEntryVal(de
) = j
->val
;
9255 incrRefCount(j
->val
);
9258 /* Handle clients waiting for this key to be loaded. */
9259 handleClientsBlockedOnSwappedKey(db
,key
);
9260 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9261 /* Now we know the amount of pages required to swap this object.
9262 * Let's find some space for it, and queue this task again
9263 * rebranded as REDIS_IOJOB_DO_SWAP. */
9264 if (!vmCanSwapOut() ||
9265 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9267 /* Ooops... no space or we can't swap as there is
9268 * a fork()ed Redis trying to save stuff on disk. */
9270 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9272 /* Note that we need to mark this pages as used now,
9273 * if the job will be canceled, we'll mark them as freed
9275 vmMarkPagesUsed(j
->page
,j
->pages
);
9276 j
->type
= REDIS_IOJOB_DO_SWAP
;
9281 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9284 /* Key swapped. We can finally free some memory. */
9285 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9286 printf("key->storage: %d\n",key
->storage
);
9287 printf("key->name: %s\n",(char*)key
->ptr
);
9288 printf("key->refcount: %d\n",key
->refcount
);
9289 printf("val: %p\n",(void*)j
->val
);
9290 printf("val->type: %d\n",j
->val
->type
);
9291 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9293 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9294 val
= dictGetEntryVal(de
);
9295 key
->vm
.page
= j
->page
;
9296 key
->vm
.usedpages
= j
->pages
;
9297 key
->storage
= REDIS_VM_SWAPPED
;
9298 key
->vtype
= j
->val
->type
;
9299 decrRefCount(val
); /* Deallocate the object from memory. */
9300 dictGetEntryVal(de
) = NULL
;
9301 redisLog(REDIS_DEBUG
,
9302 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9303 (unsigned char*) key
->ptr
,
9304 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9305 server
.vm_stats_swapped_objects
++;
9306 server
.vm_stats_swapouts
++;
9308 /* Put a few more swap requests in queue if we are still
9310 if (trytoswap
&& vmCanSwapOut() &&
9311 zmalloc_used_memory() > server
.vm_max_memory
)
9316 more
= listLength(server
.io_newjobs
) <
9317 (unsigned) server
.vm_max_threads
;
9319 /* Don't waste CPU time if swappable objects are rare. */
9320 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9328 if (processed
== toprocess
) return;
9330 if (retval
< 0 && errno
!= EAGAIN
) {
9331 redisLog(REDIS_WARNING
,
9332 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9337 static void lockThreadedIO(void) {
9338 pthread_mutex_lock(&server
.io_mutex
);
9341 static void unlockThreadedIO(void) {
9342 pthread_mutex_unlock(&server
.io_mutex
);
9345 /* Remove the specified object from the threaded I/O queue if still not
9346 * processed, otherwise make sure to flag it as canceled. */
9347 static void vmCancelThreadedIOJob(robj
*o
) {
9349 server
.io_newjobs
, /* 0 */
9350 server
.io_processing
, /* 1 */
9351 server
.io_processed
/* 2 */
9355 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9358 /* Search for a matching key in one of the queues */
9359 for (i
= 0; i
< 3; i
++) {
9363 listRewind(lists
[i
],&li
);
9364 while ((ln
= listNext(&li
)) != NULL
) {
9365 iojob
*job
= ln
->value
;
9367 if (job
->canceled
) continue; /* Skip this, already canceled. */
9368 if (job
->key
== o
) {
9369 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9370 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9371 /* Mark the pages as free since the swap didn't happened
9372 * or happened but is now discarded. */
9373 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9374 vmMarkPagesFree(job
->page
,job
->pages
);
9375 /* Cancel the job. It depends on the list the job is
9378 case 0: /* io_newjobs */
9379 /* If the job was yet not processed the best thing to do
9380 * is to remove it from the queue at all */
9382 listDelNode(lists
[i
],ln
);
9384 case 1: /* io_processing */
9385 /* Oh Shi- the thread is messing with the Job:
9387 * Probably it's accessing the object if this is a
9388 * PREPARE_SWAP or DO_SWAP job.
9389 * If it's a LOAD job it may be reading from disk and
9390 * if we don't wait for the job to terminate before to
9391 * cancel it, maybe in a few microseconds data can be
9392 * corrupted in this pages. So the short story is:
9394 * Better to wait for the job to move into the
9395 * next queue (processed)... */
9397 /* We try again and again until the job is completed. */
9399 /* But let's wait some time for the I/O thread
9400 * to finish with this job. After all this condition
9401 * should be very rare. */
9404 case 2: /* io_processed */
9405 /* The job was already processed, that's easy...
9406 * just mark it as canceled so that we'll ignore it
9407 * when processing completed jobs. */
9411 /* Finally we have to adjust the storage type of the object
9412 * in order to "UNDO" the operaiton. */
9413 if (o
->storage
== REDIS_VM_LOADING
)
9414 o
->storage
= REDIS_VM_SWAPPED
;
9415 else if (o
->storage
== REDIS_VM_SWAPPING
)
9416 o
->storage
= REDIS_VM_MEMORY
;
9423 assert(1 != 1); /* We should never reach this */
9426 static void *IOThreadEntryPoint(void *arg
) {
9431 pthread_detach(pthread_self());
9433 /* Get a new job to process */
9435 if (listLength(server
.io_newjobs
) == 0) {
9436 /* No new jobs in queue, exit. */
9437 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9438 (long) pthread_self());
9439 server
.io_active_threads
--;
9443 ln
= listFirst(server
.io_newjobs
);
9445 listDelNode(server
.io_newjobs
,ln
);
9446 /* Add the job in the processing queue */
9447 j
->thread
= pthread_self();
9448 listAddNodeTail(server
.io_processing
,j
);
9449 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9451 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9452 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9454 /* Process the Job */
9455 if (j
->type
== REDIS_IOJOB_LOAD
) {
9456 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9457 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9458 FILE *fp
= fopen("/dev/null","w+");
9459 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9461 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9462 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9466 /* Done: insert the job into the processed queue */
9467 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9468 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9470 listDelNode(server
.io_processing
,ln
);
9471 listAddNodeTail(server
.io_processed
,j
);
9474 /* Signal the main thread there is new stuff to process */
9475 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9477 return NULL
; /* never reached */
9480 static void spawnIOThread(void) {
9482 sigset_t mask
, omask
;
9486 sigaddset(&mask
,SIGCHLD
);
9487 sigaddset(&mask
,SIGHUP
);
9488 sigaddset(&mask
,SIGPIPE
);
9489 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9490 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9491 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9495 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9496 server
.io_active_threads
++;
9499 /* We need to wait for the last thread to exit before we are able to
9500 * fork() in order to BGSAVE or BGREWRITEAOF. */
9501 static void waitEmptyIOJobsQueue(void) {
9503 int io_processed_len
;
9506 if (listLength(server
.io_newjobs
) == 0 &&
9507 listLength(server
.io_processing
) == 0 &&
9508 server
.io_active_threads
== 0)
9513 /* While waiting for empty jobs queue condition we post-process some
9514 * finshed job, as I/O threads may be hanging trying to write against
9515 * the io_ready_pipe_write FD but there are so much pending jobs that
9517 io_processed_len
= listLength(server
.io_processed
);
9519 if (io_processed_len
) {
9520 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9521 usleep(1000); /* 1 millisecond */
9523 usleep(10000); /* 10 milliseconds */
9528 static void vmReopenSwapFile(void) {
9529 /* Note: we don't close the old one as we are in the child process
9530 * and don't want to mess at all with the original file object. */
9531 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9532 if (server
.vm_fp
== NULL
) {
9533 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9534 server
.vm_swap_file
);
9537 server
.vm_fd
= fileno(server
.vm_fp
);
9540 /* This function must be called while with threaded IO locked */
9541 static void queueIOJob(iojob
*j
) {
9542 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9543 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9544 listAddNodeTail(server
.io_newjobs
,j
);
9545 if (server
.io_active_threads
< server
.vm_max_threads
)
9549 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9552 assert(key
->storage
== REDIS_VM_MEMORY
);
9553 assert(key
->refcount
== 1);
9555 j
= zmalloc(sizeof(*j
));
9556 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9562 j
->thread
= (pthread_t
) -1;
9563 key
->storage
= REDIS_VM_SWAPPING
;
9571 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9573 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9574 * If there is not already a job loading the key, it is craeted.
9575 * The key is added to the io_keys list in the client structure, and also
9576 * in the hash table mapping swapped keys to waiting clients, that is,
9577 * server.io_waited_keys. */
9578 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9579 struct dictEntry
*de
;
9583 /* If the key does not exist or is already in RAM we don't need to
9584 * block the client at all. */
9585 de
= dictFind(c
->db
->dict
,key
);
9586 if (de
== NULL
) return 0;
9587 o
= dictGetEntryKey(de
);
9588 if (o
->storage
== REDIS_VM_MEMORY
) {
9590 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9591 /* We were swapping the key, undo it! */
9592 vmCancelThreadedIOJob(o
);
9596 /* OK: the key is either swapped, or being loaded just now. */
9598 /* Add the key to the list of keys this client is waiting for.
9599 * This maps clients to keys they are waiting for. */
9600 listAddNodeTail(c
->io_keys
,key
);
9603 /* Add the client to the swapped keys => clients waiting map. */
9604 de
= dictFind(c
->db
->io_keys
,key
);
9608 /* For every key we take a list of clients blocked for it */
9610 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9612 assert(retval
== DICT_OK
);
9614 l
= dictGetEntryVal(de
);
9616 listAddNodeTail(l
,c
);
9618 /* Are we already loading the key from disk? If not create a job */
9619 if (o
->storage
== REDIS_VM_SWAPPED
) {
9622 o
->storage
= REDIS_VM_LOADING
;
9623 j
= zmalloc(sizeof(*j
));
9624 j
->type
= REDIS_IOJOB_LOAD
;
9627 j
->key
->vtype
= o
->vtype
;
9628 j
->page
= o
->vm
.page
;
9631 j
->thread
= (pthread_t
) -1;
9639 /* Preload keys needed for the ZUNION and ZINTER commands. */
9640 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9642 num
= atoi(c
->argv
[2]->ptr
);
9643 for (i
= 0; i
< num
; i
++) {
9644 waitForSwappedKey(c
,c
->argv
[3+i
]);
9648 /* Is this client attempting to run a command against swapped keys?
9649 * If so, block it ASAP, load the keys in background, then resume it.
9651 * The important idea about this function is that it can fail! If keys will
9652 * still be swapped when the client is resumed, this key lookups will
9653 * just block loading keys from disk. In practical terms this should only
9654 * happen with SORT BY command or if there is a bug in this function.
9656 * Return 1 if the client is marked as blocked, 0 if the client can
9657 * continue as the keys it is going to access appear to be in memory. */
9658 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9661 if (cmd
->vm_preload_proc
!= NULL
) {
9662 cmd
->vm_preload_proc(c
);
9664 if (cmd
->vm_firstkey
== 0) return 0;
9665 last
= cmd
->vm_lastkey
;
9666 if (last
< 0) last
= c
->argc
+last
;
9667 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9668 waitForSwappedKey(c
,c
->argv
[j
]);
9671 /* If the client was blocked for at least one key, mark it as blocked. */
9672 if (listLength(c
->io_keys
)) {
9673 c
->flags
|= REDIS_IO_WAIT
;
9674 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9675 server
.vm_blocked_clients
++;
9682 /* Remove the 'key' from the list of blocked keys for a given client.
9684 * The function returns 1 when there are no longer blocking keys after
9685 * the current one was removed (and the client can be unblocked). */
9686 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9690 struct dictEntry
*de
;
9692 /* Remove the key from the list of keys this client is waiting for. */
9693 listRewind(c
->io_keys
,&li
);
9694 while ((ln
= listNext(&li
)) != NULL
) {
9695 if (equalStringObjects(ln
->value
,key
)) {
9696 listDelNode(c
->io_keys
,ln
);
9702 /* Remove the client form the key => waiting clients map. */
9703 de
= dictFind(c
->db
->io_keys
,key
);
9705 l
= dictGetEntryVal(de
);
9706 ln
= listSearchKey(l
,c
);
9709 if (listLength(l
) == 0)
9710 dictDelete(c
->db
->io_keys
,key
);
9712 return listLength(c
->io_keys
) == 0;
9715 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9716 struct dictEntry
*de
;
9721 de
= dictFind(db
->io_keys
,key
);
9724 l
= dictGetEntryVal(de
);
9725 len
= listLength(l
);
9726 /* Note: we can't use something like while(listLength(l)) as the list
9727 * can be freed by the calling function when we remove the last element. */
9730 redisClient
*c
= ln
->value
;
9732 if (dontWaitForSwappedKey(c
,key
)) {
9733 /* Put the client in the list of clients ready to go as we
9734 * loaded all the keys about it. */
9735 listAddNodeTail(server
.io_ready_clients
,c
);
9740 /* =========================== Remote Configuration ========================= */
9742 static void configSetCommand(redisClient
*c
) {
9743 robj
*o
= getDecodedObject(c
->argv
[3]);
9744 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9745 zfree(server
.dbfilename
);
9746 server
.dbfilename
= zstrdup(o
->ptr
);
9747 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9748 zfree(server
.requirepass
);
9749 server
.requirepass
= zstrdup(o
->ptr
);
9750 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9751 zfree(server
.masterauth
);
9752 server
.masterauth
= zstrdup(o
->ptr
);
9753 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9754 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9755 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
9756 if (!strcasecmp(o
->ptr
,"no")) {
9757 server
.appendfsync
= APPENDFSYNC_NO
;
9758 } else if (!strcasecmp(o
->ptr
,"everysec")) {
9759 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
9760 } else if (!strcasecmp(o
->ptr
,"always")) {
9761 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
9765 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
9767 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
9769 /* Perform sanity check before setting the new config:
9770 * - Even number of args
9771 * - Seconds >= 1, changes >= 0 */
9773 sdsfreesplitres(v
,vlen
);
9776 for (j
= 0; j
< vlen
; j
++) {
9780 val
= strtoll(v
[j
], &eptr
, 10);
9781 if (eptr
[0] != '\0' ||
9782 ((j
& 1) == 0 && val
< 1) ||
9783 ((j
& 1) == 1 && val
< 0)) {
9784 sdsfreesplitres(v
,vlen
);
9788 /* Finally set the new config */
9789 resetServerSaveParams();
9790 for (j
= 0; j
< vlen
; j
+= 2) {
9794 seconds
= strtoll(v
[j
],NULL
,10);
9795 changes
= strtoll(v
[j
+1],NULL
,10);
9796 appendServerSaveParams(seconds
, changes
);
9798 sdsfreesplitres(v
,vlen
);
9800 addReplySds(c
,sdscatprintf(sdsempty(),
9801 "-ERR not supported CONFIG parameter %s\r\n",
9802 (char*)c
->argv
[2]->ptr
));
9807 addReply(c
,shared
.ok
);
9810 badfmt
: /* Bad format errors */
9811 addReplySds(c
,sdscatprintf(sdsempty(),
9812 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9814 (char*)c
->argv
[2]->ptr
));
9818 static void configGetCommand(redisClient
*c
) {
9819 robj
*o
= getDecodedObject(c
->argv
[2]);
9820 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9821 char *pattern
= o
->ptr
;
9825 decrRefCount(lenobj
);
9827 if (stringmatch(pattern
,"dbfilename",0)) {
9828 addReplyBulkCString(c
,"dbfilename");
9829 addReplyBulkCString(c
,server
.dbfilename
);
9832 if (stringmatch(pattern
,"requirepass",0)) {
9833 addReplyBulkCString(c
,"requirepass");
9834 addReplyBulkCString(c
,server
.requirepass
);
9837 if (stringmatch(pattern
,"masterauth",0)) {
9838 addReplyBulkCString(c
,"masterauth");
9839 addReplyBulkCString(c
,server
.masterauth
);
9842 if (stringmatch(pattern
,"maxmemory",0)) {
9845 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9846 addReplyBulkCString(c
,"maxmemory");
9847 addReplyBulkCString(c
,buf
);
9850 if (stringmatch(pattern
,"appendfsync",0)) {
9853 switch(server
.appendfsync
) {
9854 case APPENDFSYNC_NO
: policy
= "no"; break;
9855 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
9856 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
9857 default: policy
= "unknown"; break; /* too harmless to panic */
9859 addReplyBulkCString(c
,"appendfsync");
9860 addReplyBulkCString(c
,policy
);
9863 if (stringmatch(pattern
,"save",0)) {
9864 sds buf
= sdsempty();
9867 for (j
= 0; j
< server
.saveparamslen
; j
++) {
9868 buf
= sdscatprintf(buf
,"%ld %d",
9869 server
.saveparams
[j
].seconds
,
9870 server
.saveparams
[j
].changes
);
9871 if (j
!= server
.saveparamslen
-1)
9872 buf
= sdscatlen(buf
," ",1);
9874 addReplyBulkCString(c
,"save");
9875 addReplyBulkCString(c
,buf
);
9880 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9883 static void configCommand(redisClient
*c
) {
9884 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9885 if (c
->argc
!= 4) goto badarity
;
9886 configSetCommand(c
);
9887 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9888 if (c
->argc
!= 3) goto badarity
;
9889 configGetCommand(c
);
9890 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9891 if (c
->argc
!= 2) goto badarity
;
9892 server
.stat_numcommands
= 0;
9893 server
.stat_numconnections
= 0;
9894 server
.stat_expiredkeys
= 0;
9895 server
.stat_starttime
= time(NULL
);
9896 addReply(c
,shared
.ok
);
9898 addReplySds(c
,sdscatprintf(sdsempty(),
9899 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9904 addReplySds(c
,sdscatprintf(sdsempty(),
9905 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9906 (char*) c
->argv
[1]->ptr
));
9909 /* =========================== Pubsub implementation ======================== */
9911 static void freePubsubPattern(void *p
) {
9912 pubsubPattern
*pat
= p
;
9914 decrRefCount(pat
->pattern
);
9918 static int listMatchPubsubPattern(void *a
, void *b
) {
9919 pubsubPattern
*pa
= a
, *pb
= b
;
9921 return (pa
->client
== pb
->client
) &&
9922 (equalStringObjects(pa
->pattern
,pb
->pattern
));
9925 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9926 * 0 if the client was already subscribed to that channel. */
9927 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9928 struct dictEntry
*de
;
9929 list
*clients
= NULL
;
9932 /* Add the channel to the client -> channels hash table */
9933 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9935 incrRefCount(channel
);
9936 /* Add the client to the channel -> list of clients hash table */
9937 de
= dictFind(server
.pubsub_channels
,channel
);
9939 clients
= listCreate();
9940 dictAdd(server
.pubsub_channels
,channel
,clients
);
9941 incrRefCount(channel
);
9943 clients
= dictGetEntryVal(de
);
9945 listAddNodeTail(clients
,c
);
9947 /* Notify the client */
9948 addReply(c
,shared
.mbulk3
);
9949 addReply(c
,shared
.subscribebulk
);
9950 addReplyBulk(c
,channel
);
9951 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9955 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9956 * 0 if the client was not subscribed to the specified channel. */
9957 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9958 struct dictEntry
*de
;
9963 /* Remove the channel from the client -> channels hash table */
9964 incrRefCount(channel
); /* channel may be just a pointer to the same object
9965 we have in the hash tables. Protect it... */
9966 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9968 /* Remove the client from the channel -> clients list hash table */
9969 de
= dictFind(server
.pubsub_channels
,channel
);
9971 clients
= dictGetEntryVal(de
);
9972 ln
= listSearchKey(clients
,c
);
9974 listDelNode(clients
,ln
);
9975 if (listLength(clients
) == 0) {
9976 /* Free the list and associated hash entry at all if this was
9977 * the latest client, so that it will be possible to abuse
9978 * Redis PUBSUB creating millions of channels. */
9979 dictDelete(server
.pubsub_channels
,channel
);
9982 /* Notify the client */
9984 addReply(c
,shared
.mbulk3
);
9985 addReply(c
,shared
.unsubscribebulk
);
9986 addReplyBulk(c
,channel
);
9987 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9988 listLength(c
->pubsub_patterns
));
9991 decrRefCount(channel
); /* it is finally safe to release it */
9995 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9996 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9999 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10001 pubsubPattern
*pat
;
10002 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10003 incrRefCount(pattern
);
10004 pat
= zmalloc(sizeof(*pat
));
10005 pat
->pattern
= getDecodedObject(pattern
);
10007 listAddNodeTail(server
.pubsub_patterns
,pat
);
10009 /* Notify the client */
10010 addReply(c
,shared
.mbulk3
);
10011 addReply(c
,shared
.psubscribebulk
);
10012 addReplyBulk(c
,pattern
);
10013 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10017 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10018 * 0 if the client was not subscribed to the specified channel. */
10019 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10024 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10025 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10027 listDelNode(c
->pubsub_patterns
,ln
);
10029 pat
.pattern
= pattern
;
10030 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10031 listDelNode(server
.pubsub_patterns
,ln
);
10033 /* Notify the client */
10035 addReply(c
,shared
.mbulk3
);
10036 addReply(c
,shared
.punsubscribebulk
);
10037 addReplyBulk(c
,pattern
);
10038 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
10039 listLength(c
->pubsub_patterns
));
10041 decrRefCount(pattern
);
10045 /* Unsubscribe from all the channels. Return the number of channels the
10046 * client was subscribed from. */
10047 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10048 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10052 while((de
= dictNext(di
)) != NULL
) {
10053 robj
*channel
= dictGetEntryKey(de
);
10055 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10057 dictReleaseIterator(di
);
10061 /* Unsubscribe from all the patterns. Return the number of patterns the
10062 * client was subscribed from. */
10063 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10068 listRewind(c
->pubsub_patterns
,&li
);
10069 while ((ln
= listNext(&li
)) != NULL
) {
10070 robj
*pattern
= ln
->value
;
10072 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10077 /* Publish a message */
10078 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10080 struct dictEntry
*de
;
10084 /* Send to clients listening for that channel */
10085 de
= dictFind(server
.pubsub_channels
,channel
);
10087 list
*list
= dictGetEntryVal(de
);
10091 listRewind(list
,&li
);
10092 while ((ln
= listNext(&li
)) != NULL
) {
10093 redisClient
*c
= ln
->value
;
10095 addReply(c
,shared
.mbulk3
);
10096 addReply(c
,shared
.messagebulk
);
10097 addReplyBulk(c
,channel
);
10098 addReplyBulk(c
,message
);
10102 /* Send to clients listening to matching channels */
10103 if (listLength(server
.pubsub_patterns
)) {
10104 listRewind(server
.pubsub_patterns
,&li
);
10105 channel
= getDecodedObject(channel
);
10106 while ((ln
= listNext(&li
)) != NULL
) {
10107 pubsubPattern
*pat
= ln
->value
;
10109 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10110 sdslen(pat
->pattern
->ptr
),
10111 (char*)channel
->ptr
,
10112 sdslen(channel
->ptr
),0)) {
10113 addReply(pat
->client
,shared
.mbulk4
);
10114 addReply(pat
->client
,shared
.pmessagebulk
);
10115 addReplyBulk(pat
->client
,pat
->pattern
);
10116 addReplyBulk(pat
->client
,channel
);
10117 addReplyBulk(pat
->client
,message
);
10121 decrRefCount(channel
);
10126 static void subscribeCommand(redisClient
*c
) {
10129 for (j
= 1; j
< c
->argc
; j
++)
10130 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10133 static void unsubscribeCommand(redisClient
*c
) {
10134 if (c
->argc
== 1) {
10135 pubsubUnsubscribeAllChannels(c
,1);
10140 for (j
= 1; j
< c
->argc
; j
++)
10141 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10145 static void psubscribeCommand(redisClient
*c
) {
10148 for (j
= 1; j
< c
->argc
; j
++)
10149 pubsubSubscribePattern(c
,c
->argv
[j
]);
10152 static void punsubscribeCommand(redisClient
*c
) {
10153 if (c
->argc
== 1) {
10154 pubsubUnsubscribeAllPatterns(c
,1);
10159 for (j
= 1; j
< c
->argc
; j
++)
10160 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10164 static void publishCommand(redisClient
*c
) {
10165 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10166 addReplyLong(c
,receivers
);
10169 /* ================================= Debugging ============================== */
10171 static void debugCommand(redisClient
*c
) {
10172 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10173 *((char*)-1) = 'x';
10174 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10175 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10176 addReply(c
,shared
.err
);
10180 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10181 addReply(c
,shared
.err
);
10184 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10185 addReply(c
,shared
.ok
);
10186 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10188 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10189 addReply(c
,shared
.err
);
10192 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10193 addReply(c
,shared
.ok
);
10194 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10195 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10199 addReply(c
,shared
.nokeyerr
);
10202 key
= dictGetEntryKey(de
);
10203 val
= dictGetEntryVal(de
);
10204 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10205 key
->storage
== REDIS_VM_SWAPPING
)) {
10209 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10210 strenc
= strencoding
[val
->encoding
];
10212 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10215 addReplySds(c
,sdscatprintf(sdsempty(),
10216 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10217 "encoding:%s serializedlength:%lld\r\n",
10218 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10219 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10221 addReplySds(c
,sdscatprintf(sdsempty(),
10222 "+Key at:%p refcount:%d, value swapped at: page %llu "
10223 "using %llu pages\r\n",
10224 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10225 (unsigned long long) key
->vm
.usedpages
));
10227 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10228 lookupKeyRead(c
->db
,c
->argv
[2]);
10229 addReply(c
,shared
.ok
);
10230 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10231 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10234 if (!server
.vm_enabled
) {
10235 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10239 addReply(c
,shared
.nokeyerr
);
10242 key
= dictGetEntryKey(de
);
10243 val
= dictGetEntryVal(de
);
10244 /* If the key is shared we want to create a copy */
10245 if (key
->refcount
> 1) {
10246 robj
*newkey
= dupStringObject(key
);
10248 key
= dictGetEntryKey(de
) = newkey
;
10251 if (key
->storage
!= REDIS_VM_MEMORY
) {
10252 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10253 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10254 dictGetEntryVal(de
) = NULL
;
10255 addReply(c
,shared
.ok
);
10257 addReply(c
,shared
.err
);
10259 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10264 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10266 for (j
= 0; j
< keys
; j
++) {
10267 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10268 key
= createStringObject(buf
,strlen(buf
));
10269 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10273 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10274 val
= createStringObject(buf
,strlen(buf
));
10275 dictAdd(c
->db
->dict
,key
,val
);
10277 addReply(c
,shared
.ok
);
10279 addReplySds(c
,sdsnew(
10280 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10284 static void _redisAssert(char *estr
, char *file
, int line
) {
10285 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10286 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10287 #ifdef HAVE_BACKTRACE
10288 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10289 *((char*)-1) = 'x';
10293 static void _redisPanic(char *msg
, char *file
, int line
) {
10294 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10295 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10296 #ifdef HAVE_BACKTRACE
10297 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10298 *((char*)-1) = 'x';
10302 /* =================================== Main! ================================ */
10305 int linuxOvercommitMemoryValue(void) {
10306 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10309 if (!fp
) return -1;
10310 if (fgets(buf
,64,fp
) == NULL
) {
10319 void linuxOvercommitMemoryWarning(void) {
10320 if (linuxOvercommitMemoryValue() == 0) {
10321 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
10324 #endif /* __linux__ */
10326 static void daemonize(void) {
10330 if (fork() != 0) exit(0); /* parent exits */
10331 setsid(); /* create a new session */
10333 /* Every output goes to /dev/null. If Redis is daemonized but
10334 * the 'logfile' is set to 'stdout' in the configuration file
10335 * it will not log at all. */
10336 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10337 dup2(fd
, STDIN_FILENO
);
10338 dup2(fd
, STDOUT_FILENO
);
10339 dup2(fd
, STDERR_FILENO
);
10340 if (fd
> STDERR_FILENO
) close(fd
);
10342 /* Try to write the pid file */
10343 fp
= fopen(server
.pidfile
,"w");
10345 fprintf(fp
,"%d\n",getpid());
10350 static void version() {
10351 printf("Redis server version %s\n", REDIS_VERSION
);
10355 static void usage() {
10356 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10357 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10361 int main(int argc
, char **argv
) {
10364 initServerConfig();
10366 if (strcmp(argv
[1], "-v") == 0 ||
10367 strcmp(argv
[1], "--version") == 0) version();
10368 if (strcmp(argv
[1], "--help") == 0) usage();
10369 resetServerSaveParams();
10370 loadServerConfig(argv
[1]);
10371 } else if ((argc
> 2)) {
10374 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'");
10376 if (server
.daemonize
) daemonize();
10378 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10380 linuxOvercommitMemoryWarning();
10382 start
= time(NULL
);
10383 if (server
.appendonly
) {
10384 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10385 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10387 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10388 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10390 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10391 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10393 aeDeleteEventLoop(server
.el
);
10397 /* ============================= Backtrace support ========================= */
10399 #ifdef HAVE_BACKTRACE
10400 static char *findFuncName(void *pointer
, unsigned long *offset
);
10402 static void *getMcontextEip(ucontext_t
*uc
) {
10403 #if defined(__FreeBSD__)
10404 return (void*) uc
->uc_mcontext
.mc_eip
;
10405 #elif defined(__dietlibc__)
10406 return (void*) uc
->uc_mcontext
.eip
;
10407 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10409 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10411 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10413 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10414 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10415 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10417 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10419 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10420 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10421 #elif defined(__ia64__) /* Linux IA64 */
10422 return (void*) uc
->uc_mcontext
.sc_ip
;
10428 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10430 char **messages
= NULL
;
10431 int i
, trace_size
= 0;
10432 unsigned long offset
=0;
10433 ucontext_t
*uc
= (ucontext_t
*) secret
;
10435 REDIS_NOTUSED(info
);
10437 redisLog(REDIS_WARNING
,
10438 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10439 infostring
= genRedisInfoString();
10440 redisLog(REDIS_WARNING
, "%s",infostring
);
10441 /* It's not safe to sdsfree() the returned string under memory
10442 * corruption conditions. Let it leak as we are going to abort */
10444 trace_size
= backtrace(trace
, 100);
10445 /* overwrite sigaction with caller's address */
10446 if (getMcontextEip(uc
) != NULL
) {
10447 trace
[1] = getMcontextEip(uc
);
10449 messages
= backtrace_symbols(trace
, trace_size
);
10451 for (i
=1; i
<trace_size
; ++i
) {
10452 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10454 p
= strchr(messages
[i
],'+');
10455 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10456 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10458 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10461 /* free(messages); Don't call free() with possibly corrupted memory. */
10465 static void setupSigSegvAction(void) {
10466 struct sigaction act
;
10468 sigemptyset (&act
.sa_mask
);
10469 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10470 * is used. Otherwise, sa_handler is used */
10471 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10472 act
.sa_sigaction
= segvHandler
;
10473 sigaction (SIGSEGV
, &act
, NULL
);
10474 sigaction (SIGBUS
, &act
, NULL
);
10475 sigaction (SIGFPE
, &act
, NULL
);
10476 sigaction (SIGILL
, &act
, NULL
);
10477 sigaction (SIGBUS
, &act
, NULL
);
10481 #include "staticsymbols.h"
10482 /* This function try to convert a pointer into a function name. It's used in
10483 * oreder to provide a backtrace under segmentation fault that's able to
10484 * display functions declared as static (otherwise the backtrace is useless). */
10485 static char *findFuncName(void *pointer
, unsigned long *offset
){
10487 unsigned long off
, minoff
= 0;
10489 /* Try to match against the Symbol with the smallest offset */
10490 for (i
=0; symsTable
[i
].pointer
; i
++) {
10491 unsigned long lp
= (unsigned long) pointer
;
10493 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10494 off
=lp
-symsTable
[i
].pointer
;
10495 if (ret
< 0 || off
< minoff
) {
10501 if (ret
== -1) return NULL
;
10503 return symsTable
[ret
].name
;
10505 #else /* HAVE_BACKTRACE */
10506 static void setupSigSegvAction(void) {
10508 #endif /* HAVE_BACKTRACE */