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>
64 #include "solarisfixes.h"
68 #include "ae.h" /* Event driven programming library */
69 #include "sds.h" /* Dynamic safe strings */
70 #include "anet.h" /* Networking the easy way */
71 #include "dict.h" /* Hash tables */
72 #include "adlist.h" /* Linked lists */
73 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
74 #include "lzf.h" /* LZF compression library */
75 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 8
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
112 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
115 #define REDIS_STRING 0
121 /* Objects encoding. Some kind of objects like Strings and Hashes can be
122 * internally represented in multiple ways. The 'encoding' field of the object
123 * is set to one of this fields for this object. */
124 #define REDIS_ENCODING_RAW 0 /* Raw representation */
125 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
126 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
127 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
129 static char* strencoding
[] = {
130 "raw", "int", "zipmap", "hashtable"
133 /* Object types only used for dumping to disk */
134 #define REDIS_EXPIRETIME 253
135 #define REDIS_SELECTDB 254
136 #define REDIS_EOF 255
138 /* Defines related to the dump file format. To store 32 bits lengths for short
139 * keys requires a lot of space, so we check the most significant 2 bits of
140 * the first byte to interpreter the length:
142 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
143 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
144 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
145 * 11|000000 this means: specially encoded object will follow. The six bits
146 * number specify the kind of object that follows.
147 * See the REDIS_RDB_ENC_* defines.
149 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
150 * values, will fit inside. */
151 #define REDIS_RDB_6BITLEN 0
152 #define REDIS_RDB_14BITLEN 1
153 #define REDIS_RDB_32BITLEN 2
154 #define REDIS_RDB_ENCVAL 3
155 #define REDIS_RDB_LENERR UINT_MAX
157 /* When a length of a string object stored on disk has the first two bits
158 * set, the remaining two bits specify a special encoding for the object
159 * accordingly to the following defines: */
160 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
161 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
162 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
163 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
165 /* Virtual memory object->where field. */
166 #define REDIS_VM_MEMORY 0 /* The object is on memory */
167 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
168 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
169 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
171 /* Virtual memory static configuration stuff.
172 * Check vmFindContiguousPages() to know more about this magic numbers. */
173 #define REDIS_VM_MAX_NEAR_PAGES 65536
174 #define REDIS_VM_MAX_RANDOM_JUMP 4096
175 #define REDIS_VM_MAX_THREADS 32
176 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
177 /* The following is the *percentage* of completed I/O jobs to process when the
178 * handelr is called. While Virtual Memory I/O operations are performed by
179 * threads, this operations must be processed by the main thread when completed
180 * in order to take effect. */
181 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
184 #define REDIS_SLAVE 1 /* This client is a slave server */
185 #define REDIS_MASTER 2 /* This client is a master server */
186 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
187 #define REDIS_MULTI 8 /* This client is in a MULTI context */
188 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
189 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
191 /* Slave replication state - slave side */
192 #define REDIS_REPL_NONE 0 /* No active replication */
193 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
194 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
196 /* Slave replication state - from the point of view of master
197 * Note that in SEND_BULK and ONLINE state the slave receives new updates
198 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
199 * to start the next background saving in order to send updates to it. */
200 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
201 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
202 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
203 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
205 /* List related stuff */
209 /* Sort operations */
210 #define REDIS_SORT_GET 0
211 #define REDIS_SORT_ASC 1
212 #define REDIS_SORT_DESC 2
213 #define REDIS_SORTKEY_MAX 1024
216 #define REDIS_DEBUG 0
217 #define REDIS_VERBOSE 1
218 #define REDIS_NOTICE 2
219 #define REDIS_WARNING 3
221 /* Anti-warning macro... */
222 #define REDIS_NOTUSED(V) ((void) V)
224 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
225 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
227 /* Append only defines */
228 #define APPENDFSYNC_NO 0
229 #define APPENDFSYNC_ALWAYS 1
230 #define APPENDFSYNC_EVERYSEC 2
232 /* Hashes related defaults */
233 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
234 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
236 /* We can print the stacktrace, so our assert is defined this way: */
237 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
238 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
239 static void _redisAssert(char *estr
, char *file
, int line
);
240 static void _redisPanic(char *msg
, char *file
, int line
);
242 /*================================= Data types ============================== */
244 /* A redis object, that is a type able to hold a string / list / set */
246 /* The VM object structure */
247 struct redisObjectVM
{
248 off_t page
; /* the page at witch the object is stored on disk */
249 off_t usedpages
; /* number of pages used on disk */
250 time_t atime
; /* Last access time */
253 /* The actual Redis Object */
254 typedef struct redisObject
{
257 unsigned char encoding
;
258 unsigned char storage
; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype
; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm
;
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
282 typedef struct redisDb
{
283 dict
*dict
; /* The keyspace for this DB */
284 dict
*expires
; /* Timeout of keys with a timeout set */
285 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
286 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd
{
294 struct redisCommand
*cmd
;
297 typedef struct multiState
{
298 multiCmd
*commands
; /* Array of MULTI commands */
299 int count
; /* Total number of MULTI commands */
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient
{
309 robj
**argv
, **mbargv
;
311 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk
; /* multi bulk command format active */
315 time_t lastinteraction
; /* time of the last interaction, used for timeout */
316 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb
; /* slave selected db, if this client is a slave */
318 int authenticated
; /* when requirepass is non-NULL */
319 int replstate
; /* replication state if this is a slave */
320 int repldbfd
; /* replication DB file descriptor */
321 long repldboff
; /* replication DB file offset */
322 off_t repldbsize
; /* replication DB file size */
323 multiState mstate
; /* MULTI/EXEC state */
324 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum
; /* Number of blocking keys */
327 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list
*io_keys
; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
332 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
340 /* Global server state structure */
345 long long dirty
; /* changes to DB from the last save */
347 list
*slaves
, *monitors
;
348 char neterr
[ANET_ERR_LEN
];
350 int cronloops
; /* number of times the cron function run */
351 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
352 time_t lastsave
; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime
; /* server start time */
355 long long stat_numcommands
; /* number of processed commands */
356 long long stat_numconnections
; /* number of connections received */
357 long long stat_expiredkeys
; /* number of expired keys */
370 pid_t bgsavechildpid
;
371 pid_t bgrewritechildpid
;
372 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
373 sds aofbuf
; /* AOF buffer, written before entering the event loop */
374 struct saveparam
*saveparams
;
379 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 #define REDIS_SHARED_INTEGERS 10000
510 struct sharedObjectsStruct
{
511 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
512 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
513 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
514 *outofrangeerr
, *plus
,
515 *select0
, *select1
, *select2
, *select3
, *select4
,
516 *select5
, *select6
, *select7
, *select8
, *select9
,
517 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
519 *integers
[REDIS_SHARED_INTEGERS
];
522 /* Global vars that are actally used as constants. The following double
523 * values are used for double on-disk serialization, and are initialized
524 * at runtime to avoid strange compiler optimizations. */
526 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
528 /* VM threaded I/O request message */
529 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
530 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
531 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
532 typedef struct iojob
{
533 int type
; /* Request type, REDIS_IOJOB_* */
534 redisDb
*db
;/* Redis database */
535 robj
*key
; /* This I/O request is about swapping this key */
536 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
537 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
538 off_t page
; /* Swap page where to read/write the object */
539 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
540 int canceled
; /* True if this command was canceled by blocking side of VM */
541 pthread_t thread
; /* ID of the thread processing this entry */
544 /*================================ Prototypes =============================== */
546 static void freeStringObject(robj
*o
);
547 static void freeListObject(robj
*o
);
548 static void freeSetObject(robj
*o
);
549 static void decrRefCount(void *o
);
550 static robj
*createObject(int type
, void *ptr
);
551 static void freeClient(redisClient
*c
);
552 static int rdbLoad(char *filename
);
553 static void addReply(redisClient
*c
, robj
*obj
);
554 static void addReplySds(redisClient
*c
, sds s
);
555 static void incrRefCount(robj
*o
);
556 static int rdbSaveBackground(char *filename
);
557 static robj
*createStringObject(char *ptr
, size_t len
);
558 static robj
*dupStringObject(robj
*o
);
559 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
560 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
561 static void flushAppendOnlyFile(void);
562 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
563 static int syncWithMaster(void);
564 static robj
*tryObjectEncoding(robj
*o
);
565 static robj
*getDecodedObject(robj
*o
);
566 static int removeExpire(redisDb
*db
, robj
*key
);
567 static int expireIfNeeded(redisDb
*db
, robj
*key
);
568 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
569 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
570 static int deleteKey(redisDb
*db
, robj
*key
);
571 static time_t getExpire(redisDb
*db
, robj
*key
);
572 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
573 static void updateSlavesWaitingBgsave(int bgsaveerr
);
574 static void freeMemoryIfNeeded(void);
575 static int processCommand(redisClient
*c
);
576 static void setupSigSegvAction(void);
577 static void rdbRemoveTempFile(pid_t childpid
);
578 static void aofRemoveTempFile(pid_t childpid
);
579 static size_t stringObjectLen(robj
*o
);
580 static void processInputBuffer(redisClient
*c
);
581 static zskiplist
*zslCreate(void);
582 static void zslFree(zskiplist
*zsl
);
583 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
584 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
585 static void initClientMultiState(redisClient
*c
);
586 static void freeClientMultiState(redisClient
*c
);
587 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
588 static void unblockClientWaitingData(redisClient
*c
);
589 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
590 static void vmInit(void);
591 static void vmMarkPagesFree(off_t page
, off_t count
);
592 static robj
*vmLoadObject(robj
*key
);
593 static robj
*vmPreviewObject(robj
*key
);
594 static int vmSwapOneObjectBlocking(void);
595 static int vmSwapOneObjectThreaded(void);
596 static int vmCanSwapOut(void);
597 static int tryFreeOneObjectFromFreelist(void);
598 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
600 static void vmCancelThreadedIOJob(robj
*o
);
601 static void lockThreadedIO(void);
602 static void unlockThreadedIO(void);
603 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
604 static void freeIOJob(iojob
*j
);
605 static void queueIOJob(iojob
*j
);
606 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
607 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
608 static void waitEmptyIOJobsQueue(void);
609 static void vmReopenSwapFile(void);
610 static int vmFreePage(off_t page
);
611 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
612 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
613 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
614 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
615 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
616 static struct redisCommand
*lookupCommand(char *name
);
617 static void call(redisClient
*c
, struct redisCommand
*cmd
);
618 static void resetClient(redisClient
*c
);
619 static void convertToRealHash(robj
*o
);
620 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
621 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
622 static void freePubsubPattern(void *p
);
623 static int listMatchPubsubPattern(void *a
, void *b
);
624 static int compareStringObjects(robj
*a
, robj
*b
);
625 static int equalStringObjects(robj
*a
, robj
*b
);
627 static int rewriteAppendOnlyFileBackground(void);
628 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
630 static void authCommand(redisClient
*c
);
631 static void pingCommand(redisClient
*c
);
632 static void echoCommand(redisClient
*c
);
633 static void setCommand(redisClient
*c
);
634 static void setnxCommand(redisClient
*c
);
635 static void setexCommand(redisClient
*c
);
636 static void getCommand(redisClient
*c
);
637 static void delCommand(redisClient
*c
);
638 static void existsCommand(redisClient
*c
);
639 static void incrCommand(redisClient
*c
);
640 static void decrCommand(redisClient
*c
);
641 static void incrbyCommand(redisClient
*c
);
642 static void decrbyCommand(redisClient
*c
);
643 static void selectCommand(redisClient
*c
);
644 static void randomkeyCommand(redisClient
*c
);
645 static void keysCommand(redisClient
*c
);
646 static void dbsizeCommand(redisClient
*c
);
647 static void lastsaveCommand(redisClient
*c
);
648 static void saveCommand(redisClient
*c
);
649 static void bgsaveCommand(redisClient
*c
);
650 static void bgrewriteaofCommand(redisClient
*c
);
651 static void shutdownCommand(redisClient
*c
);
652 static void moveCommand(redisClient
*c
);
653 static void renameCommand(redisClient
*c
);
654 static void renamenxCommand(redisClient
*c
);
655 static void lpushCommand(redisClient
*c
);
656 static void rpushCommand(redisClient
*c
);
657 static void lpopCommand(redisClient
*c
);
658 static void rpopCommand(redisClient
*c
);
659 static void llenCommand(redisClient
*c
);
660 static void lindexCommand(redisClient
*c
);
661 static void lrangeCommand(redisClient
*c
);
662 static void ltrimCommand(redisClient
*c
);
663 static void typeCommand(redisClient
*c
);
664 static void lsetCommand(redisClient
*c
);
665 static void saddCommand(redisClient
*c
);
666 static void sremCommand(redisClient
*c
);
667 static void smoveCommand(redisClient
*c
);
668 static void sismemberCommand(redisClient
*c
);
669 static void scardCommand(redisClient
*c
);
670 static void spopCommand(redisClient
*c
);
671 static void srandmemberCommand(redisClient
*c
);
672 static void sinterCommand(redisClient
*c
);
673 static void sinterstoreCommand(redisClient
*c
);
674 static void sunionCommand(redisClient
*c
);
675 static void sunionstoreCommand(redisClient
*c
);
676 static void sdiffCommand(redisClient
*c
);
677 static void sdiffstoreCommand(redisClient
*c
);
678 static void syncCommand(redisClient
*c
);
679 static void flushdbCommand(redisClient
*c
);
680 static void flushallCommand(redisClient
*c
);
681 static void sortCommand(redisClient
*c
);
682 static void lremCommand(redisClient
*c
);
683 static void rpoplpushcommand(redisClient
*c
);
684 static void infoCommand(redisClient
*c
);
685 static void mgetCommand(redisClient
*c
);
686 static void monitorCommand(redisClient
*c
);
687 static void expireCommand(redisClient
*c
);
688 static void expireatCommand(redisClient
*c
);
689 static void getsetCommand(redisClient
*c
);
690 static void ttlCommand(redisClient
*c
);
691 static void slaveofCommand(redisClient
*c
);
692 static void debugCommand(redisClient
*c
);
693 static void msetCommand(redisClient
*c
);
694 static void msetnxCommand(redisClient
*c
);
695 static void zaddCommand(redisClient
*c
);
696 static void zincrbyCommand(redisClient
*c
);
697 static void zrangeCommand(redisClient
*c
);
698 static void zrangebyscoreCommand(redisClient
*c
);
699 static void zcountCommand(redisClient
*c
);
700 static void zrevrangeCommand(redisClient
*c
);
701 static void zcardCommand(redisClient
*c
);
702 static void zremCommand(redisClient
*c
);
703 static void zscoreCommand(redisClient
*c
);
704 static void zremrangebyscoreCommand(redisClient
*c
);
705 static void multiCommand(redisClient
*c
);
706 static void execCommand(redisClient
*c
);
707 static void discardCommand(redisClient
*c
);
708 static void blpopCommand(redisClient
*c
);
709 static void brpopCommand(redisClient
*c
);
710 static void appendCommand(redisClient
*c
);
711 static void substrCommand(redisClient
*c
);
712 static void zrankCommand(redisClient
*c
);
713 static void zrevrankCommand(redisClient
*c
);
714 static void hsetCommand(redisClient
*c
);
715 static void hsetnxCommand(redisClient
*c
);
716 static void hgetCommand(redisClient
*c
);
717 static void hmsetCommand(redisClient
*c
);
718 static void hmgetCommand(redisClient
*c
);
719 static void hdelCommand(redisClient
*c
);
720 static void hlenCommand(redisClient
*c
);
721 static void zremrangebyrankCommand(redisClient
*c
);
722 static void zunionCommand(redisClient
*c
);
723 static void zinterCommand(redisClient
*c
);
724 static void hkeysCommand(redisClient
*c
);
725 static void hvalsCommand(redisClient
*c
);
726 static void hgetallCommand(redisClient
*c
);
727 static void hexistsCommand(redisClient
*c
);
728 static void configCommand(redisClient
*c
);
729 static void hincrbyCommand(redisClient
*c
);
730 static void subscribeCommand(redisClient
*c
);
731 static void unsubscribeCommand(redisClient
*c
);
732 static void psubscribeCommand(redisClient
*c
);
733 static void punsubscribeCommand(redisClient
*c
);
734 static void publishCommand(redisClient
*c
);
736 /*================================= Globals ================================= */
739 static struct redisServer server
; /* server global state */
740 static struct redisCommand cmdTable
[] = {
741 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
742 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
743 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
744 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
745 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
746 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
748 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
750 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
751 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
752 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
753 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
754 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
755 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
761 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
764 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
765 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
766 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
767 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
768 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
769 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
770 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
771 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
772 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
773 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
774 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
775 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
776 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
777 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
778 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
780 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
781 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
782 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
784 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
785 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
786 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
792 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
794 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
796 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
797 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
798 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
799 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
800 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
801 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
805 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
806 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
807 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
808 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
809 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
810 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
811 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
814 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
815 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
816 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
823 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
829 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
831 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
836 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
839 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
842 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
846 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
847 {NULL
,NULL
,0,0,NULL
,0,0,0}
850 /*============================ Utility functions ============================ */
852 /* Glob-style pattern matching. */
853 static int stringmatchlen(const char *pattern
, int patternLen
,
854 const char *string
, int stringLen
, int nocase
)
859 while (pattern
[1] == '*') {
864 return 1; /* match */
866 if (stringmatchlen(pattern
+1, patternLen
-1,
867 string
, stringLen
, nocase
))
868 return 1; /* match */
872 return 0; /* no match */
876 return 0; /* no match */
886 not = pattern
[0] == '^';
893 if (pattern
[0] == '\\') {
896 if (pattern
[0] == string
[0])
898 } else if (pattern
[0] == ']') {
900 } else if (patternLen
== 0) {
904 } else if (pattern
[1] == '-' && patternLen
>= 3) {
905 int start
= pattern
[0];
906 int end
= pattern
[2];
914 start
= tolower(start
);
920 if (c
>= start
&& c
<= end
)
924 if (pattern
[0] == string
[0])
927 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
937 return 0; /* no match */
943 if (patternLen
>= 2) {
950 if (pattern
[0] != string
[0])
951 return 0; /* no match */
953 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
954 return 0; /* no match */
962 if (stringLen
== 0) {
963 while(*pattern
== '*') {
970 if (patternLen
== 0 && stringLen
== 0)
975 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
976 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
979 /* Convert a string representing an amount of memory into the number of
980 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
983 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
985 static long long memtoll(const char *p
, int *err
) {
988 long mul
; /* unit multiplier */
993 /* Search the first non digit character. */
996 while(*u
&& isdigit(*u
)) u
++;
997 if (*u
== '\0' || !strcasecmp(u
,"b")) {
999 } else if (!strcasecmp(u
,"k")) {
1001 } else if (!strcasecmp(u
,"kb")) {
1003 } else if (!strcasecmp(u
,"m")) {
1005 } else if (!strcasecmp(u
,"mb")) {
1007 } else if (!strcasecmp(u
,"g")) {
1008 mul
= 1000L*1000*1000;
1009 } else if (!strcasecmp(u
,"gb")) {
1010 mul
= 1024L*1024*1024;
1016 if (digits
>= sizeof(buf
)) {
1020 memcpy(buf
,p
,digits
);
1022 val
= strtoll(buf
,NULL
,10);
1026 /* Convert a long long into a string. Returns the number of
1027 * characters needed to represent the number, that can be shorter if passed
1028 * buffer length is not enough to store the whole number. */
1029 static int ll2string(char *s
, size_t len
, long long value
) {
1031 unsigned long long v
;
1034 if (len
== 0) return 0;
1035 v
= (value
< 0) ? -value
: value
;
1036 p
= buf
+31; /* point to the last character */
1041 if (value
< 0) *p
-- = '-';
1044 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1050 static void redisLog(int level
, const char *fmt
, ...) {
1054 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1058 if (level
>= server
.verbosity
) {
1064 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1065 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1066 vfprintf(fp
, fmt
, ap
);
1072 if (server
.logfile
) fclose(fp
);
1075 /*====================== Hash table type implementation ==================== */
1077 /* This is an hash table type that uses the SDS dynamic strings libary as
1078 * keys and radis objects as values (objects can hold SDS strings,
1081 static void dictVanillaFree(void *privdata
, void *val
)
1083 DICT_NOTUSED(privdata
);
1087 static void dictListDestructor(void *privdata
, void *val
)
1089 DICT_NOTUSED(privdata
);
1090 listRelease((list
*)val
);
1093 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1097 DICT_NOTUSED(privdata
);
1099 l1
= sdslen((sds
)key1
);
1100 l2
= sdslen((sds
)key2
);
1101 if (l1
!= l2
) return 0;
1102 return memcmp(key1
, key2
, l1
) == 0;
1105 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1107 DICT_NOTUSED(privdata
);
1109 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1113 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1116 const robj
*o1
= key1
, *o2
= key2
;
1117 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1120 static unsigned int dictObjHash(const void *key
) {
1121 const robj
*o
= key
;
1122 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1125 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1128 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1131 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1132 o2
->encoding
== REDIS_ENCODING_INT
)
1133 return o1
->ptr
== o2
->ptr
;
1135 o1
= getDecodedObject(o1
);
1136 o2
= getDecodedObject(o2
);
1137 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1143 static unsigned int dictEncObjHash(const void *key
) {
1144 robj
*o
= (robj
*) key
;
1146 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1147 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1149 if (o
->encoding
== REDIS_ENCODING_INT
) {
1153 len
= ll2string(buf
,32,(long)o
->ptr
);
1154 return dictGenHashFunction((unsigned char*)buf
, len
);
1158 o
= getDecodedObject(o
);
1159 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1166 /* Sets type and expires */
1167 static dictType setDictType
= {
1168 dictEncObjHash
, /* hash function */
1171 dictEncObjKeyCompare
, /* key compare */
1172 dictRedisObjectDestructor
, /* key destructor */
1173 NULL
/* val destructor */
1176 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1177 static dictType zsetDictType
= {
1178 dictEncObjHash
, /* hash function */
1181 dictEncObjKeyCompare
, /* key compare */
1182 dictRedisObjectDestructor
, /* key destructor */
1183 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1187 static dictType dbDictType
= {
1188 dictObjHash
, /* hash function */
1191 dictObjKeyCompare
, /* key compare */
1192 dictRedisObjectDestructor
, /* key destructor */
1193 dictRedisObjectDestructor
/* val destructor */
1197 static dictType keyptrDictType
= {
1198 dictObjHash
, /* hash function */
1201 dictObjKeyCompare
, /* key compare */
1202 dictRedisObjectDestructor
, /* key destructor */
1203 NULL
/* val destructor */
1206 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1207 static dictType hashDictType
= {
1208 dictEncObjHash
, /* hash function */
1211 dictEncObjKeyCompare
, /* key compare */
1212 dictRedisObjectDestructor
, /* key destructor */
1213 dictRedisObjectDestructor
/* val destructor */
1216 /* Keylist hash table type has unencoded redis objects as keys and
1217 * lists as values. It's used for blocking operations (BLPOP) and to
1218 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1219 static dictType keylistDictType
= {
1220 dictObjHash
, /* hash function */
1223 dictObjKeyCompare
, /* key compare */
1224 dictRedisObjectDestructor
, /* key destructor */
1225 dictListDestructor
/* val destructor */
1228 static void version();
1230 /* ========================= Random utility functions ======================= */
1232 /* Redis generally does not try to recover from out of memory conditions
1233 * when allocating objects or strings, it is not clear if it will be possible
1234 * to report this condition to the client since the networking layer itself
1235 * is based on heap allocation for send buffers, so we simply abort.
1236 * At least the code will be simpler to read... */
1237 static void oom(const char *msg
) {
1238 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1243 /* ====================== Redis server networking stuff ===================== */
1244 static void closeTimedoutClients(void) {
1247 time_t now
= time(NULL
);
1250 listRewind(server
.clients
,&li
);
1251 while ((ln
= listNext(&li
)) != NULL
) {
1252 c
= listNodeValue(ln
);
1253 if (server
.maxidletime
&&
1254 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1255 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1256 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1257 listLength(c
->pubsub_patterns
) == 0 &&
1258 (now
- c
->lastinteraction
> server
.maxidletime
))
1260 redisLog(REDIS_VERBOSE
,"Closing idle client");
1262 } else if (c
->flags
& REDIS_BLOCKED
) {
1263 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1264 addReply(c
,shared
.nullmultibulk
);
1265 unblockClientWaitingData(c
);
1271 static int htNeedsResize(dict
*dict
) {
1272 long long size
, used
;
1274 size
= dictSlots(dict
);
1275 used
= dictSize(dict
);
1276 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1277 (used
*100/size
< REDIS_HT_MINFILL
));
1280 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1281 * we resize the hash table to save memory */
1282 static void tryResizeHashTables(void) {
1285 for (j
= 0; j
< server
.dbnum
; j
++) {
1286 if (htNeedsResize(server
.db
[j
].dict
))
1287 dictResize(server
.db
[j
].dict
);
1288 if (htNeedsResize(server
.db
[j
].expires
))
1289 dictResize(server
.db
[j
].expires
);
1293 /* Our hash table implementation performs rehashing incrementally while
1294 * we write/read from the hash table. Still if the server is idle, the hash
1295 * table will use two tables for a long time. So we try to use 1 millisecond
1296 * of CPU time at every serverCron() loop in order to rehash some key. */
1297 static void incrementallyRehash(void) {
1300 for (j
= 0; j
< server
.dbnum
; j
++) {
1301 if (dictIsRehashing(server
.db
[j
].dict
)) {
1302 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1303 break; /* already used our millisecond for this loop... */
1308 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1309 void backgroundSaveDoneHandler(int statloc
) {
1310 int exitcode
= WEXITSTATUS(statloc
);
1311 int bysignal
= WIFSIGNALED(statloc
);
1313 if (!bysignal
&& exitcode
== 0) {
1314 redisLog(REDIS_NOTICE
,
1315 "Background saving terminated with success");
1317 server
.lastsave
= time(NULL
);
1318 } else if (!bysignal
&& exitcode
!= 0) {
1319 redisLog(REDIS_WARNING
, "Background saving error");
1321 redisLog(REDIS_WARNING
,
1322 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1323 rdbRemoveTempFile(server
.bgsavechildpid
);
1325 server
.bgsavechildpid
= -1;
1326 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1327 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1328 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1331 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1333 void backgroundRewriteDoneHandler(int statloc
) {
1334 int exitcode
= WEXITSTATUS(statloc
);
1335 int bysignal
= WIFSIGNALED(statloc
);
1337 if (!bysignal
&& exitcode
== 0) {
1341 redisLog(REDIS_NOTICE
,
1342 "Background append only file rewriting terminated with success");
1343 /* Now it's time to flush the differences accumulated by the parent */
1344 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1345 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1347 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1350 /* Flush our data... */
1351 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1352 (signed) sdslen(server
.bgrewritebuf
)) {
1353 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
));
1357 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1358 /* Now our work is to rename the temp file into the stable file. And
1359 * switch the file descriptor used by the server for append only. */
1360 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1361 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1365 /* Mission completed... almost */
1366 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1367 if (server
.appendfd
!= -1) {
1368 /* If append only is actually enabled... */
1369 close(server
.appendfd
);
1370 server
.appendfd
= fd
;
1372 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1373 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1375 /* If append only is disabled we just generate a dump in this
1376 * format. Why not? */
1379 } else if (!bysignal
&& exitcode
!= 0) {
1380 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1382 redisLog(REDIS_WARNING
,
1383 "Background append only file rewriting terminated by signal %d",
1387 sdsfree(server
.bgrewritebuf
);
1388 server
.bgrewritebuf
= sdsempty();
1389 aofRemoveTempFile(server
.bgrewritechildpid
);
1390 server
.bgrewritechildpid
= -1;
1393 /* This function is called once a background process of some kind terminates,
1394 * as we want to avoid resizing the hash tables when there is a child in order
1395 * to play well with copy-on-write (otherwise when a resize happens lots of
1396 * memory pages are copied). The goal of this function is to update the ability
1397 * for dict.c to resize the hash tables accordingly to the fact we have o not
1398 * running childs. */
1399 static void updateDictResizePolicy(void) {
1400 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1403 dictDisableResize();
1406 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1407 int j
, loops
= server
.cronloops
++;
1408 REDIS_NOTUSED(eventLoop
);
1410 REDIS_NOTUSED(clientData
);
1412 /* We take a cached value of the unix time in the global state because
1413 * with virtual memory and aging there is to store the current time
1414 * in objects at every object access, and accuracy is not needed.
1415 * To access a global var is faster than calling time(NULL) */
1416 server
.unixtime
= time(NULL
);
1418 /* Show some info about non-empty databases */
1419 for (j
= 0; j
< server
.dbnum
; j
++) {
1420 long long size
, used
, vkeys
;
1422 size
= dictSlots(server
.db
[j
].dict
);
1423 used
= dictSize(server
.db
[j
].dict
);
1424 vkeys
= dictSize(server
.db
[j
].expires
);
1425 if (!(loops
% 50) && (used
|| vkeys
)) {
1426 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1427 /* dictPrintStats(server.dict); */
1431 /* We don't want to resize the hash tables while a bacground saving
1432 * is in progress: the saving child is created using fork() that is
1433 * implemented with a copy-on-write semantic in most modern systems, so
1434 * if we resize the HT while there is the saving child at work actually
1435 * a lot of memory movements in the parent will cause a lot of pages
1437 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1438 if (!(loops
% 10)) tryResizeHashTables();
1439 if (server
.activerehashing
) incrementallyRehash();
1442 /* Show information about connected clients */
1443 if (!(loops
% 50)) {
1444 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1445 listLength(server
.clients
)-listLength(server
.slaves
),
1446 listLength(server
.slaves
),
1447 zmalloc_used_memory());
1450 /* Close connections of timedout clients */
1451 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1452 closeTimedoutClients();
1454 /* Check if a background saving or AOF rewrite in progress terminated */
1455 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1459 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1460 if (pid
== server
.bgsavechildpid
) {
1461 backgroundSaveDoneHandler(statloc
);
1463 backgroundRewriteDoneHandler(statloc
);
1465 updateDictResizePolicy();
1468 /* If there is not a background saving in progress check if
1469 * we have to save now */
1470 time_t now
= time(NULL
);
1471 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1472 struct saveparam
*sp
= server
.saveparams
+j
;
1474 if (server
.dirty
>= sp
->changes
&&
1475 now
-server
.lastsave
> sp
->seconds
) {
1476 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1477 sp
->changes
, sp
->seconds
);
1478 rdbSaveBackground(server
.dbfilename
);
1484 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1485 * will use few CPU cycles if there are few expiring keys, otherwise
1486 * it will get more aggressive to avoid that too much memory is used by
1487 * keys that can be removed from the keyspace. */
1488 for (j
= 0; j
< server
.dbnum
; j
++) {
1490 redisDb
*db
= server
.db
+j
;
1492 /* Continue to expire if at the end of the cycle more than 25%
1493 * of the keys were expired. */
1495 long num
= dictSize(db
->expires
);
1496 time_t now
= time(NULL
);
1499 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1500 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1505 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1506 t
= (time_t) dictGetEntryVal(de
);
1508 deleteKey(db
,dictGetEntryKey(de
));
1510 server
.stat_expiredkeys
++;
1513 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1516 /* Swap a few keys on disk if we are over the memory limit and VM
1517 * is enbled. Try to free objects from the free list first. */
1518 if (vmCanSwapOut()) {
1519 while (server
.vm_enabled
&& zmalloc_used_memory() >
1520 server
.vm_max_memory
)
1524 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1525 retval
= (server
.vm_max_threads
== 0) ?
1526 vmSwapOneObjectBlocking() :
1527 vmSwapOneObjectThreaded();
1528 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1529 zmalloc_used_memory() >
1530 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1532 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1534 /* Note that when using threade I/O we free just one object,
1535 * because anyway when the I/O thread in charge to swap this
1536 * object out will finish, the handler of completed jobs
1537 * will try to swap more objects if we are still out of memory. */
1538 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1542 /* Check if we should connect to a MASTER */
1543 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1544 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1545 if (syncWithMaster() == REDIS_OK
) {
1546 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1547 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1553 /* This function gets called every time Redis is entering the
1554 * main loop of the event driven library, that is, before to sleep
1555 * for ready file descriptors. */
1556 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1557 REDIS_NOTUSED(eventLoop
);
1559 /* Awake clients that got all the swapped keys they requested */
1560 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1564 listRewind(server
.io_ready_clients
,&li
);
1565 while((ln
= listNext(&li
))) {
1566 redisClient
*c
= ln
->value
;
1567 struct redisCommand
*cmd
;
1569 /* Resume the client. */
1570 listDelNode(server
.io_ready_clients
,ln
);
1571 c
->flags
&= (~REDIS_IO_WAIT
);
1572 server
.vm_blocked_clients
--;
1573 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1574 readQueryFromClient
, c
);
1575 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1576 assert(cmd
!= NULL
);
1579 /* There may be more data to process in the input buffer. */
1580 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1581 processInputBuffer(c
);
1584 /* Write the AOF buffer on disk */
1585 flushAppendOnlyFile();
1588 static void createSharedObjects(void) {
1591 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1592 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1593 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1594 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1595 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1596 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1597 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1598 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1599 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1600 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1601 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1602 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1603 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1604 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1605 "-ERR no such key\r\n"));
1606 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1607 "-ERR syntax error\r\n"));
1608 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1609 "-ERR source and destination objects are the same\r\n"));
1610 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1611 "-ERR index out of range\r\n"));
1612 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1613 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1614 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1615 shared
.select0
= createStringObject("select 0\r\n",10);
1616 shared
.select1
= createStringObject("select 1\r\n",10);
1617 shared
.select2
= createStringObject("select 2\r\n",10);
1618 shared
.select3
= createStringObject("select 3\r\n",10);
1619 shared
.select4
= createStringObject("select 4\r\n",10);
1620 shared
.select5
= createStringObject("select 5\r\n",10);
1621 shared
.select6
= createStringObject("select 6\r\n",10);
1622 shared
.select7
= createStringObject("select 7\r\n",10);
1623 shared
.select8
= createStringObject("select 8\r\n",10);
1624 shared
.select9
= createStringObject("select 9\r\n",10);
1625 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1626 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1627 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1628 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1629 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1630 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1631 shared
.mbulk3
= createStringObject("*3\r\n",4);
1632 shared
.mbulk4
= createStringObject("*4\r\n",4);
1633 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1634 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1635 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1639 static void appendServerSaveParams(time_t seconds
, int changes
) {
1640 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1641 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1642 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1643 server
.saveparamslen
++;
1646 static void resetServerSaveParams() {
1647 zfree(server
.saveparams
);
1648 server
.saveparams
= NULL
;
1649 server
.saveparamslen
= 0;
1652 static void initServerConfig() {
1653 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1654 server
.port
= REDIS_SERVERPORT
;
1655 server
.verbosity
= REDIS_VERBOSE
;
1656 server
.maxidletime
= REDIS_MAXIDLETIME
;
1657 server
.saveparams
= NULL
;
1658 server
.logfile
= NULL
; /* NULL = log on standard output */
1659 server
.bindaddr
= NULL
;
1660 server
.glueoutputbuf
= 1;
1661 server
.daemonize
= 0;
1662 server
.appendonly
= 0;
1663 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1664 server
.lastfsync
= time(NULL
);
1665 server
.appendfd
= -1;
1666 server
.appendseldb
= -1; /* Make sure the first time will not match */
1667 server
.pidfile
= zstrdup("/var/run/redis.pid");
1668 server
.dbfilename
= zstrdup("dump.rdb");
1669 server
.appendfilename
= zstrdup("appendonly.aof");
1670 server
.requirepass
= NULL
;
1671 server
.rdbcompression
= 1;
1672 server
.activerehashing
= 1;
1673 server
.maxclients
= 0;
1674 server
.blpop_blocked_clients
= 0;
1675 server
.maxmemory
= 0;
1676 server
.vm_enabled
= 0;
1677 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1678 server
.vm_page_size
= 256; /* 256 bytes per page */
1679 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1680 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1681 server
.vm_max_threads
= 4;
1682 server
.vm_blocked_clients
= 0;
1683 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1684 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1686 resetServerSaveParams();
1688 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1689 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1690 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1691 /* Replication related */
1693 server
.masterauth
= NULL
;
1694 server
.masterhost
= NULL
;
1695 server
.masterport
= 6379;
1696 server
.master
= NULL
;
1697 server
.replstate
= REDIS_REPL_NONE
;
1699 /* Double constants initialization */
1701 R_PosInf
= 1.0/R_Zero
;
1702 R_NegInf
= -1.0/R_Zero
;
1703 R_Nan
= R_Zero
/R_Zero
;
1706 static void initServer() {
1709 signal(SIGHUP
, SIG_IGN
);
1710 signal(SIGPIPE
, SIG_IGN
);
1711 setupSigSegvAction();
1713 server
.devnull
= fopen("/dev/null","w");
1714 if (server
.devnull
== NULL
) {
1715 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1718 server
.clients
= listCreate();
1719 server
.slaves
= listCreate();
1720 server
.monitors
= listCreate();
1721 server
.objfreelist
= listCreate();
1722 createSharedObjects();
1723 server
.el
= aeCreateEventLoop();
1724 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1725 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1726 if (server
.fd
== -1) {
1727 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1730 for (j
= 0; j
< server
.dbnum
; j
++) {
1731 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1732 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1733 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1734 if (server
.vm_enabled
)
1735 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1736 server
.db
[j
].id
= j
;
1738 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1739 server
.pubsub_patterns
= listCreate();
1740 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1741 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1742 server
.cronloops
= 0;
1743 server
.bgsavechildpid
= -1;
1744 server
.bgrewritechildpid
= -1;
1745 server
.bgrewritebuf
= sdsempty();
1746 server
.aofbuf
= sdsempty();
1747 server
.lastsave
= time(NULL
);
1749 server
.stat_numcommands
= 0;
1750 server
.stat_numconnections
= 0;
1751 server
.stat_expiredkeys
= 0;
1752 server
.stat_starttime
= time(NULL
);
1753 server
.unixtime
= time(NULL
);
1754 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1755 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1756 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1758 if (server
.appendonly
) {
1759 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1760 if (server
.appendfd
== -1) {
1761 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1767 if (server
.vm_enabled
) vmInit();
1770 /* Empty the whole database */
1771 static long long emptyDb() {
1773 long long removed
= 0;
1775 for (j
= 0; j
< server
.dbnum
; j
++) {
1776 removed
+= dictSize(server
.db
[j
].dict
);
1777 dictEmpty(server
.db
[j
].dict
);
1778 dictEmpty(server
.db
[j
].expires
);
1783 static int yesnotoi(char *s
) {
1784 if (!strcasecmp(s
,"yes")) return 1;
1785 else if (!strcasecmp(s
,"no")) return 0;
1789 /* I agree, this is a very rudimental way to load a configuration...
1790 will improve later if the config gets more complex */
1791 static void loadServerConfig(char *filename
) {
1793 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1797 if (filename
[0] == '-' && filename
[1] == '\0')
1800 if ((fp
= fopen(filename
,"r")) == NULL
) {
1801 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1806 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1812 line
= sdstrim(line
," \t\r\n");
1814 /* Skip comments and blank lines*/
1815 if (line
[0] == '#' || line
[0] == '\0') {
1820 /* Split into arguments */
1821 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1822 sdstolower(argv
[0]);
1824 /* Execute config directives */
1825 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1826 server
.maxidletime
= atoi(argv
[1]);
1827 if (server
.maxidletime
< 0) {
1828 err
= "Invalid timeout value"; goto loaderr
;
1830 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1831 server
.port
= atoi(argv
[1]);
1832 if (server
.port
< 1 || server
.port
> 65535) {
1833 err
= "Invalid port"; goto loaderr
;
1835 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1836 server
.bindaddr
= zstrdup(argv
[1]);
1837 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1838 int seconds
= atoi(argv
[1]);
1839 int changes
= atoi(argv
[2]);
1840 if (seconds
< 1 || changes
< 0) {
1841 err
= "Invalid save parameters"; goto loaderr
;
1843 appendServerSaveParams(seconds
,changes
);
1844 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1845 if (chdir(argv
[1]) == -1) {
1846 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1847 argv
[1], strerror(errno
));
1850 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1851 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1852 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1853 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1854 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1856 err
= "Invalid log level. Must be one of debug, notice, warning";
1859 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1862 server
.logfile
= zstrdup(argv
[1]);
1863 if (!strcasecmp(server
.logfile
,"stdout")) {
1864 zfree(server
.logfile
);
1865 server
.logfile
= NULL
;
1867 if (server
.logfile
) {
1868 /* Test if we are able to open the file. The server will not
1869 * be able to abort just for this problem later... */
1870 logfp
= fopen(server
.logfile
,"a");
1871 if (logfp
== NULL
) {
1872 err
= sdscatprintf(sdsempty(),
1873 "Can't open the log file: %s", strerror(errno
));
1878 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1879 server
.dbnum
= atoi(argv
[1]);
1880 if (server
.dbnum
< 1) {
1881 err
= "Invalid number of databases"; goto loaderr
;
1883 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1884 loadServerConfig(argv
[1]);
1885 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1886 server
.maxclients
= atoi(argv
[1]);
1887 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1888 server
.maxmemory
= memtoll(argv
[1],NULL
);
1889 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1890 server
.masterhost
= sdsnew(argv
[1]);
1891 server
.masterport
= atoi(argv
[2]);
1892 server
.replstate
= REDIS_REPL_CONNECT
;
1893 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1894 server
.masterauth
= zstrdup(argv
[1]);
1895 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1896 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1897 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1899 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1900 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1901 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1903 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1904 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1905 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1907 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1908 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1909 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1911 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1912 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1913 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1915 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1916 if (!strcasecmp(argv
[1],"no")) {
1917 server
.appendfsync
= APPENDFSYNC_NO
;
1918 } else if (!strcasecmp(argv
[1],"always")) {
1919 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1920 } else if (!strcasecmp(argv
[1],"everysec")) {
1921 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1923 err
= "argument must be 'no', 'always' or 'everysec'";
1926 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1927 server
.requirepass
= zstrdup(argv
[1]);
1928 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1929 zfree(server
.pidfile
);
1930 server
.pidfile
= zstrdup(argv
[1]);
1931 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1932 zfree(server
.dbfilename
);
1933 server
.dbfilename
= zstrdup(argv
[1]);
1934 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1935 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1936 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1938 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1939 zfree(server
.vm_swap_file
);
1940 server
.vm_swap_file
= zstrdup(argv
[1]);
1941 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1942 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1943 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1944 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1945 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1946 server
.vm_pages
= memtoll(argv
[1], NULL
);
1947 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1948 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1949 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1950 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1951 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1952 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1954 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1956 for (j
= 0; j
< argc
; j
++)
1961 if (fp
!= stdin
) fclose(fp
);
1965 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1966 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1967 fprintf(stderr
, ">>> '%s'\n", line
);
1968 fprintf(stderr
, "%s\n", err
);
1972 static void freeClientArgv(redisClient
*c
) {
1975 for (j
= 0; j
< c
->argc
; j
++)
1976 decrRefCount(c
->argv
[j
]);
1977 for (j
= 0; j
< c
->mbargc
; j
++)
1978 decrRefCount(c
->mbargv
[j
]);
1983 static void freeClient(redisClient
*c
) {
1986 /* Note that if the client we are freeing is blocked into a blocking
1987 * call, we have to set querybuf to NULL *before* to call
1988 * unblockClientWaitingData() to avoid processInputBuffer() will get
1989 * called. Also it is important to remove the file events after
1990 * this, because this call adds the READABLE event. */
1991 sdsfree(c
->querybuf
);
1993 if (c
->flags
& REDIS_BLOCKED
)
1994 unblockClientWaitingData(c
);
1996 /* Unsubscribe from all the pubsub channels */
1997 pubsubUnsubscribeAllChannels(c
,0);
1998 pubsubUnsubscribeAllPatterns(c
,0);
1999 dictRelease(c
->pubsub_channels
);
2000 listRelease(c
->pubsub_patterns
);
2001 /* Obvious cleanup */
2002 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2003 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2004 listRelease(c
->reply
);
2007 /* Remove from the list of clients */
2008 ln
= listSearchKey(server
.clients
,c
);
2009 redisAssert(ln
!= NULL
);
2010 listDelNode(server
.clients
,ln
);
2011 /* Remove from the list of clients waiting for swapped keys */
2012 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2013 ln
= listSearchKey(server
.io_ready_clients
,c
);
2015 listDelNode(server
.io_ready_clients
,ln
);
2016 server
.vm_blocked_clients
--;
2019 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2020 ln
= listFirst(c
->io_keys
);
2021 dontWaitForSwappedKey(c
,ln
->value
);
2023 listRelease(c
->io_keys
);
2024 /* Master/slave cleanup */
2025 if (c
->flags
& REDIS_SLAVE
) {
2026 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2028 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2029 ln
= listSearchKey(l
,c
);
2030 redisAssert(ln
!= NULL
);
2033 if (c
->flags
& REDIS_MASTER
) {
2034 server
.master
= NULL
;
2035 server
.replstate
= REDIS_REPL_CONNECT
;
2037 /* Release memory */
2040 freeClientMultiState(c
);
2044 #define GLUEREPLY_UP_TO (1024)
2045 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2047 char buf
[GLUEREPLY_UP_TO
];
2052 listRewind(c
->reply
,&li
);
2053 while((ln
= listNext(&li
))) {
2057 objlen
= sdslen(o
->ptr
);
2058 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2059 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2061 listDelNode(c
->reply
,ln
);
2063 if (copylen
== 0) return;
2067 /* Now the output buffer is empty, add the new single element */
2068 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2069 listAddNodeHead(c
->reply
,o
);
2072 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2073 redisClient
*c
= privdata
;
2074 int nwritten
= 0, totwritten
= 0, objlen
;
2077 REDIS_NOTUSED(mask
);
2079 /* Use writev() if we have enough buffers to send */
2080 if (!server
.glueoutputbuf
&&
2081 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2082 !(c
->flags
& REDIS_MASTER
))
2084 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2088 while(listLength(c
->reply
)) {
2089 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2090 glueReplyBuffersIfNeeded(c
);
2092 o
= listNodeValue(listFirst(c
->reply
));
2093 objlen
= sdslen(o
->ptr
);
2096 listDelNode(c
->reply
,listFirst(c
->reply
));
2100 if (c
->flags
& REDIS_MASTER
) {
2101 /* Don't reply to a master */
2102 nwritten
= objlen
- c
->sentlen
;
2104 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2105 if (nwritten
<= 0) break;
2107 c
->sentlen
+= nwritten
;
2108 totwritten
+= nwritten
;
2109 /* If we fully sent the object on head go to the next one */
2110 if (c
->sentlen
== objlen
) {
2111 listDelNode(c
->reply
,listFirst(c
->reply
));
2114 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2115 * bytes, in a single threaded server it's a good idea to serve
2116 * other clients as well, even if a very large request comes from
2117 * super fast link that is always able to accept data (in real world
2118 * scenario think about 'KEYS *' against the loopback interfae) */
2119 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2121 if (nwritten
== -1) {
2122 if (errno
== EAGAIN
) {
2125 redisLog(REDIS_VERBOSE
,
2126 "Error writing to client: %s", strerror(errno
));
2131 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2132 if (listLength(c
->reply
) == 0) {
2134 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2138 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2140 redisClient
*c
= privdata
;
2141 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2143 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2144 int offset
, ion
= 0;
2146 REDIS_NOTUSED(mask
);
2149 while (listLength(c
->reply
)) {
2150 offset
= c
->sentlen
;
2154 /* fill-in the iov[] array */
2155 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2156 o
= listNodeValue(node
);
2157 objlen
= sdslen(o
->ptr
);
2159 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2162 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2163 break; /* no more iovecs */
2165 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2166 iov
[ion
].iov_len
= objlen
- offset
;
2167 willwrite
+= objlen
- offset
;
2168 offset
= 0; /* just for the first item */
2175 /* write all collected blocks at once */
2176 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2177 if (errno
!= EAGAIN
) {
2178 redisLog(REDIS_VERBOSE
,
2179 "Error writing to client: %s", strerror(errno
));
2186 totwritten
+= nwritten
;
2187 offset
= c
->sentlen
;
2189 /* remove written robjs from c->reply */
2190 while (nwritten
&& listLength(c
->reply
)) {
2191 o
= listNodeValue(listFirst(c
->reply
));
2192 objlen
= sdslen(o
->ptr
);
2194 if(nwritten
>= objlen
- offset
) {
2195 listDelNode(c
->reply
, listFirst(c
->reply
));
2196 nwritten
-= objlen
- offset
;
2200 c
->sentlen
+= nwritten
;
2208 c
->lastinteraction
= time(NULL
);
2210 if (listLength(c
->reply
) == 0) {
2212 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2216 static struct redisCommand
*lookupCommand(char *name
) {
2218 while(cmdTable
[j
].name
!= NULL
) {
2219 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2225 /* resetClient prepare the client to process the next command */
2226 static void resetClient(redisClient
*c
) {
2232 /* Call() is the core of Redis execution of a command */
2233 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2236 dirty
= server
.dirty
;
2238 dirty
= server
.dirty
-dirty
;
2240 if (server
.appendonly
&& dirty
)
2241 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2242 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2243 listLength(server
.slaves
))
2244 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2245 if (listLength(server
.monitors
))
2246 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2247 server
.stat_numcommands
++;
2250 /* If this function gets called we already read a whole
2251 * command, argments are in the client argv/argc fields.
2252 * processCommand() execute the command or prepare the
2253 * server for a bulk read from the client.
2255 * If 1 is returned the client is still alive and valid and
2256 * and other operations can be performed by the caller. Otherwise
2257 * if 0 is returned the client was destroied (i.e. after QUIT). */
2258 static int processCommand(redisClient
*c
) {
2259 struct redisCommand
*cmd
;
2261 /* Free some memory if needed (maxmemory setting) */
2262 if (server
.maxmemory
) freeMemoryIfNeeded();
2264 /* Handle the multi bulk command type. This is an alternative protocol
2265 * supported by Redis in order to receive commands that are composed of
2266 * multiple binary-safe "bulk" arguments. The latency of processing is
2267 * a bit higher but this allows things like multi-sets, so if this
2268 * protocol is used only for MSET and similar commands this is a big win. */
2269 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2270 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2271 if (c
->multibulk
<= 0) {
2275 decrRefCount(c
->argv
[c
->argc
-1]);
2279 } else if (c
->multibulk
) {
2280 if (c
->bulklen
== -1) {
2281 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2282 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2286 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2287 decrRefCount(c
->argv
[0]);
2288 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2290 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2295 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2299 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2300 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2304 if (c
->multibulk
== 0) {
2308 /* Here we need to swap the multi-bulk argc/argv with the
2309 * normal argc/argv of the client structure. */
2311 c
->argv
= c
->mbargv
;
2312 c
->mbargv
= auxargv
;
2315 c
->argc
= c
->mbargc
;
2316 c
->mbargc
= auxargc
;
2318 /* We need to set bulklen to something different than -1
2319 * in order for the code below to process the command without
2320 * to try to read the last argument of a bulk command as
2321 * a special argument. */
2323 /* continue below and process the command */
2330 /* -- end of multi bulk commands processing -- */
2332 /* The QUIT command is handled as a special case. Normal command
2333 * procs are unable to close the client connection safely */
2334 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2339 /* Now lookup the command and check ASAP about trivial error conditions
2340 * such wrong arity, bad command name and so forth. */
2341 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2344 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2345 (char*)c
->argv
[0]->ptr
));
2348 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2349 (c
->argc
< -cmd
->arity
)) {
2351 sdscatprintf(sdsempty(),
2352 "-ERR wrong number of arguments for '%s' command\r\n",
2356 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2357 /* This is a bulk command, we have to read the last argument yet. */
2358 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2360 decrRefCount(c
->argv
[c
->argc
-1]);
2361 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2363 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2368 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2369 /* It is possible that the bulk read is already in the
2370 * buffer. Check this condition and handle it accordingly.
2371 * This is just a fast path, alternative to call processInputBuffer().
2372 * It's a good idea since the code is small and this condition
2373 * happens most of the times. */
2374 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2375 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2377 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2379 /* Otherwise return... there is to read the last argument
2380 * from the socket. */
2384 /* Let's try to encode the bulk object to save space. */
2385 if (cmd
->flags
& REDIS_CMD_BULK
)
2386 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2388 /* Check if the user is authenticated */
2389 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2390 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2395 /* Handle the maxmemory directive */
2396 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2397 zmalloc_used_memory() > server
.maxmemory
)
2399 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2404 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2405 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2407 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2408 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2409 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2414 /* Exec the command */
2415 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2416 queueMultiCommand(c
,cmd
);
2417 addReply(c
,shared
.queued
);
2419 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2420 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2424 /* Prepare the client for the next command */
2429 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2434 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2435 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2436 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2437 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2440 if (argc
<= REDIS_STATIC_ARGS
) {
2443 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2446 lenobj
= createObject(REDIS_STRING
,
2447 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2448 lenobj
->refcount
= 0;
2449 outv
[outc
++] = lenobj
;
2450 for (j
= 0; j
< argc
; j
++) {
2451 lenobj
= createObject(REDIS_STRING
,
2452 sdscatprintf(sdsempty(),"$%lu\r\n",
2453 (unsigned long) stringObjectLen(argv
[j
])));
2454 lenobj
->refcount
= 0;
2455 outv
[outc
++] = lenobj
;
2456 outv
[outc
++] = argv
[j
];
2457 outv
[outc
++] = shared
.crlf
;
2460 /* Increment all the refcounts at start and decrement at end in order to
2461 * be sure to free objects if there is no slave in a replication state
2462 * able to be feed with commands */
2463 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2464 listRewind(slaves
,&li
);
2465 while((ln
= listNext(&li
))) {
2466 redisClient
*slave
= ln
->value
;
2468 /* Don't feed slaves that are still waiting for BGSAVE to start */
2469 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2471 /* Feed all the other slaves, MONITORs and so on */
2472 if (slave
->slaveseldb
!= dictid
) {
2476 case 0: selectcmd
= shared
.select0
; break;
2477 case 1: selectcmd
= shared
.select1
; break;
2478 case 2: selectcmd
= shared
.select2
; break;
2479 case 3: selectcmd
= shared
.select3
; break;
2480 case 4: selectcmd
= shared
.select4
; break;
2481 case 5: selectcmd
= shared
.select5
; break;
2482 case 6: selectcmd
= shared
.select6
; break;
2483 case 7: selectcmd
= shared
.select7
; break;
2484 case 8: selectcmd
= shared
.select8
; break;
2485 case 9: selectcmd
= shared
.select9
; break;
2487 selectcmd
= createObject(REDIS_STRING
,
2488 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2489 selectcmd
->refcount
= 0;
2492 addReply(slave
,selectcmd
);
2493 slave
->slaveseldb
= dictid
;
2495 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2497 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2498 if (outv
!= static_outv
) zfree(outv
);
2501 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2502 s
= sdscatlen(s
,"\"",1);
2507 s
= sdscatprintf(s
,"\\%c",*p
);
2509 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2510 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2511 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2512 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2513 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2516 s
= sdscatprintf(s
,"%c",*p
);
2518 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2523 return sdscatlen(s
,"\"",1);
2526 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2530 sds cmdrepr
= sdsnew("+");
2534 gettimeofday(&tv
,NULL
);
2535 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2536 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2538 for (j
= 0; j
< argc
; j
++) {
2539 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2540 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2542 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2543 sdslen(argv
[j
]->ptr
));
2546 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2548 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2549 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2551 listRewind(monitors
,&li
);
2552 while((ln
= listNext(&li
))) {
2553 redisClient
*monitor
= ln
->value
;
2554 addReply(monitor
,cmdobj
);
2556 decrRefCount(cmdobj
);
2559 static void processInputBuffer(redisClient
*c
) {
2561 /* Before to process the input buffer, make sure the client is not
2562 * waitig for a blocking operation such as BLPOP. Note that the first
2563 * iteration the client is never blocked, otherwise the processInputBuffer
2564 * would not be called at all, but after the execution of the first commands
2565 * in the input buffer the client may be blocked, and the "goto again"
2566 * will try to reiterate. The following line will make it return asap. */
2567 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2568 if (c
->bulklen
== -1) {
2569 /* Read the first line of the query */
2570 char *p
= strchr(c
->querybuf
,'\n');
2577 query
= c
->querybuf
;
2578 c
->querybuf
= sdsempty();
2579 querylen
= 1+(p
-(query
));
2580 if (sdslen(query
) > querylen
) {
2581 /* leave data after the first line of the query in the buffer */
2582 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2584 *p
= '\0'; /* remove "\n" */
2585 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2586 sdsupdatelen(query
);
2588 /* Now we can split the query in arguments */
2589 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2592 if (c
->argv
) zfree(c
->argv
);
2593 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2595 for (j
= 0; j
< argc
; j
++) {
2596 if (sdslen(argv
[j
])) {
2597 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2605 /* Execute the command. If the client is still valid
2606 * after processCommand() return and there is something
2607 * on the query buffer try to process the next command. */
2608 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2610 /* Nothing to process, argc == 0. Just process the query
2611 * buffer if it's not empty or return to the caller */
2612 if (sdslen(c
->querybuf
)) goto again
;
2615 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2616 redisLog(REDIS_VERBOSE
, "Client protocol error");
2621 /* Bulk read handling. Note that if we are at this point
2622 the client already sent a command terminated with a newline,
2623 we are reading the bulk data that is actually the last
2624 argument of the command. */
2625 int qbl
= sdslen(c
->querybuf
);
2627 if (c
->bulklen
<= qbl
) {
2628 /* Copy everything but the final CRLF as final argument */
2629 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2631 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2632 /* Process the command. If the client is still valid after
2633 * the processing and there is more data in the buffer
2634 * try to parse it. */
2635 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2641 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2642 redisClient
*c
= (redisClient
*) privdata
;
2643 char buf
[REDIS_IOBUF_LEN
];
2646 REDIS_NOTUSED(mask
);
2648 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2650 if (errno
== EAGAIN
) {
2653 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2657 } else if (nread
== 0) {
2658 redisLog(REDIS_VERBOSE
, "Client closed connection");
2663 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2664 c
->lastinteraction
= time(NULL
);
2668 processInputBuffer(c
);
2671 static int selectDb(redisClient
*c
, int id
) {
2672 if (id
< 0 || id
>= server
.dbnum
)
2674 c
->db
= &server
.db
[id
];
2678 static void *dupClientReplyValue(void *o
) {
2679 incrRefCount((robj
*)o
);
2683 static int listMatchObjects(void *a
, void *b
) {
2684 return equalStringObjects(a
,b
);
2687 static redisClient
*createClient(int fd
) {
2688 redisClient
*c
= zmalloc(sizeof(*c
));
2690 anetNonBlock(NULL
,fd
);
2691 anetTcpNoDelay(NULL
,fd
);
2692 if (!c
) return NULL
;
2695 c
->querybuf
= sdsempty();
2704 c
->lastinteraction
= time(NULL
);
2705 c
->authenticated
= 0;
2706 c
->replstate
= REDIS_REPL_NONE
;
2707 c
->reply
= listCreate();
2708 listSetFreeMethod(c
->reply
,decrRefCount
);
2709 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2710 c
->blockingkeys
= NULL
;
2711 c
->blockingkeysnum
= 0;
2712 c
->io_keys
= listCreate();
2713 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2714 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2715 c
->pubsub_patterns
= listCreate();
2716 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2717 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2718 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2719 readQueryFromClient
, c
) == AE_ERR
) {
2723 listAddNodeTail(server
.clients
,c
);
2724 initClientMultiState(c
);
2728 static void addReply(redisClient
*c
, robj
*obj
) {
2729 if (listLength(c
->reply
) == 0 &&
2730 (c
->replstate
== REDIS_REPL_NONE
||
2731 c
->replstate
== REDIS_REPL_ONLINE
) &&
2732 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2733 sendReplyToClient
, c
) == AE_ERR
) return;
2735 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2736 obj
= dupStringObject(obj
);
2737 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2739 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2742 static void addReplySds(redisClient
*c
, sds s
) {
2743 robj
*o
= createObject(REDIS_STRING
,s
);
2748 static void addReplyDouble(redisClient
*c
, double d
) {
2751 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2752 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2753 (unsigned long) strlen(buf
),buf
));
2756 static void addReplyLong(redisClient
*c
, long l
) {
2761 addReply(c
,shared
.czero
);
2763 } else if (l
== 1) {
2764 addReply(c
,shared
.cone
);
2767 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2768 addReplySds(c
,sdsnewlen(buf
,len
));
2771 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2776 addReply(c
,shared
.czero
);
2778 } else if (ll
== 1) {
2779 addReply(c
,shared
.cone
);
2782 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2783 addReplySds(c
,sdsnewlen(buf
,len
));
2786 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2791 addReply(c
,shared
.czero
);
2793 } else if (ul
== 1) {
2794 addReply(c
,shared
.cone
);
2797 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2798 addReplySds(c
,sdsnewlen(buf
,len
));
2801 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2804 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2805 len
= sdslen(obj
->ptr
);
2807 long n
= (long)obj
->ptr
;
2809 /* Compute how many bytes will take this integer as a radix 10 string */
2815 while((n
= n
/10) != 0) {
2819 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2822 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2823 addReplyBulkLen(c
,obj
);
2825 addReply(c
,shared
.crlf
);
2828 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2829 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2831 addReply(c
,shared
.nullbulk
);
2833 robj
*o
= createStringObject(s
,strlen(s
));
2839 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2844 REDIS_NOTUSED(mask
);
2845 REDIS_NOTUSED(privdata
);
2847 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2848 if (cfd
== AE_ERR
) {
2849 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2852 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2853 if ((c
= createClient(cfd
)) == NULL
) {
2854 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2855 close(cfd
); /* May be already closed, just ingore errors */
2858 /* If maxclient directive is set and this is one client more... close the
2859 * connection. Note that we create the client instead to check before
2860 * for this condition, since now the socket is already set in nonblocking
2861 * mode and we can send an error for free using the Kernel I/O */
2862 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2863 char *err
= "-ERR max number of clients reached\r\n";
2865 /* That's a best effort error message, don't check write errors */
2866 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2867 /* Nothing to do, Just to avoid the warning... */
2872 server
.stat_numconnections
++;
2875 /* ======================= Redis objects implementation ===================== */
2877 static robj
*createObject(int type
, void *ptr
) {
2880 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2881 if (listLength(server
.objfreelist
)) {
2882 listNode
*head
= listFirst(server
.objfreelist
);
2883 o
= listNodeValue(head
);
2884 listDelNode(server
.objfreelist
,head
);
2885 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2887 if (server
.vm_enabled
) {
2888 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2889 o
= zmalloc(sizeof(*o
));
2891 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2895 o
->encoding
= REDIS_ENCODING_RAW
;
2898 if (server
.vm_enabled
) {
2899 /* Note that this code may run in the context of an I/O thread
2900 * and accessing to server.unixtime in theory is an error
2901 * (no locks). But in practice this is safe, and even if we read
2902 * garbage Redis will not fail, as it's just a statistical info */
2903 o
->vm
.atime
= server
.unixtime
;
2904 o
->storage
= REDIS_VM_MEMORY
;
2909 static robj
*createStringObject(char *ptr
, size_t len
) {
2910 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2913 static robj
*createStringObjectFromLongLong(long long value
) {
2915 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2916 incrRefCount(shared
.integers
[value
]);
2917 o
= shared
.integers
[value
];
2919 o
= createObject(REDIS_STRING
, NULL
);
2920 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2921 o
->encoding
= REDIS_ENCODING_INT
;
2922 o
->ptr
= (void*)((long)value
);
2924 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
2930 static robj
*dupStringObject(robj
*o
) {
2931 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2932 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2935 static robj
*createListObject(void) {
2936 list
*l
= listCreate();
2938 listSetFreeMethod(l
,decrRefCount
);
2939 return createObject(REDIS_LIST
,l
);
2942 static robj
*createSetObject(void) {
2943 dict
*d
= dictCreate(&setDictType
,NULL
);
2944 return createObject(REDIS_SET
,d
);
2947 static robj
*createHashObject(void) {
2948 /* All the Hashes start as zipmaps. Will be automatically converted
2949 * into hash tables if there are enough elements or big elements
2951 unsigned char *zm
= zipmapNew();
2952 robj
*o
= createObject(REDIS_HASH
,zm
);
2953 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2957 static robj
*createZsetObject(void) {
2958 zset
*zs
= zmalloc(sizeof(*zs
));
2960 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2961 zs
->zsl
= zslCreate();
2962 return createObject(REDIS_ZSET
,zs
);
2965 static void freeStringObject(robj
*o
) {
2966 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2971 static void freeListObject(robj
*o
) {
2972 listRelease((list
*) o
->ptr
);
2975 static void freeSetObject(robj
*o
) {
2976 dictRelease((dict
*) o
->ptr
);
2979 static void freeZsetObject(robj
*o
) {
2982 dictRelease(zs
->dict
);
2987 static void freeHashObject(robj
*o
) {
2988 switch (o
->encoding
) {
2989 case REDIS_ENCODING_HT
:
2990 dictRelease((dict
*) o
->ptr
);
2992 case REDIS_ENCODING_ZIPMAP
:
2996 redisPanic("Unknown hash encoding type");
3001 static void incrRefCount(robj
*o
) {
3005 static void decrRefCount(void *obj
) {
3008 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3009 /* Object is a key of a swapped out value, or in the process of being
3011 if (server
.vm_enabled
&&
3012 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3014 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3015 redisAssert(o
->type
== REDIS_STRING
);
3016 freeStringObject(o
);
3017 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3018 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3019 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3020 !listAddNodeHead(server
.objfreelist
,o
))
3022 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3023 server
.vm_stats_swapped_objects
--;
3026 /* Object is in memory, or in the process of being swapped out. */
3027 if (--(o
->refcount
) == 0) {
3028 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3029 vmCancelThreadedIOJob(obj
);
3031 case REDIS_STRING
: freeStringObject(o
); break;
3032 case REDIS_LIST
: freeListObject(o
); break;
3033 case REDIS_SET
: freeSetObject(o
); break;
3034 case REDIS_ZSET
: freeZsetObject(o
); break;
3035 case REDIS_HASH
: freeHashObject(o
); break;
3036 default: redisPanic("Unknown object type"); break;
3038 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3039 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3040 !listAddNodeHead(server
.objfreelist
,o
))
3042 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3046 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3047 dictEntry
*de
= dictFind(db
->dict
,key
);
3049 robj
*key
= dictGetEntryKey(de
);
3050 robj
*val
= dictGetEntryVal(de
);
3052 if (server
.vm_enabled
) {
3053 if (key
->storage
== REDIS_VM_MEMORY
||
3054 key
->storage
== REDIS_VM_SWAPPING
)
3056 /* If we were swapping the object out, stop it, this key
3058 if (key
->storage
== REDIS_VM_SWAPPING
)
3059 vmCancelThreadedIOJob(key
);
3060 /* Update the access time of the key for the aging algorithm. */
3061 key
->vm
.atime
= server
.unixtime
;
3063 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3065 /* Our value was swapped on disk. Bring it at home. */
3066 redisAssert(val
== NULL
);
3067 val
= vmLoadObject(key
);
3068 dictGetEntryVal(de
) = val
;
3070 /* Clients blocked by the VM subsystem may be waiting for
3072 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3081 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3082 expireIfNeeded(db
,key
);
3083 return lookupKey(db
,key
);
3086 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3087 deleteIfVolatile(db
,key
);
3088 return lookupKey(db
,key
);
3091 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3092 robj
*o
= lookupKeyRead(c
->db
, key
);
3093 if (!o
) addReply(c
,reply
);
3097 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3098 robj
*o
= lookupKeyWrite(c
->db
, key
);
3099 if (!o
) addReply(c
,reply
);
3103 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3104 if (o
->type
!= type
) {
3105 addReply(c
,shared
.wrongtypeerr
);
3111 static int deleteKey(redisDb
*db
, robj
*key
) {
3114 /* We need to protect key from destruction: after the first dictDelete()
3115 * it may happen that 'key' is no longer valid if we don't increment
3116 * it's count. This may happen when we get the object reference directly
3117 * from the hash table with dictRandomKey() or dict iterators */
3119 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3120 retval
= dictDelete(db
->dict
,key
);
3123 return retval
== DICT_OK
;
3126 /* Check if the nul-terminated string 's' can be represented by a long
3127 * (that is, is a number that fits into long without any other space or
3128 * character before or after the digits).
3130 * If so, the function returns REDIS_OK and *longval is set to the value
3131 * of the number. Otherwise REDIS_ERR is returned */
3132 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3133 char buf
[32], *endptr
;
3137 value
= strtol(s
, &endptr
, 10);
3138 if (endptr
[0] != '\0') return REDIS_ERR
;
3139 slen
= ll2string(buf
,32,value
);
3141 /* If the number converted back into a string is not identical
3142 * then it's not possible to encode the string as integer */
3143 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3144 if (longval
) *longval
= value
;
3148 /* Try to encode a string object in order to save space */
3149 static robj
*tryObjectEncoding(robj
*o
) {
3153 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3154 return o
; /* Already encoded */
3156 /* It's not safe to encode shared objects: shared objects can be shared
3157 * everywhere in the "object space" of Redis. Encoded objects can only
3158 * appear as "values" (and not, for instance, as keys) */
3159 if (o
->refcount
> 1) return o
;
3161 /* Currently we try to encode only strings */
3162 redisAssert(o
->type
== REDIS_STRING
);
3164 /* Check if we can represent this string as a long integer */
3165 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3167 /* Ok, this object can be encoded */
3168 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3170 incrRefCount(shared
.integers
[value
]);
3171 return shared
.integers
[value
];
3173 o
->encoding
= REDIS_ENCODING_INT
;
3175 o
->ptr
= (void*) value
;
3180 /* Get a decoded version of an encoded object (returned as a new object).
3181 * If the object is already raw-encoded just increment the ref count. */
3182 static robj
*getDecodedObject(robj
*o
) {
3185 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3189 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3192 ll2string(buf
,32,(long)o
->ptr
);
3193 dec
= createStringObject(buf
,strlen(buf
));
3196 redisPanic("Unknown encoding type");
3200 /* Compare two string objects via strcmp() or alike.
3201 * Note that the objects may be integer-encoded. In such a case we
3202 * use ll2string() to get a string representation of the numbers on the stack
3203 * and compare the strings, it's much faster than calling getDecodedObject().
3205 * Important note: if objects are not integer encoded, but binary-safe strings,
3206 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3208 static int compareStringObjects(robj
*a
, robj
*b
) {
3209 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3210 char bufa
[128], bufb
[128], *astr
, *bstr
;
3213 if (a
== b
) return 0;
3214 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3215 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3221 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3222 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3228 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3231 /* Equal string objects return 1 if the two objects are the same from the
3232 * point of view of a string comparison, otherwise 0 is returned. Note that
3233 * this function is faster then checking for (compareStringObject(a,b) == 0)
3234 * because it can perform some more optimization. */
3235 static int equalStringObjects(robj
*a
, robj
*b
) {
3236 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3237 return a
->ptr
== b
->ptr
;
3239 return compareStringObjects(a
,b
) == 0;
3243 static size_t stringObjectLen(robj
*o
) {
3244 redisAssert(o
->type
== REDIS_STRING
);
3245 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3246 return sdslen(o
->ptr
);
3250 return ll2string(buf
,32,(long)o
->ptr
);
3254 static int getDoubleFromObject(robj
*o
, double *target
) {
3261 redisAssert(o
->type
== REDIS_STRING
);
3262 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3263 value
= strtod(o
->ptr
, &eptr
);
3264 if (eptr
[0] != '\0') return REDIS_ERR
;
3265 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3266 value
= (long)o
->ptr
;
3268 redisPanic("Unknown string encoding");
3276 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3278 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3280 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3282 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3291 static int getLongLongFromObject(robj
*o
, long long *target
) {
3298 redisAssert(o
->type
== REDIS_STRING
);
3299 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3300 value
= strtoll(o
->ptr
, &eptr
, 10);
3301 if (eptr
[0] != '\0') return REDIS_ERR
;
3302 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3303 value
= (long)o
->ptr
;
3305 redisPanic("Unknown string encoding");
3313 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3315 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3317 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3319 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3328 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3331 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3332 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3334 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3336 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3345 /*============================ RDB saving/loading =========================== */
3347 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3348 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3352 static int rdbSaveTime(FILE *fp
, time_t t
) {
3353 int32_t t32
= (int32_t) t
;
3354 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3358 /* check rdbLoadLen() comments for more info */
3359 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3360 unsigned char buf
[2];
3363 /* Save a 6 bit len */
3364 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3365 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3366 } else if (len
< (1<<14)) {
3367 /* Save a 14 bit len */
3368 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3370 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3372 /* Save a 32 bit len */
3373 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3374 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3376 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3381 /* String objects in the form "2391" "-100" without any space and with a
3382 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3383 * encoded as integers to save space */
3384 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3386 char *endptr
, buf
[32];
3388 /* Check if it's possible to encode this value as a number */
3389 value
= strtoll(s
, &endptr
, 10);
3390 if (endptr
[0] != '\0') return 0;
3391 ll2string(buf
,32,value
);
3393 /* If the number converted back into a string is not identical
3394 * then it's not possible to encode the string as integer */
3395 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3397 /* Finally check if it fits in our ranges */
3398 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3399 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3400 enc
[1] = value
&0xFF;
3402 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3403 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3404 enc
[1] = value
&0xFF;
3405 enc
[2] = (value
>>8)&0xFF;
3407 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3408 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3409 enc
[1] = value
&0xFF;
3410 enc
[2] = (value
>>8)&0xFF;
3411 enc
[3] = (value
>>16)&0xFF;
3412 enc
[4] = (value
>>24)&0xFF;
3419 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3420 size_t comprlen
, outlen
;
3424 /* We require at least four bytes compression for this to be worth it */
3425 if (len
<= 4) return 0;
3427 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3428 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3429 if (comprlen
== 0) {
3433 /* Data compressed! Let's save it on disk */
3434 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3435 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3436 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3437 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3438 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3447 /* Save a string objet as [len][data] on disk. If the object is a string
3448 * representation of an integer value we try to safe it in a special form */
3449 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3452 /* Try integer encoding */
3454 unsigned char buf
[5];
3455 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3456 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3461 /* Try LZF compression - under 20 bytes it's unable to compress even
3462 * aaaaaaaaaaaaaaaaaa so skip it */
3463 if (server
.rdbcompression
&& len
> 20) {
3466 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3467 if (retval
== -1) return -1;
3468 if (retval
> 0) return 0;
3469 /* retval == 0 means data can't be compressed, save the old way */
3472 /* Store verbatim */
3473 if (rdbSaveLen(fp
,len
) == -1) return -1;
3474 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3478 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3479 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3482 /* Avoid incr/decr ref count business when possible.
3483 * This plays well with copy-on-write given that we are probably
3484 * in a child process (BGSAVE). Also this makes sure key objects
3485 * of swapped objects are not incRefCount-ed (an assert does not allow
3486 * this in order to avoid bugs) */
3487 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3488 obj
= getDecodedObject(obj
);
3489 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3492 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3497 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3498 * 8 bit integer specifing the length of the representation.
3499 * This 8 bit integer has special values in order to specify the following
3505 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3506 unsigned char buf
[128];
3512 } else if (!isfinite(val
)) {
3514 buf
[0] = (val
< 0) ? 255 : 254;
3516 /* Check if the float is in a safe range to be casted into a
3517 * long long. We are assuming that long long is 64 bit here.
3518 * Also we are assuming that there are no implementations around where
3519 * double has precision < 52 bit.
3521 * Under this assumptions we test if a double is inside an interval
3522 * where casting to long long is safe. Then using two castings we
3523 * make sure the decimal part is zero. If all this is true we use
3524 * integer printing function that is much faster. */
3525 double min
= -4503599627370495;
3526 double max
= 4503599627370496;
3527 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3528 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3530 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3531 buf
[0] = strlen((char*)buf
+1);
3534 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3538 /* Save a Redis object. */
3539 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3540 if (o
->type
== REDIS_STRING
) {
3541 /* Save a string value */
3542 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3543 } else if (o
->type
== REDIS_LIST
) {
3544 /* Save a list value */
3545 list
*list
= o
->ptr
;
3549 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3550 listRewind(list
,&li
);
3551 while((ln
= listNext(&li
))) {
3552 robj
*eleobj
= listNodeValue(ln
);
3554 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3556 } else if (o
->type
== REDIS_SET
) {
3557 /* Save a set value */
3559 dictIterator
*di
= dictGetIterator(set
);
3562 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3563 while((de
= dictNext(di
)) != NULL
) {
3564 robj
*eleobj
= dictGetEntryKey(de
);
3566 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3568 dictReleaseIterator(di
);
3569 } else if (o
->type
== REDIS_ZSET
) {
3570 /* Save a set value */
3572 dictIterator
*di
= dictGetIterator(zs
->dict
);
3575 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3576 while((de
= dictNext(di
)) != NULL
) {
3577 robj
*eleobj
= dictGetEntryKey(de
);
3578 double *score
= dictGetEntryVal(de
);
3580 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3581 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3583 dictReleaseIterator(di
);
3584 } else if (o
->type
== REDIS_HASH
) {
3585 /* Save a hash value */
3586 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3587 unsigned char *p
= zipmapRewind(o
->ptr
);
3588 unsigned int count
= zipmapLen(o
->ptr
);
3589 unsigned char *key
, *val
;
3590 unsigned int klen
, vlen
;
3592 if (rdbSaveLen(fp
,count
) == -1) return -1;
3593 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3594 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3595 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3598 dictIterator
*di
= dictGetIterator(o
->ptr
);
3601 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3602 while((de
= dictNext(di
)) != NULL
) {
3603 robj
*key
= dictGetEntryKey(de
);
3604 robj
*val
= dictGetEntryVal(de
);
3606 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3607 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3609 dictReleaseIterator(di
);
3612 redisPanic("Unknown object type");
3617 /* Return the length the object will have on disk if saved with
3618 * the rdbSaveObject() function. Currently we use a trick to get
3619 * this length with very little changes to the code. In the future
3620 * we could switch to a faster solution. */
3621 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3622 if (fp
== NULL
) fp
= server
.devnull
;
3624 assert(rdbSaveObject(fp
,o
) != 1);
3628 /* Return the number of pages required to save this object in the swap file */
3629 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3630 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3632 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3635 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3636 static int rdbSave(char *filename
) {
3637 dictIterator
*di
= NULL
;
3642 time_t now
= time(NULL
);
3644 /* Wait for I/O therads to terminate, just in case this is a
3645 * foreground-saving, to avoid seeking the swap file descriptor at the
3647 if (server
.vm_enabled
)
3648 waitEmptyIOJobsQueue();
3650 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3651 fp
= fopen(tmpfile
,"w");
3653 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3656 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3657 for (j
= 0; j
< server
.dbnum
; j
++) {
3658 redisDb
*db
= server
.db
+j
;
3660 if (dictSize(d
) == 0) continue;
3661 di
= dictGetIterator(d
);
3667 /* Write the SELECT DB opcode */
3668 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3669 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3671 /* Iterate this DB writing every entry */
3672 while((de
= dictNext(di
)) != NULL
) {
3673 robj
*key
= dictGetEntryKey(de
);
3674 robj
*o
= dictGetEntryVal(de
);
3675 time_t expiretime
= getExpire(db
,key
);
3677 /* Save the expire time */
3678 if (expiretime
!= -1) {
3679 /* If this key is already expired skip it */
3680 if (expiretime
< now
) continue;
3681 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3682 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3684 /* Save the key and associated value. This requires special
3685 * handling if the value is swapped out. */
3686 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3687 key
->storage
== REDIS_VM_SWAPPING
) {
3688 /* Save type, key, value */
3689 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3690 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3691 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3693 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3695 /* Get a preview of the object in memory */
3696 po
= vmPreviewObject(key
);
3697 /* Save type, key, value */
3698 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3699 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3700 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3701 /* Remove the loaded object from memory */
3705 dictReleaseIterator(di
);
3708 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3710 /* Make sure data will not remain on the OS's output buffers */
3715 /* Use RENAME to make sure the DB file is changed atomically only
3716 * if the generate DB file is ok. */
3717 if (rename(tmpfile
,filename
) == -1) {
3718 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3722 redisLog(REDIS_NOTICE
,"DB saved on disk");
3724 server
.lastsave
= time(NULL
);
3730 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3731 if (di
) dictReleaseIterator(di
);
3735 static int rdbSaveBackground(char *filename
) {
3738 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3739 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3740 if ((childpid
= fork()) == 0) {
3742 if (server
.vm_enabled
) vmReopenSwapFile();
3744 if (rdbSave(filename
) == REDIS_OK
) {
3751 if (childpid
== -1) {
3752 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3756 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3757 server
.bgsavechildpid
= childpid
;
3758 updateDictResizePolicy();
3761 return REDIS_OK
; /* unreached */
3764 static void rdbRemoveTempFile(pid_t childpid
) {
3767 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3771 static int rdbLoadType(FILE *fp
) {
3773 if (fread(&type
,1,1,fp
) == 0) return -1;
3777 static time_t rdbLoadTime(FILE *fp
) {
3779 if (fread(&t32
,4,1,fp
) == 0) return -1;
3780 return (time_t) t32
;
3783 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3784 * of this file for a description of how this are stored on disk.
3786 * isencoded is set to 1 if the readed length is not actually a length but
3787 * an "encoding type", check the above comments for more info */
3788 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3789 unsigned char buf
[2];
3793 if (isencoded
) *isencoded
= 0;
3794 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3795 type
= (buf
[0]&0xC0)>>6;
3796 if (type
== REDIS_RDB_6BITLEN
) {
3797 /* Read a 6 bit len */
3799 } else if (type
== REDIS_RDB_ENCVAL
) {
3800 /* Read a 6 bit len encoding type */
3801 if (isencoded
) *isencoded
= 1;
3803 } else if (type
== REDIS_RDB_14BITLEN
) {
3804 /* Read a 14 bit len */
3805 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3806 return ((buf
[0]&0x3F)<<8)|buf
[1];
3808 /* Read a 32 bit len */
3809 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3814 /* Load an integer-encoded object from file 'fp', with the specified
3815 * encoding type 'enctype'. If encode is true the function may return
3816 * an integer-encoded object as reply, otherwise the returned object
3817 * will always be encoded as a raw string. */
3818 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3819 unsigned char enc
[4];
3822 if (enctype
== REDIS_RDB_ENC_INT8
) {
3823 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3824 val
= (signed char)enc
[0];
3825 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3827 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3828 v
= enc
[0]|(enc
[1]<<8);
3830 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3832 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3833 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3836 val
= 0; /* anti-warning */
3837 redisPanic("Unknown RDB integer encoding type");
3840 return createStringObjectFromLongLong(val
);
3842 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3845 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3846 unsigned int len
, clen
;
3847 unsigned char *c
= NULL
;
3850 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3851 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3852 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3853 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3854 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3855 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3857 return createObject(REDIS_STRING
,val
);
3864 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3869 len
= rdbLoadLen(fp
,&isencoded
);
3872 case REDIS_RDB_ENC_INT8
:
3873 case REDIS_RDB_ENC_INT16
:
3874 case REDIS_RDB_ENC_INT32
:
3875 return rdbLoadIntegerObject(fp
,len
,encode
);
3876 case REDIS_RDB_ENC_LZF
:
3877 return rdbLoadLzfStringObject(fp
);
3879 redisPanic("Unknown RDB encoding type");
3883 if (len
== REDIS_RDB_LENERR
) return NULL
;
3884 val
= sdsnewlen(NULL
,len
);
3885 if (len
&& fread(val
,len
,1,fp
) == 0) {
3889 return createObject(REDIS_STRING
,val
);
3892 static robj
*rdbLoadStringObject(FILE *fp
) {
3893 return rdbGenericLoadStringObject(fp
,0);
3896 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3897 return rdbGenericLoadStringObject(fp
,1);
3900 /* For information about double serialization check rdbSaveDoubleValue() */
3901 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3905 if (fread(&len
,1,1,fp
) == 0) return -1;
3907 case 255: *val
= R_NegInf
; return 0;
3908 case 254: *val
= R_PosInf
; return 0;
3909 case 253: *val
= R_Nan
; return 0;
3911 if (fread(buf
,len
,1,fp
) == 0) return -1;
3913 sscanf(buf
, "%lg", val
);
3918 /* Load a Redis object of the specified type from the specified file.
3919 * On success a newly allocated object is returned, otherwise NULL. */
3920 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3923 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3924 if (type
== REDIS_STRING
) {
3925 /* Read string value */
3926 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3927 o
= tryObjectEncoding(o
);
3928 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3929 /* Read list/set value */
3932 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3933 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3934 /* It's faster to expand the dict to the right size asap in order
3935 * to avoid rehashing */
3936 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3937 dictExpand(o
->ptr
,listlen
);
3938 /* Load every single element of the list/set */
3942 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3943 ele
= tryObjectEncoding(ele
);
3944 if (type
== REDIS_LIST
) {
3945 listAddNodeTail((list
*)o
->ptr
,ele
);
3947 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3950 } else if (type
== REDIS_ZSET
) {
3951 /* Read list/set value */
3955 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3956 o
= createZsetObject();
3958 /* Load every single element of the list/set */
3961 double *score
= zmalloc(sizeof(double));
3963 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3964 ele
= tryObjectEncoding(ele
);
3965 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3966 dictAdd(zs
->dict
,ele
,score
);
3967 zslInsert(zs
->zsl
,*score
,ele
);
3968 incrRefCount(ele
); /* added to skiplist */
3970 } else if (type
== REDIS_HASH
) {
3973 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3974 o
= createHashObject();
3975 /* Too many entries? Use an hash table. */
3976 if (hashlen
> server
.hash_max_zipmap_entries
)
3977 convertToRealHash(o
);
3978 /* Load every key/value, then set it into the zipmap or hash
3979 * table, as needed. */
3983 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3984 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3985 /* If we are using a zipmap and there are too big values
3986 * the object is converted to real hash table encoding. */
3987 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3988 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3989 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3991 convertToRealHash(o
);
3994 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3995 unsigned char *zm
= o
->ptr
;
3997 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3998 val
->ptr
,sdslen(val
->ptr
),NULL
);
4003 key
= tryObjectEncoding(key
);
4004 val
= tryObjectEncoding(val
);
4005 dictAdd((dict
*)o
->ptr
,key
,val
);
4009 redisPanic("Unknown object type");
4014 static int rdbLoad(char *filename
) {
4017 int type
, retval
, rdbver
;
4018 int swap_all_values
= 0;
4019 dict
*d
= server
.db
[0].dict
;
4020 redisDb
*db
= server
.db
+0;
4022 time_t expiretime
, now
= time(NULL
);
4023 long long loadedkeys
= 0;
4025 fp
= fopen(filename
,"r");
4026 if (!fp
) return REDIS_ERR
;
4027 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4029 if (memcmp(buf
,"REDIS",5) != 0) {
4031 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4034 rdbver
= atoi(buf
+5);
4037 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4045 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4046 if (type
== REDIS_EXPIRETIME
) {
4047 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4048 /* We read the time so we need to read the object type again */
4049 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4051 if (type
== REDIS_EOF
) break;
4052 /* Handle SELECT DB opcode as a special case */
4053 if (type
== REDIS_SELECTDB
) {
4054 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4056 if (dbid
>= (unsigned)server
.dbnum
) {
4057 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4060 db
= server
.db
+dbid
;
4065 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4067 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4068 /* Check if the key already expired */
4069 if (expiretime
!= -1 && expiretime
< now
) {
4074 /* Add the new object in the hash table */
4075 retval
= dictAdd(d
,key
,val
);
4076 if (retval
== DICT_ERR
) {
4077 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4081 /* Set the expire time if needed */
4082 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4084 /* Handle swapping while loading big datasets when VM is on */
4086 /* If we detecter we are hopeless about fitting something in memory
4087 * we just swap every new key on disk. Directly...
4088 * Note that's important to check for this condition before resorting
4089 * to random sampling, otherwise we may try to swap already
4091 if (swap_all_values
) {
4092 dictEntry
*de
= dictFind(d
,key
);
4094 /* de may be NULL since the key already expired */
4096 key
= dictGetEntryKey(de
);
4097 val
= dictGetEntryVal(de
);
4099 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4100 dictGetEntryVal(de
) = NULL
;
4106 /* If we have still some hope of having some value fitting memory
4107 * then we try random sampling. */
4108 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4109 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4110 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4112 if (zmalloc_used_memory() > server
.vm_max_memory
)
4113 swap_all_values
= 1; /* We are already using too much mem */
4119 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4120 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4122 return REDIS_ERR
; /* Just to avoid warning */
4125 /*================================== Commands =============================== */
4127 static void authCommand(redisClient
*c
) {
4128 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4129 c
->authenticated
= 1;
4130 addReply(c
,shared
.ok
);
4132 c
->authenticated
= 0;
4133 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4137 static void pingCommand(redisClient
*c
) {
4138 addReply(c
,shared
.pong
);
4141 static void echoCommand(redisClient
*c
) {
4142 addReplyBulk(c
,c
->argv
[1]);
4145 /*=================================== Strings =============================== */
4147 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4149 long seconds
= 0; /* initialized to avoid an harmness warning */
4152 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4155 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4160 if (nx
) deleteIfVolatile(c
->db
,key
);
4161 retval
= dictAdd(c
->db
->dict
,key
,val
);
4162 if (retval
== DICT_ERR
) {
4164 /* If the key is about a swapped value, we want a new key object
4165 * to overwrite the old. So we delete the old key in the database.
4166 * This will also make sure that swap pages about the old object
4167 * will be marked as free. */
4168 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4170 dictReplace(c
->db
->dict
,key
,val
);
4173 addReply(c
,shared
.czero
);
4181 removeExpire(c
->db
,key
);
4182 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4183 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4186 static void setCommand(redisClient
*c
) {
4187 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4190 static void setnxCommand(redisClient
*c
) {
4191 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4194 static void setexCommand(redisClient
*c
) {
4195 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4198 static int getGenericCommand(redisClient
*c
) {
4201 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4204 if (o
->type
!= REDIS_STRING
) {
4205 addReply(c
,shared
.wrongtypeerr
);
4213 static void getCommand(redisClient
*c
) {
4214 getGenericCommand(c
);
4217 static void getsetCommand(redisClient
*c
) {
4218 if (getGenericCommand(c
) == REDIS_ERR
) return;
4219 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4220 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4222 incrRefCount(c
->argv
[1]);
4224 incrRefCount(c
->argv
[2]);
4226 removeExpire(c
->db
,c
->argv
[1]);
4229 static void mgetCommand(redisClient
*c
) {
4232 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4233 for (j
= 1; j
< c
->argc
; j
++) {
4234 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4236 addReply(c
,shared
.nullbulk
);
4238 if (o
->type
!= REDIS_STRING
) {
4239 addReply(c
,shared
.nullbulk
);
4247 static void msetGenericCommand(redisClient
*c
, int nx
) {
4248 int j
, busykeys
= 0;
4250 if ((c
->argc
% 2) == 0) {
4251 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4254 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4255 * set nothing at all if at least one already key exists. */
4257 for (j
= 1; j
< c
->argc
; j
+= 2) {
4258 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4264 addReply(c
, shared
.czero
);
4268 for (j
= 1; j
< c
->argc
; j
+= 2) {
4271 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4272 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4273 if (retval
== DICT_ERR
) {
4274 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4275 incrRefCount(c
->argv
[j
+1]);
4277 incrRefCount(c
->argv
[j
]);
4278 incrRefCount(c
->argv
[j
+1]);
4280 removeExpire(c
->db
,c
->argv
[j
]);
4282 server
.dirty
+= (c
->argc
-1)/2;
4283 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4286 static void msetCommand(redisClient
*c
) {
4287 msetGenericCommand(c
,0);
4290 static void msetnxCommand(redisClient
*c
) {
4291 msetGenericCommand(c
,1);
4294 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4299 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4300 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4301 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4304 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4305 o
= tryObjectEncoding(o
);
4306 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4307 if (retval
== DICT_ERR
) {
4308 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4309 removeExpire(c
->db
,c
->argv
[1]);
4311 incrRefCount(c
->argv
[1]);
4314 addReply(c
,shared
.colon
);
4316 addReply(c
,shared
.crlf
);
4319 static void incrCommand(redisClient
*c
) {
4320 incrDecrCommand(c
,1);
4323 static void decrCommand(redisClient
*c
) {
4324 incrDecrCommand(c
,-1);
4327 static void incrbyCommand(redisClient
*c
) {
4330 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4331 incrDecrCommand(c
,incr
);
4334 static void decrbyCommand(redisClient
*c
) {
4337 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4338 incrDecrCommand(c
,-incr
);
4341 static void appendCommand(redisClient
*c
) {
4346 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4348 /* Create the key */
4349 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4350 incrRefCount(c
->argv
[1]);
4351 incrRefCount(c
->argv
[2]);
4352 totlen
= stringObjectLen(c
->argv
[2]);
4356 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4359 o
= dictGetEntryVal(de
);
4360 if (o
->type
!= REDIS_STRING
) {
4361 addReply(c
,shared
.wrongtypeerr
);
4364 /* If the object is specially encoded or shared we have to make
4366 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4367 robj
*decoded
= getDecodedObject(o
);
4369 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4370 decrRefCount(decoded
);
4371 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4374 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4375 o
->ptr
= sdscatlen(o
->ptr
,
4376 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4378 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4379 (unsigned long) c
->argv
[2]->ptr
);
4381 totlen
= sdslen(o
->ptr
);
4384 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4387 static void substrCommand(redisClient
*c
) {
4389 long start
= atoi(c
->argv
[2]->ptr
);
4390 long end
= atoi(c
->argv
[3]->ptr
);
4391 size_t rangelen
, strlen
;
4394 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4395 checkType(c
,o
,REDIS_STRING
)) return;
4397 o
= getDecodedObject(o
);
4398 strlen
= sdslen(o
->ptr
);
4400 /* convert negative indexes */
4401 if (start
< 0) start
= strlen
+start
;
4402 if (end
< 0) end
= strlen
+end
;
4403 if (start
< 0) start
= 0;
4404 if (end
< 0) end
= 0;
4406 /* indexes sanity checks */
4407 if (start
> end
|| (size_t)start
>= strlen
) {
4408 /* Out of range start or start > end result in null reply */
4409 addReply(c
,shared
.nullbulk
);
4413 if ((size_t)end
>= strlen
) end
= strlen
-1;
4414 rangelen
= (end
-start
)+1;
4416 /* Return the result */
4417 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4418 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4419 addReplySds(c
,range
);
4420 addReply(c
,shared
.crlf
);
4424 /* ========================= Type agnostic commands ========================= */
4426 static void delCommand(redisClient
*c
) {
4429 for (j
= 1; j
< c
->argc
; j
++) {
4430 if (deleteKey(c
->db
,c
->argv
[j
])) {
4435 addReplyLong(c
,deleted
);
4438 static void existsCommand(redisClient
*c
) {
4439 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4442 static void selectCommand(redisClient
*c
) {
4443 int id
= atoi(c
->argv
[1]->ptr
);
4445 if (selectDb(c
,id
) == REDIS_ERR
) {
4446 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4448 addReply(c
,shared
.ok
);
4452 static void randomkeyCommand(redisClient
*c
) {
4457 de
= dictGetRandomKey(c
->db
->dict
);
4458 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4462 addReply(c
,shared
.nullbulk
);
4466 key
= dictGetEntryKey(de
);
4467 if (server
.vm_enabled
) {
4468 key
= dupStringObject(key
);
4469 addReplyBulk(c
,key
);
4472 addReplyBulk(c
,key
);
4476 static void keysCommand(redisClient
*c
) {
4479 sds pattern
= c
->argv
[1]->ptr
;
4480 int plen
= sdslen(pattern
);
4481 unsigned long numkeys
= 0;
4482 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4484 di
= dictGetIterator(c
->db
->dict
);
4486 decrRefCount(lenobj
);
4487 while((de
= dictNext(di
)) != NULL
) {
4488 robj
*keyobj
= dictGetEntryKey(de
);
4490 sds key
= keyobj
->ptr
;
4491 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4492 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4493 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4494 addReplyBulk(c
,keyobj
);
4499 dictReleaseIterator(di
);
4500 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4503 static void dbsizeCommand(redisClient
*c
) {
4505 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4508 static void lastsaveCommand(redisClient
*c
) {
4510 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4513 static void typeCommand(redisClient
*c
) {
4517 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4522 case REDIS_STRING
: type
= "+string"; break;
4523 case REDIS_LIST
: type
= "+list"; break;
4524 case REDIS_SET
: type
= "+set"; break;
4525 case REDIS_ZSET
: type
= "+zset"; break;
4526 case REDIS_HASH
: type
= "+hash"; break;
4527 default: type
= "+unknown"; break;
4530 addReplySds(c
,sdsnew(type
));
4531 addReply(c
,shared
.crlf
);
4534 static void saveCommand(redisClient
*c
) {
4535 if (server
.bgsavechildpid
!= -1) {
4536 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4539 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4540 addReply(c
,shared
.ok
);
4542 addReply(c
,shared
.err
);
4546 static void bgsaveCommand(redisClient
*c
) {
4547 if (server
.bgsavechildpid
!= -1) {
4548 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4551 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4552 char *status
= "+Background saving started\r\n";
4553 addReplySds(c
,sdsnew(status
));
4555 addReply(c
,shared
.err
);
4559 static void shutdownCommand(redisClient
*c
) {
4560 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4561 /* Kill the saving child if there is a background saving in progress.
4562 We want to avoid race conditions, for instance our saving child may
4563 overwrite the synchronous saving did by SHUTDOWN. */
4564 if (server
.bgsavechildpid
!= -1) {
4565 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4566 kill(server
.bgsavechildpid
,SIGKILL
);
4567 rdbRemoveTempFile(server
.bgsavechildpid
);
4569 if (server
.appendonly
) {
4570 /* Append only file: fsync() the AOF and exit */
4571 fsync(server
.appendfd
);
4572 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4575 /* Snapshotting. Perform a SYNC SAVE and exit */
4576 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4577 if (server
.daemonize
)
4578 unlink(server
.pidfile
);
4579 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4580 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4583 /* Ooops.. error saving! The best we can do is to continue
4584 * operating. Note that if there was a background saving process,
4585 * in the next cron() Redis will be notified that the background
4586 * saving aborted, handling special stuff like slaves pending for
4587 * synchronization... */
4588 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4590 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4595 static void renameGenericCommand(redisClient
*c
, int nx
) {
4598 /* To use the same key as src and dst is probably an error */
4599 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4600 addReply(c
,shared
.sameobjecterr
);
4604 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4608 deleteIfVolatile(c
->db
,c
->argv
[2]);
4609 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4612 addReply(c
,shared
.czero
);
4615 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4617 incrRefCount(c
->argv
[2]);
4619 deleteKey(c
->db
,c
->argv
[1]);
4621 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4624 static void renameCommand(redisClient
*c
) {
4625 renameGenericCommand(c
,0);
4628 static void renamenxCommand(redisClient
*c
) {
4629 renameGenericCommand(c
,1);
4632 static void moveCommand(redisClient
*c
) {
4637 /* Obtain source and target DB pointers */
4640 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4641 addReply(c
,shared
.outofrangeerr
);
4645 selectDb(c
,srcid
); /* Back to the source DB */
4647 /* If the user is moving using as target the same
4648 * DB as the source DB it is probably an error. */
4650 addReply(c
,shared
.sameobjecterr
);
4654 /* Check if the element exists and get a reference */
4655 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4657 addReply(c
,shared
.czero
);
4661 /* Try to add the element to the target DB */
4662 deleteIfVolatile(dst
,c
->argv
[1]);
4663 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4664 addReply(c
,shared
.czero
);
4667 incrRefCount(c
->argv
[1]);
4670 /* OK! key moved, free the entry in the source DB */
4671 deleteKey(src
,c
->argv
[1]);
4673 addReply(c
,shared
.cone
);
4676 /* =================================== Lists ================================ */
4677 static void pushGenericCommand(redisClient
*c
, int where
) {
4681 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4683 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4684 addReply(c
,shared
.cone
);
4687 lobj
= createListObject();
4689 if (where
== REDIS_HEAD
) {
4690 listAddNodeHead(list
,c
->argv
[2]);
4692 listAddNodeTail(list
,c
->argv
[2]);
4694 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4695 incrRefCount(c
->argv
[1]);
4696 incrRefCount(c
->argv
[2]);
4698 if (lobj
->type
!= REDIS_LIST
) {
4699 addReply(c
,shared
.wrongtypeerr
);
4702 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4703 addReply(c
,shared
.cone
);
4707 if (where
== REDIS_HEAD
) {
4708 listAddNodeHead(list
,c
->argv
[2]);
4710 listAddNodeTail(list
,c
->argv
[2]);
4712 incrRefCount(c
->argv
[2]);
4715 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4718 static void lpushCommand(redisClient
*c
) {
4719 pushGenericCommand(c
,REDIS_HEAD
);
4722 static void rpushCommand(redisClient
*c
) {
4723 pushGenericCommand(c
,REDIS_TAIL
);
4726 static void llenCommand(redisClient
*c
) {
4730 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4731 checkType(c
,o
,REDIS_LIST
)) return;
4734 addReplyUlong(c
,listLength(l
));
4737 static void lindexCommand(redisClient
*c
) {
4739 int index
= atoi(c
->argv
[2]->ptr
);
4743 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4744 checkType(c
,o
,REDIS_LIST
)) return;
4747 ln
= listIndex(list
, index
);
4749 addReply(c
,shared
.nullbulk
);
4751 robj
*ele
= listNodeValue(ln
);
4752 addReplyBulk(c
,ele
);
4756 static void lsetCommand(redisClient
*c
) {
4758 int index
= atoi(c
->argv
[2]->ptr
);
4762 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4763 checkType(c
,o
,REDIS_LIST
)) return;
4766 ln
= listIndex(list
, index
);
4768 addReply(c
,shared
.outofrangeerr
);
4770 robj
*ele
= listNodeValue(ln
);
4773 listNodeValue(ln
) = c
->argv
[3];
4774 incrRefCount(c
->argv
[3]);
4775 addReply(c
,shared
.ok
);
4780 static void popGenericCommand(redisClient
*c
, int where
) {
4785 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4786 checkType(c
,o
,REDIS_LIST
)) return;
4789 if (where
== REDIS_HEAD
)
4790 ln
= listFirst(list
);
4792 ln
= listLast(list
);
4795 addReply(c
,shared
.nullbulk
);
4797 robj
*ele
= listNodeValue(ln
);
4798 addReplyBulk(c
,ele
);
4799 listDelNode(list
,ln
);
4800 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4805 static void lpopCommand(redisClient
*c
) {
4806 popGenericCommand(c
,REDIS_HEAD
);
4809 static void rpopCommand(redisClient
*c
) {
4810 popGenericCommand(c
,REDIS_TAIL
);
4813 static void lrangeCommand(redisClient
*c
) {
4815 int start
= atoi(c
->argv
[2]->ptr
);
4816 int end
= atoi(c
->argv
[3]->ptr
);
4823 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4824 || checkType(c
,o
,REDIS_LIST
)) return;
4826 llen
= listLength(list
);
4828 /* convert negative indexes */
4829 if (start
< 0) start
= llen
+start
;
4830 if (end
< 0) end
= llen
+end
;
4831 if (start
< 0) start
= 0;
4832 if (end
< 0) end
= 0;
4834 /* indexes sanity checks */
4835 if (start
> end
|| start
>= llen
) {
4836 /* Out of range start or start > end result in empty list */
4837 addReply(c
,shared
.emptymultibulk
);
4840 if (end
>= llen
) end
= llen
-1;
4841 rangelen
= (end
-start
)+1;
4843 /* Return the result in form of a multi-bulk reply */
4844 ln
= listIndex(list
, start
);
4845 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4846 for (j
= 0; j
< rangelen
; j
++) {
4847 ele
= listNodeValue(ln
);
4848 addReplyBulk(c
,ele
);
4853 static void ltrimCommand(redisClient
*c
) {
4855 int start
= atoi(c
->argv
[2]->ptr
);
4856 int end
= atoi(c
->argv
[3]->ptr
);
4858 int j
, ltrim
, rtrim
;
4862 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4863 checkType(c
,o
,REDIS_LIST
)) return;
4865 llen
= listLength(list
);
4867 /* convert negative indexes */
4868 if (start
< 0) start
= llen
+start
;
4869 if (end
< 0) end
= llen
+end
;
4870 if (start
< 0) start
= 0;
4871 if (end
< 0) end
= 0;
4873 /* indexes sanity checks */
4874 if (start
> end
|| start
>= llen
) {
4875 /* Out of range start or start > end result in empty list */
4879 if (end
>= llen
) end
= llen
-1;
4884 /* Remove list elements to perform the trim */
4885 for (j
= 0; j
< ltrim
; j
++) {
4886 ln
= listFirst(list
);
4887 listDelNode(list
,ln
);
4889 for (j
= 0; j
< rtrim
; j
++) {
4890 ln
= listLast(list
);
4891 listDelNode(list
,ln
);
4893 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4895 addReply(c
,shared
.ok
);
4898 static void lremCommand(redisClient
*c
) {
4901 listNode
*ln
, *next
;
4902 int toremove
= atoi(c
->argv
[2]->ptr
);
4906 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4907 checkType(c
,o
,REDIS_LIST
)) return;
4911 toremove
= -toremove
;
4914 ln
= fromtail
? list
->tail
: list
->head
;
4916 robj
*ele
= listNodeValue(ln
);
4918 next
= fromtail
? ln
->prev
: ln
->next
;
4919 if (equalStringObjects(ele
,c
->argv
[3])) {
4920 listDelNode(list
,ln
);
4923 if (toremove
&& removed
== toremove
) break;
4927 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4928 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4931 /* This is the semantic of this command:
4932 * RPOPLPUSH srclist dstlist:
4933 * IF LLEN(srclist) > 0
4934 * element = RPOP srclist
4935 * LPUSH dstlist element
4942 * The idea is to be able to get an element from a list in a reliable way
4943 * since the element is not just returned but pushed against another list
4944 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4946 static void rpoplpushcommand(redisClient
*c
) {
4951 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4952 checkType(c
,sobj
,REDIS_LIST
)) return;
4953 srclist
= sobj
->ptr
;
4954 ln
= listLast(srclist
);
4957 addReply(c
,shared
.nullbulk
);
4959 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4960 robj
*ele
= listNodeValue(ln
);
4963 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4964 addReply(c
,shared
.wrongtypeerr
);
4968 /* Add the element to the target list (unless it's directly
4969 * passed to some BLPOP-ing client */
4970 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4972 /* Create the list if the key does not exist */
4973 dobj
= createListObject();
4974 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4975 incrRefCount(c
->argv
[2]);
4977 dstlist
= dobj
->ptr
;
4978 listAddNodeHead(dstlist
,ele
);
4982 /* Send the element to the client as reply as well */
4983 addReplyBulk(c
,ele
);
4985 /* Finally remove the element from the source list */
4986 listDelNode(srclist
,ln
);
4987 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4992 /* ==================================== Sets ================================ */
4994 static void saddCommand(redisClient
*c
) {
4997 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4999 set
= createSetObject();
5000 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5001 incrRefCount(c
->argv
[1]);
5003 if (set
->type
!= REDIS_SET
) {
5004 addReply(c
,shared
.wrongtypeerr
);
5008 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5009 incrRefCount(c
->argv
[2]);
5011 addReply(c
,shared
.cone
);
5013 addReply(c
,shared
.czero
);
5017 static void sremCommand(redisClient
*c
) {
5020 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5021 checkType(c
,set
,REDIS_SET
)) return;
5023 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5025 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5026 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5027 addReply(c
,shared
.cone
);
5029 addReply(c
,shared
.czero
);
5033 static void smoveCommand(redisClient
*c
) {
5034 robj
*srcset
, *dstset
;
5036 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5037 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5039 /* If the source key does not exist return 0, if it's of the wrong type
5041 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5042 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5045 /* Error if the destination key is not a set as well */
5046 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5047 addReply(c
,shared
.wrongtypeerr
);
5050 /* Remove the element from the source set */
5051 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5052 /* Key not found in the src set! return zero */
5053 addReply(c
,shared
.czero
);
5056 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5057 deleteKey(c
->db
,c
->argv
[1]);
5059 /* Add the element to the destination set */
5061 dstset
= createSetObject();
5062 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5063 incrRefCount(c
->argv
[2]);
5065 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5066 incrRefCount(c
->argv
[3]);
5067 addReply(c
,shared
.cone
);
5070 static void sismemberCommand(redisClient
*c
) {
5073 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5074 checkType(c
,set
,REDIS_SET
)) return;
5076 if (dictFind(set
->ptr
,c
->argv
[2]))
5077 addReply(c
,shared
.cone
);
5079 addReply(c
,shared
.czero
);
5082 static void scardCommand(redisClient
*c
) {
5086 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5087 checkType(c
,o
,REDIS_SET
)) return;
5090 addReplyUlong(c
,dictSize(s
));
5093 static void spopCommand(redisClient
*c
) {
5097 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5098 checkType(c
,set
,REDIS_SET
)) return;
5100 de
= dictGetRandomKey(set
->ptr
);
5102 addReply(c
,shared
.nullbulk
);
5104 robj
*ele
= dictGetEntryKey(de
);
5106 addReplyBulk(c
,ele
);
5107 dictDelete(set
->ptr
,ele
);
5108 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5109 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5114 static void srandmemberCommand(redisClient
*c
) {
5118 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5119 checkType(c
,set
,REDIS_SET
)) return;
5121 de
= dictGetRandomKey(set
->ptr
);
5123 addReply(c
,shared
.nullbulk
);
5125 robj
*ele
= dictGetEntryKey(de
);
5127 addReplyBulk(c
,ele
);
5131 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5132 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5134 return dictSize(*d1
)-dictSize(*d2
);
5137 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5138 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5141 robj
*lenobj
= NULL
, *dstset
= NULL
;
5142 unsigned long j
, cardinality
= 0;
5144 for (j
= 0; j
< setsnum
; j
++) {
5148 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5149 lookupKeyRead(c
->db
,setskeys
[j
]);
5153 if (deleteKey(c
->db
,dstkey
))
5155 addReply(c
,shared
.czero
);
5157 addReply(c
,shared
.emptymultibulk
);
5161 if (setobj
->type
!= REDIS_SET
) {
5163 addReply(c
,shared
.wrongtypeerr
);
5166 dv
[j
] = setobj
->ptr
;
5168 /* Sort sets from the smallest to largest, this will improve our
5169 * algorithm's performace */
5170 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5172 /* The first thing we should output is the total number of elements...
5173 * since this is a multi-bulk write, but at this stage we don't know
5174 * the intersection set size, so we use a trick, append an empty object
5175 * to the output list and save the pointer to later modify it with the
5178 lenobj
= createObject(REDIS_STRING
,NULL
);
5180 decrRefCount(lenobj
);
5182 /* If we have a target key where to store the resulting set
5183 * create this key with an empty set inside */
5184 dstset
= createSetObject();
5187 /* Iterate all the elements of the first (smallest) set, and test
5188 * the element against all the other sets, if at least one set does
5189 * not include the element it is discarded */
5190 di
= dictGetIterator(dv
[0]);
5192 while((de
= dictNext(di
)) != NULL
) {
5195 for (j
= 1; j
< setsnum
; j
++)
5196 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5198 continue; /* at least one set does not contain the member */
5199 ele
= dictGetEntryKey(de
);
5201 addReplyBulk(c
,ele
);
5204 dictAdd(dstset
->ptr
,ele
,NULL
);
5208 dictReleaseIterator(di
);
5211 /* Store the resulting set into the target, if the intersection
5212 * is not an empty set. */
5213 deleteKey(c
->db
,dstkey
);
5214 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5215 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5216 incrRefCount(dstkey
);
5217 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5219 decrRefCount(dstset
);
5220 addReply(c
,shared
.czero
);
5224 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5229 static void sinterCommand(redisClient
*c
) {
5230 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5233 static void sinterstoreCommand(redisClient
*c
) {
5234 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5237 #define REDIS_OP_UNION 0
5238 #define REDIS_OP_DIFF 1
5239 #define REDIS_OP_INTER 2
5241 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5242 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5245 robj
*dstset
= NULL
;
5246 int j
, cardinality
= 0;
5248 for (j
= 0; j
< setsnum
; j
++) {
5252 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5253 lookupKeyRead(c
->db
,setskeys
[j
]);
5258 if (setobj
->type
!= REDIS_SET
) {
5260 addReply(c
,shared
.wrongtypeerr
);
5263 dv
[j
] = setobj
->ptr
;
5266 /* We need a temp set object to store our union. If the dstkey
5267 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5268 * this set object will be the resulting object to set into the target key*/
5269 dstset
= createSetObject();
5271 /* Iterate all the elements of all the sets, add every element a single
5272 * time to the result set */
5273 for (j
= 0; j
< setsnum
; j
++) {
5274 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5275 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5277 di
= dictGetIterator(dv
[j
]);
5279 while((de
= dictNext(di
)) != NULL
) {
5282 /* dictAdd will not add the same element multiple times */
5283 ele
= dictGetEntryKey(de
);
5284 if (op
== REDIS_OP_UNION
|| j
== 0) {
5285 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5289 } else if (op
== REDIS_OP_DIFF
) {
5290 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5295 dictReleaseIterator(di
);
5297 /* result set is empty? Exit asap. */
5298 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5301 /* Output the content of the resulting set, if not in STORE mode */
5303 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5304 di
= dictGetIterator(dstset
->ptr
);
5305 while((de
= dictNext(di
)) != NULL
) {
5308 ele
= dictGetEntryKey(de
);
5309 addReplyBulk(c
,ele
);
5311 dictReleaseIterator(di
);
5312 decrRefCount(dstset
);
5314 /* If we have a target key where to store the resulting set
5315 * create this key with the result set inside */
5316 deleteKey(c
->db
,dstkey
);
5317 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5318 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5319 incrRefCount(dstkey
);
5320 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5322 decrRefCount(dstset
);
5323 addReply(c
,shared
.czero
);
5330 static void sunionCommand(redisClient
*c
) {
5331 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5334 static void sunionstoreCommand(redisClient
*c
) {
5335 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5338 static void sdiffCommand(redisClient
*c
) {
5339 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5342 static void sdiffstoreCommand(redisClient
*c
) {
5343 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5346 /* ==================================== ZSets =============================== */
5348 /* ZSETs are ordered sets using two data structures to hold the same elements
5349 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5352 * The elements are added to an hash table mapping Redis objects to scores.
5353 * At the same time the elements are added to a skip list mapping scores
5354 * to Redis objects (so objects are sorted by scores in this "view"). */
5356 /* This skiplist implementation is almost a C translation of the original
5357 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5358 * Alternative to Balanced Trees", modified in three ways:
5359 * a) this implementation allows for repeated values.
5360 * b) the comparison is not just by key (our 'score') but by satellite data.
5361 * c) there is a back pointer, so it's a doubly linked list with the back
5362 * pointers being only at "level 1". This allows to traverse the list
5363 * from tail to head, useful for ZREVRANGE. */
5365 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5366 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5368 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5370 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5376 static zskiplist
*zslCreate(void) {
5380 zsl
= zmalloc(sizeof(*zsl
));
5383 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5384 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5385 zsl
->header
->forward
[j
] = NULL
;
5387 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5388 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5389 zsl
->header
->span
[j
] = 0;
5391 zsl
->header
->backward
= NULL
;
5396 static void zslFreeNode(zskiplistNode
*node
) {
5397 decrRefCount(node
->obj
);
5398 zfree(node
->forward
);
5403 static void zslFree(zskiplist
*zsl
) {
5404 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5406 zfree(zsl
->header
->forward
);
5407 zfree(zsl
->header
->span
);
5410 next
= node
->forward
[0];
5417 static int zslRandomLevel(void) {
5419 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5421 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5424 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5425 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5426 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5430 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5431 /* store rank that is crossed to reach the insert position */
5432 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5434 while (x
->forward
[i
] &&
5435 (x
->forward
[i
]->score
< score
||
5436 (x
->forward
[i
]->score
== score
&&
5437 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5438 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5443 /* we assume the key is not already inside, since we allow duplicated
5444 * scores, and the re-insertion of score and redis object should never
5445 * happpen since the caller of zslInsert() should test in the hash table
5446 * if the element is already inside or not. */
5447 level
= zslRandomLevel();
5448 if (level
> zsl
->level
) {
5449 for (i
= zsl
->level
; i
< level
; i
++) {
5451 update
[i
] = zsl
->header
;
5452 update
[i
]->span
[i
-1] = zsl
->length
;
5456 x
= zslCreateNode(level
,score
,obj
);
5457 for (i
= 0; i
< level
; i
++) {
5458 x
->forward
[i
] = update
[i
]->forward
[i
];
5459 update
[i
]->forward
[i
] = x
;
5461 /* update span covered by update[i] as x is inserted here */
5463 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5464 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5468 /* increment span for untouched levels */
5469 for (i
= level
; i
< zsl
->level
; i
++) {
5470 update
[i
]->span
[i
-1]++;
5473 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5475 x
->forward
[0]->backward
= x
;
5481 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5482 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5484 for (i
= 0; i
< zsl
->level
; i
++) {
5485 if (update
[i
]->forward
[i
] == x
) {
5487 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5489 update
[i
]->forward
[i
] = x
->forward
[i
];
5491 /* invariant: i > 0, because update[0]->forward[0]
5492 * is always equal to x */
5493 update
[i
]->span
[i
-1] -= 1;
5496 if (x
->forward
[0]) {
5497 x
->forward
[0]->backward
= x
->backward
;
5499 zsl
->tail
= x
->backward
;
5501 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5506 /* Delete an element with matching score/object from the skiplist. */
5507 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5508 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5512 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5513 while (x
->forward
[i
] &&
5514 (x
->forward
[i
]->score
< score
||
5515 (x
->forward
[i
]->score
== score
&&
5516 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5520 /* We may have multiple elements with the same score, what we need
5521 * is to find the element with both the right score and object. */
5523 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5524 zslDeleteNode(zsl
, x
, update
);
5528 return 0; /* not found */
5530 return 0; /* not found */
5533 /* Delete all the elements with score between min and max from the skiplist.
5534 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5535 * Note that this function takes the reference to the hash table view of the
5536 * sorted set, in order to remove the elements from the hash table too. */
5537 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5538 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5539 unsigned long removed
= 0;
5543 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5544 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5548 /* We may have multiple elements with the same score, what we need
5549 * is to find the element with both the right score and object. */
5551 while (x
&& x
->score
<= max
) {
5552 zskiplistNode
*next
= x
->forward
[0];
5553 zslDeleteNode(zsl
, x
, update
);
5554 dictDelete(dict
,x
->obj
);
5559 return removed
; /* not found */
5562 /* Delete all the elements with rank between start and end from the skiplist.
5563 * Start and end are inclusive. Note that start and end need to be 1-based */
5564 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5565 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5566 unsigned long traversed
= 0, removed
= 0;
5570 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5571 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5572 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5580 while (x
&& traversed
<= end
) {
5581 zskiplistNode
*next
= x
->forward
[0];
5582 zslDeleteNode(zsl
, x
, update
);
5583 dictDelete(dict
,x
->obj
);
5592 /* Find the first node having a score equal or greater than the specified one.
5593 * Returns NULL if there is no match. */
5594 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5599 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5600 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5603 /* We may have multiple elements with the same score, what we need
5604 * is to find the element with both the right score and object. */
5605 return x
->forward
[0];
5608 /* Find the rank for an element by both score and key.
5609 * Returns 0 when the element cannot be found, rank otherwise.
5610 * Note that the rank is 1-based due to the span of zsl->header to the
5612 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5614 unsigned long rank
= 0;
5618 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5619 while (x
->forward
[i
] &&
5620 (x
->forward
[i
]->score
< score
||
5621 (x
->forward
[i
]->score
== score
&&
5622 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5623 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5627 /* x might be equal to zsl->header, so test if obj is non-NULL */
5628 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5635 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5636 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5638 unsigned long traversed
= 0;
5642 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5643 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5645 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5648 if (traversed
== rank
) {
5655 /* The actual Z-commands implementations */
5657 /* This generic command implements both ZADD and ZINCRBY.
5658 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5659 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5660 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5665 zsetobj
= lookupKeyWrite(c
->db
,key
);
5666 if (zsetobj
== NULL
) {
5667 zsetobj
= createZsetObject();
5668 dictAdd(c
->db
->dict
,key
,zsetobj
);
5671 if (zsetobj
->type
!= REDIS_ZSET
) {
5672 addReply(c
,shared
.wrongtypeerr
);
5678 /* Ok now since we implement both ZADD and ZINCRBY here the code
5679 * needs to handle the two different conditions. It's all about setting
5680 * '*score', that is, the new score to set, to the right value. */
5681 score
= zmalloc(sizeof(double));
5685 /* Read the old score. If the element was not present starts from 0 */
5686 de
= dictFind(zs
->dict
,ele
);
5688 double *oldscore
= dictGetEntryVal(de
);
5689 *score
= *oldscore
+ scoreval
;
5697 /* What follows is a simple remove and re-insert operation that is common
5698 * to both ZADD and ZINCRBY... */
5699 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5700 /* case 1: New element */
5701 incrRefCount(ele
); /* added to hash */
5702 zslInsert(zs
->zsl
,*score
,ele
);
5703 incrRefCount(ele
); /* added to skiplist */
5706 addReplyDouble(c
,*score
);
5708 addReply(c
,shared
.cone
);
5713 /* case 2: Score update operation */
5714 de
= dictFind(zs
->dict
,ele
);
5715 redisAssert(de
!= NULL
);
5716 oldscore
= dictGetEntryVal(de
);
5717 if (*score
!= *oldscore
) {
5720 /* Remove and insert the element in the skip list with new score */
5721 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5722 redisAssert(deleted
!= 0);
5723 zslInsert(zs
->zsl
,*score
,ele
);
5725 /* Update the score in the hash table */
5726 dictReplace(zs
->dict
,ele
,score
);
5732 addReplyDouble(c
,*score
);
5734 addReply(c
,shared
.czero
);
5738 static void zaddCommand(redisClient
*c
) {
5741 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5742 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5745 static void zincrbyCommand(redisClient
*c
) {
5748 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5749 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5752 static void zremCommand(redisClient
*c
) {
5759 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5760 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5763 de
= dictFind(zs
->dict
,c
->argv
[2]);
5765 addReply(c
,shared
.czero
);
5768 /* Delete from the skiplist */
5769 oldscore
= dictGetEntryVal(de
);
5770 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5771 redisAssert(deleted
!= 0);
5773 /* Delete from the hash table */
5774 dictDelete(zs
->dict
,c
->argv
[2]);
5775 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5776 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5778 addReply(c
,shared
.cone
);
5781 static void zremrangebyscoreCommand(redisClient
*c
) {
5788 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5789 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5791 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5792 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5795 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5796 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5797 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5798 server
.dirty
+= deleted
;
5799 addReplyLong(c
,deleted
);
5802 static void zremrangebyrankCommand(redisClient
*c
) {
5810 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5811 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5813 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5814 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5816 llen
= zs
->zsl
->length
;
5818 /* convert negative indexes */
5819 if (start
< 0) start
= llen
+start
;
5820 if (end
< 0) end
= llen
+end
;
5821 if (start
< 0) start
= 0;
5822 if (end
< 0) end
= 0;
5824 /* indexes sanity checks */
5825 if (start
> end
|| start
>= llen
) {
5826 addReply(c
,shared
.czero
);
5829 if (end
>= llen
) end
= llen
-1;
5831 /* increment start and end because zsl*Rank functions
5832 * use 1-based rank */
5833 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5834 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5835 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5836 server
.dirty
+= deleted
;
5837 addReplyLong(c
, deleted
);
5845 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5846 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5847 unsigned long size1
, size2
;
5848 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5849 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5850 return size1
- size2
;
5853 #define REDIS_AGGR_SUM 1
5854 #define REDIS_AGGR_MIN 2
5855 #define REDIS_AGGR_MAX 3
5857 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5858 if (aggregate
== REDIS_AGGR_SUM
) {
5859 *target
= *target
+ val
;
5860 } else if (aggregate
== REDIS_AGGR_MIN
) {
5861 *target
= val
< *target
? val
: *target
;
5862 } else if (aggregate
== REDIS_AGGR_MAX
) {
5863 *target
= val
> *target
? val
: *target
;
5866 redisPanic("Unknown ZUNION/INTER aggregate type");
5870 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5872 int aggregate
= REDIS_AGGR_SUM
;
5879 /* expect zsetnum input keys to be given */
5880 zsetnum
= atoi(c
->argv
[2]->ptr
);
5882 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5886 /* test if the expected number of keys would overflow */
5887 if (3+zsetnum
> c
->argc
) {
5888 addReply(c
,shared
.syntaxerr
);
5892 /* read keys to be used for input */
5893 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5894 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5895 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5899 if (zsetobj
->type
!= REDIS_ZSET
) {
5901 addReply(c
,shared
.wrongtypeerr
);
5904 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5907 /* default all weights to 1 */
5908 src
[i
].weight
= 1.0;
5911 /* parse optional extra arguments */
5913 int remaining
= c
->argc
- j
;
5916 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5918 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5919 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5922 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5924 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5925 aggregate
= REDIS_AGGR_SUM
;
5926 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5927 aggregate
= REDIS_AGGR_MIN
;
5928 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5929 aggregate
= REDIS_AGGR_MAX
;
5932 addReply(c
,shared
.syntaxerr
);
5938 addReply(c
,shared
.syntaxerr
);
5944 /* sort sets from the smallest to largest, this will improve our
5945 * algorithm's performance */
5946 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5948 dstobj
= createZsetObject();
5949 dstzset
= dstobj
->ptr
;
5951 if (op
== REDIS_OP_INTER
) {
5952 /* skip going over all entries if the smallest zset is NULL or empty */
5953 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5954 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5955 * from small to large, all src[i > 0].dict are non-empty too */
5956 di
= dictGetIterator(src
[0].dict
);
5957 while((de
= dictNext(di
)) != NULL
) {
5958 double *score
= zmalloc(sizeof(double)), value
;
5959 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5961 for (j
= 1; j
< zsetnum
; j
++) {
5962 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5964 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5965 zunionInterAggregate(score
, value
, aggregate
);
5971 /* skip entry when not present in every source dict */
5975 robj
*o
= dictGetEntryKey(de
);
5976 dictAdd(dstzset
->dict
,o
,score
);
5977 incrRefCount(o
); /* added to dictionary */
5978 zslInsert(dstzset
->zsl
,*score
,o
);
5979 incrRefCount(o
); /* added to skiplist */
5982 dictReleaseIterator(di
);
5984 } else if (op
== REDIS_OP_UNION
) {
5985 for (i
= 0; i
< zsetnum
; i
++) {
5986 if (!src
[i
].dict
) continue;
5988 di
= dictGetIterator(src
[i
].dict
);
5989 while((de
= dictNext(di
)) != NULL
) {
5990 /* skip key when already processed */
5991 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5993 double *score
= zmalloc(sizeof(double)), value
;
5994 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5996 /* because the zsets are sorted by size, its only possible
5997 * for sets at larger indices to hold this entry */
5998 for (j
= (i
+1); j
< zsetnum
; j
++) {
5999 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6001 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
6002 zunionInterAggregate(score
, value
, aggregate
);
6006 robj
*o
= dictGetEntryKey(de
);
6007 dictAdd(dstzset
->dict
,o
,score
);
6008 incrRefCount(o
); /* added to dictionary */
6009 zslInsert(dstzset
->zsl
,*score
,o
);
6010 incrRefCount(o
); /* added to skiplist */
6012 dictReleaseIterator(di
);
6015 /* unknown operator */
6016 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6019 deleteKey(c
->db
,dstkey
);
6020 if (dstzset
->zsl
->length
) {
6021 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6022 incrRefCount(dstkey
);
6023 addReplyLong(c
, dstzset
->zsl
->length
);
6026 decrRefCount(dstobj
);
6027 addReply(c
, shared
.czero
);
6032 static void zunionCommand(redisClient
*c
) {
6033 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6036 static void zinterCommand(redisClient
*c
) {
6037 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6040 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6052 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6053 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6055 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6057 } else if (c
->argc
>= 5) {
6058 addReply(c
,shared
.syntaxerr
);
6062 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6063 || checkType(c
,o
,REDIS_ZSET
)) return;
6068 /* convert negative indexes */
6069 if (start
< 0) start
= llen
+start
;
6070 if (end
< 0) end
= llen
+end
;
6071 if (start
< 0) start
= 0;
6072 if (end
< 0) end
= 0;
6074 /* indexes sanity checks */
6075 if (start
> end
|| start
>= llen
) {
6076 /* Out of range start or start > end result in empty list */
6077 addReply(c
,shared
.emptymultibulk
);
6080 if (end
>= llen
) end
= llen
-1;
6081 rangelen
= (end
-start
)+1;
6083 /* check if starting point is trivial, before searching
6084 * the element in log(N) time */
6086 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6089 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6092 /* Return the result in form of a multi-bulk reply */
6093 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6094 withscores
? (rangelen
*2) : rangelen
));
6095 for (j
= 0; j
< rangelen
; j
++) {
6097 addReplyBulk(c
,ele
);
6099 addReplyDouble(c
,ln
->score
);
6100 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6104 static void zrangeCommand(redisClient
*c
) {
6105 zrangeGenericCommand(c
,0);
6108 static void zrevrangeCommand(redisClient
*c
) {
6109 zrangeGenericCommand(c
,1);
6112 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6113 * If justcount is non-zero, just the count is returned. */
6114 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6117 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6118 int offset
= 0, limit
= -1;
6122 /* Parse the min-max interval. If one of the values is prefixed
6123 * by the "(" character, it's considered "open". For instance
6124 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6125 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6126 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6127 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6130 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6132 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6133 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6136 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6139 /* Parse "WITHSCORES": note that if the command was called with
6140 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6141 * enter the following paths to parse WITHSCORES and LIMIT. */
6142 if (c
->argc
== 5 || c
->argc
== 8) {
6143 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6148 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6152 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6157 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6158 addReply(c
,shared
.syntaxerr
);
6160 } else if (c
->argc
== (7 + withscores
)) {
6161 offset
= atoi(c
->argv
[5]->ptr
);
6162 limit
= atoi(c
->argv
[6]->ptr
);
6163 if (offset
< 0) offset
= 0;
6166 /* Ok, lookup the key and get the range */
6167 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6169 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6171 if (o
->type
!= REDIS_ZSET
) {
6172 addReply(c
,shared
.wrongtypeerr
);
6174 zset
*zsetobj
= o
->ptr
;
6175 zskiplist
*zsl
= zsetobj
->zsl
;
6177 robj
*ele
, *lenobj
= NULL
;
6178 unsigned long rangelen
= 0;
6180 /* Get the first node with the score >= min, or with
6181 * score > min if 'minex' is true. */
6182 ln
= zslFirstWithScore(zsl
,min
);
6183 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6186 /* No element matching the speciifed interval */
6187 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6191 /* We don't know in advance how many matching elements there
6192 * are in the list, so we push this object that will represent
6193 * the multi-bulk length in the output buffer, and will "fix"
6196 lenobj
= createObject(REDIS_STRING
,NULL
);
6198 decrRefCount(lenobj
);
6201 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6204 ln
= ln
->forward
[0];
6207 if (limit
== 0) break;
6210 addReplyBulk(c
,ele
);
6212 addReplyDouble(c
,ln
->score
);
6214 ln
= ln
->forward
[0];
6216 if (limit
> 0) limit
--;
6219 addReplyLong(c
,(long)rangelen
);
6221 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6222 withscores
? (rangelen
*2) : rangelen
);
6228 static void zrangebyscoreCommand(redisClient
*c
) {
6229 genericZrangebyscoreCommand(c
,0);
6232 static void zcountCommand(redisClient
*c
) {
6233 genericZrangebyscoreCommand(c
,1);
6236 static void zcardCommand(redisClient
*c
) {
6240 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6241 checkType(c
,o
,REDIS_ZSET
)) return;
6244 addReplyUlong(c
,zs
->zsl
->length
);
6247 static void zscoreCommand(redisClient
*c
) {
6252 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6253 checkType(c
,o
,REDIS_ZSET
)) return;
6256 de
= dictFind(zs
->dict
,c
->argv
[2]);
6258 addReply(c
,shared
.nullbulk
);
6260 double *score
= dictGetEntryVal(de
);
6262 addReplyDouble(c
,*score
);
6266 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6274 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6275 checkType(c
,o
,REDIS_ZSET
)) return;
6279 de
= dictFind(zs
->dict
,c
->argv
[2]);
6281 addReply(c
,shared
.nullbulk
);
6285 score
= dictGetEntryVal(de
);
6286 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6289 addReplyLong(c
, zsl
->length
- rank
);
6291 addReplyLong(c
, rank
-1);
6294 addReply(c
,shared
.nullbulk
);
6298 static void zrankCommand(redisClient
*c
) {
6299 zrankGenericCommand(c
, 0);
6302 static void zrevrankCommand(redisClient
*c
) {
6303 zrankGenericCommand(c
, 1);
6306 /* ========================= Hashes utility functions ======================= */
6307 #define REDIS_HASH_KEY 1
6308 #define REDIS_HASH_VALUE 2
6310 /* Check the length of a number of objects to see if we need to convert a
6311 * zipmap to a real hash. Note that we only check string encoded objects
6312 * as their string length can be queried in constant time. */
6313 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6315 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6317 for (i
= start
; i
<= end
; i
++) {
6318 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6319 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6321 convertToRealHash(subject
);
6327 /* Encode given objects in-place when the hash uses a dict. */
6328 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6329 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6330 if (o1
) *o1
= tryObjectEncoding(*o1
);
6331 if (o2
) *o2
= tryObjectEncoding(*o2
);
6335 /* Get the value from a hash identified by key. Returns either a string
6336 * object or NULL if the value cannot be found. The refcount of the object
6337 * is always increased by 1 when the value was found. */
6338 static robj
*hashGet(robj
*o
, robj
*key
) {
6340 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6343 key
= getDecodedObject(key
);
6344 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6345 value
= createStringObject((char*)v
,vlen
);
6349 dictEntry
*de
= dictFind(o
->ptr
,key
);
6351 value
= dictGetEntryVal(de
);
6352 incrRefCount(value
);
6358 /* Test if the key exists in the given hash. Returns 1 if the key
6359 * exists and 0 when it doesn't. */
6360 static int hashExists(robj
*o
, robj
*key
) {
6361 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6362 key
= getDecodedObject(key
);
6363 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6369 if (dictFind(o
->ptr
,key
) != NULL
) {
6376 /* Add an element, discard the old if the key already exists.
6377 * Return 0 on insert and 1 on update. */
6378 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6380 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6381 key
= getDecodedObject(key
);
6382 value
= getDecodedObject(value
);
6383 o
->ptr
= zipmapSet(o
->ptr
,
6384 key
->ptr
,sdslen(key
->ptr
),
6385 value
->ptr
,sdslen(value
->ptr
), &update
);
6387 decrRefCount(value
);
6389 /* Check if the zipmap needs to be upgraded to a real hash table */
6390 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6391 convertToRealHash(o
);
6393 if (dictReplace(o
->ptr
,key
,value
)) {
6400 incrRefCount(value
);
6405 /* Delete an element from a hash.
6406 * Return 1 on deleted and 0 on not found. */
6407 static int hashDelete(robj
*o
, robj
*key
) {
6409 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6410 key
= getDecodedObject(key
);
6411 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6414 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6415 /* Always check if the dictionary needs a resize after a delete. */
6416 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6421 /* Return the number of elements in a hash. */
6422 static unsigned long hashLength(robj
*o
) {
6423 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6424 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6427 /* Structure to hold hash iteration abstration. Note that iteration over
6428 * hashes involves both fields and values. Because it is possible that
6429 * not both are required, store pointers in the iterator to avoid
6430 * unnecessary memory allocation for fields/values. */
6434 unsigned char *zk
, *zv
;
6435 unsigned int zklen
, zvlen
;
6441 static hashIterator
*hashInitIterator(robj
*subject
) {
6442 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6443 hi
->encoding
= subject
->encoding
;
6444 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6445 hi
->zi
= zipmapRewind(subject
->ptr
);
6446 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6447 hi
->di
= dictGetIterator(subject
->ptr
);
6454 static void hashReleaseIterator(hashIterator
*hi
) {
6455 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6456 dictReleaseIterator(hi
->di
);
6461 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6462 * could be found and REDIS_ERR when the iterator reaches the end. */
6463 static int hashNext(hashIterator
*hi
) {
6464 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6465 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6466 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6468 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6473 /* Get key or value object at current iteration position.
6474 * This increases the refcount of the field object by 1. */
6475 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6477 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6478 if (what
& REDIS_HASH_KEY
) {
6479 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6481 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6484 if (what
& REDIS_HASH_KEY
) {
6485 o
= dictGetEntryKey(hi
->de
);
6487 o
= dictGetEntryVal(hi
->de
);
6494 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6495 robj
*o
= lookupKeyWrite(c
->db
,key
);
6497 o
= createHashObject();
6498 dictAdd(c
->db
->dict
,key
,o
);
6501 if (o
->type
!= REDIS_HASH
) {
6502 addReply(c
,shared
.wrongtypeerr
);
6509 /* ============================= Hash commands ============================== */
6510 static void hsetCommand(redisClient
*c
) {
6514 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6515 hashTryConversion(o
,c
->argv
,2,3);
6516 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6517 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6518 addReply(c
, update
? shared
.czero
: shared
.cone
);
6522 static void hsetnxCommand(redisClient
*c
) {
6524 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6525 hashTryConversion(o
,c
->argv
,2,3);
6527 if (hashExists(o
, c
->argv
[2])) {
6528 addReply(c
, shared
.czero
);
6530 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6531 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6532 addReply(c
, shared
.cone
);
6537 static void hmsetCommand(redisClient
*c
) {
6541 if ((c
->argc
% 2) == 1) {
6542 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6546 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6547 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6548 for (i
= 2; i
< c
->argc
; i
+= 2) {
6549 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6550 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6552 addReply(c
, shared
.ok
);
6556 static void hincrbyCommand(redisClient
*c
) {
6557 long long value
, incr
;
6558 robj
*o
, *current
, *new;
6560 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6561 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6562 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6563 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6564 "hash value is not an integer") != REDIS_OK
) {
6565 decrRefCount(current
);
6568 decrRefCount(current
);
6574 new = createStringObjectFromLongLong(value
);
6575 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6576 hashSet(o
,c
->argv
[2],new);
6578 addReplyLongLong(c
,value
);
6582 static void hgetCommand(redisClient
*c
) {
6584 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6585 checkType(c
,o
,REDIS_HASH
)) return;
6587 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6588 addReplyBulk(c
,value
);
6589 decrRefCount(value
);
6591 addReply(c
,shared
.nullbulk
);
6595 static void hmgetCommand(redisClient
*c
) {
6598 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6599 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6600 addReply(c
,shared
.wrongtypeerr
);
6603 /* Note the check for o != NULL happens inside the loop. This is
6604 * done because objects that cannot be found are considered to be
6605 * an empty hash. The reply should then be a series of NULLs. */
6606 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6607 for (i
= 2; i
< c
->argc
; i
++) {
6608 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6609 addReplyBulk(c
,value
);
6610 decrRefCount(value
);
6612 addReply(c
,shared
.nullbulk
);
6617 static void hdelCommand(redisClient
*c
) {
6619 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6620 checkType(c
,o
,REDIS_HASH
)) return;
6622 if (hashDelete(o
,c
->argv
[2])) {
6623 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6624 addReply(c
,shared
.cone
);
6627 addReply(c
,shared
.czero
);
6631 static void hlenCommand(redisClient
*c
) {
6633 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6634 checkType(c
,o
,REDIS_HASH
)) return;
6636 addReplyUlong(c
,hashLength(o
));
6639 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6640 robj
*o
, *lenobj
, *obj
;
6641 unsigned long count
= 0;
6644 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6645 || checkType(c
,o
,REDIS_HASH
)) return;
6647 lenobj
= createObject(REDIS_STRING
,NULL
);
6649 decrRefCount(lenobj
);
6651 hi
= hashInitIterator(o
);
6652 while (hashNext(hi
) != REDIS_ERR
) {
6653 if (flags
& REDIS_HASH_KEY
) {
6654 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6655 addReplyBulk(c
,obj
);
6659 if (flags
& REDIS_HASH_VALUE
) {
6660 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6661 addReplyBulk(c
,obj
);
6666 hashReleaseIterator(hi
);
6668 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6671 static void hkeysCommand(redisClient
*c
) {
6672 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6675 static void hvalsCommand(redisClient
*c
) {
6676 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6679 static void hgetallCommand(redisClient
*c
) {
6680 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6683 static void hexistsCommand(redisClient
*c
) {
6685 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6686 checkType(c
,o
,REDIS_HASH
)) return;
6688 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6691 static void convertToRealHash(robj
*o
) {
6692 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6693 unsigned int klen
, vlen
;
6694 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6696 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6697 p
= zipmapRewind(zm
);
6698 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6699 robj
*keyobj
, *valobj
;
6701 keyobj
= createStringObject((char*)key
,klen
);
6702 valobj
= createStringObject((char*)val
,vlen
);
6703 keyobj
= tryObjectEncoding(keyobj
);
6704 valobj
= tryObjectEncoding(valobj
);
6705 dictAdd(dict
,keyobj
,valobj
);
6707 o
->encoding
= REDIS_ENCODING_HT
;
6712 /* ========================= Non type-specific commands ==================== */
6714 static void flushdbCommand(redisClient
*c
) {
6715 server
.dirty
+= dictSize(c
->db
->dict
);
6716 dictEmpty(c
->db
->dict
);
6717 dictEmpty(c
->db
->expires
);
6718 addReply(c
,shared
.ok
);
6721 static void flushallCommand(redisClient
*c
) {
6722 server
.dirty
+= emptyDb();
6723 addReply(c
,shared
.ok
);
6724 if (server
.bgsavechildpid
!= -1) {
6725 kill(server
.bgsavechildpid
,SIGKILL
);
6726 rdbRemoveTempFile(server
.bgsavechildpid
);
6728 rdbSave(server
.dbfilename
);
6732 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6733 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6735 so
->pattern
= pattern
;
6739 /* Return the value associated to the key with a name obtained
6740 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6741 * The returned object will always have its refcount increased by 1
6742 * when it is non-NULL. */
6743 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6746 robj keyobj
, fieldobj
, *o
;
6747 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6748 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6752 char buf
[REDIS_SORTKEY_MAX
+1];
6753 } keyname
, fieldname
;
6755 /* If the pattern is "#" return the substitution object itself in order
6756 * to implement the "SORT ... GET #" feature. */
6757 spat
= pattern
->ptr
;
6758 if (spat
[0] == '#' && spat
[1] == '\0') {
6759 incrRefCount(subst
);
6763 /* The substitution object may be specially encoded. If so we create
6764 * a decoded object on the fly. Otherwise getDecodedObject will just
6765 * increment the ref count, that we'll decrement later. */
6766 subst
= getDecodedObject(subst
);
6769 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6770 p
= strchr(spat
,'*');
6772 decrRefCount(subst
);
6776 /* Find out if we're dealing with a hash dereference. */
6777 if ((f
= strstr(p
+1, "->")) != NULL
) {
6778 fieldlen
= sdslen(spat
)-(f
-spat
);
6779 /* this also copies \0 character */
6780 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6781 fieldname
.len
= fieldlen
-2;
6787 sublen
= sdslen(ssub
);
6788 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6789 memcpy(keyname
.buf
,spat
,prefixlen
);
6790 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6791 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6792 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6793 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6794 decrRefCount(subst
);
6796 /* Lookup substituted key */
6797 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6798 o
= lookupKeyRead(db
,&keyobj
);
6799 if (o
== NULL
) return NULL
;
6802 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6804 /* Retrieve value from hash by the field name. This operation
6805 * already increases the refcount of the returned object. */
6806 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6807 o
= hashGet(o
, &fieldobj
);
6809 if (o
->type
!= REDIS_STRING
) return NULL
;
6811 /* Every object that this function returns needs to have its refcount
6812 * increased. sortCommand decreases it again. */
6819 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6820 * the additional parameter is not standard but a BSD-specific we have to
6821 * pass sorting parameters via the global 'server' structure */
6822 static int sortCompare(const void *s1
, const void *s2
) {
6823 const redisSortObject
*so1
= s1
, *so2
= s2
;
6826 if (!server
.sort_alpha
) {
6827 /* Numeric sorting. Here it's trivial as we precomputed scores */
6828 if (so1
->u
.score
> so2
->u
.score
) {
6830 } else if (so1
->u
.score
< so2
->u
.score
) {
6836 /* Alphanumeric sorting */
6837 if (server
.sort_bypattern
) {
6838 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6839 /* At least one compare object is NULL */
6840 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6842 else if (so1
->u
.cmpobj
== NULL
)
6847 /* We have both the objects, use strcoll */
6848 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6851 /* Compare elements directly. */
6852 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6855 return server
.sort_desc
? -cmp
: cmp
;
6858 /* The SORT command is the most complex command in Redis. Warning: this code
6859 * is optimized for speed and a bit less for readability */
6860 static void sortCommand(redisClient
*c
) {
6863 int desc
= 0, alpha
= 0;
6864 int limit_start
= 0, limit_count
= -1, start
, end
;
6865 int j
, dontsort
= 0, vectorlen
;
6866 int getop
= 0; /* GET operation counter */
6867 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6868 redisSortObject
*vector
; /* Resulting vector to sort */
6870 /* Lookup the key to sort. It must be of the right types */
6871 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6872 if (sortval
== NULL
) {
6873 addReply(c
,shared
.emptymultibulk
);
6876 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6877 sortval
->type
!= REDIS_ZSET
)
6879 addReply(c
,shared
.wrongtypeerr
);
6883 /* Create a list of operations to perform for every sorted element.
6884 * Operations can be GET/DEL/INCR/DECR */
6885 operations
= listCreate();
6886 listSetFreeMethod(operations
,zfree
);
6889 /* Now we need to protect sortval incrementing its count, in the future
6890 * SORT may have options able to overwrite/delete keys during the sorting
6891 * and the sorted key itself may get destroied */
6892 incrRefCount(sortval
);
6894 /* The SORT command has an SQL-alike syntax, parse it */
6895 while(j
< c
->argc
) {
6896 int leftargs
= c
->argc
-j
-1;
6897 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6899 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6901 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6903 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6904 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6905 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6907 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6908 storekey
= c
->argv
[j
+1];
6910 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6911 sortby
= c
->argv
[j
+1];
6912 /* If the BY pattern does not contain '*', i.e. it is constant,
6913 * we don't need to sort nor to lookup the weight keys. */
6914 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6916 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6917 listAddNodeTail(operations
,createSortOperation(
6918 REDIS_SORT_GET
,c
->argv
[j
+1]));
6922 decrRefCount(sortval
);
6923 listRelease(operations
);
6924 addReply(c
,shared
.syntaxerr
);
6930 /* Load the sorting vector with all the objects to sort */
6931 switch(sortval
->type
) {
6932 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6933 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6934 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6935 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6937 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6940 if (sortval
->type
== REDIS_LIST
) {
6941 list
*list
= sortval
->ptr
;
6945 listRewind(list
,&li
);
6946 while((ln
= listNext(&li
))) {
6947 robj
*ele
= ln
->value
;
6948 vector
[j
].obj
= ele
;
6949 vector
[j
].u
.score
= 0;
6950 vector
[j
].u
.cmpobj
= NULL
;
6958 if (sortval
->type
== REDIS_SET
) {
6961 zset
*zs
= sortval
->ptr
;
6965 di
= dictGetIterator(set
);
6966 while((setele
= dictNext(di
)) != NULL
) {
6967 vector
[j
].obj
= dictGetEntryKey(setele
);
6968 vector
[j
].u
.score
= 0;
6969 vector
[j
].u
.cmpobj
= NULL
;
6972 dictReleaseIterator(di
);
6974 redisAssert(j
== vectorlen
);
6976 /* Now it's time to load the right scores in the sorting vector */
6977 if (dontsort
== 0) {
6978 for (j
= 0; j
< vectorlen
; j
++) {
6981 /* lookup value to sort by */
6982 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6983 if (!byval
) continue;
6985 /* use object itself to sort by */
6986 byval
= vector
[j
].obj
;
6990 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6992 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6993 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6994 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6995 /* Don't need to decode the object if it's
6996 * integer-encoded (the only encoding supported) so
6997 * far. We can just cast it */
6998 vector
[j
].u
.score
= (long)byval
->ptr
;
7000 redisAssert(1 != 1);
7004 /* when the object was retrieved using lookupKeyByPattern,
7005 * its refcount needs to be decreased. */
7007 decrRefCount(byval
);
7012 /* We are ready to sort the vector... perform a bit of sanity check
7013 * on the LIMIT option too. We'll use a partial version of quicksort. */
7014 start
= (limit_start
< 0) ? 0 : limit_start
;
7015 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7016 if (start
>= vectorlen
) {
7017 start
= vectorlen
-1;
7020 if (end
>= vectorlen
) end
= vectorlen
-1;
7022 if (dontsort
== 0) {
7023 server
.sort_desc
= desc
;
7024 server
.sort_alpha
= alpha
;
7025 server
.sort_bypattern
= sortby
? 1 : 0;
7026 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7027 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7029 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7032 /* Send command output to the output buffer, performing the specified
7033 * GET/DEL/INCR/DECR operations if any. */
7034 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7035 if (storekey
== NULL
) {
7036 /* STORE option not specified, sent the sorting result to client */
7037 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7038 for (j
= start
; j
<= end
; j
++) {
7042 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7043 listRewind(operations
,&li
);
7044 while((ln
= listNext(&li
))) {
7045 redisSortOperation
*sop
= ln
->value
;
7046 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7049 if (sop
->type
== REDIS_SORT_GET
) {
7051 addReply(c
,shared
.nullbulk
);
7053 addReplyBulk(c
,val
);
7057 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7062 robj
*listObject
= createListObject();
7063 list
*listPtr
= (list
*) listObject
->ptr
;
7065 /* STORE option specified, set the sorting result as a List object */
7066 for (j
= start
; j
<= end
; j
++) {
7071 listAddNodeTail(listPtr
,vector
[j
].obj
);
7072 incrRefCount(vector
[j
].obj
);
7074 listRewind(operations
,&li
);
7075 while((ln
= listNext(&li
))) {
7076 redisSortOperation
*sop
= ln
->value
;
7077 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7080 if (sop
->type
== REDIS_SORT_GET
) {
7082 listAddNodeTail(listPtr
,createStringObject("",0));
7084 /* We should do a incrRefCount on val because it is
7085 * added to the list, but also a decrRefCount because
7086 * it is returned by lookupKeyByPattern. This results
7087 * in doing nothing at all. */
7088 listAddNodeTail(listPtr
,val
);
7091 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7095 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7096 incrRefCount(storekey
);
7098 /* Note: we add 1 because the DB is dirty anyway since even if the
7099 * SORT result is empty a new key is set and maybe the old content
7101 server
.dirty
+= 1+outputlen
;
7102 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7106 decrRefCount(sortval
);
7107 listRelease(operations
);
7108 for (j
= 0; j
< vectorlen
; j
++) {
7109 if (alpha
&& vector
[j
].u
.cmpobj
)
7110 decrRefCount(vector
[j
].u
.cmpobj
);
7115 /* Convert an amount of bytes into a human readable string in the form
7116 * of 100B, 2G, 100M, 4K, and so forth. */
7117 static void bytesToHuman(char *s
, unsigned long long n
) {
7122 sprintf(s
,"%lluB",n
);
7124 } else if (n
< (1024*1024)) {
7125 d
= (double)n
/(1024);
7126 sprintf(s
,"%.2fK",d
);
7127 } else if (n
< (1024LL*1024*1024)) {
7128 d
= (double)n
/(1024*1024);
7129 sprintf(s
,"%.2fM",d
);
7130 } else if (n
< (1024LL*1024*1024*1024)) {
7131 d
= (double)n
/(1024LL*1024*1024);
7132 sprintf(s
,"%.2fG",d
);
7136 /* Create the string returned by the INFO command. This is decoupled
7137 * by the INFO command itself as we need to report the same information
7138 * on memory corruption problems. */
7139 static sds
genRedisInfoString(void) {
7141 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7145 bytesToHuman(hmem
,zmalloc_used_memory());
7146 info
= sdscatprintf(sdsempty(),
7147 "redis_version:%s\r\n"
7149 "multiplexing_api:%s\r\n"
7150 "process_id:%ld\r\n"
7151 "uptime_in_seconds:%ld\r\n"
7152 "uptime_in_days:%ld\r\n"
7153 "connected_clients:%d\r\n"
7154 "connected_slaves:%d\r\n"
7155 "blocked_clients:%d\r\n"
7156 "used_memory:%zu\r\n"
7157 "used_memory_human:%s\r\n"
7158 "changes_since_last_save:%lld\r\n"
7159 "bgsave_in_progress:%d\r\n"
7160 "last_save_time:%ld\r\n"
7161 "bgrewriteaof_in_progress:%d\r\n"
7162 "total_connections_received:%lld\r\n"
7163 "total_commands_processed:%lld\r\n"
7164 "expired_keys:%lld\r\n"
7165 "hash_max_zipmap_entries:%ld\r\n"
7166 "hash_max_zipmap_value:%ld\r\n"
7167 "pubsub_channels:%ld\r\n"
7168 "pubsub_patterns:%u\r\n"
7172 (sizeof(long) == 8) ? "64" : "32",
7177 listLength(server
.clients
)-listLength(server
.slaves
),
7178 listLength(server
.slaves
),
7179 server
.blpop_blocked_clients
,
7180 zmalloc_used_memory(),
7183 server
.bgsavechildpid
!= -1,
7185 server
.bgrewritechildpid
!= -1,
7186 server
.stat_numconnections
,
7187 server
.stat_numcommands
,
7188 server
.stat_expiredkeys
,
7189 server
.hash_max_zipmap_entries
,
7190 server
.hash_max_zipmap_value
,
7191 dictSize(server
.pubsub_channels
),
7192 listLength(server
.pubsub_patterns
),
7193 server
.vm_enabled
!= 0,
7194 server
.masterhost
== NULL
? "master" : "slave"
7196 if (server
.masterhost
) {
7197 info
= sdscatprintf(info
,
7198 "master_host:%s\r\n"
7199 "master_port:%d\r\n"
7200 "master_link_status:%s\r\n"
7201 "master_last_io_seconds_ago:%d\r\n"
7204 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7206 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7209 if (server
.vm_enabled
) {
7211 info
= sdscatprintf(info
,
7212 "vm_conf_max_memory:%llu\r\n"
7213 "vm_conf_page_size:%llu\r\n"
7214 "vm_conf_pages:%llu\r\n"
7215 "vm_stats_used_pages:%llu\r\n"
7216 "vm_stats_swapped_objects:%llu\r\n"
7217 "vm_stats_swappin_count:%llu\r\n"
7218 "vm_stats_swappout_count:%llu\r\n"
7219 "vm_stats_io_newjobs_len:%lu\r\n"
7220 "vm_stats_io_processing_len:%lu\r\n"
7221 "vm_stats_io_processed_len:%lu\r\n"
7222 "vm_stats_io_active_threads:%lu\r\n"
7223 "vm_stats_blocked_clients:%lu\r\n"
7224 ,(unsigned long long) server
.vm_max_memory
,
7225 (unsigned long long) server
.vm_page_size
,
7226 (unsigned long long) server
.vm_pages
,
7227 (unsigned long long) server
.vm_stats_used_pages
,
7228 (unsigned long long) server
.vm_stats_swapped_objects
,
7229 (unsigned long long) server
.vm_stats_swapins
,
7230 (unsigned long long) server
.vm_stats_swapouts
,
7231 (unsigned long) listLength(server
.io_newjobs
),
7232 (unsigned long) listLength(server
.io_processing
),
7233 (unsigned long) listLength(server
.io_processed
),
7234 (unsigned long) server
.io_active_threads
,
7235 (unsigned long) server
.vm_blocked_clients
7239 for (j
= 0; j
< server
.dbnum
; j
++) {
7240 long long keys
, vkeys
;
7242 keys
= dictSize(server
.db
[j
].dict
);
7243 vkeys
= dictSize(server
.db
[j
].expires
);
7244 if (keys
|| vkeys
) {
7245 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7252 static void infoCommand(redisClient
*c
) {
7253 sds info
= genRedisInfoString();
7254 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7255 (unsigned long)sdslen(info
)));
7256 addReplySds(c
,info
);
7257 addReply(c
,shared
.crlf
);
7260 static void monitorCommand(redisClient
*c
) {
7261 /* ignore MONITOR if aleady slave or in monitor mode */
7262 if (c
->flags
& REDIS_SLAVE
) return;
7264 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7266 listAddNodeTail(server
.monitors
,c
);
7267 addReply(c
,shared
.ok
);
7270 /* ================================= Expire ================================= */
7271 static int removeExpire(redisDb
*db
, robj
*key
) {
7272 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7279 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7280 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7288 /* Return the expire time of the specified key, or -1 if no expire
7289 * is associated with this key (i.e. the key is non volatile) */
7290 static time_t getExpire(redisDb
*db
, robj
*key
) {
7293 /* No expire? return ASAP */
7294 if (dictSize(db
->expires
) == 0 ||
7295 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7297 return (time_t) dictGetEntryVal(de
);
7300 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7304 /* No expire? return ASAP */
7305 if (dictSize(db
->expires
) == 0 ||
7306 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7308 /* Lookup the expire */
7309 when
= (time_t) dictGetEntryVal(de
);
7310 if (time(NULL
) <= when
) return 0;
7312 /* Delete the key */
7313 dictDelete(db
->expires
,key
);
7314 server
.stat_expiredkeys
++;
7315 return dictDelete(db
->dict
,key
) == DICT_OK
;
7318 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7321 /* No expire? return ASAP */
7322 if (dictSize(db
->expires
) == 0 ||
7323 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7325 /* Delete the key */
7327 server
.stat_expiredkeys
++;
7328 dictDelete(db
->expires
,key
);
7329 return dictDelete(db
->dict
,key
) == DICT_OK
;
7332 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7336 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7340 de
= dictFind(c
->db
->dict
,key
);
7342 addReply(c
,shared
.czero
);
7346 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7347 addReply(c
, shared
.cone
);
7350 time_t when
= time(NULL
)+seconds
;
7351 if (setExpire(c
->db
,key
,when
)) {
7352 addReply(c
,shared
.cone
);
7355 addReply(c
,shared
.czero
);
7361 static void expireCommand(redisClient
*c
) {
7362 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7365 static void expireatCommand(redisClient
*c
) {
7366 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7369 static void ttlCommand(redisClient
*c
) {
7373 expire
= getExpire(c
->db
,c
->argv
[1]);
7375 ttl
= (int) (expire
-time(NULL
));
7376 if (ttl
< 0) ttl
= -1;
7378 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7381 /* ================================ MULTI/EXEC ============================== */
7383 /* Client state initialization for MULTI/EXEC */
7384 static void initClientMultiState(redisClient
*c
) {
7385 c
->mstate
.commands
= NULL
;
7386 c
->mstate
.count
= 0;
7389 /* Release all the resources associated with MULTI/EXEC state */
7390 static void freeClientMultiState(redisClient
*c
) {
7393 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7395 multiCmd
*mc
= c
->mstate
.commands
+j
;
7397 for (i
= 0; i
< mc
->argc
; i
++)
7398 decrRefCount(mc
->argv
[i
]);
7401 zfree(c
->mstate
.commands
);
7404 /* Add a new command into the MULTI commands queue */
7405 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7409 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7410 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7411 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7414 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7415 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7416 for (j
= 0; j
< c
->argc
; j
++)
7417 incrRefCount(mc
->argv
[j
]);
7421 static void multiCommand(redisClient
*c
) {
7422 c
->flags
|= REDIS_MULTI
;
7423 addReply(c
,shared
.ok
);
7426 static void discardCommand(redisClient
*c
) {
7427 if (!(c
->flags
& REDIS_MULTI
)) {
7428 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7432 freeClientMultiState(c
);
7433 initClientMultiState(c
);
7434 c
->flags
&= (~REDIS_MULTI
);
7435 addReply(c
,shared
.ok
);
7438 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7439 * implememntation for more information. */
7440 static void execCommandReplicateMulti(redisClient
*c
) {
7441 struct redisCommand
*cmd
;
7442 robj
*multistring
= createStringObject("MULTI",5);
7444 cmd
= lookupCommand("multi");
7445 if (server
.appendonly
)
7446 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7447 if (listLength(server
.slaves
))
7448 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7449 decrRefCount(multistring
);
7452 static void execCommand(redisClient
*c
) {
7457 if (!(c
->flags
& REDIS_MULTI
)) {
7458 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7462 /* Replicate a MULTI request now that we are sure the block is executed.
7463 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7464 * both the AOF and the replication link will have the same consistency
7465 * and atomicity guarantees. */
7466 execCommandReplicateMulti(c
);
7468 /* Exec all the queued commands */
7469 orig_argv
= c
->argv
;
7470 orig_argc
= c
->argc
;
7471 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7472 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7473 c
->argc
= c
->mstate
.commands
[j
].argc
;
7474 c
->argv
= c
->mstate
.commands
[j
].argv
;
7475 call(c
,c
->mstate
.commands
[j
].cmd
);
7477 c
->argv
= orig_argv
;
7478 c
->argc
= orig_argc
;
7479 freeClientMultiState(c
);
7480 initClientMultiState(c
);
7481 c
->flags
&= (~REDIS_MULTI
);
7482 /* Make sure the EXEC command is always replicated / AOF, since we
7483 * always send the MULTI command (we can't know beforehand if the
7484 * next operations will contain at least a modification to the DB). */
7488 /* =========================== Blocking Operations ========================= */
7490 /* Currently Redis blocking operations support is limited to list POP ops,
7491 * so the current implementation is not fully generic, but it is also not
7492 * completely specific so it will not require a rewrite to support new
7493 * kind of blocking operations in the future.
7495 * Still it's important to note that list blocking operations can be already
7496 * used as a notification mechanism in order to implement other blocking
7497 * operations at application level, so there must be a very strong evidence
7498 * of usefulness and generality before new blocking operations are implemented.
7500 * This is how the current blocking POP works, we use BLPOP as example:
7501 * - If the user calls BLPOP and the key exists and contains a non empty list
7502 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7503 * if there is not to block.
7504 * - If instead BLPOP is called and the key does not exists or the list is
7505 * empty we need to block. In order to do so we remove the notification for
7506 * new data to read in the client socket (so that we'll not serve new
7507 * requests if the blocking request is not served). Also we put the client
7508 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7509 * blocking for this keys.
7510 * - If a PUSH operation against a key with blocked clients waiting is
7511 * performed, we serve the first in the list: basically instead to push
7512 * the new element inside the list we return it to the (first / oldest)
7513 * blocking client, unblock the client, and remove it form the list.
7515 * The above comment and the source code should be enough in order to understand
7516 * the implementation and modify / fix it later.
7519 /* Set a client in blocking mode for the specified key, with the specified
7521 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7526 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7527 c
->blockingkeysnum
= numkeys
;
7528 c
->blockingto
= timeout
;
7529 for (j
= 0; j
< numkeys
; j
++) {
7530 /* Add the key in the client structure, to map clients -> keys */
7531 c
->blockingkeys
[j
] = keys
[j
];
7532 incrRefCount(keys
[j
]);
7534 /* And in the other "side", to map keys -> clients */
7535 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7539 /* For every key we take a list of clients blocked for it */
7541 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7542 incrRefCount(keys
[j
]);
7543 assert(retval
== DICT_OK
);
7545 l
= dictGetEntryVal(de
);
7547 listAddNodeTail(l
,c
);
7549 /* Mark the client as a blocked client */
7550 c
->flags
|= REDIS_BLOCKED
;
7551 server
.blpop_blocked_clients
++;
7554 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7555 static void unblockClientWaitingData(redisClient
*c
) {
7560 assert(c
->blockingkeys
!= NULL
);
7561 /* The client may wait for multiple keys, so unblock it for every key. */
7562 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7563 /* Remove this client from the list of clients waiting for this key. */
7564 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7566 l
= dictGetEntryVal(de
);
7567 listDelNode(l
,listSearchKey(l
,c
));
7568 /* If the list is empty we need to remove it to avoid wasting memory */
7569 if (listLength(l
) == 0)
7570 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7571 decrRefCount(c
->blockingkeys
[j
]);
7573 /* Cleanup the client structure */
7574 zfree(c
->blockingkeys
);
7575 c
->blockingkeys
= NULL
;
7576 c
->flags
&= (~REDIS_BLOCKED
);
7577 server
.blpop_blocked_clients
--;
7578 /* We want to process data if there is some command waiting
7579 * in the input buffer. Note that this is safe even if
7580 * unblockClientWaitingData() gets called from freeClient() because
7581 * freeClient() will be smart enough to call this function
7582 * *after* c->querybuf was set to NULL. */
7583 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7586 /* This should be called from any function PUSHing into lists.
7587 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7588 * 'ele' is the element pushed.
7590 * If the function returns 0 there was no client waiting for a list push
7593 * If the function returns 1 there was a client waiting for a list push
7594 * against this key, the element was passed to this client thus it's not
7595 * needed to actually add it to the list and the caller should return asap. */
7596 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7597 struct dictEntry
*de
;
7598 redisClient
*receiver
;
7602 de
= dictFind(c
->db
->blockingkeys
,key
);
7603 if (de
== NULL
) return 0;
7604 l
= dictGetEntryVal(de
);
7607 receiver
= ln
->value
;
7609 addReplySds(receiver
,sdsnew("*2\r\n"));
7610 addReplyBulk(receiver
,key
);
7611 addReplyBulk(receiver
,ele
);
7612 unblockClientWaitingData(receiver
);
7616 /* Blocking RPOP/LPOP */
7617 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7622 for (j
= 1; j
< c
->argc
-1; j
++) {
7623 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7625 if (o
->type
!= REDIS_LIST
) {
7626 addReply(c
,shared
.wrongtypeerr
);
7629 list
*list
= o
->ptr
;
7630 if (listLength(list
) != 0) {
7631 /* If the list contains elements fall back to the usual
7632 * non-blocking POP operation */
7633 robj
*argv
[2], **orig_argv
;
7636 /* We need to alter the command arguments before to call
7637 * popGenericCommand() as the command takes a single key. */
7638 orig_argv
= c
->argv
;
7639 orig_argc
= c
->argc
;
7640 argv
[1] = c
->argv
[j
];
7644 /* Also the return value is different, we need to output
7645 * the multi bulk reply header and the key name. The
7646 * "real" command will add the last element (the value)
7647 * for us. If this souds like an hack to you it's just
7648 * because it is... */
7649 addReplySds(c
,sdsnew("*2\r\n"));
7650 addReplyBulk(c
,argv
[1]);
7651 popGenericCommand(c
,where
);
7653 /* Fix the client structure with the original stuff */
7654 c
->argv
= orig_argv
;
7655 c
->argc
= orig_argc
;
7661 /* If the list is empty or the key does not exists we must block */
7662 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7663 if (timeout
> 0) timeout
+= time(NULL
);
7664 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7667 static void blpopCommand(redisClient
*c
) {
7668 blockingPopGenericCommand(c
,REDIS_HEAD
);
7671 static void brpopCommand(redisClient
*c
) {
7672 blockingPopGenericCommand(c
,REDIS_TAIL
);
7675 /* =============================== Replication ============================= */
7677 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7678 ssize_t nwritten
, ret
= size
;
7679 time_t start
= time(NULL
);
7683 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7684 nwritten
= write(fd
,ptr
,size
);
7685 if (nwritten
== -1) return -1;
7689 if ((time(NULL
)-start
) > timeout
) {
7697 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7698 ssize_t nread
, totread
= 0;
7699 time_t start
= time(NULL
);
7703 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7704 nread
= read(fd
,ptr
,size
);
7705 if (nread
== -1) return -1;
7710 if ((time(NULL
)-start
) > timeout
) {
7718 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7725 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7728 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7739 static void syncCommand(redisClient
*c
) {
7740 /* ignore SYNC if aleady slave or in monitor mode */
7741 if (c
->flags
& REDIS_SLAVE
) return;
7743 /* SYNC can't be issued when the server has pending data to send to
7744 * the client about already issued commands. We need a fresh reply
7745 * buffer registering the differences between the BGSAVE and the current
7746 * dataset, so that we can copy to other slaves if needed. */
7747 if (listLength(c
->reply
) != 0) {
7748 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7752 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7753 /* Here we need to check if there is a background saving operation
7754 * in progress, or if it is required to start one */
7755 if (server
.bgsavechildpid
!= -1) {
7756 /* Ok a background save is in progress. Let's check if it is a good
7757 * one for replication, i.e. if there is another slave that is
7758 * registering differences since the server forked to save */
7763 listRewind(server
.slaves
,&li
);
7764 while((ln
= listNext(&li
))) {
7766 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7769 /* Perfect, the server is already registering differences for
7770 * another slave. Set the right state, and copy the buffer. */
7771 listRelease(c
->reply
);
7772 c
->reply
= listDup(slave
->reply
);
7773 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7774 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7776 /* No way, we need to wait for the next BGSAVE in order to
7777 * register differences */
7778 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7779 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7782 /* Ok we don't have a BGSAVE in progress, let's start one */
7783 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7784 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7785 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7786 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7789 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7792 c
->flags
|= REDIS_SLAVE
;
7794 listAddNodeTail(server
.slaves
,c
);
7798 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7799 redisClient
*slave
= privdata
;
7801 REDIS_NOTUSED(mask
);
7802 char buf
[REDIS_IOBUF_LEN
];
7803 ssize_t nwritten
, buflen
;
7805 if (slave
->repldboff
== 0) {
7806 /* Write the bulk write count before to transfer the DB. In theory here
7807 * we don't know how much room there is in the output buffer of the
7808 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7809 * operations) will never be smaller than the few bytes we need. */
7812 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7814 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7822 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7823 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7825 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7826 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7830 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7831 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7836 slave
->repldboff
+= nwritten
;
7837 if (slave
->repldboff
== slave
->repldbsize
) {
7838 close(slave
->repldbfd
);
7839 slave
->repldbfd
= -1;
7840 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7841 slave
->replstate
= REDIS_REPL_ONLINE
;
7842 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7843 sendReplyToClient
, slave
) == AE_ERR
) {
7847 addReplySds(slave
,sdsempty());
7848 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7852 /* This function is called at the end of every backgrond saving.
7853 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7854 * otherwise REDIS_ERR is passed to the function.
7856 * The goal of this function is to handle slaves waiting for a successful
7857 * background saving in order to perform non-blocking synchronization. */
7858 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7860 int startbgsave
= 0;
7863 listRewind(server
.slaves
,&li
);
7864 while((ln
= listNext(&li
))) {
7865 redisClient
*slave
= ln
->value
;
7867 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7869 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7870 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7871 struct redis_stat buf
;
7873 if (bgsaveerr
!= REDIS_OK
) {
7875 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7878 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7879 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7881 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7884 slave
->repldboff
= 0;
7885 slave
->repldbsize
= buf
.st_size
;
7886 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7887 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7888 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7895 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7898 listRewind(server
.slaves
,&li
);
7899 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7900 while((ln
= listNext(&li
))) {
7901 redisClient
*slave
= ln
->value
;
7903 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7910 static int syncWithMaster(void) {
7911 char buf
[1024], tmpfile
[256], authcmd
[1024];
7913 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7914 int dfd
, maxtries
= 5;
7917 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7922 /* AUTH with the master if required. */
7923 if(server
.masterauth
) {
7924 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7925 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7927 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7931 /* Read the AUTH result. */
7932 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7934 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7938 if (buf
[0] != '+') {
7940 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7945 /* Issue the SYNC command */
7946 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7948 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7952 /* Read the bulk write count */
7953 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7955 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7959 if (buf
[0] != '$') {
7961 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7964 dumpsize
= strtol(buf
+1,NULL
,10);
7965 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7966 /* Read the bulk write data on a temp file */
7968 snprintf(tmpfile
,256,
7969 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7970 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7971 if (dfd
!= -1) break;
7976 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7980 int nread
, nwritten
;
7982 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7984 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7990 nwritten
= write(dfd
,buf
,nread
);
7991 if (nwritten
== -1) {
7992 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8000 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8001 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8007 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8008 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8012 server
.master
= createClient(fd
);
8013 server
.master
->flags
|= REDIS_MASTER
;
8014 server
.master
->authenticated
= 1;
8015 server
.replstate
= REDIS_REPL_CONNECTED
;
8019 static void slaveofCommand(redisClient
*c
) {
8020 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8021 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8022 if (server
.masterhost
) {
8023 sdsfree(server
.masterhost
);
8024 server
.masterhost
= NULL
;
8025 if (server
.master
) freeClient(server
.master
);
8026 server
.replstate
= REDIS_REPL_NONE
;
8027 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8030 sdsfree(server
.masterhost
);
8031 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8032 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8033 if (server
.master
) freeClient(server
.master
);
8034 server
.replstate
= REDIS_REPL_CONNECT
;
8035 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8036 server
.masterhost
, server
.masterport
);
8038 addReply(c
,shared
.ok
);
8041 /* ============================ Maxmemory directive ======================== */
8043 /* Try to free one object form the pre-allocated objects free list.
8044 * This is useful under low mem conditions as by default we take 1 million
8045 * free objects allocated. On success REDIS_OK is returned, otherwise
8047 static int tryFreeOneObjectFromFreelist(void) {
8050 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8051 if (listLength(server
.objfreelist
)) {
8052 listNode
*head
= listFirst(server
.objfreelist
);
8053 o
= listNodeValue(head
);
8054 listDelNode(server
.objfreelist
,head
);
8055 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8059 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8064 /* This function gets called when 'maxmemory' is set on the config file to limit
8065 * the max memory used by the server, and we are out of memory.
8066 * This function will try to, in order:
8068 * - Free objects from the free list
8069 * - Try to remove keys with an EXPIRE set
8071 * It is not possible to free enough memory to reach used-memory < maxmemory
8072 * the server will start refusing commands that will enlarge even more the
8075 static void freeMemoryIfNeeded(void) {
8076 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8077 int j
, k
, freed
= 0;
8079 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8080 for (j
= 0; j
< server
.dbnum
; j
++) {
8082 robj
*minkey
= NULL
;
8083 struct dictEntry
*de
;
8085 if (dictSize(server
.db
[j
].expires
)) {
8087 /* From a sample of three keys drop the one nearest to
8088 * the natural expire */
8089 for (k
= 0; k
< 3; k
++) {
8092 de
= dictGetRandomKey(server
.db
[j
].expires
);
8093 t
= (time_t) dictGetEntryVal(de
);
8094 if (minttl
== -1 || t
< minttl
) {
8095 minkey
= dictGetEntryKey(de
);
8099 deleteKey(server
.db
+j
,minkey
);
8102 if (!freed
) return; /* nothing to free... */
8106 /* ============================== Append Only file ========================== */
8108 /* Write the append only file buffer on disk.
8110 * Since we are required to write the AOF before replying to the client,
8111 * and the only way the client socket can get a write is entering when the
8112 * the event loop, we accumulate all the AOF writes in a memory
8113 * buffer and write it on disk using this function just before entering
8114 * the event loop again. */
8115 static void flushAppendOnlyFile(void) {
8119 if (sdslen(server
.aofbuf
) == 0) return;
8121 /* We want to perform a single write. This should be guaranteed atomic
8122 * at least if the filesystem we are writing is a real physical one.
8123 * While this will save us against the server being killed I don't think
8124 * there is much to do about the whole server stopping for power problems
8126 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8127 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8128 /* Ooops, we are in troubles. The best thing to do for now is
8129 * aborting instead of giving the illusion that everything is
8130 * working as expected. */
8131 if (nwritten
== -1) {
8132 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8134 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8138 sdsfree(server
.aofbuf
);
8139 server
.aofbuf
= sdsempty();
8141 /* Fsync if needed */
8143 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8144 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8145 now
-server
.lastfsync
> 1))
8147 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8148 * flushing metadata. */
8149 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8150 server
.lastfsync
= now
;
8154 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8155 sds buf
= sdsempty();
8159 /* The DB this command was targetting is not the same as the last command
8160 * we appendend. To issue a SELECT command is needed. */
8161 if (dictid
!= server
.appendseldb
) {
8164 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8165 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8166 (unsigned long)strlen(seldb
),seldb
);
8167 server
.appendseldb
= dictid
;
8170 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8171 * EXPIREs into EXPIREATs calls */
8172 if (cmd
->proc
== expireCommand
) {
8175 tmpargv
[0] = createStringObject("EXPIREAT",8);
8176 tmpargv
[1] = argv
[1];
8177 incrRefCount(argv
[1]);
8178 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8179 tmpargv
[2] = createObject(REDIS_STRING
,
8180 sdscatprintf(sdsempty(),"%ld",when
));
8184 /* Append the actual command */
8185 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8186 for (j
= 0; j
< argc
; j
++) {
8189 o
= getDecodedObject(o
);
8190 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8191 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8192 buf
= sdscatlen(buf
,"\r\n",2);
8196 /* Free the objects from the modified argv for EXPIREAT */
8197 if (cmd
->proc
== expireCommand
) {
8198 for (j
= 0; j
< 3; j
++)
8199 decrRefCount(argv
[j
]);
8202 /* Append to the AOF buffer. This will be flushed on disk just before
8203 * of re-entering the event loop, so before the client will get a
8204 * positive reply about the operation performed. */
8205 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8207 /* If a background append only file rewriting is in progress we want to
8208 * accumulate the differences between the child DB and the current one
8209 * in a buffer, so that when the child process will do its work we
8210 * can append the differences to the new append only file. */
8211 if (server
.bgrewritechildpid
!= -1)
8212 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8217 /* In Redis commands are always executed in the context of a client, so in
8218 * order to load the append only file we need to create a fake client. */
8219 static struct redisClient
*createFakeClient(void) {
8220 struct redisClient
*c
= zmalloc(sizeof(*c
));
8224 c
->querybuf
= sdsempty();
8228 /* We set the fake client as a slave waiting for the synchronization
8229 * so that Redis will not try to send replies to this client. */
8230 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8231 c
->reply
= listCreate();
8232 listSetFreeMethod(c
->reply
,decrRefCount
);
8233 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8234 initClientMultiState(c
);
8238 static void freeFakeClient(struct redisClient
*c
) {
8239 sdsfree(c
->querybuf
);
8240 listRelease(c
->reply
);
8241 freeClientMultiState(c
);
8245 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8246 * error (the append only file is zero-length) REDIS_ERR is returned. On
8247 * fatal error an error message is logged and the program exists. */
8248 int loadAppendOnlyFile(char *filename
) {
8249 struct redisClient
*fakeClient
;
8250 FILE *fp
= fopen(filename
,"r");
8251 struct redis_stat sb
;
8252 unsigned long long loadedkeys
= 0;
8253 int appendonly
= server
.appendonly
;
8255 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8259 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8263 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8264 * to the same file we're about to read. */
8265 server
.appendonly
= 0;
8267 fakeClient
= createFakeClient();
8274 struct redisCommand
*cmd
;
8276 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8282 if (buf
[0] != '*') goto fmterr
;
8284 argv
= zmalloc(sizeof(robj
*)*argc
);
8285 for (j
= 0; j
< argc
; j
++) {
8286 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8287 if (buf
[0] != '$') goto fmterr
;
8288 len
= strtol(buf
+1,NULL
,10);
8289 argsds
= sdsnewlen(NULL
,len
);
8290 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8291 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8292 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8295 /* Command lookup */
8296 cmd
= lookupCommand(argv
[0]->ptr
);
8298 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8301 /* Try object encoding */
8302 if (cmd
->flags
& REDIS_CMD_BULK
)
8303 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8304 /* Run the command in the context of a fake client */
8305 fakeClient
->argc
= argc
;
8306 fakeClient
->argv
= argv
;
8307 cmd
->proc(fakeClient
);
8308 /* Discard the reply objects list from the fake client */
8309 while(listLength(fakeClient
->reply
))
8310 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8311 /* Clean up, ready for the next command */
8312 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8314 /* Handle swapping while loading big datasets when VM is on */
8316 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8317 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8318 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8323 /* This point can only be reached when EOF is reached without errors.
8324 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8325 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8328 freeFakeClient(fakeClient
);
8329 server
.appendonly
= appendonly
;
8334 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8336 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8340 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8344 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8345 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8349 /* Avoid the incr/decr ref count business if possible to help
8350 * copy-on-write (we are often in a child process when this function
8352 * Also makes sure that key objects don't get incrRefCount-ed when VM
8354 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8355 obj
= getDecodedObject(obj
);
8358 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8359 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8360 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8362 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8363 if (decrrc
) decrRefCount(obj
);
8366 if (decrrc
) decrRefCount(obj
);
8370 /* Write binary-safe string into a file in the bulkformat
8371 * $<count>\r\n<payload>\r\n */
8372 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8375 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8376 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8377 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8378 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8382 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8383 static int fwriteBulkDouble(FILE *fp
, double d
) {
8384 char buf
[128], dbuf
[128];
8386 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8387 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8388 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8389 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8393 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8394 static int fwriteBulkLong(FILE *fp
, long l
) {
8395 char buf
[128], lbuf
[128];
8397 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8398 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8399 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8400 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8404 /* Write a sequence of commands able to fully rebuild the dataset into
8405 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8406 static int rewriteAppendOnlyFile(char *filename
) {
8407 dictIterator
*di
= NULL
;
8412 time_t now
= time(NULL
);
8414 /* Note that we have to use a different temp name here compared to the
8415 * one used by rewriteAppendOnlyFileBackground() function. */
8416 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8417 fp
= fopen(tmpfile
,"w");
8419 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8422 for (j
= 0; j
< server
.dbnum
; j
++) {
8423 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8424 redisDb
*db
= server
.db
+j
;
8426 if (dictSize(d
) == 0) continue;
8427 di
= dictGetIterator(d
);
8433 /* SELECT the new DB */
8434 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8435 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8437 /* Iterate this DB writing every entry */
8438 while((de
= dictNext(di
)) != NULL
) {
8443 key
= dictGetEntryKey(de
);
8444 /* If the value for this key is swapped, load a preview in memory.
8445 * We use a "swapped" flag to remember if we need to free the
8446 * value object instead to just increment the ref count anyway
8447 * in order to avoid copy-on-write of pages if we are forked() */
8448 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8449 key
->storage
== REDIS_VM_SWAPPING
) {
8450 o
= dictGetEntryVal(de
);
8453 o
= vmPreviewObject(key
);
8456 expiretime
= getExpire(db
,key
);
8458 /* Save the key and associated value */
8459 if (o
->type
== REDIS_STRING
) {
8460 /* Emit a SET command */
8461 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8462 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8464 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8465 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8466 } else if (o
->type
== REDIS_LIST
) {
8467 /* Emit the RPUSHes needed to rebuild the list */
8468 list
*list
= o
->ptr
;
8472 listRewind(list
,&li
);
8473 while((ln
= listNext(&li
))) {
8474 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8475 robj
*eleobj
= listNodeValue(ln
);
8477 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8478 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8479 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8481 } else if (o
->type
== REDIS_SET
) {
8482 /* Emit the SADDs needed to rebuild the set */
8484 dictIterator
*di
= dictGetIterator(set
);
8487 while((de
= dictNext(di
)) != NULL
) {
8488 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8489 robj
*eleobj
= dictGetEntryKey(de
);
8491 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8492 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8493 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8495 dictReleaseIterator(di
);
8496 } else if (o
->type
== REDIS_ZSET
) {
8497 /* Emit the ZADDs needed to rebuild the sorted set */
8499 dictIterator
*di
= dictGetIterator(zs
->dict
);
8502 while((de
= dictNext(di
)) != NULL
) {
8503 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8504 robj
*eleobj
= dictGetEntryKey(de
);
8505 double *score
= dictGetEntryVal(de
);
8507 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8508 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8509 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8510 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8512 dictReleaseIterator(di
);
8513 } else if (o
->type
== REDIS_HASH
) {
8514 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8516 /* Emit the HSETs needed to rebuild the hash */
8517 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8518 unsigned char *p
= zipmapRewind(o
->ptr
);
8519 unsigned char *field
, *val
;
8520 unsigned int flen
, vlen
;
8522 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8523 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8524 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8525 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8527 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8531 dictIterator
*di
= dictGetIterator(o
->ptr
);
8534 while((de
= dictNext(di
)) != NULL
) {
8535 robj
*field
= dictGetEntryKey(de
);
8536 robj
*val
= dictGetEntryVal(de
);
8538 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8539 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8540 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8541 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8543 dictReleaseIterator(di
);
8546 redisPanic("Unknown object type");
8548 /* Save the expire time */
8549 if (expiretime
!= -1) {
8550 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8551 /* If this key is already expired skip it */
8552 if (expiretime
< now
) continue;
8553 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8554 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8555 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8557 if (swapped
) decrRefCount(o
);
8559 dictReleaseIterator(di
);
8562 /* Make sure data will not remain on the OS's output buffers */
8567 /* Use RENAME to make sure the DB file is changed atomically only
8568 * if the generate DB file is ok. */
8569 if (rename(tmpfile
,filename
) == -1) {
8570 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8574 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8580 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8581 if (di
) dictReleaseIterator(di
);
8585 /* This is how rewriting of the append only file in background works:
8587 * 1) The user calls BGREWRITEAOF
8588 * 2) Redis calls this function, that forks():
8589 * 2a) the child rewrite the append only file in a temp file.
8590 * 2b) the parent accumulates differences in server.bgrewritebuf.
8591 * 3) When the child finished '2a' exists.
8592 * 4) The parent will trap the exit code, if it's OK, will append the
8593 * data accumulated into server.bgrewritebuf into the temp file, and
8594 * finally will rename(2) the temp file in the actual file name.
8595 * The the new file is reopened as the new append only file. Profit!
8597 static int rewriteAppendOnlyFileBackground(void) {
8600 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8601 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8602 if ((childpid
= fork()) == 0) {
8606 if (server
.vm_enabled
) vmReopenSwapFile();
8608 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8609 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8616 if (childpid
== -1) {
8617 redisLog(REDIS_WARNING
,
8618 "Can't rewrite append only file in background: fork: %s",
8622 redisLog(REDIS_NOTICE
,
8623 "Background append only file rewriting started by pid %d",childpid
);
8624 server
.bgrewritechildpid
= childpid
;
8625 updateDictResizePolicy();
8626 /* We set appendseldb to -1 in order to force the next call to the
8627 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8628 * accumulated by the parent into server.bgrewritebuf will start
8629 * with a SELECT statement and it will be safe to merge. */
8630 server
.appendseldb
= -1;
8633 return REDIS_OK
; /* unreached */
8636 static void bgrewriteaofCommand(redisClient
*c
) {
8637 if (server
.bgrewritechildpid
!= -1) {
8638 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8641 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8642 char *status
= "+Background append only file rewriting started\r\n";
8643 addReplySds(c
,sdsnew(status
));
8645 addReply(c
,shared
.err
);
8649 static void aofRemoveTempFile(pid_t childpid
) {
8652 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8656 /* Virtual Memory is composed mainly of two subsystems:
8657 * - Blocking Virutal Memory
8658 * - Threaded Virtual Memory I/O
8659 * The two parts are not fully decoupled, but functions are split among two
8660 * different sections of the source code (delimited by comments) in order to
8661 * make more clear what functionality is about the blocking VM and what about
8662 * the threaded (not blocking) VM.
8666 * Redis VM is a blocking VM (one that blocks reading swapped values from
8667 * disk into memory when a value swapped out is needed in memory) that is made
8668 * unblocking by trying to examine the command argument vector in order to
8669 * load in background values that will likely be needed in order to exec
8670 * the command. The command is executed only once all the relevant keys
8671 * are loaded into memory.
8673 * This basically is almost as simple of a blocking VM, but almost as parallel
8674 * as a fully non-blocking VM.
8677 /* =================== Virtual Memory - Blocking Side ====================== */
8679 static void vmInit(void) {
8685 if (server
.vm_max_threads
!= 0)
8686 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8688 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8689 /* Try to open the old swap file, otherwise create it */
8690 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8691 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8693 if (server
.vm_fp
== NULL
) {
8694 redisLog(REDIS_WARNING
,
8695 "Can't open the swap file: %s. Exiting.",
8699 server
.vm_fd
= fileno(server
.vm_fp
);
8700 /* Lock the swap file for writing, this is useful in order to avoid
8701 * another instance to use the same swap file for a config error. */
8702 fl
.l_type
= F_WRLCK
;
8703 fl
.l_whence
= SEEK_SET
;
8704 fl
.l_start
= fl
.l_len
= 0;
8705 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8706 redisLog(REDIS_WARNING
,
8707 "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
));
8711 server
.vm_next_page
= 0;
8712 server
.vm_near_pages
= 0;
8713 server
.vm_stats_used_pages
= 0;
8714 server
.vm_stats_swapped_objects
= 0;
8715 server
.vm_stats_swapouts
= 0;
8716 server
.vm_stats_swapins
= 0;
8717 totsize
= server
.vm_pages
*server
.vm_page_size
;
8718 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8719 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8720 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8724 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8726 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8727 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8728 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8729 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8731 /* Initialize threaded I/O (used by Virtual Memory) */
8732 server
.io_newjobs
= listCreate();
8733 server
.io_processing
= listCreate();
8734 server
.io_processed
= listCreate();
8735 server
.io_ready_clients
= listCreate();
8736 pthread_mutex_init(&server
.io_mutex
,NULL
);
8737 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8738 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8739 server
.io_active_threads
= 0;
8740 if (pipe(pipefds
) == -1) {
8741 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8745 server
.io_ready_pipe_read
= pipefds
[0];
8746 server
.io_ready_pipe_write
= pipefds
[1];
8747 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8748 /* LZF requires a lot of stack */
8749 pthread_attr_init(&server
.io_threads_attr
);
8750 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8751 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8752 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8753 /* Listen for events in the threaded I/O pipe */
8754 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8755 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8756 oom("creating file event");
8759 /* Mark the page as used */
8760 static void vmMarkPageUsed(off_t page
) {
8761 off_t byte
= page
/8;
8763 redisAssert(vmFreePage(page
) == 1);
8764 server
.vm_bitmap
[byte
] |= 1<<bit
;
8767 /* Mark N contiguous pages as used, with 'page' being the first. */
8768 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8771 for (j
= 0; j
< count
; j
++)
8772 vmMarkPageUsed(page
+j
);
8773 server
.vm_stats_used_pages
+= count
;
8774 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8775 (long long)count
, (long long)page
);
8778 /* Mark the page as free */
8779 static void vmMarkPageFree(off_t page
) {
8780 off_t byte
= page
/8;
8782 redisAssert(vmFreePage(page
) == 0);
8783 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8786 /* Mark N contiguous pages as free, with 'page' being the first. */
8787 static void vmMarkPagesFree(off_t page
, off_t count
) {
8790 for (j
= 0; j
< count
; j
++)
8791 vmMarkPageFree(page
+j
);
8792 server
.vm_stats_used_pages
-= count
;
8793 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8794 (long long)count
, (long long)page
);
8797 /* Test if the page is free */
8798 static int vmFreePage(off_t page
) {
8799 off_t byte
= page
/8;
8801 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8804 /* Find N contiguous free pages storing the first page of the cluster in *first.
8805 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8806 * REDIS_ERR is returned.
8808 * This function uses a simple algorithm: we try to allocate
8809 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8810 * again from the start of the swap file searching for free spaces.
8812 * If it looks pretty clear that there are no free pages near our offset
8813 * we try to find less populated places doing a forward jump of
8814 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8815 * without hurry, and then we jump again and so forth...
8817 * This function can be improved using a free list to avoid to guess
8818 * too much, since we could collect data about freed pages.
8820 * note: I implemented this function just after watching an episode of
8821 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8823 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8824 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8826 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8827 server
.vm_near_pages
= 0;
8828 server
.vm_next_page
= 0;
8830 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8831 base
= server
.vm_next_page
;
8833 while(offset
< server
.vm_pages
) {
8834 off_t
this = base
+offset
;
8836 /* If we overflow, restart from page zero */
8837 if (this >= server
.vm_pages
) {
8838 this -= server
.vm_pages
;
8840 /* Just overflowed, what we found on tail is no longer
8841 * interesting, as it's no longer contiguous. */
8845 if (vmFreePage(this)) {
8846 /* This is a free page */
8848 /* Already got N free pages? Return to the caller, with success */
8850 *first
= this-(n
-1);
8851 server
.vm_next_page
= this+1;
8852 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8856 /* The current one is not a free page */
8860 /* Fast-forward if the current page is not free and we already
8861 * searched enough near this place. */
8863 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8864 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8866 /* Note that even if we rewind after the jump, we are don't need
8867 * to make sure numfree is set to zero as we only jump *if* it
8868 * is set to zero. */
8870 /* Otherwise just check the next page */
8877 /* Write the specified object at the specified page of the swap file */
8878 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8879 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8880 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8881 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8882 redisLog(REDIS_WARNING
,
8883 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8887 rdbSaveObject(server
.vm_fp
,o
);
8888 fflush(server
.vm_fp
);
8889 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8893 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8894 * needed to later retrieve the object into the key object.
8895 * If we can't find enough contiguous empty pages to swap the object on disk
8896 * REDIS_ERR is returned. */
8897 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8898 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8901 assert(key
->storage
== REDIS_VM_MEMORY
);
8902 assert(key
->refcount
== 1);
8903 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8904 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8905 key
->vm
.page
= page
;
8906 key
->vm
.usedpages
= pages
;
8907 key
->storage
= REDIS_VM_SWAPPED
;
8908 key
->vtype
= val
->type
;
8909 decrRefCount(val
); /* Deallocate the object from memory. */
8910 vmMarkPagesUsed(page
,pages
);
8911 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8912 (unsigned char*) key
->ptr
,
8913 (unsigned long long) page
, (unsigned long long) pages
);
8914 server
.vm_stats_swapped_objects
++;
8915 server
.vm_stats_swapouts
++;
8919 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8922 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8923 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8924 redisLog(REDIS_WARNING
,
8925 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8929 o
= rdbLoadObject(type
,server
.vm_fp
);
8931 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8934 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8938 /* Load the value object relative to the 'key' object from swap to memory.
8939 * The newly allocated object is returned.
8941 * If preview is true the unserialized object is returned to the caller but
8942 * no changes are made to the key object, nor the pages are marked as freed */
8943 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8946 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8947 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8949 key
->storage
= REDIS_VM_MEMORY
;
8950 key
->vm
.atime
= server
.unixtime
;
8951 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8952 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8953 (unsigned char*) key
->ptr
);
8954 server
.vm_stats_swapped_objects
--;
8956 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8957 (unsigned char*) key
->ptr
);
8959 server
.vm_stats_swapins
++;
8963 /* Plain object loading, from swap to memory */
8964 static robj
*vmLoadObject(robj
*key
) {
8965 /* If we are loading the object in background, stop it, we
8966 * need to load this object synchronously ASAP. */
8967 if (key
->storage
== REDIS_VM_LOADING
)
8968 vmCancelThreadedIOJob(key
);
8969 return vmGenericLoadObject(key
,0);
8972 /* Just load the value on disk, without to modify the key.
8973 * This is useful when we want to perform some operation on the value
8974 * without to really bring it from swap to memory, like while saving the
8975 * dataset or rewriting the append only log. */
8976 static robj
*vmPreviewObject(robj
*key
) {
8977 return vmGenericLoadObject(key
,1);
8980 /* How a good candidate is this object for swapping?
8981 * The better candidate it is, the greater the returned value.
8983 * Currently we try to perform a fast estimation of the object size in
8984 * memory, and combine it with aging informations.
8986 * Basically swappability = idle-time * log(estimated size)
8988 * Bigger objects are preferred over smaller objects, but not
8989 * proportionally, this is why we use the logarithm. This algorithm is
8990 * just a first try and will probably be tuned later. */
8991 static double computeObjectSwappability(robj
*o
) {
8992 time_t age
= server
.unixtime
- o
->vm
.atime
;
8996 struct dictEntry
*de
;
8999 if (age
<= 0) return 0;
9002 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9005 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9010 listNode
*ln
= listFirst(l
);
9012 asize
= sizeof(list
);
9014 robj
*ele
= ln
->value
;
9017 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9018 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9020 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9025 z
= (o
->type
== REDIS_ZSET
);
9026 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9028 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9029 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9034 de
= dictGetRandomKey(d
);
9035 ele
= dictGetEntryKey(de
);
9036 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9037 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9039 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9040 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9044 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9045 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9046 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9047 unsigned int klen
, vlen
;
9048 unsigned char *key
, *val
;
9050 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9054 asize
= len
*(klen
+vlen
+3);
9055 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9057 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9062 de
= dictGetRandomKey(d
);
9063 ele
= dictGetEntryKey(de
);
9064 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9065 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9067 ele
= dictGetEntryVal(de
);
9068 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9069 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9071 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9076 return (double)age
*log(1+asize
);
9079 /* Try to swap an object that's a good candidate for swapping.
9080 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9081 * to swap any object at all.
9083 * If 'usethreaded' is true, Redis will try to swap the object in background
9084 * using I/O threads. */
9085 static int vmSwapOneObject(int usethreads
) {
9087 struct dictEntry
*best
= NULL
;
9088 double best_swappability
= 0;
9089 redisDb
*best_db
= NULL
;
9092 for (j
= 0; j
< server
.dbnum
; j
++) {
9093 redisDb
*db
= server
.db
+j
;
9094 /* Why maxtries is set to 100?
9095 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9096 * are swappable objects */
9099 if (dictSize(db
->dict
) == 0) continue;
9100 for (i
= 0; i
< 5; i
++) {
9102 double swappability
;
9104 if (maxtries
) maxtries
--;
9105 de
= dictGetRandomKey(db
->dict
);
9106 key
= dictGetEntryKey(de
);
9107 val
= dictGetEntryVal(de
);
9108 /* Only swap objects that are currently in memory.
9110 * Also don't swap shared objects if threaded VM is on, as we
9111 * try to ensure that the main thread does not touch the
9112 * object while the I/O thread is using it, but we can't
9113 * control other keys without adding additional mutex. */
9114 if (key
->storage
!= REDIS_VM_MEMORY
||
9115 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9116 if (maxtries
) i
--; /* don't count this try */
9119 swappability
= computeObjectSwappability(val
);
9120 if (!best
|| swappability
> best_swappability
) {
9122 best_swappability
= swappability
;
9127 if (best
== NULL
) return REDIS_ERR
;
9128 key
= dictGetEntryKey(best
);
9129 val
= dictGetEntryVal(best
);
9131 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9132 key
->ptr
, best_swappability
);
9134 /* Unshare the key if needed */
9135 if (key
->refcount
> 1) {
9136 robj
*newkey
= dupStringObject(key
);
9138 key
= dictGetEntryKey(best
) = newkey
;
9142 vmSwapObjectThreaded(key
,val
,best_db
);
9145 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9146 dictGetEntryVal(best
) = NULL
;
9154 static int vmSwapOneObjectBlocking() {
9155 return vmSwapOneObject(0);
9158 static int vmSwapOneObjectThreaded() {
9159 return vmSwapOneObject(1);
9162 /* Return true if it's safe to swap out objects in a given moment.
9163 * Basically we don't want to swap objects out while there is a BGSAVE
9164 * or a BGAEOREWRITE running in backgroud. */
9165 static int vmCanSwapOut(void) {
9166 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9169 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9170 * and was deleted. Otherwise 0 is returned. */
9171 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9175 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9176 foundkey
= dictGetEntryKey(de
);
9177 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9182 /* =================== Virtual Memory - Threaded I/O ======================= */
9184 static void freeIOJob(iojob
*j
) {
9185 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9186 j
->type
== REDIS_IOJOB_DO_SWAP
||
9187 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9188 decrRefCount(j
->val
);
9189 /* We don't decrRefCount the j->key field as we did't incremented
9190 * the count creating IO Jobs. This is because the key field here is
9191 * just used as an indentifier and if a key is removed the Job should
9192 * never be touched again. */
9196 /* Every time a thread finished a Job, it writes a byte into the write side
9197 * of an unix pipe in order to "awake" the main thread, and this function
9199 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9203 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9205 REDIS_NOTUSED(mask
);
9206 REDIS_NOTUSED(privdata
);
9208 /* For every byte we read in the read side of the pipe, there is one
9209 * I/O job completed to process. */
9210 while((retval
= read(fd
,buf
,1)) == 1) {
9214 struct dictEntry
*de
;
9216 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9218 /* Get the processed element (the oldest one) */
9220 assert(listLength(server
.io_processed
) != 0);
9221 if (toprocess
== -1) {
9222 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9223 if (toprocess
<= 0) toprocess
= 1;
9225 ln
= listFirst(server
.io_processed
);
9227 listDelNode(server
.io_processed
,ln
);
9229 /* If this job is marked as canceled, just ignore it */
9234 /* Post process it in the main thread, as there are things we
9235 * can do just here to avoid race conditions and/or invasive locks */
9236 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
);
9237 de
= dictFind(j
->db
->dict
,j
->key
);
9239 key
= dictGetEntryKey(de
);
9240 if (j
->type
== REDIS_IOJOB_LOAD
) {
9243 /* Key loaded, bring it at home */
9244 key
->storage
= REDIS_VM_MEMORY
;
9245 key
->vm
.atime
= server
.unixtime
;
9246 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9247 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9248 (unsigned char*) key
->ptr
);
9249 server
.vm_stats_swapped_objects
--;
9250 server
.vm_stats_swapins
++;
9251 dictGetEntryVal(de
) = j
->val
;
9252 incrRefCount(j
->val
);
9255 /* Handle clients waiting for this key to be loaded. */
9256 handleClientsBlockedOnSwappedKey(db
,key
);
9257 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9258 /* Now we know the amount of pages required to swap this object.
9259 * Let's find some space for it, and queue this task again
9260 * rebranded as REDIS_IOJOB_DO_SWAP. */
9261 if (!vmCanSwapOut() ||
9262 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9264 /* Ooops... no space or we can't swap as there is
9265 * a fork()ed Redis trying to save stuff on disk. */
9267 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9269 /* Note that we need to mark this pages as used now,
9270 * if the job will be canceled, we'll mark them as freed
9272 vmMarkPagesUsed(j
->page
,j
->pages
);
9273 j
->type
= REDIS_IOJOB_DO_SWAP
;
9278 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9281 /* Key swapped. We can finally free some memory. */
9282 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9283 printf("key->storage: %d\n",key
->storage
);
9284 printf("key->name: %s\n",(char*)key
->ptr
);
9285 printf("key->refcount: %d\n",key
->refcount
);
9286 printf("val: %p\n",(void*)j
->val
);
9287 printf("val->type: %d\n",j
->val
->type
);
9288 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9290 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9291 val
= dictGetEntryVal(de
);
9292 key
->vm
.page
= j
->page
;
9293 key
->vm
.usedpages
= j
->pages
;
9294 key
->storage
= REDIS_VM_SWAPPED
;
9295 key
->vtype
= j
->val
->type
;
9296 decrRefCount(val
); /* Deallocate the object from memory. */
9297 dictGetEntryVal(de
) = NULL
;
9298 redisLog(REDIS_DEBUG
,
9299 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9300 (unsigned char*) key
->ptr
,
9301 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9302 server
.vm_stats_swapped_objects
++;
9303 server
.vm_stats_swapouts
++;
9305 /* Put a few more swap requests in queue if we are still
9307 if (trytoswap
&& vmCanSwapOut() &&
9308 zmalloc_used_memory() > server
.vm_max_memory
)
9313 more
= listLength(server
.io_newjobs
) <
9314 (unsigned) server
.vm_max_threads
;
9316 /* Don't waste CPU time if swappable objects are rare. */
9317 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9325 if (processed
== toprocess
) return;
9327 if (retval
< 0 && errno
!= EAGAIN
) {
9328 redisLog(REDIS_WARNING
,
9329 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9334 static void lockThreadedIO(void) {
9335 pthread_mutex_lock(&server
.io_mutex
);
9338 static void unlockThreadedIO(void) {
9339 pthread_mutex_unlock(&server
.io_mutex
);
9342 /* Remove the specified object from the threaded I/O queue if still not
9343 * processed, otherwise make sure to flag it as canceled. */
9344 static void vmCancelThreadedIOJob(robj
*o
) {
9346 server
.io_newjobs
, /* 0 */
9347 server
.io_processing
, /* 1 */
9348 server
.io_processed
/* 2 */
9352 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9355 /* Search for a matching key in one of the queues */
9356 for (i
= 0; i
< 3; i
++) {
9360 listRewind(lists
[i
],&li
);
9361 while ((ln
= listNext(&li
)) != NULL
) {
9362 iojob
*job
= ln
->value
;
9364 if (job
->canceled
) continue; /* Skip this, already canceled. */
9365 if (job
->key
== o
) {
9366 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9367 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9368 /* Mark the pages as free since the swap didn't happened
9369 * or happened but is now discarded. */
9370 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9371 vmMarkPagesFree(job
->page
,job
->pages
);
9372 /* Cancel the job. It depends on the list the job is
9375 case 0: /* io_newjobs */
9376 /* If the job was yet not processed the best thing to do
9377 * is to remove it from the queue at all */
9379 listDelNode(lists
[i
],ln
);
9381 case 1: /* io_processing */
9382 /* Oh Shi- the thread is messing with the Job:
9384 * Probably it's accessing the object if this is a
9385 * PREPARE_SWAP or DO_SWAP job.
9386 * If it's a LOAD job it may be reading from disk and
9387 * if we don't wait for the job to terminate before to
9388 * cancel it, maybe in a few microseconds data can be
9389 * corrupted in this pages. So the short story is:
9391 * Better to wait for the job to move into the
9392 * next queue (processed)... */
9394 /* We try again and again until the job is completed. */
9396 /* But let's wait some time for the I/O thread
9397 * to finish with this job. After all this condition
9398 * should be very rare. */
9401 case 2: /* io_processed */
9402 /* The job was already processed, that's easy...
9403 * just mark it as canceled so that we'll ignore it
9404 * when processing completed jobs. */
9408 /* Finally we have to adjust the storage type of the object
9409 * in order to "UNDO" the operaiton. */
9410 if (o
->storage
== REDIS_VM_LOADING
)
9411 o
->storage
= REDIS_VM_SWAPPED
;
9412 else if (o
->storage
== REDIS_VM_SWAPPING
)
9413 o
->storage
= REDIS_VM_MEMORY
;
9420 assert(1 != 1); /* We should never reach this */
9423 static void *IOThreadEntryPoint(void *arg
) {
9428 pthread_detach(pthread_self());
9430 /* Get a new job to process */
9432 if (listLength(server
.io_newjobs
) == 0) {
9433 /* No new jobs in queue, exit. */
9434 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9435 (long) pthread_self());
9436 server
.io_active_threads
--;
9440 ln
= listFirst(server
.io_newjobs
);
9442 listDelNode(server
.io_newjobs
,ln
);
9443 /* Add the job in the processing queue */
9444 j
->thread
= pthread_self();
9445 listAddNodeTail(server
.io_processing
,j
);
9446 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9448 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9449 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9451 /* Process the Job */
9452 if (j
->type
== REDIS_IOJOB_LOAD
) {
9453 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9454 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9455 FILE *fp
= fopen("/dev/null","w+");
9456 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9458 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9459 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9463 /* Done: insert the job into the processed queue */
9464 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9465 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9467 listDelNode(server
.io_processing
,ln
);
9468 listAddNodeTail(server
.io_processed
,j
);
9471 /* Signal the main thread there is new stuff to process */
9472 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9474 return NULL
; /* never reached */
9477 static void spawnIOThread(void) {
9479 sigset_t mask
, omask
;
9483 sigaddset(&mask
,SIGCHLD
);
9484 sigaddset(&mask
,SIGHUP
);
9485 sigaddset(&mask
,SIGPIPE
);
9486 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9487 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9488 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9492 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9493 server
.io_active_threads
++;
9496 /* We need to wait for the last thread to exit before we are able to
9497 * fork() in order to BGSAVE or BGREWRITEAOF. */
9498 static void waitEmptyIOJobsQueue(void) {
9500 int io_processed_len
;
9503 if (listLength(server
.io_newjobs
) == 0 &&
9504 listLength(server
.io_processing
) == 0 &&
9505 server
.io_active_threads
== 0)
9510 /* While waiting for empty jobs queue condition we post-process some
9511 * finshed job, as I/O threads may be hanging trying to write against
9512 * the io_ready_pipe_write FD but there are so much pending jobs that
9514 io_processed_len
= listLength(server
.io_processed
);
9516 if (io_processed_len
) {
9517 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9518 usleep(1000); /* 1 millisecond */
9520 usleep(10000); /* 10 milliseconds */
9525 static void vmReopenSwapFile(void) {
9526 /* Note: we don't close the old one as we are in the child process
9527 * and don't want to mess at all with the original file object. */
9528 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9529 if (server
.vm_fp
== NULL
) {
9530 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9531 server
.vm_swap_file
);
9534 server
.vm_fd
= fileno(server
.vm_fp
);
9537 /* This function must be called while with threaded IO locked */
9538 static void queueIOJob(iojob
*j
) {
9539 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9540 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9541 listAddNodeTail(server
.io_newjobs
,j
);
9542 if (server
.io_active_threads
< server
.vm_max_threads
)
9546 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9549 assert(key
->storage
== REDIS_VM_MEMORY
);
9550 assert(key
->refcount
== 1);
9552 j
= zmalloc(sizeof(*j
));
9553 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9559 j
->thread
= (pthread_t
) -1;
9560 key
->storage
= REDIS_VM_SWAPPING
;
9568 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9570 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9571 * If there is not already a job loading the key, it is craeted.
9572 * The key is added to the io_keys list in the client structure, and also
9573 * in the hash table mapping swapped keys to waiting clients, that is,
9574 * server.io_waited_keys. */
9575 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9576 struct dictEntry
*de
;
9580 /* If the key does not exist or is already in RAM we don't need to
9581 * block the client at all. */
9582 de
= dictFind(c
->db
->dict
,key
);
9583 if (de
== NULL
) return 0;
9584 o
= dictGetEntryKey(de
);
9585 if (o
->storage
== REDIS_VM_MEMORY
) {
9587 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9588 /* We were swapping the key, undo it! */
9589 vmCancelThreadedIOJob(o
);
9593 /* OK: the key is either swapped, or being loaded just now. */
9595 /* Add the key to the list of keys this client is waiting for.
9596 * This maps clients to keys they are waiting for. */
9597 listAddNodeTail(c
->io_keys
,key
);
9600 /* Add the client to the swapped keys => clients waiting map. */
9601 de
= dictFind(c
->db
->io_keys
,key
);
9605 /* For every key we take a list of clients blocked for it */
9607 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9609 assert(retval
== DICT_OK
);
9611 l
= dictGetEntryVal(de
);
9613 listAddNodeTail(l
,c
);
9615 /* Are we already loading the key from disk? If not create a job */
9616 if (o
->storage
== REDIS_VM_SWAPPED
) {
9619 o
->storage
= REDIS_VM_LOADING
;
9620 j
= zmalloc(sizeof(*j
));
9621 j
->type
= REDIS_IOJOB_LOAD
;
9624 j
->key
->vtype
= o
->vtype
;
9625 j
->page
= o
->vm
.page
;
9628 j
->thread
= (pthread_t
) -1;
9636 /* Preload keys needed for the ZUNION and ZINTER commands. */
9637 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9639 num
= atoi(c
->argv
[2]->ptr
);
9640 for (i
= 0; i
< num
; i
++) {
9641 waitForSwappedKey(c
,c
->argv
[3+i
]);
9645 /* Is this client attempting to run a command against swapped keys?
9646 * If so, block it ASAP, load the keys in background, then resume it.
9648 * The important idea about this function is that it can fail! If keys will
9649 * still be swapped when the client is resumed, this key lookups will
9650 * just block loading keys from disk. In practical terms this should only
9651 * happen with SORT BY command or if there is a bug in this function.
9653 * Return 1 if the client is marked as blocked, 0 if the client can
9654 * continue as the keys it is going to access appear to be in memory. */
9655 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9658 if (cmd
->vm_preload_proc
!= NULL
) {
9659 cmd
->vm_preload_proc(c
);
9661 if (cmd
->vm_firstkey
== 0) return 0;
9662 last
= cmd
->vm_lastkey
;
9663 if (last
< 0) last
= c
->argc
+last
;
9664 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9665 waitForSwappedKey(c
,c
->argv
[j
]);
9668 /* If the client was blocked for at least one key, mark it as blocked. */
9669 if (listLength(c
->io_keys
)) {
9670 c
->flags
|= REDIS_IO_WAIT
;
9671 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9672 server
.vm_blocked_clients
++;
9679 /* Remove the 'key' from the list of blocked keys for a given client.
9681 * The function returns 1 when there are no longer blocking keys after
9682 * the current one was removed (and the client can be unblocked). */
9683 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9687 struct dictEntry
*de
;
9689 /* Remove the key from the list of keys this client is waiting for. */
9690 listRewind(c
->io_keys
,&li
);
9691 while ((ln
= listNext(&li
)) != NULL
) {
9692 if (equalStringObjects(ln
->value
,key
)) {
9693 listDelNode(c
->io_keys
,ln
);
9699 /* Remove the client form the key => waiting clients map. */
9700 de
= dictFind(c
->db
->io_keys
,key
);
9702 l
= dictGetEntryVal(de
);
9703 ln
= listSearchKey(l
,c
);
9706 if (listLength(l
) == 0)
9707 dictDelete(c
->db
->io_keys
,key
);
9709 return listLength(c
->io_keys
) == 0;
9712 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9713 struct dictEntry
*de
;
9718 de
= dictFind(db
->io_keys
,key
);
9721 l
= dictGetEntryVal(de
);
9722 len
= listLength(l
);
9723 /* Note: we can't use something like while(listLength(l)) as the list
9724 * can be freed by the calling function when we remove the last element. */
9727 redisClient
*c
= ln
->value
;
9729 if (dontWaitForSwappedKey(c
,key
)) {
9730 /* Put the client in the list of clients ready to go as we
9731 * loaded all the keys about it. */
9732 listAddNodeTail(server
.io_ready_clients
,c
);
9737 /* =========================== Remote Configuration ========================= */
9739 static void configSetCommand(redisClient
*c
) {
9740 robj
*o
= getDecodedObject(c
->argv
[3]);
9741 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9742 zfree(server
.dbfilename
);
9743 server
.dbfilename
= zstrdup(o
->ptr
);
9744 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9745 zfree(server
.requirepass
);
9746 server
.requirepass
= zstrdup(o
->ptr
);
9747 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9748 zfree(server
.masterauth
);
9749 server
.masterauth
= zstrdup(o
->ptr
);
9750 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9751 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9752 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
9753 if (!strcasecmp(o
->ptr
,"no")) {
9754 server
.appendfsync
= APPENDFSYNC_NO
;
9755 } else if (!strcasecmp(o
->ptr
,"everysec")) {
9756 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
9757 } else if (!strcasecmp(o
->ptr
,"always")) {
9758 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
9762 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
9764 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
9766 /* Perform sanity check before setting the new config:
9767 * - Even number of args
9768 * - Seconds >= 1, changes >= 0 */
9770 sdsfreesplitres(v
,vlen
);
9773 for (j
= 0; j
< vlen
; j
++) {
9777 val
= strtoll(v
[j
], &eptr
, 10);
9778 if (eptr
[0] != '\0' ||
9779 ((j
& 1) == 0 && val
< 1) ||
9780 ((j
& 1) == 1 && val
< 0)) {
9781 sdsfreesplitres(v
,vlen
);
9785 /* Finally set the new config */
9786 resetServerSaveParams();
9787 for (j
= 0; j
< vlen
; j
+= 2) {
9791 seconds
= strtoll(v
[j
],NULL
,10);
9792 changes
= strtoll(v
[j
+1],NULL
,10);
9793 appendServerSaveParams(seconds
, changes
);
9795 sdsfreesplitres(v
,vlen
);
9797 addReplySds(c
,sdscatprintf(sdsempty(),
9798 "-ERR not supported CONFIG parameter %s\r\n",
9799 (char*)c
->argv
[2]->ptr
));
9804 addReply(c
,shared
.ok
);
9807 badfmt
: /* Bad format errors */
9808 addReplySds(c
,sdscatprintf(sdsempty(),
9809 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9811 (char*)c
->argv
[2]->ptr
));
9815 static void configGetCommand(redisClient
*c
) {
9816 robj
*o
= getDecodedObject(c
->argv
[2]);
9817 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9818 char *pattern
= o
->ptr
;
9822 decrRefCount(lenobj
);
9824 if (stringmatch(pattern
,"dbfilename",0)) {
9825 addReplyBulkCString(c
,"dbfilename");
9826 addReplyBulkCString(c
,server
.dbfilename
);
9829 if (stringmatch(pattern
,"requirepass",0)) {
9830 addReplyBulkCString(c
,"requirepass");
9831 addReplyBulkCString(c
,server
.requirepass
);
9834 if (stringmatch(pattern
,"masterauth",0)) {
9835 addReplyBulkCString(c
,"masterauth");
9836 addReplyBulkCString(c
,server
.masterauth
);
9839 if (stringmatch(pattern
,"maxmemory",0)) {
9842 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9843 addReplyBulkCString(c
,"maxmemory");
9844 addReplyBulkCString(c
,buf
);
9847 if (stringmatch(pattern
,"appendfsync",0)) {
9850 switch(server
.appendfsync
) {
9851 case APPENDFSYNC_NO
: policy
= "no"; break;
9852 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
9853 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
9854 default: policy
= "unknown"; break; /* too harmless to panic */
9856 addReplyBulkCString(c
,"appendfsync");
9857 addReplyBulkCString(c
,policy
);
9860 if (stringmatch(pattern
,"save",0)) {
9861 sds buf
= sdsempty();
9864 for (j
= 0; j
< server
.saveparamslen
; j
++) {
9865 buf
= sdscatprintf(buf
,"%ld %d",
9866 server
.saveparams
[j
].seconds
,
9867 server
.saveparams
[j
].changes
);
9868 if (j
!= server
.saveparamslen
-1)
9869 buf
= sdscatlen(buf
," ",1);
9871 addReplyBulkCString(c
,"save");
9872 addReplyBulkCString(c
,buf
);
9877 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9880 static void configCommand(redisClient
*c
) {
9881 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9882 if (c
->argc
!= 4) goto badarity
;
9883 configSetCommand(c
);
9884 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9885 if (c
->argc
!= 3) goto badarity
;
9886 configGetCommand(c
);
9887 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9888 if (c
->argc
!= 2) goto badarity
;
9889 server
.stat_numcommands
= 0;
9890 server
.stat_numconnections
= 0;
9891 server
.stat_expiredkeys
= 0;
9892 server
.stat_starttime
= time(NULL
);
9893 addReply(c
,shared
.ok
);
9895 addReplySds(c
,sdscatprintf(sdsempty(),
9896 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9901 addReplySds(c
,sdscatprintf(sdsempty(),
9902 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9903 (char*) c
->argv
[1]->ptr
));
9906 /* =========================== Pubsub implementation ======================== */
9908 static void freePubsubPattern(void *p
) {
9909 pubsubPattern
*pat
= p
;
9911 decrRefCount(pat
->pattern
);
9915 static int listMatchPubsubPattern(void *a
, void *b
) {
9916 pubsubPattern
*pa
= a
, *pb
= b
;
9918 return (pa
->client
== pb
->client
) &&
9919 (equalStringObjects(pa
->pattern
,pb
->pattern
));
9922 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9923 * 0 if the client was already subscribed to that channel. */
9924 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9925 struct dictEntry
*de
;
9926 list
*clients
= NULL
;
9929 /* Add the channel to the client -> channels hash table */
9930 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9932 incrRefCount(channel
);
9933 /* Add the client to the channel -> list of clients hash table */
9934 de
= dictFind(server
.pubsub_channels
,channel
);
9936 clients
= listCreate();
9937 dictAdd(server
.pubsub_channels
,channel
,clients
);
9938 incrRefCount(channel
);
9940 clients
= dictGetEntryVal(de
);
9942 listAddNodeTail(clients
,c
);
9944 /* Notify the client */
9945 addReply(c
,shared
.mbulk3
);
9946 addReply(c
,shared
.subscribebulk
);
9947 addReplyBulk(c
,channel
);
9948 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9952 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9953 * 0 if the client was not subscribed to the specified channel. */
9954 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9955 struct dictEntry
*de
;
9960 /* Remove the channel from the client -> channels hash table */
9961 incrRefCount(channel
); /* channel may be just a pointer to the same object
9962 we have in the hash tables. Protect it... */
9963 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9965 /* Remove the client from the channel -> clients list hash table */
9966 de
= dictFind(server
.pubsub_channels
,channel
);
9968 clients
= dictGetEntryVal(de
);
9969 ln
= listSearchKey(clients
,c
);
9971 listDelNode(clients
,ln
);
9972 if (listLength(clients
) == 0) {
9973 /* Free the list and associated hash entry at all if this was
9974 * the latest client, so that it will be possible to abuse
9975 * Redis PUBSUB creating millions of channels. */
9976 dictDelete(server
.pubsub_channels
,channel
);
9979 /* Notify the client */
9981 addReply(c
,shared
.mbulk3
);
9982 addReply(c
,shared
.unsubscribebulk
);
9983 addReplyBulk(c
,channel
);
9984 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9985 listLength(c
->pubsub_patterns
));
9988 decrRefCount(channel
); /* it is finally safe to release it */
9992 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9993 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9996 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9999 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10000 incrRefCount(pattern
);
10001 pat
= zmalloc(sizeof(*pat
));
10002 pat
->pattern
= getDecodedObject(pattern
);
10004 listAddNodeTail(server
.pubsub_patterns
,pat
);
10006 /* Notify the client */
10007 addReply(c
,shared
.mbulk3
);
10008 addReply(c
,shared
.psubscribebulk
);
10009 addReplyBulk(c
,pattern
);
10010 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10014 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10015 * 0 if the client was not subscribed to the specified channel. */
10016 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10021 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10022 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10024 listDelNode(c
->pubsub_patterns
,ln
);
10026 pat
.pattern
= pattern
;
10027 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10028 listDelNode(server
.pubsub_patterns
,ln
);
10030 /* Notify the client */
10032 addReply(c
,shared
.mbulk3
);
10033 addReply(c
,shared
.punsubscribebulk
);
10034 addReplyBulk(c
,pattern
);
10035 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
10036 listLength(c
->pubsub_patterns
));
10038 decrRefCount(pattern
);
10042 /* Unsubscribe from all the channels. Return the number of channels the
10043 * client was subscribed from. */
10044 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10045 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10049 while((de
= dictNext(di
)) != NULL
) {
10050 robj
*channel
= dictGetEntryKey(de
);
10052 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10054 dictReleaseIterator(di
);
10058 /* Unsubscribe from all the patterns. Return the number of patterns the
10059 * client was subscribed from. */
10060 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10065 listRewind(c
->pubsub_patterns
,&li
);
10066 while ((ln
= listNext(&li
)) != NULL
) {
10067 robj
*pattern
= ln
->value
;
10069 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10074 /* Publish a message */
10075 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10077 struct dictEntry
*de
;
10081 /* Send to clients listening for that channel */
10082 de
= dictFind(server
.pubsub_channels
,channel
);
10084 list
*list
= dictGetEntryVal(de
);
10088 listRewind(list
,&li
);
10089 while ((ln
= listNext(&li
)) != NULL
) {
10090 redisClient
*c
= ln
->value
;
10092 addReply(c
,shared
.mbulk3
);
10093 addReply(c
,shared
.messagebulk
);
10094 addReplyBulk(c
,channel
);
10095 addReplyBulk(c
,message
);
10099 /* Send to clients listening to matching channels */
10100 if (listLength(server
.pubsub_patterns
)) {
10101 listRewind(server
.pubsub_patterns
,&li
);
10102 channel
= getDecodedObject(channel
);
10103 while ((ln
= listNext(&li
)) != NULL
) {
10104 pubsubPattern
*pat
= ln
->value
;
10106 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10107 sdslen(pat
->pattern
->ptr
),
10108 (char*)channel
->ptr
,
10109 sdslen(channel
->ptr
),0)) {
10110 addReply(pat
->client
,shared
.mbulk4
);
10111 addReply(pat
->client
,shared
.pmessagebulk
);
10112 addReplyBulk(pat
->client
,pat
->pattern
);
10113 addReplyBulk(pat
->client
,channel
);
10114 addReplyBulk(pat
->client
,message
);
10118 decrRefCount(channel
);
10123 static void subscribeCommand(redisClient
*c
) {
10126 for (j
= 1; j
< c
->argc
; j
++)
10127 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10130 static void unsubscribeCommand(redisClient
*c
) {
10131 if (c
->argc
== 1) {
10132 pubsubUnsubscribeAllChannels(c
,1);
10137 for (j
= 1; j
< c
->argc
; j
++)
10138 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10142 static void psubscribeCommand(redisClient
*c
) {
10145 for (j
= 1; j
< c
->argc
; j
++)
10146 pubsubSubscribePattern(c
,c
->argv
[j
]);
10149 static void punsubscribeCommand(redisClient
*c
) {
10150 if (c
->argc
== 1) {
10151 pubsubUnsubscribeAllPatterns(c
,1);
10156 for (j
= 1; j
< c
->argc
; j
++)
10157 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10161 static void publishCommand(redisClient
*c
) {
10162 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10163 addReplyLong(c
,receivers
);
10166 /* ================================= Debugging ============================== */
10168 static void debugCommand(redisClient
*c
) {
10169 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10170 *((char*)-1) = 'x';
10171 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10172 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10173 addReply(c
,shared
.err
);
10177 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10178 addReply(c
,shared
.err
);
10181 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10182 addReply(c
,shared
.ok
);
10183 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10185 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10186 addReply(c
,shared
.err
);
10189 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10190 addReply(c
,shared
.ok
);
10191 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10192 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10196 addReply(c
,shared
.nokeyerr
);
10199 key
= dictGetEntryKey(de
);
10200 val
= dictGetEntryVal(de
);
10201 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10202 key
->storage
== REDIS_VM_SWAPPING
)) {
10206 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10207 strenc
= strencoding
[val
->encoding
];
10209 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10212 addReplySds(c
,sdscatprintf(sdsempty(),
10213 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10214 "encoding:%s serializedlength:%lld\r\n",
10215 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10216 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10218 addReplySds(c
,sdscatprintf(sdsempty(),
10219 "+Key at:%p refcount:%d, value swapped at: page %llu "
10220 "using %llu pages\r\n",
10221 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10222 (unsigned long long) key
->vm
.usedpages
));
10224 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10225 lookupKeyRead(c
->db
,c
->argv
[2]);
10226 addReply(c
,shared
.ok
);
10227 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10228 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10231 if (!server
.vm_enabled
) {
10232 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10236 addReply(c
,shared
.nokeyerr
);
10239 key
= dictGetEntryKey(de
);
10240 val
= dictGetEntryVal(de
);
10241 /* If the key is shared we want to create a copy */
10242 if (key
->refcount
> 1) {
10243 robj
*newkey
= dupStringObject(key
);
10245 key
= dictGetEntryKey(de
) = newkey
;
10248 if (key
->storage
!= REDIS_VM_MEMORY
) {
10249 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10250 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10251 dictGetEntryVal(de
) = NULL
;
10252 addReply(c
,shared
.ok
);
10254 addReply(c
,shared
.err
);
10256 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10261 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10263 for (j
= 0; j
< keys
; j
++) {
10264 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10265 key
= createStringObject(buf
,strlen(buf
));
10266 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10270 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10271 val
= createStringObject(buf
,strlen(buf
));
10272 dictAdd(c
->db
->dict
,key
,val
);
10274 addReply(c
,shared
.ok
);
10276 addReplySds(c
,sdsnew(
10277 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10281 static void _redisAssert(char *estr
, char *file
, int line
) {
10282 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10283 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10284 #ifdef HAVE_BACKTRACE
10285 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10286 *((char*)-1) = 'x';
10290 static void _redisPanic(char *msg
, char *file
, int line
) {
10291 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10292 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10293 #ifdef HAVE_BACKTRACE
10294 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10295 *((char*)-1) = 'x';
10299 /* =================================== Main! ================================ */
10302 int linuxOvercommitMemoryValue(void) {
10303 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10306 if (!fp
) return -1;
10307 if (fgets(buf
,64,fp
) == NULL
) {
10316 void linuxOvercommitMemoryWarning(void) {
10317 if (linuxOvercommitMemoryValue() == 0) {
10318 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.");
10321 #endif /* __linux__ */
10323 static void daemonize(void) {
10327 if (fork() != 0) exit(0); /* parent exits */
10328 setsid(); /* create a new session */
10330 /* Every output goes to /dev/null. If Redis is daemonized but
10331 * the 'logfile' is set to 'stdout' in the configuration file
10332 * it will not log at all. */
10333 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10334 dup2(fd
, STDIN_FILENO
);
10335 dup2(fd
, STDOUT_FILENO
);
10336 dup2(fd
, STDERR_FILENO
);
10337 if (fd
> STDERR_FILENO
) close(fd
);
10339 /* Try to write the pid file */
10340 fp
= fopen(server
.pidfile
,"w");
10342 fprintf(fp
,"%d\n",getpid());
10347 static void version() {
10348 printf("Redis server version %s\n", REDIS_VERSION
);
10352 static void usage() {
10353 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10354 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10358 int main(int argc
, char **argv
) {
10361 initServerConfig();
10363 if (strcmp(argv
[1], "-v") == 0 ||
10364 strcmp(argv
[1], "--version") == 0) version();
10365 if (strcmp(argv
[1], "--help") == 0) usage();
10366 resetServerSaveParams();
10367 loadServerConfig(argv
[1]);
10368 } else if ((argc
> 2)) {
10371 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'");
10373 if (server
.daemonize
) daemonize();
10375 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10377 linuxOvercommitMemoryWarning();
10379 start
= time(NULL
);
10380 if (server
.appendonly
) {
10381 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10382 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10384 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10385 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10387 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10388 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10390 aeDeleteEventLoop(server
.el
);
10394 /* ============================= Backtrace support ========================= */
10396 #ifdef HAVE_BACKTRACE
10397 static char *findFuncName(void *pointer
, unsigned long *offset
);
10399 static void *getMcontextEip(ucontext_t
*uc
) {
10400 #if defined(__FreeBSD__)
10401 return (void*) uc
->uc_mcontext
.mc_eip
;
10402 #elif defined(__dietlibc__)
10403 return (void*) uc
->uc_mcontext
.eip
;
10404 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10406 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10408 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10410 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10411 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10412 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10414 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10416 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10417 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10418 #elif defined(__ia64__) /* Linux IA64 */
10419 return (void*) uc
->uc_mcontext
.sc_ip
;
10425 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10427 char **messages
= NULL
;
10428 int i
, trace_size
= 0;
10429 unsigned long offset
=0;
10430 ucontext_t
*uc
= (ucontext_t
*) secret
;
10432 REDIS_NOTUSED(info
);
10434 redisLog(REDIS_WARNING
,
10435 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10436 infostring
= genRedisInfoString();
10437 redisLog(REDIS_WARNING
, "%s",infostring
);
10438 /* It's not safe to sdsfree() the returned string under memory
10439 * corruption conditions. Let it leak as we are going to abort */
10441 trace_size
= backtrace(trace
, 100);
10442 /* overwrite sigaction with caller's address */
10443 if (getMcontextEip(uc
) != NULL
) {
10444 trace
[1] = getMcontextEip(uc
);
10446 messages
= backtrace_symbols(trace
, trace_size
);
10448 for (i
=1; i
<trace_size
; ++i
) {
10449 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10451 p
= strchr(messages
[i
],'+');
10452 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10453 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10455 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10458 /* free(messages); Don't call free() with possibly corrupted memory. */
10462 static void setupSigSegvAction(void) {
10463 struct sigaction act
;
10465 sigemptyset (&act
.sa_mask
);
10466 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10467 * is used. Otherwise, sa_handler is used */
10468 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10469 act
.sa_sigaction
= segvHandler
;
10470 sigaction (SIGSEGV
, &act
, NULL
);
10471 sigaction (SIGBUS
, &act
, NULL
);
10472 sigaction (SIGFPE
, &act
, NULL
);
10473 sigaction (SIGILL
, &act
, NULL
);
10474 sigaction (SIGBUS
, &act
, NULL
);
10478 #include "staticsymbols.h"
10479 /* This function try to convert a pointer into a function name. It's used in
10480 * oreder to provide a backtrace under segmentation fault that's able to
10481 * display functions declared as static (otherwise the backtrace is useless). */
10482 static char *findFuncName(void *pointer
, unsigned long *offset
){
10484 unsigned long off
, minoff
= 0;
10486 /* Try to match against the Symbol with the smallest offset */
10487 for (i
=0; symsTable
[i
].pointer
; i
++) {
10488 unsigned long lp
= (unsigned long) pointer
;
10490 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10491 off
=lp
-symsTable
[i
].pointer
;
10492 if (ret
< 0 || off
< minoff
) {
10498 if (ret
== -1) return NULL
;
10500 return symsTable
[ret
].name
;
10502 #else /* HAVE_BACKTRACE */
10503 static void setupSigSegvAction(void) {
10505 #endif /* HAVE_BACKTRACE */