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 if (val
> LLONG_MAX
&& val
< LLONG_MIN
&& val
== ((long long)val
))
3517 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3519 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3520 buf
[0] = strlen((char*)buf
+1);
3523 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3527 /* Save a Redis object. */
3528 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3529 if (o
->type
== REDIS_STRING
) {
3530 /* Save a string value */
3531 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3532 } else if (o
->type
== REDIS_LIST
) {
3533 /* Save a list value */
3534 list
*list
= o
->ptr
;
3538 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3539 listRewind(list
,&li
);
3540 while((ln
= listNext(&li
))) {
3541 robj
*eleobj
= listNodeValue(ln
);
3543 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3545 } else if (o
->type
== REDIS_SET
) {
3546 /* Save a set value */
3548 dictIterator
*di
= dictGetIterator(set
);
3551 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3552 while((de
= dictNext(di
)) != NULL
) {
3553 robj
*eleobj
= dictGetEntryKey(de
);
3555 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3557 dictReleaseIterator(di
);
3558 } else if (o
->type
== REDIS_ZSET
) {
3559 /* Save a set value */
3561 dictIterator
*di
= dictGetIterator(zs
->dict
);
3564 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3565 while((de
= dictNext(di
)) != NULL
) {
3566 robj
*eleobj
= dictGetEntryKey(de
);
3567 double *score
= dictGetEntryVal(de
);
3569 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3570 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3572 dictReleaseIterator(di
);
3573 } else if (o
->type
== REDIS_HASH
) {
3574 /* Save a hash value */
3575 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3576 unsigned char *p
= zipmapRewind(o
->ptr
);
3577 unsigned int count
= zipmapLen(o
->ptr
);
3578 unsigned char *key
, *val
;
3579 unsigned int klen
, vlen
;
3581 if (rdbSaveLen(fp
,count
) == -1) return -1;
3582 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3583 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3584 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3587 dictIterator
*di
= dictGetIterator(o
->ptr
);
3590 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3591 while((de
= dictNext(di
)) != NULL
) {
3592 robj
*key
= dictGetEntryKey(de
);
3593 robj
*val
= dictGetEntryVal(de
);
3595 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3596 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3598 dictReleaseIterator(di
);
3601 redisPanic("Unknown object type");
3606 /* Return the length the object will have on disk if saved with
3607 * the rdbSaveObject() function. Currently we use a trick to get
3608 * this length with very little changes to the code. In the future
3609 * we could switch to a faster solution. */
3610 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3611 if (fp
== NULL
) fp
= server
.devnull
;
3613 assert(rdbSaveObject(fp
,o
) != 1);
3617 /* Return the number of pages required to save this object in the swap file */
3618 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3619 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3621 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3624 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3625 static int rdbSave(char *filename
) {
3626 dictIterator
*di
= NULL
;
3631 time_t now
= time(NULL
);
3633 /* Wait for I/O therads to terminate, just in case this is a
3634 * foreground-saving, to avoid seeking the swap file descriptor at the
3636 if (server
.vm_enabled
)
3637 waitEmptyIOJobsQueue();
3639 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3640 fp
= fopen(tmpfile
,"w");
3642 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3645 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3646 for (j
= 0; j
< server
.dbnum
; j
++) {
3647 redisDb
*db
= server
.db
+j
;
3649 if (dictSize(d
) == 0) continue;
3650 di
= dictGetIterator(d
);
3656 /* Write the SELECT DB opcode */
3657 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3658 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3660 /* Iterate this DB writing every entry */
3661 while((de
= dictNext(di
)) != NULL
) {
3662 robj
*key
= dictGetEntryKey(de
);
3663 robj
*o
= dictGetEntryVal(de
);
3664 time_t expiretime
= getExpire(db
,key
);
3666 /* Save the expire time */
3667 if (expiretime
!= -1) {
3668 /* If this key is already expired skip it */
3669 if (expiretime
< now
) continue;
3670 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3671 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3673 /* Save the key and associated value. This requires special
3674 * handling if the value is swapped out. */
3675 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3676 key
->storage
== REDIS_VM_SWAPPING
) {
3677 /* Save type, key, value */
3678 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3679 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3680 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3682 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3684 /* Get a preview of the object in memory */
3685 po
= vmPreviewObject(key
);
3686 /* Save type, key, value */
3687 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3688 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3689 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3690 /* Remove the loaded object from memory */
3694 dictReleaseIterator(di
);
3697 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3699 /* Make sure data will not remain on the OS's output buffers */
3704 /* Use RENAME to make sure the DB file is changed atomically only
3705 * if the generate DB file is ok. */
3706 if (rename(tmpfile
,filename
) == -1) {
3707 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3711 redisLog(REDIS_NOTICE
,"DB saved on disk");
3713 server
.lastsave
= time(NULL
);
3719 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3720 if (di
) dictReleaseIterator(di
);
3724 static int rdbSaveBackground(char *filename
) {
3727 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3728 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3729 if ((childpid
= fork()) == 0) {
3731 if (server
.vm_enabled
) vmReopenSwapFile();
3733 if (rdbSave(filename
) == REDIS_OK
) {
3740 if (childpid
== -1) {
3741 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3745 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3746 server
.bgsavechildpid
= childpid
;
3747 updateDictResizePolicy();
3750 return REDIS_OK
; /* unreached */
3753 static void rdbRemoveTempFile(pid_t childpid
) {
3756 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3760 static int rdbLoadType(FILE *fp
) {
3762 if (fread(&type
,1,1,fp
) == 0) return -1;
3766 static time_t rdbLoadTime(FILE *fp
) {
3768 if (fread(&t32
,4,1,fp
) == 0) return -1;
3769 return (time_t) t32
;
3772 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3773 * of this file for a description of how this are stored on disk.
3775 * isencoded is set to 1 if the readed length is not actually a length but
3776 * an "encoding type", check the above comments for more info */
3777 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3778 unsigned char buf
[2];
3782 if (isencoded
) *isencoded
= 0;
3783 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3784 type
= (buf
[0]&0xC0)>>6;
3785 if (type
== REDIS_RDB_6BITLEN
) {
3786 /* Read a 6 bit len */
3788 } else if (type
== REDIS_RDB_ENCVAL
) {
3789 /* Read a 6 bit len encoding type */
3790 if (isencoded
) *isencoded
= 1;
3792 } else if (type
== REDIS_RDB_14BITLEN
) {
3793 /* Read a 14 bit len */
3794 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3795 return ((buf
[0]&0x3F)<<8)|buf
[1];
3797 /* Read a 32 bit len */
3798 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3803 /* Load an integer-encoded object from file 'fp', with the specified
3804 * encoding type 'enctype'. If encode is true the function may return
3805 * an integer-encoded object as reply, otherwise the returned object
3806 * will always be encoded as a raw string. */
3807 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3808 unsigned char enc
[4];
3811 if (enctype
== REDIS_RDB_ENC_INT8
) {
3812 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3813 val
= (signed char)enc
[0];
3814 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3816 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3817 v
= enc
[0]|(enc
[1]<<8);
3819 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3821 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3822 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3825 val
= 0; /* anti-warning */
3826 redisPanic("Unknown RDB integer encoding type");
3829 return createStringObjectFromLongLong(val
);
3831 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3834 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3835 unsigned int len
, clen
;
3836 unsigned char *c
= NULL
;
3839 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3840 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3841 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3842 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3843 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3844 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3846 return createObject(REDIS_STRING
,val
);
3853 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3858 len
= rdbLoadLen(fp
,&isencoded
);
3861 case REDIS_RDB_ENC_INT8
:
3862 case REDIS_RDB_ENC_INT16
:
3863 case REDIS_RDB_ENC_INT32
:
3864 return rdbLoadIntegerObject(fp
,len
,encode
);
3865 case REDIS_RDB_ENC_LZF
:
3866 return rdbLoadLzfStringObject(fp
);
3868 redisPanic("Unknown RDB encoding type");
3872 if (len
== REDIS_RDB_LENERR
) return NULL
;
3873 val
= sdsnewlen(NULL
,len
);
3874 if (len
&& fread(val
,len
,1,fp
) == 0) {
3878 return createObject(REDIS_STRING
,val
);
3881 static robj
*rdbLoadStringObject(FILE *fp
) {
3882 return rdbGenericLoadStringObject(fp
,0);
3885 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3886 return rdbGenericLoadStringObject(fp
,1);
3889 /* For information about double serialization check rdbSaveDoubleValue() */
3890 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3894 if (fread(&len
,1,1,fp
) == 0) return -1;
3896 case 255: *val
= R_NegInf
; return 0;
3897 case 254: *val
= R_PosInf
; return 0;
3898 case 253: *val
= R_Nan
; return 0;
3900 if (fread(buf
,len
,1,fp
) == 0) return -1;
3902 sscanf(buf
, "%lg", val
);
3907 /* Load a Redis object of the specified type from the specified file.
3908 * On success a newly allocated object is returned, otherwise NULL. */
3909 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3912 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3913 if (type
== REDIS_STRING
) {
3914 /* Read string value */
3915 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3916 o
= tryObjectEncoding(o
);
3917 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3918 /* Read list/set value */
3921 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3922 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3923 /* It's faster to expand the dict to the right size asap in order
3924 * to avoid rehashing */
3925 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3926 dictExpand(o
->ptr
,listlen
);
3927 /* Load every single element of the list/set */
3931 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3932 ele
= tryObjectEncoding(ele
);
3933 if (type
== REDIS_LIST
) {
3934 listAddNodeTail((list
*)o
->ptr
,ele
);
3936 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3939 } else if (type
== REDIS_ZSET
) {
3940 /* Read list/set value */
3944 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3945 o
= createZsetObject();
3947 /* Load every single element of the list/set */
3950 double *score
= zmalloc(sizeof(double));
3952 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
3953 ele
= tryObjectEncoding(ele
);
3954 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3955 dictAdd(zs
->dict
,ele
,score
);
3956 zslInsert(zs
->zsl
,*score
,ele
);
3957 incrRefCount(ele
); /* added to skiplist */
3959 } else if (type
== REDIS_HASH
) {
3962 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3963 o
= createHashObject();
3964 /* Too many entries? Use an hash table. */
3965 if (hashlen
> server
.hash_max_zipmap_entries
)
3966 convertToRealHash(o
);
3967 /* Load every key/value, then set it into the zipmap or hash
3968 * table, as needed. */
3972 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3973 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3974 /* If we are using a zipmap and there are too big values
3975 * the object is converted to real hash table encoding. */
3976 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3977 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3978 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3980 convertToRealHash(o
);
3983 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3984 unsigned char *zm
= o
->ptr
;
3986 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3987 val
->ptr
,sdslen(val
->ptr
),NULL
);
3992 key
= tryObjectEncoding(key
);
3993 val
= tryObjectEncoding(val
);
3994 dictAdd((dict
*)o
->ptr
,key
,val
);
3998 redisPanic("Unknown object type");
4003 static int rdbLoad(char *filename
) {
4006 int type
, retval
, rdbver
;
4007 int swap_all_values
= 0;
4008 dict
*d
= server
.db
[0].dict
;
4009 redisDb
*db
= server
.db
+0;
4011 time_t expiretime
, now
= time(NULL
);
4012 long long loadedkeys
= 0;
4014 fp
= fopen(filename
,"r");
4015 if (!fp
) return REDIS_ERR
;
4016 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4018 if (memcmp(buf
,"REDIS",5) != 0) {
4020 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4023 rdbver
= atoi(buf
+5);
4026 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4034 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4035 if (type
== REDIS_EXPIRETIME
) {
4036 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4037 /* We read the time so we need to read the object type again */
4038 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4040 if (type
== REDIS_EOF
) break;
4041 /* Handle SELECT DB opcode as a special case */
4042 if (type
== REDIS_SELECTDB
) {
4043 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4045 if (dbid
>= (unsigned)server
.dbnum
) {
4046 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4049 db
= server
.db
+dbid
;
4054 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4056 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4057 /* Check if the key already expired */
4058 if (expiretime
!= -1 && expiretime
< now
) {
4063 /* Add the new object in the hash table */
4064 retval
= dictAdd(d
,key
,val
);
4065 if (retval
== DICT_ERR
) {
4066 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4070 /* Set the expire time if needed */
4071 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4073 /* Handle swapping while loading big datasets when VM is on */
4075 /* If we detecter we are hopeless about fitting something in memory
4076 * we just swap every new key on disk. Directly...
4077 * Note that's important to check for this condition before resorting
4078 * to random sampling, otherwise we may try to swap already
4080 if (swap_all_values
) {
4081 dictEntry
*de
= dictFind(d
,key
);
4083 /* de may be NULL since the key already expired */
4085 key
= dictGetEntryKey(de
);
4086 val
= dictGetEntryVal(de
);
4088 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4089 dictGetEntryVal(de
) = NULL
;
4095 /* If we have still some hope of having some value fitting memory
4096 * then we try random sampling. */
4097 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4098 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4099 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4101 if (zmalloc_used_memory() > server
.vm_max_memory
)
4102 swap_all_values
= 1; /* We are already using too much mem */
4108 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4109 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4111 return REDIS_ERR
; /* Just to avoid warning */
4114 /*================================== Commands =============================== */
4116 static void authCommand(redisClient
*c
) {
4117 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4118 c
->authenticated
= 1;
4119 addReply(c
,shared
.ok
);
4121 c
->authenticated
= 0;
4122 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4126 static void pingCommand(redisClient
*c
) {
4127 addReply(c
,shared
.pong
);
4130 static void echoCommand(redisClient
*c
) {
4131 addReplyBulk(c
,c
->argv
[1]);
4134 /*=================================== Strings =============================== */
4136 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4138 long seconds
= 0; /* initialized to avoid an harmness warning */
4141 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4144 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4149 if (nx
) deleteIfVolatile(c
->db
,key
);
4150 retval
= dictAdd(c
->db
->dict
,key
,val
);
4151 if (retval
== DICT_ERR
) {
4153 /* If the key is about a swapped value, we want a new key object
4154 * to overwrite the old. So we delete the old key in the database.
4155 * This will also make sure that swap pages about the old object
4156 * will be marked as free. */
4157 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4159 dictReplace(c
->db
->dict
,key
,val
);
4162 addReply(c
,shared
.czero
);
4170 removeExpire(c
->db
,key
);
4171 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4172 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4175 static void setCommand(redisClient
*c
) {
4176 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4179 static void setnxCommand(redisClient
*c
) {
4180 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4183 static void setexCommand(redisClient
*c
) {
4184 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4187 static int getGenericCommand(redisClient
*c
) {
4190 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4193 if (o
->type
!= REDIS_STRING
) {
4194 addReply(c
,shared
.wrongtypeerr
);
4202 static void getCommand(redisClient
*c
) {
4203 getGenericCommand(c
);
4206 static void getsetCommand(redisClient
*c
) {
4207 if (getGenericCommand(c
) == REDIS_ERR
) return;
4208 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4209 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4211 incrRefCount(c
->argv
[1]);
4213 incrRefCount(c
->argv
[2]);
4215 removeExpire(c
->db
,c
->argv
[1]);
4218 static void mgetCommand(redisClient
*c
) {
4221 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4222 for (j
= 1; j
< c
->argc
; j
++) {
4223 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4225 addReply(c
,shared
.nullbulk
);
4227 if (o
->type
!= REDIS_STRING
) {
4228 addReply(c
,shared
.nullbulk
);
4236 static void msetGenericCommand(redisClient
*c
, int nx
) {
4237 int j
, busykeys
= 0;
4239 if ((c
->argc
% 2) == 0) {
4240 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4243 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4244 * set nothing at all if at least one already key exists. */
4246 for (j
= 1; j
< c
->argc
; j
+= 2) {
4247 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4253 addReply(c
, shared
.czero
);
4257 for (j
= 1; j
< c
->argc
; j
+= 2) {
4260 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4261 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4262 if (retval
== DICT_ERR
) {
4263 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4264 incrRefCount(c
->argv
[j
+1]);
4266 incrRefCount(c
->argv
[j
]);
4267 incrRefCount(c
->argv
[j
+1]);
4269 removeExpire(c
->db
,c
->argv
[j
]);
4271 server
.dirty
+= (c
->argc
-1)/2;
4272 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4275 static void msetCommand(redisClient
*c
) {
4276 msetGenericCommand(c
,0);
4279 static void msetnxCommand(redisClient
*c
) {
4280 msetGenericCommand(c
,1);
4283 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4288 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4289 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4290 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4293 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4294 o
= tryObjectEncoding(o
);
4295 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4296 if (retval
== DICT_ERR
) {
4297 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4298 removeExpire(c
->db
,c
->argv
[1]);
4300 incrRefCount(c
->argv
[1]);
4303 addReply(c
,shared
.colon
);
4305 addReply(c
,shared
.crlf
);
4308 static void incrCommand(redisClient
*c
) {
4309 incrDecrCommand(c
,1);
4312 static void decrCommand(redisClient
*c
) {
4313 incrDecrCommand(c
,-1);
4316 static void incrbyCommand(redisClient
*c
) {
4319 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4320 incrDecrCommand(c
,incr
);
4323 static void decrbyCommand(redisClient
*c
) {
4326 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4327 incrDecrCommand(c
,-incr
);
4330 static void appendCommand(redisClient
*c
) {
4335 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4337 /* Create the key */
4338 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4339 incrRefCount(c
->argv
[1]);
4340 incrRefCount(c
->argv
[2]);
4341 totlen
= stringObjectLen(c
->argv
[2]);
4345 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4348 o
= dictGetEntryVal(de
);
4349 if (o
->type
!= REDIS_STRING
) {
4350 addReply(c
,shared
.wrongtypeerr
);
4353 /* If the object is specially encoded or shared we have to make
4355 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4356 robj
*decoded
= getDecodedObject(o
);
4358 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4359 decrRefCount(decoded
);
4360 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4363 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4364 o
->ptr
= sdscatlen(o
->ptr
,
4365 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4367 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4368 (unsigned long) c
->argv
[2]->ptr
);
4370 totlen
= sdslen(o
->ptr
);
4373 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4376 static void substrCommand(redisClient
*c
) {
4378 long start
= atoi(c
->argv
[2]->ptr
);
4379 long end
= atoi(c
->argv
[3]->ptr
);
4380 size_t rangelen
, strlen
;
4383 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4384 checkType(c
,o
,REDIS_STRING
)) return;
4386 o
= getDecodedObject(o
);
4387 strlen
= sdslen(o
->ptr
);
4389 /* convert negative indexes */
4390 if (start
< 0) start
= strlen
+start
;
4391 if (end
< 0) end
= strlen
+end
;
4392 if (start
< 0) start
= 0;
4393 if (end
< 0) end
= 0;
4395 /* indexes sanity checks */
4396 if (start
> end
|| (size_t)start
>= strlen
) {
4397 /* Out of range start or start > end result in null reply */
4398 addReply(c
,shared
.nullbulk
);
4402 if ((size_t)end
>= strlen
) end
= strlen
-1;
4403 rangelen
= (end
-start
)+1;
4405 /* Return the result */
4406 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4407 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4408 addReplySds(c
,range
);
4409 addReply(c
,shared
.crlf
);
4413 /* ========================= Type agnostic commands ========================= */
4415 static void delCommand(redisClient
*c
) {
4418 for (j
= 1; j
< c
->argc
; j
++) {
4419 if (deleteKey(c
->db
,c
->argv
[j
])) {
4424 addReplyLong(c
,deleted
);
4427 static void existsCommand(redisClient
*c
) {
4428 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4431 static void selectCommand(redisClient
*c
) {
4432 int id
= atoi(c
->argv
[1]->ptr
);
4434 if (selectDb(c
,id
) == REDIS_ERR
) {
4435 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4437 addReply(c
,shared
.ok
);
4441 static void randomkeyCommand(redisClient
*c
) {
4446 de
= dictGetRandomKey(c
->db
->dict
);
4447 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4451 addReply(c
,shared
.nullbulk
);
4455 key
= dictGetEntryKey(de
);
4456 if (server
.vm_enabled
) {
4457 key
= dupStringObject(key
);
4458 addReplyBulk(c
,key
);
4461 addReplyBulk(c
,key
);
4465 static void keysCommand(redisClient
*c
) {
4468 sds pattern
= c
->argv
[1]->ptr
;
4469 int plen
= sdslen(pattern
);
4470 unsigned long numkeys
= 0;
4471 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4473 di
= dictGetIterator(c
->db
->dict
);
4475 decrRefCount(lenobj
);
4476 while((de
= dictNext(di
)) != NULL
) {
4477 robj
*keyobj
= dictGetEntryKey(de
);
4479 sds key
= keyobj
->ptr
;
4480 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4481 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4482 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4483 addReplyBulk(c
,keyobj
);
4488 dictReleaseIterator(di
);
4489 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4492 static void dbsizeCommand(redisClient
*c
) {
4494 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4497 static void lastsaveCommand(redisClient
*c
) {
4499 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4502 static void typeCommand(redisClient
*c
) {
4506 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4511 case REDIS_STRING
: type
= "+string"; break;
4512 case REDIS_LIST
: type
= "+list"; break;
4513 case REDIS_SET
: type
= "+set"; break;
4514 case REDIS_ZSET
: type
= "+zset"; break;
4515 case REDIS_HASH
: type
= "+hash"; break;
4516 default: type
= "+unknown"; break;
4519 addReplySds(c
,sdsnew(type
));
4520 addReply(c
,shared
.crlf
);
4523 static void saveCommand(redisClient
*c
) {
4524 if (server
.bgsavechildpid
!= -1) {
4525 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4528 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4529 addReply(c
,shared
.ok
);
4531 addReply(c
,shared
.err
);
4535 static void bgsaveCommand(redisClient
*c
) {
4536 if (server
.bgsavechildpid
!= -1) {
4537 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4540 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4541 char *status
= "+Background saving started\r\n";
4542 addReplySds(c
,sdsnew(status
));
4544 addReply(c
,shared
.err
);
4548 static void shutdownCommand(redisClient
*c
) {
4549 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4550 /* Kill the saving child if there is a background saving in progress.
4551 We want to avoid race conditions, for instance our saving child may
4552 overwrite the synchronous saving did by SHUTDOWN. */
4553 if (server
.bgsavechildpid
!= -1) {
4554 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4555 kill(server
.bgsavechildpid
,SIGKILL
);
4556 rdbRemoveTempFile(server
.bgsavechildpid
);
4558 if (server
.appendonly
) {
4559 /* Append only file: fsync() the AOF and exit */
4560 fsync(server
.appendfd
);
4561 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4564 /* Snapshotting. Perform a SYNC SAVE and exit */
4565 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4566 if (server
.daemonize
)
4567 unlink(server
.pidfile
);
4568 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4569 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4572 /* Ooops.. error saving! The best we can do is to continue
4573 * operating. Note that if there was a background saving process,
4574 * in the next cron() Redis will be notified that the background
4575 * saving aborted, handling special stuff like slaves pending for
4576 * synchronization... */
4577 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4579 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4584 static void renameGenericCommand(redisClient
*c
, int nx
) {
4587 /* To use the same key as src and dst is probably an error */
4588 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4589 addReply(c
,shared
.sameobjecterr
);
4593 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4597 deleteIfVolatile(c
->db
,c
->argv
[2]);
4598 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4601 addReply(c
,shared
.czero
);
4604 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4606 incrRefCount(c
->argv
[2]);
4608 deleteKey(c
->db
,c
->argv
[1]);
4610 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4613 static void renameCommand(redisClient
*c
) {
4614 renameGenericCommand(c
,0);
4617 static void renamenxCommand(redisClient
*c
) {
4618 renameGenericCommand(c
,1);
4621 static void moveCommand(redisClient
*c
) {
4626 /* Obtain source and target DB pointers */
4629 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4630 addReply(c
,shared
.outofrangeerr
);
4634 selectDb(c
,srcid
); /* Back to the source DB */
4636 /* If the user is moving using as target the same
4637 * DB as the source DB it is probably an error. */
4639 addReply(c
,shared
.sameobjecterr
);
4643 /* Check if the element exists and get a reference */
4644 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4646 addReply(c
,shared
.czero
);
4650 /* Try to add the element to the target DB */
4651 deleteIfVolatile(dst
,c
->argv
[1]);
4652 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4653 addReply(c
,shared
.czero
);
4656 incrRefCount(c
->argv
[1]);
4659 /* OK! key moved, free the entry in the source DB */
4660 deleteKey(src
,c
->argv
[1]);
4662 addReply(c
,shared
.cone
);
4665 /* =================================== Lists ================================ */
4666 static void pushGenericCommand(redisClient
*c
, int where
) {
4670 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4672 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4673 addReply(c
,shared
.cone
);
4676 lobj
= createListObject();
4678 if (where
== REDIS_HEAD
) {
4679 listAddNodeHead(list
,c
->argv
[2]);
4681 listAddNodeTail(list
,c
->argv
[2]);
4683 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4684 incrRefCount(c
->argv
[1]);
4685 incrRefCount(c
->argv
[2]);
4687 if (lobj
->type
!= REDIS_LIST
) {
4688 addReply(c
,shared
.wrongtypeerr
);
4691 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4692 addReply(c
,shared
.cone
);
4696 if (where
== REDIS_HEAD
) {
4697 listAddNodeHead(list
,c
->argv
[2]);
4699 listAddNodeTail(list
,c
->argv
[2]);
4701 incrRefCount(c
->argv
[2]);
4704 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4707 static void lpushCommand(redisClient
*c
) {
4708 pushGenericCommand(c
,REDIS_HEAD
);
4711 static void rpushCommand(redisClient
*c
) {
4712 pushGenericCommand(c
,REDIS_TAIL
);
4715 static void llenCommand(redisClient
*c
) {
4719 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4720 checkType(c
,o
,REDIS_LIST
)) return;
4723 addReplyUlong(c
,listLength(l
));
4726 static void lindexCommand(redisClient
*c
) {
4728 int index
= atoi(c
->argv
[2]->ptr
);
4732 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4733 checkType(c
,o
,REDIS_LIST
)) return;
4736 ln
= listIndex(list
, index
);
4738 addReply(c
,shared
.nullbulk
);
4740 robj
*ele
= listNodeValue(ln
);
4741 addReplyBulk(c
,ele
);
4745 static void lsetCommand(redisClient
*c
) {
4747 int index
= atoi(c
->argv
[2]->ptr
);
4751 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4752 checkType(c
,o
,REDIS_LIST
)) return;
4755 ln
= listIndex(list
, index
);
4757 addReply(c
,shared
.outofrangeerr
);
4759 robj
*ele
= listNodeValue(ln
);
4762 listNodeValue(ln
) = c
->argv
[3];
4763 incrRefCount(c
->argv
[3]);
4764 addReply(c
,shared
.ok
);
4769 static void popGenericCommand(redisClient
*c
, int where
) {
4774 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4775 checkType(c
,o
,REDIS_LIST
)) return;
4778 if (where
== REDIS_HEAD
)
4779 ln
= listFirst(list
);
4781 ln
= listLast(list
);
4784 addReply(c
,shared
.nullbulk
);
4786 robj
*ele
= listNodeValue(ln
);
4787 addReplyBulk(c
,ele
);
4788 listDelNode(list
,ln
);
4789 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4794 static void lpopCommand(redisClient
*c
) {
4795 popGenericCommand(c
,REDIS_HEAD
);
4798 static void rpopCommand(redisClient
*c
) {
4799 popGenericCommand(c
,REDIS_TAIL
);
4802 static void lrangeCommand(redisClient
*c
) {
4804 int start
= atoi(c
->argv
[2]->ptr
);
4805 int end
= atoi(c
->argv
[3]->ptr
);
4812 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4813 || checkType(c
,o
,REDIS_LIST
)) return;
4815 llen
= listLength(list
);
4817 /* convert negative indexes */
4818 if (start
< 0) start
= llen
+start
;
4819 if (end
< 0) end
= llen
+end
;
4820 if (start
< 0) start
= 0;
4821 if (end
< 0) end
= 0;
4823 /* indexes sanity checks */
4824 if (start
> end
|| start
>= llen
) {
4825 /* Out of range start or start > end result in empty list */
4826 addReply(c
,shared
.emptymultibulk
);
4829 if (end
>= llen
) end
= llen
-1;
4830 rangelen
= (end
-start
)+1;
4832 /* Return the result in form of a multi-bulk reply */
4833 ln
= listIndex(list
, start
);
4834 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4835 for (j
= 0; j
< rangelen
; j
++) {
4836 ele
= listNodeValue(ln
);
4837 addReplyBulk(c
,ele
);
4842 static void ltrimCommand(redisClient
*c
) {
4844 int start
= atoi(c
->argv
[2]->ptr
);
4845 int end
= atoi(c
->argv
[3]->ptr
);
4847 int j
, ltrim
, rtrim
;
4851 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4852 checkType(c
,o
,REDIS_LIST
)) return;
4854 llen
= listLength(list
);
4856 /* convert negative indexes */
4857 if (start
< 0) start
= llen
+start
;
4858 if (end
< 0) end
= llen
+end
;
4859 if (start
< 0) start
= 0;
4860 if (end
< 0) end
= 0;
4862 /* indexes sanity checks */
4863 if (start
> end
|| start
>= llen
) {
4864 /* Out of range start or start > end result in empty list */
4868 if (end
>= llen
) end
= llen
-1;
4873 /* Remove list elements to perform the trim */
4874 for (j
= 0; j
< ltrim
; j
++) {
4875 ln
= listFirst(list
);
4876 listDelNode(list
,ln
);
4878 for (j
= 0; j
< rtrim
; j
++) {
4879 ln
= listLast(list
);
4880 listDelNode(list
,ln
);
4882 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4884 addReply(c
,shared
.ok
);
4887 static void lremCommand(redisClient
*c
) {
4890 listNode
*ln
, *next
;
4891 int toremove
= atoi(c
->argv
[2]->ptr
);
4895 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4896 checkType(c
,o
,REDIS_LIST
)) return;
4900 toremove
= -toremove
;
4903 ln
= fromtail
? list
->tail
: list
->head
;
4905 robj
*ele
= listNodeValue(ln
);
4907 next
= fromtail
? ln
->prev
: ln
->next
;
4908 if (equalStringObjects(ele
,c
->argv
[3])) {
4909 listDelNode(list
,ln
);
4912 if (toremove
&& removed
== toremove
) break;
4916 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4917 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4920 /* This is the semantic of this command:
4921 * RPOPLPUSH srclist dstlist:
4922 * IF LLEN(srclist) > 0
4923 * element = RPOP srclist
4924 * LPUSH dstlist element
4931 * The idea is to be able to get an element from a list in a reliable way
4932 * since the element is not just returned but pushed against another list
4933 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4935 static void rpoplpushcommand(redisClient
*c
) {
4940 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4941 checkType(c
,sobj
,REDIS_LIST
)) return;
4942 srclist
= sobj
->ptr
;
4943 ln
= listLast(srclist
);
4946 addReply(c
,shared
.nullbulk
);
4948 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4949 robj
*ele
= listNodeValue(ln
);
4952 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4953 addReply(c
,shared
.wrongtypeerr
);
4957 /* Add the element to the target list (unless it's directly
4958 * passed to some BLPOP-ing client */
4959 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4961 /* Create the list if the key does not exist */
4962 dobj
= createListObject();
4963 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4964 incrRefCount(c
->argv
[2]);
4966 dstlist
= dobj
->ptr
;
4967 listAddNodeHead(dstlist
,ele
);
4971 /* Send the element to the client as reply as well */
4972 addReplyBulk(c
,ele
);
4974 /* Finally remove the element from the source list */
4975 listDelNode(srclist
,ln
);
4976 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4981 /* ==================================== Sets ================================ */
4983 static void saddCommand(redisClient
*c
) {
4986 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4988 set
= createSetObject();
4989 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4990 incrRefCount(c
->argv
[1]);
4992 if (set
->type
!= REDIS_SET
) {
4993 addReply(c
,shared
.wrongtypeerr
);
4997 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4998 incrRefCount(c
->argv
[2]);
5000 addReply(c
,shared
.cone
);
5002 addReply(c
,shared
.czero
);
5006 static void sremCommand(redisClient
*c
) {
5009 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5010 checkType(c
,set
,REDIS_SET
)) return;
5012 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5014 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5015 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5016 addReply(c
,shared
.cone
);
5018 addReply(c
,shared
.czero
);
5022 static void smoveCommand(redisClient
*c
) {
5023 robj
*srcset
, *dstset
;
5025 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5026 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5028 /* If the source key does not exist return 0, if it's of the wrong type
5030 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5031 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5034 /* Error if the destination key is not a set as well */
5035 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5036 addReply(c
,shared
.wrongtypeerr
);
5039 /* Remove the element from the source set */
5040 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5041 /* Key not found in the src set! return zero */
5042 addReply(c
,shared
.czero
);
5045 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5046 deleteKey(c
->db
,c
->argv
[1]);
5048 /* Add the element to the destination set */
5050 dstset
= createSetObject();
5051 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5052 incrRefCount(c
->argv
[2]);
5054 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5055 incrRefCount(c
->argv
[3]);
5056 addReply(c
,shared
.cone
);
5059 static void sismemberCommand(redisClient
*c
) {
5062 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5063 checkType(c
,set
,REDIS_SET
)) return;
5065 if (dictFind(set
->ptr
,c
->argv
[2]))
5066 addReply(c
,shared
.cone
);
5068 addReply(c
,shared
.czero
);
5071 static void scardCommand(redisClient
*c
) {
5075 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5076 checkType(c
,o
,REDIS_SET
)) return;
5079 addReplyUlong(c
,dictSize(s
));
5082 static void spopCommand(redisClient
*c
) {
5086 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5087 checkType(c
,set
,REDIS_SET
)) return;
5089 de
= dictGetRandomKey(set
->ptr
);
5091 addReply(c
,shared
.nullbulk
);
5093 robj
*ele
= dictGetEntryKey(de
);
5095 addReplyBulk(c
,ele
);
5096 dictDelete(set
->ptr
,ele
);
5097 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5098 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5103 static void srandmemberCommand(redisClient
*c
) {
5107 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5108 checkType(c
,set
,REDIS_SET
)) return;
5110 de
= dictGetRandomKey(set
->ptr
);
5112 addReply(c
,shared
.nullbulk
);
5114 robj
*ele
= dictGetEntryKey(de
);
5116 addReplyBulk(c
,ele
);
5120 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5121 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5123 return dictSize(*d1
)-dictSize(*d2
);
5126 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5127 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5130 robj
*lenobj
= NULL
, *dstset
= NULL
;
5131 unsigned long j
, cardinality
= 0;
5133 for (j
= 0; j
< setsnum
; j
++) {
5137 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5138 lookupKeyRead(c
->db
,setskeys
[j
]);
5142 if (deleteKey(c
->db
,dstkey
))
5144 addReply(c
,shared
.czero
);
5146 addReply(c
,shared
.emptymultibulk
);
5150 if (setobj
->type
!= REDIS_SET
) {
5152 addReply(c
,shared
.wrongtypeerr
);
5155 dv
[j
] = setobj
->ptr
;
5157 /* Sort sets from the smallest to largest, this will improve our
5158 * algorithm's performace */
5159 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5161 /* The first thing we should output is the total number of elements...
5162 * since this is a multi-bulk write, but at this stage we don't know
5163 * the intersection set size, so we use a trick, append an empty object
5164 * to the output list and save the pointer to later modify it with the
5167 lenobj
= createObject(REDIS_STRING
,NULL
);
5169 decrRefCount(lenobj
);
5171 /* If we have a target key where to store the resulting set
5172 * create this key with an empty set inside */
5173 dstset
= createSetObject();
5176 /* Iterate all the elements of the first (smallest) set, and test
5177 * the element against all the other sets, if at least one set does
5178 * not include the element it is discarded */
5179 di
= dictGetIterator(dv
[0]);
5181 while((de
= dictNext(di
)) != NULL
) {
5184 for (j
= 1; j
< setsnum
; j
++)
5185 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5187 continue; /* at least one set does not contain the member */
5188 ele
= dictGetEntryKey(de
);
5190 addReplyBulk(c
,ele
);
5193 dictAdd(dstset
->ptr
,ele
,NULL
);
5197 dictReleaseIterator(di
);
5200 /* Store the resulting set into the target, if the intersection
5201 * is not an empty set. */
5202 deleteKey(c
->db
,dstkey
);
5203 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5204 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5205 incrRefCount(dstkey
);
5206 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5208 decrRefCount(dstset
);
5209 addReply(c
,shared
.czero
);
5213 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5218 static void sinterCommand(redisClient
*c
) {
5219 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5222 static void sinterstoreCommand(redisClient
*c
) {
5223 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5226 #define REDIS_OP_UNION 0
5227 #define REDIS_OP_DIFF 1
5228 #define REDIS_OP_INTER 2
5230 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5231 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5234 robj
*dstset
= NULL
;
5235 int j
, cardinality
= 0;
5237 for (j
= 0; j
< setsnum
; j
++) {
5241 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5242 lookupKeyRead(c
->db
,setskeys
[j
]);
5247 if (setobj
->type
!= REDIS_SET
) {
5249 addReply(c
,shared
.wrongtypeerr
);
5252 dv
[j
] = setobj
->ptr
;
5255 /* We need a temp set object to store our union. If the dstkey
5256 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5257 * this set object will be the resulting object to set into the target key*/
5258 dstset
= createSetObject();
5260 /* Iterate all the elements of all the sets, add every element a single
5261 * time to the result set */
5262 for (j
= 0; j
< setsnum
; j
++) {
5263 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5264 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5266 di
= dictGetIterator(dv
[j
]);
5268 while((de
= dictNext(di
)) != NULL
) {
5271 /* dictAdd will not add the same element multiple times */
5272 ele
= dictGetEntryKey(de
);
5273 if (op
== REDIS_OP_UNION
|| j
== 0) {
5274 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5278 } else if (op
== REDIS_OP_DIFF
) {
5279 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5284 dictReleaseIterator(di
);
5286 /* result set is empty? Exit asap. */
5287 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5290 /* Output the content of the resulting set, if not in STORE mode */
5292 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5293 di
= dictGetIterator(dstset
->ptr
);
5294 while((de
= dictNext(di
)) != NULL
) {
5297 ele
= dictGetEntryKey(de
);
5298 addReplyBulk(c
,ele
);
5300 dictReleaseIterator(di
);
5301 decrRefCount(dstset
);
5303 /* If we have a target key where to store the resulting set
5304 * create this key with the result set inside */
5305 deleteKey(c
->db
,dstkey
);
5306 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5307 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5308 incrRefCount(dstkey
);
5309 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5311 decrRefCount(dstset
);
5312 addReply(c
,shared
.czero
);
5319 static void sunionCommand(redisClient
*c
) {
5320 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5323 static void sunionstoreCommand(redisClient
*c
) {
5324 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5327 static void sdiffCommand(redisClient
*c
) {
5328 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5331 static void sdiffstoreCommand(redisClient
*c
) {
5332 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5335 /* ==================================== ZSets =============================== */
5337 /* ZSETs are ordered sets using two data structures to hold the same elements
5338 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5341 * The elements are added to an hash table mapping Redis objects to scores.
5342 * At the same time the elements are added to a skip list mapping scores
5343 * to Redis objects (so objects are sorted by scores in this "view"). */
5345 /* This skiplist implementation is almost a C translation of the original
5346 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5347 * Alternative to Balanced Trees", modified in three ways:
5348 * a) this implementation allows for repeated values.
5349 * b) the comparison is not just by key (our 'score') but by satellite data.
5350 * c) there is a back pointer, so it's a doubly linked list with the back
5351 * pointers being only at "level 1". This allows to traverse the list
5352 * from tail to head, useful for ZREVRANGE. */
5354 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5355 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5357 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5359 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5365 static zskiplist
*zslCreate(void) {
5369 zsl
= zmalloc(sizeof(*zsl
));
5372 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5373 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5374 zsl
->header
->forward
[j
] = NULL
;
5376 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5377 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5378 zsl
->header
->span
[j
] = 0;
5380 zsl
->header
->backward
= NULL
;
5385 static void zslFreeNode(zskiplistNode
*node
) {
5386 decrRefCount(node
->obj
);
5387 zfree(node
->forward
);
5392 static void zslFree(zskiplist
*zsl
) {
5393 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5395 zfree(zsl
->header
->forward
);
5396 zfree(zsl
->header
->span
);
5399 next
= node
->forward
[0];
5406 static int zslRandomLevel(void) {
5408 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5410 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5413 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5414 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5415 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5419 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5420 /* store rank that is crossed to reach the insert position */
5421 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5423 while (x
->forward
[i
] &&
5424 (x
->forward
[i
]->score
< score
||
5425 (x
->forward
[i
]->score
== score
&&
5426 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5427 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5432 /* we assume the key is not already inside, since we allow duplicated
5433 * scores, and the re-insertion of score and redis object should never
5434 * happpen since the caller of zslInsert() should test in the hash table
5435 * if the element is already inside or not. */
5436 level
= zslRandomLevel();
5437 if (level
> zsl
->level
) {
5438 for (i
= zsl
->level
; i
< level
; i
++) {
5440 update
[i
] = zsl
->header
;
5441 update
[i
]->span
[i
-1] = zsl
->length
;
5445 x
= zslCreateNode(level
,score
,obj
);
5446 for (i
= 0; i
< level
; i
++) {
5447 x
->forward
[i
] = update
[i
]->forward
[i
];
5448 update
[i
]->forward
[i
] = x
;
5450 /* update span covered by update[i] as x is inserted here */
5452 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5453 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5457 /* increment span for untouched levels */
5458 for (i
= level
; i
< zsl
->level
; i
++) {
5459 update
[i
]->span
[i
-1]++;
5462 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5464 x
->forward
[0]->backward
= x
;
5470 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5471 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5473 for (i
= 0; i
< zsl
->level
; i
++) {
5474 if (update
[i
]->forward
[i
] == x
) {
5476 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5478 update
[i
]->forward
[i
] = x
->forward
[i
];
5480 /* invariant: i > 0, because update[0]->forward[0]
5481 * is always equal to x */
5482 update
[i
]->span
[i
-1] -= 1;
5485 if (x
->forward
[0]) {
5486 x
->forward
[0]->backward
= x
->backward
;
5488 zsl
->tail
= x
->backward
;
5490 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5495 /* Delete an element with matching score/object from the skiplist. */
5496 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5497 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5501 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5502 while (x
->forward
[i
] &&
5503 (x
->forward
[i
]->score
< score
||
5504 (x
->forward
[i
]->score
== score
&&
5505 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5509 /* We may have multiple elements with the same score, what we need
5510 * is to find the element with both the right score and object. */
5512 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5513 zslDeleteNode(zsl
, x
, update
);
5517 return 0; /* not found */
5519 return 0; /* not found */
5522 /* Delete all the elements with score between min and max from the skiplist.
5523 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5524 * Note that this function takes the reference to the hash table view of the
5525 * sorted set, in order to remove the elements from the hash table too. */
5526 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5527 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5528 unsigned long removed
= 0;
5532 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5533 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5537 /* We may have multiple elements with the same score, what we need
5538 * is to find the element with both the right score and object. */
5540 while (x
&& x
->score
<= max
) {
5541 zskiplistNode
*next
= x
->forward
[0];
5542 zslDeleteNode(zsl
, x
, update
);
5543 dictDelete(dict
,x
->obj
);
5548 return removed
; /* not found */
5551 /* Delete all the elements with rank between start and end from the skiplist.
5552 * Start and end are inclusive. Note that start and end need to be 1-based */
5553 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5554 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5555 unsigned long traversed
= 0, removed
= 0;
5559 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5560 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5561 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5569 while (x
&& traversed
<= end
) {
5570 zskiplistNode
*next
= x
->forward
[0];
5571 zslDeleteNode(zsl
, x
, update
);
5572 dictDelete(dict
,x
->obj
);
5581 /* Find the first node having a score equal or greater than the specified one.
5582 * Returns NULL if there is no match. */
5583 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5588 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5589 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5592 /* We may have multiple elements with the same score, what we need
5593 * is to find the element with both the right score and object. */
5594 return x
->forward
[0];
5597 /* Find the rank for an element by both score and key.
5598 * Returns 0 when the element cannot be found, rank otherwise.
5599 * Note that the rank is 1-based due to the span of zsl->header to the
5601 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5603 unsigned long rank
= 0;
5607 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5608 while (x
->forward
[i
] &&
5609 (x
->forward
[i
]->score
< score
||
5610 (x
->forward
[i
]->score
== score
&&
5611 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5612 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5616 /* x might be equal to zsl->header, so test if obj is non-NULL */
5617 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5624 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5625 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5627 unsigned long traversed
= 0;
5631 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5632 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5634 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5637 if (traversed
== rank
) {
5644 /* The actual Z-commands implementations */
5646 /* This generic command implements both ZADD and ZINCRBY.
5647 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5648 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5649 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5654 zsetobj
= lookupKeyWrite(c
->db
,key
);
5655 if (zsetobj
== NULL
) {
5656 zsetobj
= createZsetObject();
5657 dictAdd(c
->db
->dict
,key
,zsetobj
);
5660 if (zsetobj
->type
!= REDIS_ZSET
) {
5661 addReply(c
,shared
.wrongtypeerr
);
5667 /* Ok now since we implement both ZADD and ZINCRBY here the code
5668 * needs to handle the two different conditions. It's all about setting
5669 * '*score', that is, the new score to set, to the right value. */
5670 score
= zmalloc(sizeof(double));
5674 /* Read the old score. If the element was not present starts from 0 */
5675 de
= dictFind(zs
->dict
,ele
);
5677 double *oldscore
= dictGetEntryVal(de
);
5678 *score
= *oldscore
+ scoreval
;
5686 /* What follows is a simple remove and re-insert operation that is common
5687 * to both ZADD and ZINCRBY... */
5688 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5689 /* case 1: New element */
5690 incrRefCount(ele
); /* added to hash */
5691 zslInsert(zs
->zsl
,*score
,ele
);
5692 incrRefCount(ele
); /* added to skiplist */
5695 addReplyDouble(c
,*score
);
5697 addReply(c
,shared
.cone
);
5702 /* case 2: Score update operation */
5703 de
= dictFind(zs
->dict
,ele
);
5704 redisAssert(de
!= NULL
);
5705 oldscore
= dictGetEntryVal(de
);
5706 if (*score
!= *oldscore
) {
5709 /* Remove and insert the element in the skip list with new score */
5710 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5711 redisAssert(deleted
!= 0);
5712 zslInsert(zs
->zsl
,*score
,ele
);
5714 /* Update the score in the hash table */
5715 dictReplace(zs
->dict
,ele
,score
);
5721 addReplyDouble(c
,*score
);
5723 addReply(c
,shared
.czero
);
5727 static void zaddCommand(redisClient
*c
) {
5730 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5731 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5734 static void zincrbyCommand(redisClient
*c
) {
5737 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5738 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5741 static void zremCommand(redisClient
*c
) {
5748 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5749 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5752 de
= dictFind(zs
->dict
,c
->argv
[2]);
5754 addReply(c
,shared
.czero
);
5757 /* Delete from the skiplist */
5758 oldscore
= dictGetEntryVal(de
);
5759 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5760 redisAssert(deleted
!= 0);
5762 /* Delete from the hash table */
5763 dictDelete(zs
->dict
,c
->argv
[2]);
5764 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5765 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5767 addReply(c
,shared
.cone
);
5770 static void zremrangebyscoreCommand(redisClient
*c
) {
5777 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5778 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5780 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5781 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5784 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5785 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5786 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5787 server
.dirty
+= deleted
;
5788 addReplyLong(c
,deleted
);
5791 static void zremrangebyrankCommand(redisClient
*c
) {
5799 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5800 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5802 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5803 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5805 llen
= zs
->zsl
->length
;
5807 /* convert negative indexes */
5808 if (start
< 0) start
= llen
+start
;
5809 if (end
< 0) end
= llen
+end
;
5810 if (start
< 0) start
= 0;
5811 if (end
< 0) end
= 0;
5813 /* indexes sanity checks */
5814 if (start
> end
|| start
>= llen
) {
5815 addReply(c
,shared
.czero
);
5818 if (end
>= llen
) end
= llen
-1;
5820 /* increment start and end because zsl*Rank functions
5821 * use 1-based rank */
5822 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5823 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5824 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5825 server
.dirty
+= deleted
;
5826 addReplyLong(c
, deleted
);
5834 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5835 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5836 unsigned long size1
, size2
;
5837 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5838 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5839 return size1
- size2
;
5842 #define REDIS_AGGR_SUM 1
5843 #define REDIS_AGGR_MIN 2
5844 #define REDIS_AGGR_MAX 3
5846 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5847 if (aggregate
== REDIS_AGGR_SUM
) {
5848 *target
= *target
+ val
;
5849 } else if (aggregate
== REDIS_AGGR_MIN
) {
5850 *target
= val
< *target
? val
: *target
;
5851 } else if (aggregate
== REDIS_AGGR_MAX
) {
5852 *target
= val
> *target
? val
: *target
;
5855 redisPanic("Unknown ZUNION/INTER aggregate type");
5859 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5861 int aggregate
= REDIS_AGGR_SUM
;
5868 /* expect zsetnum input keys to be given */
5869 zsetnum
= atoi(c
->argv
[2]->ptr
);
5871 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5875 /* test if the expected number of keys would overflow */
5876 if (3+zsetnum
> c
->argc
) {
5877 addReply(c
,shared
.syntaxerr
);
5881 /* read keys to be used for input */
5882 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5883 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5884 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5888 if (zsetobj
->type
!= REDIS_ZSET
) {
5890 addReply(c
,shared
.wrongtypeerr
);
5893 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5896 /* default all weights to 1 */
5897 src
[i
].weight
= 1.0;
5900 /* parse optional extra arguments */
5902 int remaining
= c
->argc
- j
;
5905 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5907 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5908 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5911 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5913 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5914 aggregate
= REDIS_AGGR_SUM
;
5915 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5916 aggregate
= REDIS_AGGR_MIN
;
5917 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5918 aggregate
= REDIS_AGGR_MAX
;
5921 addReply(c
,shared
.syntaxerr
);
5927 addReply(c
,shared
.syntaxerr
);
5933 /* sort sets from the smallest to largest, this will improve our
5934 * algorithm's performance */
5935 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5937 dstobj
= createZsetObject();
5938 dstzset
= dstobj
->ptr
;
5940 if (op
== REDIS_OP_INTER
) {
5941 /* skip going over all entries if the smallest zset is NULL or empty */
5942 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5943 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5944 * from small to large, all src[i > 0].dict are non-empty too */
5945 di
= dictGetIterator(src
[0].dict
);
5946 while((de
= dictNext(di
)) != NULL
) {
5947 double *score
= zmalloc(sizeof(double)), value
;
5948 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5950 for (j
= 1; j
< zsetnum
; j
++) {
5951 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5953 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5954 zunionInterAggregate(score
, value
, aggregate
);
5960 /* skip entry when not present in every source dict */
5964 robj
*o
= dictGetEntryKey(de
);
5965 dictAdd(dstzset
->dict
,o
,score
);
5966 incrRefCount(o
); /* added to dictionary */
5967 zslInsert(dstzset
->zsl
,*score
,o
);
5968 incrRefCount(o
); /* added to skiplist */
5971 dictReleaseIterator(di
);
5973 } else if (op
== REDIS_OP_UNION
) {
5974 for (i
= 0; i
< zsetnum
; i
++) {
5975 if (!src
[i
].dict
) continue;
5977 di
= dictGetIterator(src
[i
].dict
);
5978 while((de
= dictNext(di
)) != NULL
) {
5979 /* skip key when already processed */
5980 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5982 double *score
= zmalloc(sizeof(double)), value
;
5983 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5985 /* because the zsets are sorted by size, its only possible
5986 * for sets at larger indices to hold this entry */
5987 for (j
= (i
+1); j
< zsetnum
; j
++) {
5988 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5990 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5991 zunionInterAggregate(score
, value
, aggregate
);
5995 robj
*o
= dictGetEntryKey(de
);
5996 dictAdd(dstzset
->dict
,o
,score
);
5997 incrRefCount(o
); /* added to dictionary */
5998 zslInsert(dstzset
->zsl
,*score
,o
);
5999 incrRefCount(o
); /* added to skiplist */
6001 dictReleaseIterator(di
);
6004 /* unknown operator */
6005 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6008 deleteKey(c
->db
,dstkey
);
6009 if (dstzset
->zsl
->length
) {
6010 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6011 incrRefCount(dstkey
);
6012 addReplyLong(c
, dstzset
->zsl
->length
);
6015 decrRefCount(dstobj
);
6016 addReply(c
, shared
.czero
);
6021 static void zunionCommand(redisClient
*c
) {
6022 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6025 static void zinterCommand(redisClient
*c
) {
6026 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6029 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6041 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6042 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6044 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6046 } else if (c
->argc
>= 5) {
6047 addReply(c
,shared
.syntaxerr
);
6051 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6052 || checkType(c
,o
,REDIS_ZSET
)) return;
6057 /* convert negative indexes */
6058 if (start
< 0) start
= llen
+start
;
6059 if (end
< 0) end
= llen
+end
;
6060 if (start
< 0) start
= 0;
6061 if (end
< 0) end
= 0;
6063 /* indexes sanity checks */
6064 if (start
> end
|| start
>= llen
) {
6065 /* Out of range start or start > end result in empty list */
6066 addReply(c
,shared
.emptymultibulk
);
6069 if (end
>= llen
) end
= llen
-1;
6070 rangelen
= (end
-start
)+1;
6072 /* check if starting point is trivial, before searching
6073 * the element in log(N) time */
6075 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6078 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6081 /* Return the result in form of a multi-bulk reply */
6082 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6083 withscores
? (rangelen
*2) : rangelen
));
6084 for (j
= 0; j
< rangelen
; j
++) {
6086 addReplyBulk(c
,ele
);
6088 addReplyDouble(c
,ln
->score
);
6089 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6093 static void zrangeCommand(redisClient
*c
) {
6094 zrangeGenericCommand(c
,0);
6097 static void zrevrangeCommand(redisClient
*c
) {
6098 zrangeGenericCommand(c
,1);
6101 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6102 * If justcount is non-zero, just the count is returned. */
6103 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6106 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6107 int offset
= 0, limit
= -1;
6111 /* Parse the min-max interval. If one of the values is prefixed
6112 * by the "(" character, it's considered "open". For instance
6113 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6114 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6115 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6116 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6119 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6121 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6122 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6125 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6128 /* Parse "WITHSCORES": note that if the command was called with
6129 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6130 * enter the following paths to parse WITHSCORES and LIMIT. */
6131 if (c
->argc
== 5 || c
->argc
== 8) {
6132 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6137 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6141 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6146 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6147 addReply(c
,shared
.syntaxerr
);
6149 } else if (c
->argc
== (7 + withscores
)) {
6150 offset
= atoi(c
->argv
[5]->ptr
);
6151 limit
= atoi(c
->argv
[6]->ptr
);
6152 if (offset
< 0) offset
= 0;
6155 /* Ok, lookup the key and get the range */
6156 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6158 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6160 if (o
->type
!= REDIS_ZSET
) {
6161 addReply(c
,shared
.wrongtypeerr
);
6163 zset
*zsetobj
= o
->ptr
;
6164 zskiplist
*zsl
= zsetobj
->zsl
;
6166 robj
*ele
, *lenobj
= NULL
;
6167 unsigned long rangelen
= 0;
6169 /* Get the first node with the score >= min, or with
6170 * score > min if 'minex' is true. */
6171 ln
= zslFirstWithScore(zsl
,min
);
6172 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6175 /* No element matching the speciifed interval */
6176 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6180 /* We don't know in advance how many matching elements there
6181 * are in the list, so we push this object that will represent
6182 * the multi-bulk length in the output buffer, and will "fix"
6185 lenobj
= createObject(REDIS_STRING
,NULL
);
6187 decrRefCount(lenobj
);
6190 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6193 ln
= ln
->forward
[0];
6196 if (limit
== 0) break;
6199 addReplyBulk(c
,ele
);
6201 addReplyDouble(c
,ln
->score
);
6203 ln
= ln
->forward
[0];
6205 if (limit
> 0) limit
--;
6208 addReplyLong(c
,(long)rangelen
);
6210 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6211 withscores
? (rangelen
*2) : rangelen
);
6217 static void zrangebyscoreCommand(redisClient
*c
) {
6218 genericZrangebyscoreCommand(c
,0);
6221 static void zcountCommand(redisClient
*c
) {
6222 genericZrangebyscoreCommand(c
,1);
6225 static void zcardCommand(redisClient
*c
) {
6229 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6230 checkType(c
,o
,REDIS_ZSET
)) return;
6233 addReplyUlong(c
,zs
->zsl
->length
);
6236 static void zscoreCommand(redisClient
*c
) {
6241 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6242 checkType(c
,o
,REDIS_ZSET
)) return;
6245 de
= dictFind(zs
->dict
,c
->argv
[2]);
6247 addReply(c
,shared
.nullbulk
);
6249 double *score
= dictGetEntryVal(de
);
6251 addReplyDouble(c
,*score
);
6255 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6263 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6264 checkType(c
,o
,REDIS_ZSET
)) return;
6268 de
= dictFind(zs
->dict
,c
->argv
[2]);
6270 addReply(c
,shared
.nullbulk
);
6274 score
= dictGetEntryVal(de
);
6275 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6278 addReplyLong(c
, zsl
->length
- rank
);
6280 addReplyLong(c
, rank
-1);
6283 addReply(c
,shared
.nullbulk
);
6287 static void zrankCommand(redisClient
*c
) {
6288 zrankGenericCommand(c
, 0);
6291 static void zrevrankCommand(redisClient
*c
) {
6292 zrankGenericCommand(c
, 1);
6295 /* ========================= Hashes utility functions ======================= */
6296 #define REDIS_HASH_KEY 1
6297 #define REDIS_HASH_VALUE 2
6299 /* Check the length of a number of objects to see if we need to convert a
6300 * zipmap to a real hash. Note that we only check string encoded objects
6301 * as their string length can be queried in constant time. */
6302 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6304 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6306 for (i
= start
; i
<= end
; i
++) {
6307 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6308 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6310 convertToRealHash(subject
);
6316 /* Encode given objects in-place when the hash uses a dict. */
6317 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6318 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6319 if (o1
) *o1
= tryObjectEncoding(*o1
);
6320 if (o2
) *o2
= tryObjectEncoding(*o2
);
6324 /* Get the value from a hash identified by key. Returns either a string
6325 * object or NULL if the value cannot be found. The refcount of the object
6326 * is always increased by 1 when the value was found. */
6327 static robj
*hashGet(robj
*o
, robj
*key
) {
6329 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6332 key
= getDecodedObject(key
);
6333 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6334 value
= createStringObject((char*)v
,vlen
);
6338 dictEntry
*de
= dictFind(o
->ptr
,key
);
6340 value
= dictGetEntryVal(de
);
6341 incrRefCount(value
);
6347 /* Test if the key exists in the given hash. Returns 1 if the key
6348 * exists and 0 when it doesn't. */
6349 static int hashExists(robj
*o
, robj
*key
) {
6350 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6351 key
= getDecodedObject(key
);
6352 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6358 if (dictFind(o
->ptr
,key
) != NULL
) {
6365 /* Add an element, discard the old if the key already exists.
6366 * Return 0 on insert and 1 on update. */
6367 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6369 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6370 key
= getDecodedObject(key
);
6371 value
= getDecodedObject(value
);
6372 o
->ptr
= zipmapSet(o
->ptr
,
6373 key
->ptr
,sdslen(key
->ptr
),
6374 value
->ptr
,sdslen(value
->ptr
), &update
);
6376 decrRefCount(value
);
6378 /* Check if the zipmap needs to be upgraded to a real hash table */
6379 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6380 convertToRealHash(o
);
6382 if (dictReplace(o
->ptr
,key
,value
)) {
6389 incrRefCount(value
);
6394 /* Delete an element from a hash.
6395 * Return 1 on deleted and 0 on not found. */
6396 static int hashDelete(robj
*o
, robj
*key
) {
6398 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6399 key
= getDecodedObject(key
);
6400 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6403 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6404 /* Always check if the dictionary needs a resize after a delete. */
6405 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6410 /* Return the number of elements in a hash. */
6411 static unsigned long hashLength(robj
*o
) {
6412 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6413 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6416 /* Structure to hold hash iteration abstration. Note that iteration over
6417 * hashes involves both fields and values. Because it is possible that
6418 * not both are required, store pointers in the iterator to avoid
6419 * unnecessary memory allocation for fields/values. */
6423 unsigned char *zk
, *zv
;
6424 unsigned int zklen
, zvlen
;
6430 static hashIterator
*hashInitIterator(robj
*subject
) {
6431 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6432 hi
->encoding
= subject
->encoding
;
6433 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6434 hi
->zi
= zipmapRewind(subject
->ptr
);
6435 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6436 hi
->di
= dictGetIterator(subject
->ptr
);
6443 static void hashReleaseIterator(hashIterator
*hi
) {
6444 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6445 dictReleaseIterator(hi
->di
);
6450 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6451 * could be found and REDIS_ERR when the iterator reaches the end. */
6452 static int hashNext(hashIterator
*hi
) {
6453 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6454 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6455 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6457 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6462 /* Get key or value object at current iteration position.
6463 * This increases the refcount of the field object by 1. */
6464 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6466 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6467 if (what
& REDIS_HASH_KEY
) {
6468 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6470 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6473 if (what
& REDIS_HASH_KEY
) {
6474 o
= dictGetEntryKey(hi
->de
);
6476 o
= dictGetEntryVal(hi
->de
);
6483 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6484 robj
*o
= lookupKeyWrite(c
->db
,key
);
6486 o
= createHashObject();
6487 dictAdd(c
->db
->dict
,key
,o
);
6490 if (o
->type
!= REDIS_HASH
) {
6491 addReply(c
,shared
.wrongtypeerr
);
6498 /* ============================= Hash commands ============================== */
6499 static void hsetCommand(redisClient
*c
) {
6503 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6504 hashTryConversion(o
,c
->argv
,2,3);
6505 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6506 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6507 addReply(c
, update
? shared
.czero
: shared
.cone
);
6511 static void hsetnxCommand(redisClient
*c
) {
6513 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6514 hashTryConversion(o
,c
->argv
,2,3);
6516 if (hashExists(o
, c
->argv
[2])) {
6517 addReply(c
, shared
.czero
);
6519 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6520 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6521 addReply(c
, shared
.cone
);
6526 static void hmsetCommand(redisClient
*c
) {
6530 if ((c
->argc
% 2) == 1) {
6531 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6535 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6536 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6537 for (i
= 2; i
< c
->argc
; i
+= 2) {
6538 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6539 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6541 addReply(c
, shared
.ok
);
6545 static void hincrbyCommand(redisClient
*c
) {
6546 long long value
, incr
;
6547 robj
*o
, *current
, *new;
6549 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6550 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6551 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6552 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6553 "hash value is not an integer") != REDIS_OK
) {
6554 decrRefCount(current
);
6557 decrRefCount(current
);
6563 new = createStringObjectFromLongLong(value
);
6564 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6565 hashSet(o
,c
->argv
[2],new);
6567 addReplyLongLong(c
,value
);
6571 static void hgetCommand(redisClient
*c
) {
6573 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6574 checkType(c
,o
,REDIS_HASH
)) return;
6576 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6577 addReplyBulk(c
,value
);
6578 decrRefCount(value
);
6580 addReply(c
,shared
.nullbulk
);
6584 static void hmgetCommand(redisClient
*c
) {
6587 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6588 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6589 addReply(c
,shared
.wrongtypeerr
);
6592 /* Note the check for o != NULL happens inside the loop. This is
6593 * done because objects that cannot be found are considered to be
6594 * an empty hash. The reply should then be a series of NULLs. */
6595 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6596 for (i
= 2; i
< c
->argc
; i
++) {
6597 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6598 addReplyBulk(c
,value
);
6599 decrRefCount(value
);
6601 addReply(c
,shared
.nullbulk
);
6606 static void hdelCommand(redisClient
*c
) {
6608 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6609 checkType(c
,o
,REDIS_HASH
)) return;
6611 if (hashDelete(o
,c
->argv
[2])) {
6612 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6613 addReply(c
,shared
.cone
);
6616 addReply(c
,shared
.czero
);
6620 static void hlenCommand(redisClient
*c
) {
6622 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6623 checkType(c
,o
,REDIS_HASH
)) return;
6625 addReplyUlong(c
,hashLength(o
));
6628 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6629 robj
*o
, *lenobj
, *obj
;
6630 unsigned long count
= 0;
6633 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6634 || checkType(c
,o
,REDIS_HASH
)) return;
6636 lenobj
= createObject(REDIS_STRING
,NULL
);
6638 decrRefCount(lenobj
);
6640 hi
= hashInitIterator(o
);
6641 while (hashNext(hi
) != REDIS_ERR
) {
6642 if (flags
& REDIS_HASH_KEY
) {
6643 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6644 addReplyBulk(c
,obj
);
6648 if (flags
& REDIS_HASH_VALUE
) {
6649 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6650 addReplyBulk(c
,obj
);
6655 hashReleaseIterator(hi
);
6657 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6660 static void hkeysCommand(redisClient
*c
) {
6661 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6664 static void hvalsCommand(redisClient
*c
) {
6665 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6668 static void hgetallCommand(redisClient
*c
) {
6669 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6672 static void hexistsCommand(redisClient
*c
) {
6674 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6675 checkType(c
,o
,REDIS_HASH
)) return;
6677 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6680 static void convertToRealHash(robj
*o
) {
6681 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6682 unsigned int klen
, vlen
;
6683 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6685 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6686 p
= zipmapRewind(zm
);
6687 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6688 robj
*keyobj
, *valobj
;
6690 keyobj
= createStringObject((char*)key
,klen
);
6691 valobj
= createStringObject((char*)val
,vlen
);
6692 keyobj
= tryObjectEncoding(keyobj
);
6693 valobj
= tryObjectEncoding(valobj
);
6694 dictAdd(dict
,keyobj
,valobj
);
6696 o
->encoding
= REDIS_ENCODING_HT
;
6701 /* ========================= Non type-specific commands ==================== */
6703 static void flushdbCommand(redisClient
*c
) {
6704 server
.dirty
+= dictSize(c
->db
->dict
);
6705 dictEmpty(c
->db
->dict
);
6706 dictEmpty(c
->db
->expires
);
6707 addReply(c
,shared
.ok
);
6710 static void flushallCommand(redisClient
*c
) {
6711 server
.dirty
+= emptyDb();
6712 addReply(c
,shared
.ok
);
6713 if (server
.bgsavechildpid
!= -1) {
6714 kill(server
.bgsavechildpid
,SIGKILL
);
6715 rdbRemoveTempFile(server
.bgsavechildpid
);
6717 rdbSave(server
.dbfilename
);
6721 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6722 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6724 so
->pattern
= pattern
;
6728 /* Return the value associated to the key with a name obtained
6729 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6730 * The returned object will always have its refcount increased by 1
6731 * when it is non-NULL. */
6732 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6735 robj keyobj
, fieldobj
, *o
;
6736 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6737 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6741 char buf
[REDIS_SORTKEY_MAX
+1];
6742 } keyname
, fieldname
;
6744 /* If the pattern is "#" return the substitution object itself in order
6745 * to implement the "SORT ... GET #" feature. */
6746 spat
= pattern
->ptr
;
6747 if (spat
[0] == '#' && spat
[1] == '\0') {
6748 incrRefCount(subst
);
6752 /* The substitution object may be specially encoded. If so we create
6753 * a decoded object on the fly. Otherwise getDecodedObject will just
6754 * increment the ref count, that we'll decrement later. */
6755 subst
= getDecodedObject(subst
);
6758 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6759 p
= strchr(spat
,'*');
6761 decrRefCount(subst
);
6765 /* Find out if we're dealing with a hash dereference. */
6766 if ((f
= strstr(p
+1, "->")) != NULL
) {
6767 fieldlen
= sdslen(spat
)-(f
-spat
);
6768 /* this also copies \0 character */
6769 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6770 fieldname
.len
= fieldlen
-2;
6776 sublen
= sdslen(ssub
);
6777 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6778 memcpy(keyname
.buf
,spat
,prefixlen
);
6779 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6780 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6781 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6782 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6783 decrRefCount(subst
);
6785 /* Lookup substituted key */
6786 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6787 o
= lookupKeyRead(db
,&keyobj
);
6788 if (o
== NULL
) return NULL
;
6791 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6793 /* Retrieve value from hash by the field name. This operation
6794 * already increases the refcount of the returned object. */
6795 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6796 o
= hashGet(o
, &fieldobj
);
6798 if (o
->type
!= REDIS_STRING
) return NULL
;
6800 /* Every object that this function returns needs to have its refcount
6801 * increased. sortCommand decreases it again. */
6808 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6809 * the additional parameter is not standard but a BSD-specific we have to
6810 * pass sorting parameters via the global 'server' structure */
6811 static int sortCompare(const void *s1
, const void *s2
) {
6812 const redisSortObject
*so1
= s1
, *so2
= s2
;
6815 if (!server
.sort_alpha
) {
6816 /* Numeric sorting. Here it's trivial as we precomputed scores */
6817 if (so1
->u
.score
> so2
->u
.score
) {
6819 } else if (so1
->u
.score
< so2
->u
.score
) {
6825 /* Alphanumeric sorting */
6826 if (server
.sort_bypattern
) {
6827 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6828 /* At least one compare object is NULL */
6829 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6831 else if (so1
->u
.cmpobj
== NULL
)
6836 /* We have both the objects, use strcoll */
6837 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6840 /* Compare elements directly. */
6841 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6844 return server
.sort_desc
? -cmp
: cmp
;
6847 /* The SORT command is the most complex command in Redis. Warning: this code
6848 * is optimized for speed and a bit less for readability */
6849 static void sortCommand(redisClient
*c
) {
6852 int desc
= 0, alpha
= 0;
6853 int limit_start
= 0, limit_count
= -1, start
, end
;
6854 int j
, dontsort
= 0, vectorlen
;
6855 int getop
= 0; /* GET operation counter */
6856 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6857 redisSortObject
*vector
; /* Resulting vector to sort */
6859 /* Lookup the key to sort. It must be of the right types */
6860 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6861 if (sortval
== NULL
) {
6862 addReply(c
,shared
.emptymultibulk
);
6865 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6866 sortval
->type
!= REDIS_ZSET
)
6868 addReply(c
,shared
.wrongtypeerr
);
6872 /* Create a list of operations to perform for every sorted element.
6873 * Operations can be GET/DEL/INCR/DECR */
6874 operations
= listCreate();
6875 listSetFreeMethod(operations
,zfree
);
6878 /* Now we need to protect sortval incrementing its count, in the future
6879 * SORT may have options able to overwrite/delete keys during the sorting
6880 * and the sorted key itself may get destroied */
6881 incrRefCount(sortval
);
6883 /* The SORT command has an SQL-alike syntax, parse it */
6884 while(j
< c
->argc
) {
6885 int leftargs
= c
->argc
-j
-1;
6886 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6888 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6890 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6892 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6893 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6894 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6896 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6897 storekey
= c
->argv
[j
+1];
6899 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6900 sortby
= c
->argv
[j
+1];
6901 /* If the BY pattern does not contain '*', i.e. it is constant,
6902 * we don't need to sort nor to lookup the weight keys. */
6903 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6905 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6906 listAddNodeTail(operations
,createSortOperation(
6907 REDIS_SORT_GET
,c
->argv
[j
+1]));
6911 decrRefCount(sortval
);
6912 listRelease(operations
);
6913 addReply(c
,shared
.syntaxerr
);
6919 /* Load the sorting vector with all the objects to sort */
6920 switch(sortval
->type
) {
6921 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6922 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6923 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6924 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6926 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6929 if (sortval
->type
== REDIS_LIST
) {
6930 list
*list
= sortval
->ptr
;
6934 listRewind(list
,&li
);
6935 while((ln
= listNext(&li
))) {
6936 robj
*ele
= ln
->value
;
6937 vector
[j
].obj
= ele
;
6938 vector
[j
].u
.score
= 0;
6939 vector
[j
].u
.cmpobj
= NULL
;
6947 if (sortval
->type
== REDIS_SET
) {
6950 zset
*zs
= sortval
->ptr
;
6954 di
= dictGetIterator(set
);
6955 while((setele
= dictNext(di
)) != NULL
) {
6956 vector
[j
].obj
= dictGetEntryKey(setele
);
6957 vector
[j
].u
.score
= 0;
6958 vector
[j
].u
.cmpobj
= NULL
;
6961 dictReleaseIterator(di
);
6963 redisAssert(j
== vectorlen
);
6965 /* Now it's time to load the right scores in the sorting vector */
6966 if (dontsort
== 0) {
6967 for (j
= 0; j
< vectorlen
; j
++) {
6970 /* lookup value to sort by */
6971 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6972 if (!byval
) continue;
6974 /* use object itself to sort by */
6975 byval
= vector
[j
].obj
;
6979 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6981 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6982 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6983 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6984 /* Don't need to decode the object if it's
6985 * integer-encoded (the only encoding supported) so
6986 * far. We can just cast it */
6987 vector
[j
].u
.score
= (long)byval
->ptr
;
6989 redisAssert(1 != 1);
6993 /* when the object was retrieved using lookupKeyByPattern,
6994 * its refcount needs to be decreased. */
6996 decrRefCount(byval
);
7001 /* We are ready to sort the vector... perform a bit of sanity check
7002 * on the LIMIT option too. We'll use a partial version of quicksort. */
7003 start
= (limit_start
< 0) ? 0 : limit_start
;
7004 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7005 if (start
>= vectorlen
) {
7006 start
= vectorlen
-1;
7009 if (end
>= vectorlen
) end
= vectorlen
-1;
7011 if (dontsort
== 0) {
7012 server
.sort_desc
= desc
;
7013 server
.sort_alpha
= alpha
;
7014 server
.sort_bypattern
= sortby
? 1 : 0;
7015 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7016 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7018 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7021 /* Send command output to the output buffer, performing the specified
7022 * GET/DEL/INCR/DECR operations if any. */
7023 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7024 if (storekey
== NULL
) {
7025 /* STORE option not specified, sent the sorting result to client */
7026 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7027 for (j
= start
; j
<= end
; j
++) {
7031 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7032 listRewind(operations
,&li
);
7033 while((ln
= listNext(&li
))) {
7034 redisSortOperation
*sop
= ln
->value
;
7035 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7038 if (sop
->type
== REDIS_SORT_GET
) {
7040 addReply(c
,shared
.nullbulk
);
7042 addReplyBulk(c
,val
);
7046 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7051 robj
*listObject
= createListObject();
7052 list
*listPtr
= (list
*) listObject
->ptr
;
7054 /* STORE option specified, set the sorting result as a List object */
7055 for (j
= start
; j
<= end
; j
++) {
7060 listAddNodeTail(listPtr
,vector
[j
].obj
);
7061 incrRefCount(vector
[j
].obj
);
7063 listRewind(operations
,&li
);
7064 while((ln
= listNext(&li
))) {
7065 redisSortOperation
*sop
= ln
->value
;
7066 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7069 if (sop
->type
== REDIS_SORT_GET
) {
7071 listAddNodeTail(listPtr
,createStringObject("",0));
7073 /* We should do a incrRefCount on val because it is
7074 * added to the list, but also a decrRefCount because
7075 * it is returned by lookupKeyByPattern. This results
7076 * in doing nothing at all. */
7077 listAddNodeTail(listPtr
,val
);
7080 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7084 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7085 incrRefCount(storekey
);
7087 /* Note: we add 1 because the DB is dirty anyway since even if the
7088 * SORT result is empty a new key is set and maybe the old content
7090 server
.dirty
+= 1+outputlen
;
7091 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7095 decrRefCount(sortval
);
7096 listRelease(operations
);
7097 for (j
= 0; j
< vectorlen
; j
++) {
7098 if (alpha
&& vector
[j
].u
.cmpobj
)
7099 decrRefCount(vector
[j
].u
.cmpobj
);
7104 /* Convert an amount of bytes into a human readable string in the form
7105 * of 100B, 2G, 100M, 4K, and so forth. */
7106 static void bytesToHuman(char *s
, unsigned long long n
) {
7111 sprintf(s
,"%lluB",n
);
7113 } else if (n
< (1024*1024)) {
7114 d
= (double)n
/(1024);
7115 sprintf(s
,"%.2fK",d
);
7116 } else if (n
< (1024LL*1024*1024)) {
7117 d
= (double)n
/(1024*1024);
7118 sprintf(s
,"%.2fM",d
);
7119 } else if (n
< (1024LL*1024*1024*1024)) {
7120 d
= (double)n
/(1024LL*1024*1024);
7121 sprintf(s
,"%.2fG",d
);
7125 /* Create the string returned by the INFO command. This is decoupled
7126 * by the INFO command itself as we need to report the same information
7127 * on memory corruption problems. */
7128 static sds
genRedisInfoString(void) {
7130 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7134 bytesToHuman(hmem
,zmalloc_used_memory());
7135 info
= sdscatprintf(sdsempty(),
7136 "redis_version:%s\r\n"
7138 "multiplexing_api:%s\r\n"
7139 "process_id:%ld\r\n"
7140 "uptime_in_seconds:%ld\r\n"
7141 "uptime_in_days:%ld\r\n"
7142 "connected_clients:%d\r\n"
7143 "connected_slaves:%d\r\n"
7144 "blocked_clients:%d\r\n"
7145 "used_memory:%zu\r\n"
7146 "used_memory_human:%s\r\n"
7147 "changes_since_last_save:%lld\r\n"
7148 "bgsave_in_progress:%d\r\n"
7149 "last_save_time:%ld\r\n"
7150 "bgrewriteaof_in_progress:%d\r\n"
7151 "total_connections_received:%lld\r\n"
7152 "total_commands_processed:%lld\r\n"
7153 "expired_keys:%lld\r\n"
7154 "hash_max_zipmap_entries:%ld\r\n"
7155 "hash_max_zipmap_value:%ld\r\n"
7156 "pubsub_channels:%ld\r\n"
7157 "pubsub_patterns:%u\r\n"
7161 (sizeof(long) == 8) ? "64" : "32",
7166 listLength(server
.clients
)-listLength(server
.slaves
),
7167 listLength(server
.slaves
),
7168 server
.blpop_blocked_clients
,
7169 zmalloc_used_memory(),
7172 server
.bgsavechildpid
!= -1,
7174 server
.bgrewritechildpid
!= -1,
7175 server
.stat_numconnections
,
7176 server
.stat_numcommands
,
7177 server
.stat_expiredkeys
,
7178 server
.hash_max_zipmap_entries
,
7179 server
.hash_max_zipmap_value
,
7180 dictSize(server
.pubsub_channels
),
7181 listLength(server
.pubsub_patterns
),
7182 server
.vm_enabled
!= 0,
7183 server
.masterhost
== NULL
? "master" : "slave"
7185 if (server
.masterhost
) {
7186 info
= sdscatprintf(info
,
7187 "master_host:%s\r\n"
7188 "master_port:%d\r\n"
7189 "master_link_status:%s\r\n"
7190 "master_last_io_seconds_ago:%d\r\n"
7193 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7195 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7198 if (server
.vm_enabled
) {
7200 info
= sdscatprintf(info
,
7201 "vm_conf_max_memory:%llu\r\n"
7202 "vm_conf_page_size:%llu\r\n"
7203 "vm_conf_pages:%llu\r\n"
7204 "vm_stats_used_pages:%llu\r\n"
7205 "vm_stats_swapped_objects:%llu\r\n"
7206 "vm_stats_swappin_count:%llu\r\n"
7207 "vm_stats_swappout_count:%llu\r\n"
7208 "vm_stats_io_newjobs_len:%lu\r\n"
7209 "vm_stats_io_processing_len:%lu\r\n"
7210 "vm_stats_io_processed_len:%lu\r\n"
7211 "vm_stats_io_active_threads:%lu\r\n"
7212 "vm_stats_blocked_clients:%lu\r\n"
7213 ,(unsigned long long) server
.vm_max_memory
,
7214 (unsigned long long) server
.vm_page_size
,
7215 (unsigned long long) server
.vm_pages
,
7216 (unsigned long long) server
.vm_stats_used_pages
,
7217 (unsigned long long) server
.vm_stats_swapped_objects
,
7218 (unsigned long long) server
.vm_stats_swapins
,
7219 (unsigned long long) server
.vm_stats_swapouts
,
7220 (unsigned long) listLength(server
.io_newjobs
),
7221 (unsigned long) listLength(server
.io_processing
),
7222 (unsigned long) listLength(server
.io_processed
),
7223 (unsigned long) server
.io_active_threads
,
7224 (unsigned long) server
.vm_blocked_clients
7228 for (j
= 0; j
< server
.dbnum
; j
++) {
7229 long long keys
, vkeys
;
7231 keys
= dictSize(server
.db
[j
].dict
);
7232 vkeys
= dictSize(server
.db
[j
].expires
);
7233 if (keys
|| vkeys
) {
7234 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7241 static void infoCommand(redisClient
*c
) {
7242 sds info
= genRedisInfoString();
7243 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7244 (unsigned long)sdslen(info
)));
7245 addReplySds(c
,info
);
7246 addReply(c
,shared
.crlf
);
7249 static void monitorCommand(redisClient
*c
) {
7250 /* ignore MONITOR if aleady slave or in monitor mode */
7251 if (c
->flags
& REDIS_SLAVE
) return;
7253 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7255 listAddNodeTail(server
.monitors
,c
);
7256 addReply(c
,shared
.ok
);
7259 /* ================================= Expire ================================= */
7260 static int removeExpire(redisDb
*db
, robj
*key
) {
7261 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7268 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7269 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7277 /* Return the expire time of the specified key, or -1 if no expire
7278 * is associated with this key (i.e. the key is non volatile) */
7279 static time_t getExpire(redisDb
*db
, robj
*key
) {
7282 /* No expire? return ASAP */
7283 if (dictSize(db
->expires
) == 0 ||
7284 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7286 return (time_t) dictGetEntryVal(de
);
7289 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7293 /* No expire? return ASAP */
7294 if (dictSize(db
->expires
) == 0 ||
7295 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7297 /* Lookup the expire */
7298 when
= (time_t) dictGetEntryVal(de
);
7299 if (time(NULL
) <= when
) return 0;
7301 /* Delete the key */
7302 dictDelete(db
->expires
,key
);
7303 server
.stat_expiredkeys
++;
7304 return dictDelete(db
->dict
,key
) == DICT_OK
;
7307 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7310 /* No expire? return ASAP */
7311 if (dictSize(db
->expires
) == 0 ||
7312 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7314 /* Delete the key */
7316 server
.stat_expiredkeys
++;
7317 dictDelete(db
->expires
,key
);
7318 return dictDelete(db
->dict
,key
) == DICT_OK
;
7321 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7325 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7329 de
= dictFind(c
->db
->dict
,key
);
7331 addReply(c
,shared
.czero
);
7335 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7336 addReply(c
, shared
.cone
);
7339 time_t when
= time(NULL
)+seconds
;
7340 if (setExpire(c
->db
,key
,when
)) {
7341 addReply(c
,shared
.cone
);
7344 addReply(c
,shared
.czero
);
7350 static void expireCommand(redisClient
*c
) {
7351 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7354 static void expireatCommand(redisClient
*c
) {
7355 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7358 static void ttlCommand(redisClient
*c
) {
7362 expire
= getExpire(c
->db
,c
->argv
[1]);
7364 ttl
= (int) (expire
-time(NULL
));
7365 if (ttl
< 0) ttl
= -1;
7367 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7370 /* ================================ MULTI/EXEC ============================== */
7372 /* Client state initialization for MULTI/EXEC */
7373 static void initClientMultiState(redisClient
*c
) {
7374 c
->mstate
.commands
= NULL
;
7375 c
->mstate
.count
= 0;
7378 /* Release all the resources associated with MULTI/EXEC state */
7379 static void freeClientMultiState(redisClient
*c
) {
7382 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7384 multiCmd
*mc
= c
->mstate
.commands
+j
;
7386 for (i
= 0; i
< mc
->argc
; i
++)
7387 decrRefCount(mc
->argv
[i
]);
7390 zfree(c
->mstate
.commands
);
7393 /* Add a new command into the MULTI commands queue */
7394 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7398 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7399 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7400 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7403 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7404 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7405 for (j
= 0; j
< c
->argc
; j
++)
7406 incrRefCount(mc
->argv
[j
]);
7410 static void multiCommand(redisClient
*c
) {
7411 c
->flags
|= REDIS_MULTI
;
7412 addReply(c
,shared
.ok
);
7415 static void discardCommand(redisClient
*c
) {
7416 if (!(c
->flags
& REDIS_MULTI
)) {
7417 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7421 freeClientMultiState(c
);
7422 initClientMultiState(c
);
7423 c
->flags
&= (~REDIS_MULTI
);
7424 addReply(c
,shared
.ok
);
7427 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7428 * implememntation for more information. */
7429 static void execCommandReplicateMulti(redisClient
*c
) {
7430 struct redisCommand
*cmd
;
7431 robj
*multistring
= createStringObject("MULTI",5);
7433 cmd
= lookupCommand("multi");
7434 if (server
.appendonly
)
7435 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7436 if (listLength(server
.slaves
))
7437 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7438 decrRefCount(multistring
);
7441 static void execCommand(redisClient
*c
) {
7446 if (!(c
->flags
& REDIS_MULTI
)) {
7447 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7451 /* Replicate a MULTI request now that we are sure the block is executed.
7452 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7453 * both the AOF and the replication link will have the same consistency
7454 * and atomicity guarantees. */
7455 execCommandReplicateMulti(c
);
7457 /* Exec all the queued commands */
7458 orig_argv
= c
->argv
;
7459 orig_argc
= c
->argc
;
7460 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7461 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7462 c
->argc
= c
->mstate
.commands
[j
].argc
;
7463 c
->argv
= c
->mstate
.commands
[j
].argv
;
7464 call(c
,c
->mstate
.commands
[j
].cmd
);
7466 c
->argv
= orig_argv
;
7467 c
->argc
= orig_argc
;
7468 freeClientMultiState(c
);
7469 initClientMultiState(c
);
7470 c
->flags
&= (~REDIS_MULTI
);
7471 /* Make sure the EXEC command is always replicated / AOF, since we
7472 * always send the MULTI command (we can't know beforehand if the
7473 * next operations will contain at least a modification to the DB). */
7477 /* =========================== Blocking Operations ========================= */
7479 /* Currently Redis blocking operations support is limited to list POP ops,
7480 * so the current implementation is not fully generic, but it is also not
7481 * completely specific so it will not require a rewrite to support new
7482 * kind of blocking operations in the future.
7484 * Still it's important to note that list blocking operations can be already
7485 * used as a notification mechanism in order to implement other blocking
7486 * operations at application level, so there must be a very strong evidence
7487 * of usefulness and generality before new blocking operations are implemented.
7489 * This is how the current blocking POP works, we use BLPOP as example:
7490 * - If the user calls BLPOP and the key exists and contains a non empty list
7491 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7492 * if there is not to block.
7493 * - If instead BLPOP is called and the key does not exists or the list is
7494 * empty we need to block. In order to do so we remove the notification for
7495 * new data to read in the client socket (so that we'll not serve new
7496 * requests if the blocking request is not served). Also we put the client
7497 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7498 * blocking for this keys.
7499 * - If a PUSH operation against a key with blocked clients waiting is
7500 * performed, we serve the first in the list: basically instead to push
7501 * the new element inside the list we return it to the (first / oldest)
7502 * blocking client, unblock the client, and remove it form the list.
7504 * The above comment and the source code should be enough in order to understand
7505 * the implementation and modify / fix it later.
7508 /* Set a client in blocking mode for the specified key, with the specified
7510 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7515 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7516 c
->blockingkeysnum
= numkeys
;
7517 c
->blockingto
= timeout
;
7518 for (j
= 0; j
< numkeys
; j
++) {
7519 /* Add the key in the client structure, to map clients -> keys */
7520 c
->blockingkeys
[j
] = keys
[j
];
7521 incrRefCount(keys
[j
]);
7523 /* And in the other "side", to map keys -> clients */
7524 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7528 /* For every key we take a list of clients blocked for it */
7530 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7531 incrRefCount(keys
[j
]);
7532 assert(retval
== DICT_OK
);
7534 l
= dictGetEntryVal(de
);
7536 listAddNodeTail(l
,c
);
7538 /* Mark the client as a blocked client */
7539 c
->flags
|= REDIS_BLOCKED
;
7540 server
.blpop_blocked_clients
++;
7543 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7544 static void unblockClientWaitingData(redisClient
*c
) {
7549 assert(c
->blockingkeys
!= NULL
);
7550 /* The client may wait for multiple keys, so unblock it for every key. */
7551 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7552 /* Remove this client from the list of clients waiting for this key. */
7553 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7555 l
= dictGetEntryVal(de
);
7556 listDelNode(l
,listSearchKey(l
,c
));
7557 /* If the list is empty we need to remove it to avoid wasting memory */
7558 if (listLength(l
) == 0)
7559 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7560 decrRefCount(c
->blockingkeys
[j
]);
7562 /* Cleanup the client structure */
7563 zfree(c
->blockingkeys
);
7564 c
->blockingkeys
= NULL
;
7565 c
->flags
&= (~REDIS_BLOCKED
);
7566 server
.blpop_blocked_clients
--;
7567 /* We want to process data if there is some command waiting
7568 * in the input buffer. Note that this is safe even if
7569 * unblockClientWaitingData() gets called from freeClient() because
7570 * freeClient() will be smart enough to call this function
7571 * *after* c->querybuf was set to NULL. */
7572 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7575 /* This should be called from any function PUSHing into lists.
7576 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7577 * 'ele' is the element pushed.
7579 * If the function returns 0 there was no client waiting for a list push
7582 * If the function returns 1 there was a client waiting for a list push
7583 * against this key, the element was passed to this client thus it's not
7584 * needed to actually add it to the list and the caller should return asap. */
7585 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7586 struct dictEntry
*de
;
7587 redisClient
*receiver
;
7591 de
= dictFind(c
->db
->blockingkeys
,key
);
7592 if (de
== NULL
) return 0;
7593 l
= dictGetEntryVal(de
);
7596 receiver
= ln
->value
;
7598 addReplySds(receiver
,sdsnew("*2\r\n"));
7599 addReplyBulk(receiver
,key
);
7600 addReplyBulk(receiver
,ele
);
7601 unblockClientWaitingData(receiver
);
7605 /* Blocking RPOP/LPOP */
7606 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7611 for (j
= 1; j
< c
->argc
-1; j
++) {
7612 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7614 if (o
->type
!= REDIS_LIST
) {
7615 addReply(c
,shared
.wrongtypeerr
);
7618 list
*list
= o
->ptr
;
7619 if (listLength(list
) != 0) {
7620 /* If the list contains elements fall back to the usual
7621 * non-blocking POP operation */
7622 robj
*argv
[2], **orig_argv
;
7625 /* We need to alter the command arguments before to call
7626 * popGenericCommand() as the command takes a single key. */
7627 orig_argv
= c
->argv
;
7628 orig_argc
= c
->argc
;
7629 argv
[1] = c
->argv
[j
];
7633 /* Also the return value is different, we need to output
7634 * the multi bulk reply header and the key name. The
7635 * "real" command will add the last element (the value)
7636 * for us. If this souds like an hack to you it's just
7637 * because it is... */
7638 addReplySds(c
,sdsnew("*2\r\n"));
7639 addReplyBulk(c
,argv
[1]);
7640 popGenericCommand(c
,where
);
7642 /* Fix the client structure with the original stuff */
7643 c
->argv
= orig_argv
;
7644 c
->argc
= orig_argc
;
7650 /* If the list is empty or the key does not exists we must block */
7651 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7652 if (timeout
> 0) timeout
+= time(NULL
);
7653 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7656 static void blpopCommand(redisClient
*c
) {
7657 blockingPopGenericCommand(c
,REDIS_HEAD
);
7660 static void brpopCommand(redisClient
*c
) {
7661 blockingPopGenericCommand(c
,REDIS_TAIL
);
7664 /* =============================== Replication ============================= */
7666 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7667 ssize_t nwritten
, ret
= size
;
7668 time_t start
= time(NULL
);
7672 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7673 nwritten
= write(fd
,ptr
,size
);
7674 if (nwritten
== -1) return -1;
7678 if ((time(NULL
)-start
) > timeout
) {
7686 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7687 ssize_t nread
, totread
= 0;
7688 time_t start
= time(NULL
);
7692 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7693 nread
= read(fd
,ptr
,size
);
7694 if (nread
== -1) return -1;
7699 if ((time(NULL
)-start
) > timeout
) {
7707 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7714 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7717 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7728 static void syncCommand(redisClient
*c
) {
7729 /* ignore SYNC if aleady slave or in monitor mode */
7730 if (c
->flags
& REDIS_SLAVE
) return;
7732 /* SYNC can't be issued when the server has pending data to send to
7733 * the client about already issued commands. We need a fresh reply
7734 * buffer registering the differences between the BGSAVE and the current
7735 * dataset, so that we can copy to other slaves if needed. */
7736 if (listLength(c
->reply
) != 0) {
7737 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7741 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7742 /* Here we need to check if there is a background saving operation
7743 * in progress, or if it is required to start one */
7744 if (server
.bgsavechildpid
!= -1) {
7745 /* Ok a background save is in progress. Let's check if it is a good
7746 * one for replication, i.e. if there is another slave that is
7747 * registering differences since the server forked to save */
7752 listRewind(server
.slaves
,&li
);
7753 while((ln
= listNext(&li
))) {
7755 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7758 /* Perfect, the server is already registering differences for
7759 * another slave. Set the right state, and copy the buffer. */
7760 listRelease(c
->reply
);
7761 c
->reply
= listDup(slave
->reply
);
7762 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7763 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7765 /* No way, we need to wait for the next BGSAVE in order to
7766 * register differences */
7767 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7768 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7771 /* Ok we don't have a BGSAVE in progress, let's start one */
7772 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7773 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7774 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7775 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7778 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7781 c
->flags
|= REDIS_SLAVE
;
7783 listAddNodeTail(server
.slaves
,c
);
7787 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7788 redisClient
*slave
= privdata
;
7790 REDIS_NOTUSED(mask
);
7791 char buf
[REDIS_IOBUF_LEN
];
7792 ssize_t nwritten
, buflen
;
7794 if (slave
->repldboff
== 0) {
7795 /* Write the bulk write count before to transfer the DB. In theory here
7796 * we don't know how much room there is in the output buffer of the
7797 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7798 * operations) will never be smaller than the few bytes we need. */
7801 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7803 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7811 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7812 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7814 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7815 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7819 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7820 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7825 slave
->repldboff
+= nwritten
;
7826 if (slave
->repldboff
== slave
->repldbsize
) {
7827 close(slave
->repldbfd
);
7828 slave
->repldbfd
= -1;
7829 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7830 slave
->replstate
= REDIS_REPL_ONLINE
;
7831 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7832 sendReplyToClient
, slave
) == AE_ERR
) {
7836 addReplySds(slave
,sdsempty());
7837 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7841 /* This function is called at the end of every backgrond saving.
7842 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7843 * otherwise REDIS_ERR is passed to the function.
7845 * The goal of this function is to handle slaves waiting for a successful
7846 * background saving in order to perform non-blocking synchronization. */
7847 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7849 int startbgsave
= 0;
7852 listRewind(server
.slaves
,&li
);
7853 while((ln
= listNext(&li
))) {
7854 redisClient
*slave
= ln
->value
;
7856 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7858 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7859 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7860 struct redis_stat buf
;
7862 if (bgsaveerr
!= REDIS_OK
) {
7864 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7867 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7868 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7870 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7873 slave
->repldboff
= 0;
7874 slave
->repldbsize
= buf
.st_size
;
7875 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7876 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7877 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7884 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7887 listRewind(server
.slaves
,&li
);
7888 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7889 while((ln
= listNext(&li
))) {
7890 redisClient
*slave
= ln
->value
;
7892 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7899 static int syncWithMaster(void) {
7900 char buf
[1024], tmpfile
[256], authcmd
[1024];
7902 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7903 int dfd
, maxtries
= 5;
7906 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7911 /* AUTH with the master if required. */
7912 if(server
.masterauth
) {
7913 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7914 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7916 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7920 /* Read the AUTH result. */
7921 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7923 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7927 if (buf
[0] != '+') {
7929 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7934 /* Issue the SYNC command */
7935 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7937 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7941 /* Read the bulk write count */
7942 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7944 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7948 if (buf
[0] != '$') {
7950 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7953 dumpsize
= strtol(buf
+1,NULL
,10);
7954 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7955 /* Read the bulk write data on a temp file */
7957 snprintf(tmpfile
,256,
7958 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7959 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7960 if (dfd
!= -1) break;
7965 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7969 int nread
, nwritten
;
7971 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7973 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7979 nwritten
= write(dfd
,buf
,nread
);
7980 if (nwritten
== -1) {
7981 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7989 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7990 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7996 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7997 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8001 server
.master
= createClient(fd
);
8002 server
.master
->flags
|= REDIS_MASTER
;
8003 server
.master
->authenticated
= 1;
8004 server
.replstate
= REDIS_REPL_CONNECTED
;
8008 static void slaveofCommand(redisClient
*c
) {
8009 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8010 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8011 if (server
.masterhost
) {
8012 sdsfree(server
.masterhost
);
8013 server
.masterhost
= NULL
;
8014 if (server
.master
) freeClient(server
.master
);
8015 server
.replstate
= REDIS_REPL_NONE
;
8016 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8019 sdsfree(server
.masterhost
);
8020 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8021 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8022 if (server
.master
) freeClient(server
.master
);
8023 server
.replstate
= REDIS_REPL_CONNECT
;
8024 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8025 server
.masterhost
, server
.masterport
);
8027 addReply(c
,shared
.ok
);
8030 /* ============================ Maxmemory directive ======================== */
8032 /* Try to free one object form the pre-allocated objects free list.
8033 * This is useful under low mem conditions as by default we take 1 million
8034 * free objects allocated. On success REDIS_OK is returned, otherwise
8036 static int tryFreeOneObjectFromFreelist(void) {
8039 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8040 if (listLength(server
.objfreelist
)) {
8041 listNode
*head
= listFirst(server
.objfreelist
);
8042 o
= listNodeValue(head
);
8043 listDelNode(server
.objfreelist
,head
);
8044 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8048 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8053 /* This function gets called when 'maxmemory' is set on the config file to limit
8054 * the max memory used by the server, and we are out of memory.
8055 * This function will try to, in order:
8057 * - Free objects from the free list
8058 * - Try to remove keys with an EXPIRE set
8060 * It is not possible to free enough memory to reach used-memory < maxmemory
8061 * the server will start refusing commands that will enlarge even more the
8064 static void freeMemoryIfNeeded(void) {
8065 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8066 int j
, k
, freed
= 0;
8068 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8069 for (j
= 0; j
< server
.dbnum
; j
++) {
8071 robj
*minkey
= NULL
;
8072 struct dictEntry
*de
;
8074 if (dictSize(server
.db
[j
].expires
)) {
8076 /* From a sample of three keys drop the one nearest to
8077 * the natural expire */
8078 for (k
= 0; k
< 3; k
++) {
8081 de
= dictGetRandomKey(server
.db
[j
].expires
);
8082 t
= (time_t) dictGetEntryVal(de
);
8083 if (minttl
== -1 || t
< minttl
) {
8084 minkey
= dictGetEntryKey(de
);
8088 deleteKey(server
.db
+j
,minkey
);
8091 if (!freed
) return; /* nothing to free... */
8095 /* ============================== Append Only file ========================== */
8097 /* Write the append only file buffer on disk.
8099 * Since we are required to write the AOF before replying to the client,
8100 * and the only way the client socket can get a write is entering when the
8101 * the event loop, we accumulate all the AOF writes in a memory
8102 * buffer and write it on disk using this function just before entering
8103 * the event loop again. */
8104 static void flushAppendOnlyFile(void) {
8108 if (sdslen(server
.aofbuf
) == 0) return;
8110 /* We want to perform a single write. This should be guaranteed atomic
8111 * at least if the filesystem we are writing is a real physical one.
8112 * While this will save us against the server being killed I don't think
8113 * there is much to do about the whole server stopping for power problems
8115 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8116 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8117 /* Ooops, we are in troubles. The best thing to do for now is
8118 * aborting instead of giving the illusion that everything is
8119 * working as expected. */
8120 if (nwritten
== -1) {
8121 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8123 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8127 sdsfree(server
.aofbuf
);
8128 server
.aofbuf
= sdsempty();
8130 /* Fsync if needed */
8132 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8133 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8134 now
-server
.lastfsync
> 1))
8136 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8137 * flushing metadata. */
8138 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8139 server
.lastfsync
= now
;
8143 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8144 sds buf
= sdsempty();
8148 /* The DB this command was targetting is not the same as the last command
8149 * we appendend. To issue a SELECT command is needed. */
8150 if (dictid
!= server
.appendseldb
) {
8153 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8154 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8155 (unsigned long)strlen(seldb
),seldb
);
8156 server
.appendseldb
= dictid
;
8159 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8160 * EXPIREs into EXPIREATs calls */
8161 if (cmd
->proc
== expireCommand
) {
8164 tmpargv
[0] = createStringObject("EXPIREAT",8);
8165 tmpargv
[1] = argv
[1];
8166 incrRefCount(argv
[1]);
8167 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8168 tmpargv
[2] = createObject(REDIS_STRING
,
8169 sdscatprintf(sdsempty(),"%ld",when
));
8173 /* Append the actual command */
8174 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8175 for (j
= 0; j
< argc
; j
++) {
8178 o
= getDecodedObject(o
);
8179 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8180 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8181 buf
= sdscatlen(buf
,"\r\n",2);
8185 /* Free the objects from the modified argv for EXPIREAT */
8186 if (cmd
->proc
== expireCommand
) {
8187 for (j
= 0; j
< 3; j
++)
8188 decrRefCount(argv
[j
]);
8191 /* Append to the AOF buffer. This will be flushed on disk just before
8192 * of re-entering the event loop, so before the client will get a
8193 * positive reply about the operation performed. */
8194 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8196 /* If a background append only file rewriting is in progress we want to
8197 * accumulate the differences between the child DB and the current one
8198 * in a buffer, so that when the child process will do its work we
8199 * can append the differences to the new append only file. */
8200 if (server
.bgrewritechildpid
!= -1)
8201 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8206 /* In Redis commands are always executed in the context of a client, so in
8207 * order to load the append only file we need to create a fake client. */
8208 static struct redisClient
*createFakeClient(void) {
8209 struct redisClient
*c
= zmalloc(sizeof(*c
));
8213 c
->querybuf
= sdsempty();
8217 /* We set the fake client as a slave waiting for the synchronization
8218 * so that Redis will not try to send replies to this client. */
8219 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8220 c
->reply
= listCreate();
8221 listSetFreeMethod(c
->reply
,decrRefCount
);
8222 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8223 initClientMultiState(c
);
8227 static void freeFakeClient(struct redisClient
*c
) {
8228 sdsfree(c
->querybuf
);
8229 listRelease(c
->reply
);
8230 freeClientMultiState(c
);
8234 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8235 * error (the append only file is zero-length) REDIS_ERR is returned. On
8236 * fatal error an error message is logged and the program exists. */
8237 int loadAppendOnlyFile(char *filename
) {
8238 struct redisClient
*fakeClient
;
8239 FILE *fp
= fopen(filename
,"r");
8240 struct redis_stat sb
;
8241 unsigned long long loadedkeys
= 0;
8242 int appendonly
= server
.appendonly
;
8244 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8248 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8252 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8253 * to the same file we're about to read. */
8254 server
.appendonly
= 0;
8256 fakeClient
= createFakeClient();
8263 struct redisCommand
*cmd
;
8265 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8271 if (buf
[0] != '*') goto fmterr
;
8273 argv
= zmalloc(sizeof(robj
*)*argc
);
8274 for (j
= 0; j
< argc
; j
++) {
8275 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8276 if (buf
[0] != '$') goto fmterr
;
8277 len
= strtol(buf
+1,NULL
,10);
8278 argsds
= sdsnewlen(NULL
,len
);
8279 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8280 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8281 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8284 /* Command lookup */
8285 cmd
= lookupCommand(argv
[0]->ptr
);
8287 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8290 /* Try object encoding */
8291 if (cmd
->flags
& REDIS_CMD_BULK
)
8292 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8293 /* Run the command in the context of a fake client */
8294 fakeClient
->argc
= argc
;
8295 fakeClient
->argv
= argv
;
8296 cmd
->proc(fakeClient
);
8297 /* Discard the reply objects list from the fake client */
8298 while(listLength(fakeClient
->reply
))
8299 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8300 /* Clean up, ready for the next command */
8301 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8303 /* Handle swapping while loading big datasets when VM is on */
8305 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8306 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8307 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8312 /* This point can only be reached when EOF is reached without errors.
8313 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8314 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8317 freeFakeClient(fakeClient
);
8318 server
.appendonly
= appendonly
;
8323 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8325 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8329 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8333 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8334 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8338 /* Avoid the incr/decr ref count business if possible to help
8339 * copy-on-write (we are often in a child process when this function
8341 * Also makes sure that key objects don't get incrRefCount-ed when VM
8343 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8344 obj
= getDecodedObject(obj
);
8347 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8348 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8349 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8351 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8352 if (decrrc
) decrRefCount(obj
);
8355 if (decrrc
) decrRefCount(obj
);
8359 /* Write binary-safe string into a file in the bulkformat
8360 * $<count>\r\n<payload>\r\n */
8361 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8364 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8365 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8366 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8367 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8371 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8372 static int fwriteBulkDouble(FILE *fp
, double d
) {
8373 char buf
[128], dbuf
[128];
8375 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8376 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8377 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8378 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8382 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8383 static int fwriteBulkLong(FILE *fp
, long l
) {
8384 char buf
[128], lbuf
[128];
8386 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8387 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8388 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8389 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8393 /* Write a sequence of commands able to fully rebuild the dataset into
8394 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8395 static int rewriteAppendOnlyFile(char *filename
) {
8396 dictIterator
*di
= NULL
;
8401 time_t now
= time(NULL
);
8403 /* Note that we have to use a different temp name here compared to the
8404 * one used by rewriteAppendOnlyFileBackground() function. */
8405 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8406 fp
= fopen(tmpfile
,"w");
8408 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8411 for (j
= 0; j
< server
.dbnum
; j
++) {
8412 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8413 redisDb
*db
= server
.db
+j
;
8415 if (dictSize(d
) == 0) continue;
8416 di
= dictGetIterator(d
);
8422 /* SELECT the new DB */
8423 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8424 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8426 /* Iterate this DB writing every entry */
8427 while((de
= dictNext(di
)) != NULL
) {
8432 key
= dictGetEntryKey(de
);
8433 /* If the value for this key is swapped, load a preview in memory.
8434 * We use a "swapped" flag to remember if we need to free the
8435 * value object instead to just increment the ref count anyway
8436 * in order to avoid copy-on-write of pages if we are forked() */
8437 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8438 key
->storage
== REDIS_VM_SWAPPING
) {
8439 o
= dictGetEntryVal(de
);
8442 o
= vmPreviewObject(key
);
8445 expiretime
= getExpire(db
,key
);
8447 /* Save the key and associated value */
8448 if (o
->type
== REDIS_STRING
) {
8449 /* Emit a SET command */
8450 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8451 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8453 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8454 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8455 } else if (o
->type
== REDIS_LIST
) {
8456 /* Emit the RPUSHes needed to rebuild the list */
8457 list
*list
= o
->ptr
;
8461 listRewind(list
,&li
);
8462 while((ln
= listNext(&li
))) {
8463 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8464 robj
*eleobj
= listNodeValue(ln
);
8466 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8467 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8468 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8470 } else if (o
->type
== REDIS_SET
) {
8471 /* Emit the SADDs needed to rebuild the set */
8473 dictIterator
*di
= dictGetIterator(set
);
8476 while((de
= dictNext(di
)) != NULL
) {
8477 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8478 robj
*eleobj
= dictGetEntryKey(de
);
8480 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8481 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8482 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8484 dictReleaseIterator(di
);
8485 } else if (o
->type
== REDIS_ZSET
) {
8486 /* Emit the ZADDs needed to rebuild the sorted set */
8488 dictIterator
*di
= dictGetIterator(zs
->dict
);
8491 while((de
= dictNext(di
)) != NULL
) {
8492 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8493 robj
*eleobj
= dictGetEntryKey(de
);
8494 double *score
= dictGetEntryVal(de
);
8496 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8497 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8498 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8499 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8501 dictReleaseIterator(di
);
8502 } else if (o
->type
== REDIS_HASH
) {
8503 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8505 /* Emit the HSETs needed to rebuild the hash */
8506 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8507 unsigned char *p
= zipmapRewind(o
->ptr
);
8508 unsigned char *field
, *val
;
8509 unsigned int flen
, vlen
;
8511 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8512 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8513 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8514 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8516 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8520 dictIterator
*di
= dictGetIterator(o
->ptr
);
8523 while((de
= dictNext(di
)) != NULL
) {
8524 robj
*field
= dictGetEntryKey(de
);
8525 robj
*val
= dictGetEntryVal(de
);
8527 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8528 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8529 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8530 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8532 dictReleaseIterator(di
);
8535 redisPanic("Unknown object type");
8537 /* Save the expire time */
8538 if (expiretime
!= -1) {
8539 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8540 /* If this key is already expired skip it */
8541 if (expiretime
< now
) continue;
8542 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8543 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8544 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8546 if (swapped
) decrRefCount(o
);
8548 dictReleaseIterator(di
);
8551 /* Make sure data will not remain on the OS's output buffers */
8556 /* Use RENAME to make sure the DB file is changed atomically only
8557 * if the generate DB file is ok. */
8558 if (rename(tmpfile
,filename
) == -1) {
8559 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8563 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8569 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8570 if (di
) dictReleaseIterator(di
);
8574 /* This is how rewriting of the append only file in background works:
8576 * 1) The user calls BGREWRITEAOF
8577 * 2) Redis calls this function, that forks():
8578 * 2a) the child rewrite the append only file in a temp file.
8579 * 2b) the parent accumulates differences in server.bgrewritebuf.
8580 * 3) When the child finished '2a' exists.
8581 * 4) The parent will trap the exit code, if it's OK, will append the
8582 * data accumulated into server.bgrewritebuf into the temp file, and
8583 * finally will rename(2) the temp file in the actual file name.
8584 * The the new file is reopened as the new append only file. Profit!
8586 static int rewriteAppendOnlyFileBackground(void) {
8589 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8590 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8591 if ((childpid
= fork()) == 0) {
8595 if (server
.vm_enabled
) vmReopenSwapFile();
8597 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8598 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8605 if (childpid
== -1) {
8606 redisLog(REDIS_WARNING
,
8607 "Can't rewrite append only file in background: fork: %s",
8611 redisLog(REDIS_NOTICE
,
8612 "Background append only file rewriting started by pid %d",childpid
);
8613 server
.bgrewritechildpid
= childpid
;
8614 updateDictResizePolicy();
8615 /* We set appendseldb to -1 in order to force the next call to the
8616 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8617 * accumulated by the parent into server.bgrewritebuf will start
8618 * with a SELECT statement and it will be safe to merge. */
8619 server
.appendseldb
= -1;
8622 return REDIS_OK
; /* unreached */
8625 static void bgrewriteaofCommand(redisClient
*c
) {
8626 if (server
.bgrewritechildpid
!= -1) {
8627 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8630 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8631 char *status
= "+Background append only file rewriting started\r\n";
8632 addReplySds(c
,sdsnew(status
));
8634 addReply(c
,shared
.err
);
8638 static void aofRemoveTempFile(pid_t childpid
) {
8641 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8645 /* Virtual Memory is composed mainly of two subsystems:
8646 * - Blocking Virutal Memory
8647 * - Threaded Virtual Memory I/O
8648 * The two parts are not fully decoupled, but functions are split among two
8649 * different sections of the source code (delimited by comments) in order to
8650 * make more clear what functionality is about the blocking VM and what about
8651 * the threaded (not blocking) VM.
8655 * Redis VM is a blocking VM (one that blocks reading swapped values from
8656 * disk into memory when a value swapped out is needed in memory) that is made
8657 * unblocking by trying to examine the command argument vector in order to
8658 * load in background values that will likely be needed in order to exec
8659 * the command. The command is executed only once all the relevant keys
8660 * are loaded into memory.
8662 * This basically is almost as simple of a blocking VM, but almost as parallel
8663 * as a fully non-blocking VM.
8666 /* =================== Virtual Memory - Blocking Side ====================== */
8668 static void vmInit(void) {
8674 if (server
.vm_max_threads
!= 0)
8675 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8677 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8678 /* Try to open the old swap file, otherwise create it */
8679 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8680 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8682 if (server
.vm_fp
== NULL
) {
8683 redisLog(REDIS_WARNING
,
8684 "Can't open the swap file: %s. Exiting.",
8688 server
.vm_fd
= fileno(server
.vm_fp
);
8689 /* Lock the swap file for writing, this is useful in order to avoid
8690 * another instance to use the same swap file for a config error. */
8691 fl
.l_type
= F_WRLCK
;
8692 fl
.l_whence
= SEEK_SET
;
8693 fl
.l_start
= fl
.l_len
= 0;
8694 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8695 redisLog(REDIS_WARNING
,
8696 "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
));
8700 server
.vm_next_page
= 0;
8701 server
.vm_near_pages
= 0;
8702 server
.vm_stats_used_pages
= 0;
8703 server
.vm_stats_swapped_objects
= 0;
8704 server
.vm_stats_swapouts
= 0;
8705 server
.vm_stats_swapins
= 0;
8706 totsize
= server
.vm_pages
*server
.vm_page_size
;
8707 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8708 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8709 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8713 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8715 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8716 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8717 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8718 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8720 /* Initialize threaded I/O (used by Virtual Memory) */
8721 server
.io_newjobs
= listCreate();
8722 server
.io_processing
= listCreate();
8723 server
.io_processed
= listCreate();
8724 server
.io_ready_clients
= listCreate();
8725 pthread_mutex_init(&server
.io_mutex
,NULL
);
8726 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8727 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8728 server
.io_active_threads
= 0;
8729 if (pipe(pipefds
) == -1) {
8730 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8734 server
.io_ready_pipe_read
= pipefds
[0];
8735 server
.io_ready_pipe_write
= pipefds
[1];
8736 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8737 /* LZF requires a lot of stack */
8738 pthread_attr_init(&server
.io_threads_attr
);
8739 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8740 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8741 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8742 /* Listen for events in the threaded I/O pipe */
8743 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8744 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8745 oom("creating file event");
8748 /* Mark the page as used */
8749 static void vmMarkPageUsed(off_t page
) {
8750 off_t byte
= page
/8;
8752 redisAssert(vmFreePage(page
) == 1);
8753 server
.vm_bitmap
[byte
] |= 1<<bit
;
8756 /* Mark N contiguous pages as used, with 'page' being the first. */
8757 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8760 for (j
= 0; j
< count
; j
++)
8761 vmMarkPageUsed(page
+j
);
8762 server
.vm_stats_used_pages
+= count
;
8763 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8764 (long long)count
, (long long)page
);
8767 /* Mark the page as free */
8768 static void vmMarkPageFree(off_t page
) {
8769 off_t byte
= page
/8;
8771 redisAssert(vmFreePage(page
) == 0);
8772 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8775 /* Mark N contiguous pages as free, with 'page' being the first. */
8776 static void vmMarkPagesFree(off_t page
, off_t count
) {
8779 for (j
= 0; j
< count
; j
++)
8780 vmMarkPageFree(page
+j
);
8781 server
.vm_stats_used_pages
-= count
;
8782 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8783 (long long)count
, (long long)page
);
8786 /* Test if the page is free */
8787 static int vmFreePage(off_t page
) {
8788 off_t byte
= page
/8;
8790 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8793 /* Find N contiguous free pages storing the first page of the cluster in *first.
8794 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8795 * REDIS_ERR is returned.
8797 * This function uses a simple algorithm: we try to allocate
8798 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8799 * again from the start of the swap file searching for free spaces.
8801 * If it looks pretty clear that there are no free pages near our offset
8802 * we try to find less populated places doing a forward jump of
8803 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8804 * without hurry, and then we jump again and so forth...
8806 * This function can be improved using a free list to avoid to guess
8807 * too much, since we could collect data about freed pages.
8809 * note: I implemented this function just after watching an episode of
8810 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8812 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8813 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8815 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8816 server
.vm_near_pages
= 0;
8817 server
.vm_next_page
= 0;
8819 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8820 base
= server
.vm_next_page
;
8822 while(offset
< server
.vm_pages
) {
8823 off_t
this = base
+offset
;
8825 /* If we overflow, restart from page zero */
8826 if (this >= server
.vm_pages
) {
8827 this -= server
.vm_pages
;
8829 /* Just overflowed, what we found on tail is no longer
8830 * interesting, as it's no longer contiguous. */
8834 if (vmFreePage(this)) {
8835 /* This is a free page */
8837 /* Already got N free pages? Return to the caller, with success */
8839 *first
= this-(n
-1);
8840 server
.vm_next_page
= this+1;
8841 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8845 /* The current one is not a free page */
8849 /* Fast-forward if the current page is not free and we already
8850 * searched enough near this place. */
8852 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8853 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8855 /* Note that even if we rewind after the jump, we are don't need
8856 * to make sure numfree is set to zero as we only jump *if* it
8857 * is set to zero. */
8859 /* Otherwise just check the next page */
8866 /* Write the specified object at the specified page of the swap file */
8867 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8868 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8869 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8870 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8871 redisLog(REDIS_WARNING
,
8872 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8876 rdbSaveObject(server
.vm_fp
,o
);
8877 fflush(server
.vm_fp
);
8878 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8882 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8883 * needed to later retrieve the object into the key object.
8884 * If we can't find enough contiguous empty pages to swap the object on disk
8885 * REDIS_ERR is returned. */
8886 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8887 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8890 assert(key
->storage
== REDIS_VM_MEMORY
);
8891 assert(key
->refcount
== 1);
8892 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8893 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8894 key
->vm
.page
= page
;
8895 key
->vm
.usedpages
= pages
;
8896 key
->storage
= REDIS_VM_SWAPPED
;
8897 key
->vtype
= val
->type
;
8898 decrRefCount(val
); /* Deallocate the object from memory. */
8899 vmMarkPagesUsed(page
,pages
);
8900 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8901 (unsigned char*) key
->ptr
,
8902 (unsigned long long) page
, (unsigned long long) pages
);
8903 server
.vm_stats_swapped_objects
++;
8904 server
.vm_stats_swapouts
++;
8908 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8911 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8912 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8913 redisLog(REDIS_WARNING
,
8914 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8918 o
= rdbLoadObject(type
,server
.vm_fp
);
8920 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8923 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8927 /* Load the value object relative to the 'key' object from swap to memory.
8928 * The newly allocated object is returned.
8930 * If preview is true the unserialized object is returned to the caller but
8931 * no changes are made to the key object, nor the pages are marked as freed */
8932 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8935 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8936 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8938 key
->storage
= REDIS_VM_MEMORY
;
8939 key
->vm
.atime
= server
.unixtime
;
8940 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8941 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8942 (unsigned char*) key
->ptr
);
8943 server
.vm_stats_swapped_objects
--;
8945 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8946 (unsigned char*) key
->ptr
);
8948 server
.vm_stats_swapins
++;
8952 /* Plain object loading, from swap to memory */
8953 static robj
*vmLoadObject(robj
*key
) {
8954 /* If we are loading the object in background, stop it, we
8955 * need to load this object synchronously ASAP. */
8956 if (key
->storage
== REDIS_VM_LOADING
)
8957 vmCancelThreadedIOJob(key
);
8958 return vmGenericLoadObject(key
,0);
8961 /* Just load the value on disk, without to modify the key.
8962 * This is useful when we want to perform some operation on the value
8963 * without to really bring it from swap to memory, like while saving the
8964 * dataset or rewriting the append only log. */
8965 static robj
*vmPreviewObject(robj
*key
) {
8966 return vmGenericLoadObject(key
,1);
8969 /* How a good candidate is this object for swapping?
8970 * The better candidate it is, the greater the returned value.
8972 * Currently we try to perform a fast estimation of the object size in
8973 * memory, and combine it with aging informations.
8975 * Basically swappability = idle-time * log(estimated size)
8977 * Bigger objects are preferred over smaller objects, but not
8978 * proportionally, this is why we use the logarithm. This algorithm is
8979 * just a first try and will probably be tuned later. */
8980 static double computeObjectSwappability(robj
*o
) {
8981 time_t age
= server
.unixtime
- o
->vm
.atime
;
8985 struct dictEntry
*de
;
8988 if (age
<= 0) return 0;
8991 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8994 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8999 listNode
*ln
= listFirst(l
);
9001 asize
= sizeof(list
);
9003 robj
*ele
= ln
->value
;
9006 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9007 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9009 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9014 z
= (o
->type
== REDIS_ZSET
);
9015 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9017 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9018 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9023 de
= dictGetRandomKey(d
);
9024 ele
= dictGetEntryKey(de
);
9025 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9026 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9028 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9029 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9033 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9034 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9035 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9036 unsigned int klen
, vlen
;
9037 unsigned char *key
, *val
;
9039 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9043 asize
= len
*(klen
+vlen
+3);
9044 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9046 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9051 de
= dictGetRandomKey(d
);
9052 ele
= dictGetEntryKey(de
);
9053 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9054 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9056 ele
= dictGetEntryVal(de
);
9057 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9058 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9060 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9065 return (double)age
*log(1+asize
);
9068 /* Try to swap an object that's a good candidate for swapping.
9069 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9070 * to swap any object at all.
9072 * If 'usethreaded' is true, Redis will try to swap the object in background
9073 * using I/O threads. */
9074 static int vmSwapOneObject(int usethreads
) {
9076 struct dictEntry
*best
= NULL
;
9077 double best_swappability
= 0;
9078 redisDb
*best_db
= NULL
;
9081 for (j
= 0; j
< server
.dbnum
; j
++) {
9082 redisDb
*db
= server
.db
+j
;
9083 /* Why maxtries is set to 100?
9084 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9085 * are swappable objects */
9088 if (dictSize(db
->dict
) == 0) continue;
9089 for (i
= 0; i
< 5; i
++) {
9091 double swappability
;
9093 if (maxtries
) maxtries
--;
9094 de
= dictGetRandomKey(db
->dict
);
9095 key
= dictGetEntryKey(de
);
9096 val
= dictGetEntryVal(de
);
9097 /* Only swap objects that are currently in memory.
9099 * Also don't swap shared objects if threaded VM is on, as we
9100 * try to ensure that the main thread does not touch the
9101 * object while the I/O thread is using it, but we can't
9102 * control other keys without adding additional mutex. */
9103 if (key
->storage
!= REDIS_VM_MEMORY
||
9104 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9105 if (maxtries
) i
--; /* don't count this try */
9108 swappability
= computeObjectSwappability(val
);
9109 if (!best
|| swappability
> best_swappability
) {
9111 best_swappability
= swappability
;
9116 if (best
== NULL
) return REDIS_ERR
;
9117 key
= dictGetEntryKey(best
);
9118 val
= dictGetEntryVal(best
);
9120 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9121 key
->ptr
, best_swappability
);
9123 /* Unshare the key if needed */
9124 if (key
->refcount
> 1) {
9125 robj
*newkey
= dupStringObject(key
);
9127 key
= dictGetEntryKey(best
) = newkey
;
9131 vmSwapObjectThreaded(key
,val
,best_db
);
9134 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9135 dictGetEntryVal(best
) = NULL
;
9143 static int vmSwapOneObjectBlocking() {
9144 return vmSwapOneObject(0);
9147 static int vmSwapOneObjectThreaded() {
9148 return vmSwapOneObject(1);
9151 /* Return true if it's safe to swap out objects in a given moment.
9152 * Basically we don't want to swap objects out while there is a BGSAVE
9153 * or a BGAEOREWRITE running in backgroud. */
9154 static int vmCanSwapOut(void) {
9155 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9158 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9159 * and was deleted. Otherwise 0 is returned. */
9160 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9164 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9165 foundkey
= dictGetEntryKey(de
);
9166 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9171 /* =================== Virtual Memory - Threaded I/O ======================= */
9173 static void freeIOJob(iojob
*j
) {
9174 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9175 j
->type
== REDIS_IOJOB_DO_SWAP
||
9176 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9177 decrRefCount(j
->val
);
9178 /* We don't decrRefCount the j->key field as we did't incremented
9179 * the count creating IO Jobs. This is because the key field here is
9180 * just used as an indentifier and if a key is removed the Job should
9181 * never be touched again. */
9185 /* Every time a thread finished a Job, it writes a byte into the write side
9186 * of an unix pipe in order to "awake" the main thread, and this function
9188 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9192 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9194 REDIS_NOTUSED(mask
);
9195 REDIS_NOTUSED(privdata
);
9197 /* For every byte we read in the read side of the pipe, there is one
9198 * I/O job completed to process. */
9199 while((retval
= read(fd
,buf
,1)) == 1) {
9203 struct dictEntry
*de
;
9205 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9207 /* Get the processed element (the oldest one) */
9209 assert(listLength(server
.io_processed
) != 0);
9210 if (toprocess
== -1) {
9211 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9212 if (toprocess
<= 0) toprocess
= 1;
9214 ln
= listFirst(server
.io_processed
);
9216 listDelNode(server
.io_processed
,ln
);
9218 /* If this job is marked as canceled, just ignore it */
9223 /* Post process it in the main thread, as there are things we
9224 * can do just here to avoid race conditions and/or invasive locks */
9225 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
);
9226 de
= dictFind(j
->db
->dict
,j
->key
);
9228 key
= dictGetEntryKey(de
);
9229 if (j
->type
== REDIS_IOJOB_LOAD
) {
9232 /* Key loaded, bring it at home */
9233 key
->storage
= REDIS_VM_MEMORY
;
9234 key
->vm
.atime
= server
.unixtime
;
9235 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9236 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9237 (unsigned char*) key
->ptr
);
9238 server
.vm_stats_swapped_objects
--;
9239 server
.vm_stats_swapins
++;
9240 dictGetEntryVal(de
) = j
->val
;
9241 incrRefCount(j
->val
);
9244 /* Handle clients waiting for this key to be loaded. */
9245 handleClientsBlockedOnSwappedKey(db
,key
);
9246 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9247 /* Now we know the amount of pages required to swap this object.
9248 * Let's find some space for it, and queue this task again
9249 * rebranded as REDIS_IOJOB_DO_SWAP. */
9250 if (!vmCanSwapOut() ||
9251 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9253 /* Ooops... no space or we can't swap as there is
9254 * a fork()ed Redis trying to save stuff on disk. */
9256 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9258 /* Note that we need to mark this pages as used now,
9259 * if the job will be canceled, we'll mark them as freed
9261 vmMarkPagesUsed(j
->page
,j
->pages
);
9262 j
->type
= REDIS_IOJOB_DO_SWAP
;
9267 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9270 /* Key swapped. We can finally free some memory. */
9271 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9272 printf("key->storage: %d\n",key
->storage
);
9273 printf("key->name: %s\n",(char*)key
->ptr
);
9274 printf("key->refcount: %d\n",key
->refcount
);
9275 printf("val: %p\n",(void*)j
->val
);
9276 printf("val->type: %d\n",j
->val
->type
);
9277 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9279 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9280 val
= dictGetEntryVal(de
);
9281 key
->vm
.page
= j
->page
;
9282 key
->vm
.usedpages
= j
->pages
;
9283 key
->storage
= REDIS_VM_SWAPPED
;
9284 key
->vtype
= j
->val
->type
;
9285 decrRefCount(val
); /* Deallocate the object from memory. */
9286 dictGetEntryVal(de
) = NULL
;
9287 redisLog(REDIS_DEBUG
,
9288 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9289 (unsigned char*) key
->ptr
,
9290 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9291 server
.vm_stats_swapped_objects
++;
9292 server
.vm_stats_swapouts
++;
9294 /* Put a few more swap requests in queue if we are still
9296 if (trytoswap
&& vmCanSwapOut() &&
9297 zmalloc_used_memory() > server
.vm_max_memory
)
9302 more
= listLength(server
.io_newjobs
) <
9303 (unsigned) server
.vm_max_threads
;
9305 /* Don't waste CPU time if swappable objects are rare. */
9306 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9314 if (processed
== toprocess
) return;
9316 if (retval
< 0 && errno
!= EAGAIN
) {
9317 redisLog(REDIS_WARNING
,
9318 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9323 static void lockThreadedIO(void) {
9324 pthread_mutex_lock(&server
.io_mutex
);
9327 static void unlockThreadedIO(void) {
9328 pthread_mutex_unlock(&server
.io_mutex
);
9331 /* Remove the specified object from the threaded I/O queue if still not
9332 * processed, otherwise make sure to flag it as canceled. */
9333 static void vmCancelThreadedIOJob(robj
*o
) {
9335 server
.io_newjobs
, /* 0 */
9336 server
.io_processing
, /* 1 */
9337 server
.io_processed
/* 2 */
9341 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9344 /* Search for a matching key in one of the queues */
9345 for (i
= 0; i
< 3; i
++) {
9349 listRewind(lists
[i
],&li
);
9350 while ((ln
= listNext(&li
)) != NULL
) {
9351 iojob
*job
= ln
->value
;
9353 if (job
->canceled
) continue; /* Skip this, already canceled. */
9354 if (job
->key
== o
) {
9355 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9356 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9357 /* Mark the pages as free since the swap didn't happened
9358 * or happened but is now discarded. */
9359 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9360 vmMarkPagesFree(job
->page
,job
->pages
);
9361 /* Cancel the job. It depends on the list the job is
9364 case 0: /* io_newjobs */
9365 /* If the job was yet not processed the best thing to do
9366 * is to remove it from the queue at all */
9368 listDelNode(lists
[i
],ln
);
9370 case 1: /* io_processing */
9371 /* Oh Shi- the thread is messing with the Job:
9373 * Probably it's accessing the object if this is a
9374 * PREPARE_SWAP or DO_SWAP job.
9375 * If it's a LOAD job it may be reading from disk and
9376 * if we don't wait for the job to terminate before to
9377 * cancel it, maybe in a few microseconds data can be
9378 * corrupted in this pages. So the short story is:
9380 * Better to wait for the job to move into the
9381 * next queue (processed)... */
9383 /* We try again and again until the job is completed. */
9385 /* But let's wait some time for the I/O thread
9386 * to finish with this job. After all this condition
9387 * should be very rare. */
9390 case 2: /* io_processed */
9391 /* The job was already processed, that's easy...
9392 * just mark it as canceled so that we'll ignore it
9393 * when processing completed jobs. */
9397 /* Finally we have to adjust the storage type of the object
9398 * in order to "UNDO" the operaiton. */
9399 if (o
->storage
== REDIS_VM_LOADING
)
9400 o
->storage
= REDIS_VM_SWAPPED
;
9401 else if (o
->storage
== REDIS_VM_SWAPPING
)
9402 o
->storage
= REDIS_VM_MEMORY
;
9409 assert(1 != 1); /* We should never reach this */
9412 static void *IOThreadEntryPoint(void *arg
) {
9417 pthread_detach(pthread_self());
9419 /* Get a new job to process */
9421 if (listLength(server
.io_newjobs
) == 0) {
9422 /* No new jobs in queue, exit. */
9423 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9424 (long) pthread_self());
9425 server
.io_active_threads
--;
9429 ln
= listFirst(server
.io_newjobs
);
9431 listDelNode(server
.io_newjobs
,ln
);
9432 /* Add the job in the processing queue */
9433 j
->thread
= pthread_self();
9434 listAddNodeTail(server
.io_processing
,j
);
9435 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9437 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9438 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9440 /* Process the Job */
9441 if (j
->type
== REDIS_IOJOB_LOAD
) {
9442 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9443 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9444 FILE *fp
= fopen("/dev/null","w+");
9445 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9447 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9448 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9452 /* Done: insert the job into the processed queue */
9453 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9454 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9456 listDelNode(server
.io_processing
,ln
);
9457 listAddNodeTail(server
.io_processed
,j
);
9460 /* Signal the main thread there is new stuff to process */
9461 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9463 return NULL
; /* never reached */
9466 static void spawnIOThread(void) {
9468 sigset_t mask
, omask
;
9472 sigaddset(&mask
,SIGCHLD
);
9473 sigaddset(&mask
,SIGHUP
);
9474 sigaddset(&mask
,SIGPIPE
);
9475 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9476 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9477 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9481 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9482 server
.io_active_threads
++;
9485 /* We need to wait for the last thread to exit before we are able to
9486 * fork() in order to BGSAVE or BGREWRITEAOF. */
9487 static void waitEmptyIOJobsQueue(void) {
9489 int io_processed_len
;
9492 if (listLength(server
.io_newjobs
) == 0 &&
9493 listLength(server
.io_processing
) == 0 &&
9494 server
.io_active_threads
== 0)
9499 /* While waiting for empty jobs queue condition we post-process some
9500 * finshed job, as I/O threads may be hanging trying to write against
9501 * the io_ready_pipe_write FD but there are so much pending jobs that
9503 io_processed_len
= listLength(server
.io_processed
);
9505 if (io_processed_len
) {
9506 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9507 usleep(1000); /* 1 millisecond */
9509 usleep(10000); /* 10 milliseconds */
9514 static void vmReopenSwapFile(void) {
9515 /* Note: we don't close the old one as we are in the child process
9516 * and don't want to mess at all with the original file object. */
9517 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9518 if (server
.vm_fp
== NULL
) {
9519 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9520 server
.vm_swap_file
);
9523 server
.vm_fd
= fileno(server
.vm_fp
);
9526 /* This function must be called while with threaded IO locked */
9527 static void queueIOJob(iojob
*j
) {
9528 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9529 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9530 listAddNodeTail(server
.io_newjobs
,j
);
9531 if (server
.io_active_threads
< server
.vm_max_threads
)
9535 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9538 assert(key
->storage
== REDIS_VM_MEMORY
);
9539 assert(key
->refcount
== 1);
9541 j
= zmalloc(sizeof(*j
));
9542 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9548 j
->thread
= (pthread_t
) -1;
9549 key
->storage
= REDIS_VM_SWAPPING
;
9557 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9559 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9560 * If there is not already a job loading the key, it is craeted.
9561 * The key is added to the io_keys list in the client structure, and also
9562 * in the hash table mapping swapped keys to waiting clients, that is,
9563 * server.io_waited_keys. */
9564 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9565 struct dictEntry
*de
;
9569 /* If the key does not exist or is already in RAM we don't need to
9570 * block the client at all. */
9571 de
= dictFind(c
->db
->dict
,key
);
9572 if (de
== NULL
) return 0;
9573 o
= dictGetEntryKey(de
);
9574 if (o
->storage
== REDIS_VM_MEMORY
) {
9576 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9577 /* We were swapping the key, undo it! */
9578 vmCancelThreadedIOJob(o
);
9582 /* OK: the key is either swapped, or being loaded just now. */
9584 /* Add the key to the list of keys this client is waiting for.
9585 * This maps clients to keys they are waiting for. */
9586 listAddNodeTail(c
->io_keys
,key
);
9589 /* Add the client to the swapped keys => clients waiting map. */
9590 de
= dictFind(c
->db
->io_keys
,key
);
9594 /* For every key we take a list of clients blocked for it */
9596 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9598 assert(retval
== DICT_OK
);
9600 l
= dictGetEntryVal(de
);
9602 listAddNodeTail(l
,c
);
9604 /* Are we already loading the key from disk? If not create a job */
9605 if (o
->storage
== REDIS_VM_SWAPPED
) {
9608 o
->storage
= REDIS_VM_LOADING
;
9609 j
= zmalloc(sizeof(*j
));
9610 j
->type
= REDIS_IOJOB_LOAD
;
9613 j
->key
->vtype
= o
->vtype
;
9614 j
->page
= o
->vm
.page
;
9617 j
->thread
= (pthread_t
) -1;
9625 /* Preload keys needed for the ZUNION and ZINTER commands. */
9626 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9628 num
= atoi(c
->argv
[2]->ptr
);
9629 for (i
= 0; i
< num
; i
++) {
9630 waitForSwappedKey(c
,c
->argv
[3+i
]);
9634 /* Is this client attempting to run a command against swapped keys?
9635 * If so, block it ASAP, load the keys in background, then resume it.
9637 * The important idea about this function is that it can fail! If keys will
9638 * still be swapped when the client is resumed, this key lookups will
9639 * just block loading keys from disk. In practical terms this should only
9640 * happen with SORT BY command or if there is a bug in this function.
9642 * Return 1 if the client is marked as blocked, 0 if the client can
9643 * continue as the keys it is going to access appear to be in memory. */
9644 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9647 if (cmd
->vm_preload_proc
!= NULL
) {
9648 cmd
->vm_preload_proc(c
);
9650 if (cmd
->vm_firstkey
== 0) return 0;
9651 last
= cmd
->vm_lastkey
;
9652 if (last
< 0) last
= c
->argc
+last
;
9653 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9654 waitForSwappedKey(c
,c
->argv
[j
]);
9657 /* If the client was blocked for at least one key, mark it as blocked. */
9658 if (listLength(c
->io_keys
)) {
9659 c
->flags
|= REDIS_IO_WAIT
;
9660 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9661 server
.vm_blocked_clients
++;
9668 /* Remove the 'key' from the list of blocked keys for a given client.
9670 * The function returns 1 when there are no longer blocking keys after
9671 * the current one was removed (and the client can be unblocked). */
9672 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9676 struct dictEntry
*de
;
9678 /* Remove the key from the list of keys this client is waiting for. */
9679 listRewind(c
->io_keys
,&li
);
9680 while ((ln
= listNext(&li
)) != NULL
) {
9681 if (equalStringObjects(ln
->value
,key
)) {
9682 listDelNode(c
->io_keys
,ln
);
9688 /* Remove the client form the key => waiting clients map. */
9689 de
= dictFind(c
->db
->io_keys
,key
);
9691 l
= dictGetEntryVal(de
);
9692 ln
= listSearchKey(l
,c
);
9695 if (listLength(l
) == 0)
9696 dictDelete(c
->db
->io_keys
,key
);
9698 return listLength(c
->io_keys
) == 0;
9701 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9702 struct dictEntry
*de
;
9707 de
= dictFind(db
->io_keys
,key
);
9710 l
= dictGetEntryVal(de
);
9711 len
= listLength(l
);
9712 /* Note: we can't use something like while(listLength(l)) as the list
9713 * can be freed by the calling function when we remove the last element. */
9716 redisClient
*c
= ln
->value
;
9718 if (dontWaitForSwappedKey(c
,key
)) {
9719 /* Put the client in the list of clients ready to go as we
9720 * loaded all the keys about it. */
9721 listAddNodeTail(server
.io_ready_clients
,c
);
9726 /* =========================== Remote Configuration ========================= */
9728 static void configSetCommand(redisClient
*c
) {
9729 robj
*o
= getDecodedObject(c
->argv
[3]);
9730 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9731 zfree(server
.dbfilename
);
9732 server
.dbfilename
= zstrdup(o
->ptr
);
9733 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9734 zfree(server
.requirepass
);
9735 server
.requirepass
= zstrdup(o
->ptr
);
9736 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9737 zfree(server
.masterauth
);
9738 server
.masterauth
= zstrdup(o
->ptr
);
9739 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9740 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9741 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
9742 if (!strcasecmp(o
->ptr
,"no")) {
9743 server
.appendfsync
= APPENDFSYNC_NO
;
9744 } else if (!strcasecmp(o
->ptr
,"everysec")) {
9745 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
9746 } else if (!strcasecmp(o
->ptr
,"always")) {
9747 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
9751 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
9753 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
9755 /* Perform sanity check before setting the new config:
9756 * - Even number of args
9757 * - Seconds >= 1, changes >= 0 */
9759 sdsfreesplitres(v
,vlen
);
9762 for (j
= 0; j
< vlen
; j
++) {
9766 val
= strtoll(v
[j
], &eptr
, 10);
9767 if (eptr
[0] != '\0' ||
9768 ((j
& 1) == 0 && val
< 1) ||
9769 ((j
& 1) == 1 && val
< 0)) {
9770 sdsfreesplitres(v
,vlen
);
9774 /* Finally set the new config */
9775 resetServerSaveParams();
9776 for (j
= 0; j
< vlen
; j
+= 2) {
9780 seconds
= strtoll(v
[j
],NULL
,10);
9781 changes
= strtoll(v
[j
+1],NULL
,10);
9782 appendServerSaveParams(seconds
, changes
);
9784 sdsfreesplitres(v
,vlen
);
9786 addReplySds(c
,sdscatprintf(sdsempty(),
9787 "-ERR not supported CONFIG parameter %s\r\n",
9788 (char*)c
->argv
[2]->ptr
));
9793 addReply(c
,shared
.ok
);
9796 badfmt
: /* Bad format errors */
9797 addReplySds(c
,sdscatprintf(sdsempty(),
9798 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9800 (char*)c
->argv
[2]->ptr
));
9804 static void configGetCommand(redisClient
*c
) {
9805 robj
*o
= getDecodedObject(c
->argv
[2]);
9806 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9807 char *pattern
= o
->ptr
;
9811 decrRefCount(lenobj
);
9813 if (stringmatch(pattern
,"dbfilename",0)) {
9814 addReplyBulkCString(c
,"dbfilename");
9815 addReplyBulkCString(c
,server
.dbfilename
);
9818 if (stringmatch(pattern
,"requirepass",0)) {
9819 addReplyBulkCString(c
,"requirepass");
9820 addReplyBulkCString(c
,server
.requirepass
);
9823 if (stringmatch(pattern
,"masterauth",0)) {
9824 addReplyBulkCString(c
,"masterauth");
9825 addReplyBulkCString(c
,server
.masterauth
);
9828 if (stringmatch(pattern
,"maxmemory",0)) {
9831 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9832 addReplyBulkCString(c
,"maxmemory");
9833 addReplyBulkCString(c
,buf
);
9836 if (stringmatch(pattern
,"appendfsync",0)) {
9839 switch(server
.appendfsync
) {
9840 case APPENDFSYNC_NO
: policy
= "no"; break;
9841 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
9842 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
9843 default: policy
= "unknown"; break; /* too harmless to panic */
9845 addReplyBulkCString(c
,"appendfsync");
9846 addReplyBulkCString(c
,policy
);
9849 if (stringmatch(pattern
,"save",0)) {
9850 sds buf
= sdsempty();
9853 for (j
= 0; j
< server
.saveparamslen
; j
++) {
9854 buf
= sdscatprintf(buf
,"%ld %d",
9855 server
.saveparams
[j
].seconds
,
9856 server
.saveparams
[j
].changes
);
9857 if (j
!= server
.saveparamslen
-1)
9858 buf
= sdscatlen(buf
," ",1);
9860 addReplyBulkCString(c
,"save");
9861 addReplyBulkCString(c
,buf
);
9866 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9869 static void configCommand(redisClient
*c
) {
9870 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9871 if (c
->argc
!= 4) goto badarity
;
9872 configSetCommand(c
);
9873 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9874 if (c
->argc
!= 3) goto badarity
;
9875 configGetCommand(c
);
9876 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9877 if (c
->argc
!= 2) goto badarity
;
9878 server
.stat_numcommands
= 0;
9879 server
.stat_numconnections
= 0;
9880 server
.stat_expiredkeys
= 0;
9881 server
.stat_starttime
= time(NULL
);
9882 addReply(c
,shared
.ok
);
9884 addReplySds(c
,sdscatprintf(sdsempty(),
9885 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9890 addReplySds(c
,sdscatprintf(sdsempty(),
9891 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9892 (char*) c
->argv
[1]->ptr
));
9895 /* =========================== Pubsub implementation ======================== */
9897 static void freePubsubPattern(void *p
) {
9898 pubsubPattern
*pat
= p
;
9900 decrRefCount(pat
->pattern
);
9904 static int listMatchPubsubPattern(void *a
, void *b
) {
9905 pubsubPattern
*pa
= a
, *pb
= b
;
9907 return (pa
->client
== pb
->client
) &&
9908 (equalStringObjects(pa
->pattern
,pb
->pattern
));
9911 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9912 * 0 if the client was already subscribed to that channel. */
9913 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9914 struct dictEntry
*de
;
9915 list
*clients
= NULL
;
9918 /* Add the channel to the client -> channels hash table */
9919 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9921 incrRefCount(channel
);
9922 /* Add the client to the channel -> list of clients hash table */
9923 de
= dictFind(server
.pubsub_channels
,channel
);
9925 clients
= listCreate();
9926 dictAdd(server
.pubsub_channels
,channel
,clients
);
9927 incrRefCount(channel
);
9929 clients
= dictGetEntryVal(de
);
9931 listAddNodeTail(clients
,c
);
9933 /* Notify the client */
9934 addReply(c
,shared
.mbulk3
);
9935 addReply(c
,shared
.subscribebulk
);
9936 addReplyBulk(c
,channel
);
9937 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9941 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9942 * 0 if the client was not subscribed to the specified channel. */
9943 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9944 struct dictEntry
*de
;
9949 /* Remove the channel from the client -> channels hash table */
9950 incrRefCount(channel
); /* channel may be just a pointer to the same object
9951 we have in the hash tables. Protect it... */
9952 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9954 /* Remove the client from the channel -> clients list hash table */
9955 de
= dictFind(server
.pubsub_channels
,channel
);
9957 clients
= dictGetEntryVal(de
);
9958 ln
= listSearchKey(clients
,c
);
9960 listDelNode(clients
,ln
);
9961 if (listLength(clients
) == 0) {
9962 /* Free the list and associated hash entry at all if this was
9963 * the latest client, so that it will be possible to abuse
9964 * Redis PUBSUB creating millions of channels. */
9965 dictDelete(server
.pubsub_channels
,channel
);
9968 /* Notify the client */
9970 addReply(c
,shared
.mbulk3
);
9971 addReply(c
,shared
.unsubscribebulk
);
9972 addReplyBulk(c
,channel
);
9973 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9974 listLength(c
->pubsub_patterns
));
9977 decrRefCount(channel
); /* it is finally safe to release it */
9981 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9982 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9985 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9988 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9989 incrRefCount(pattern
);
9990 pat
= zmalloc(sizeof(*pat
));
9991 pat
->pattern
= getDecodedObject(pattern
);
9993 listAddNodeTail(server
.pubsub_patterns
,pat
);
9995 /* Notify the client */
9996 addReply(c
,shared
.mbulk3
);
9997 addReply(c
,shared
.psubscribebulk
);
9998 addReplyBulk(c
,pattern
);
9999 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10003 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10004 * 0 if the client was not subscribed to the specified channel. */
10005 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10010 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10011 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10013 listDelNode(c
->pubsub_patterns
,ln
);
10015 pat
.pattern
= pattern
;
10016 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10017 listDelNode(server
.pubsub_patterns
,ln
);
10019 /* Notify the client */
10021 addReply(c
,shared
.mbulk3
);
10022 addReply(c
,shared
.punsubscribebulk
);
10023 addReplyBulk(c
,pattern
);
10024 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
10025 listLength(c
->pubsub_patterns
));
10027 decrRefCount(pattern
);
10031 /* Unsubscribe from all the channels. Return the number of channels the
10032 * client was subscribed from. */
10033 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10034 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10038 while((de
= dictNext(di
)) != NULL
) {
10039 robj
*channel
= dictGetEntryKey(de
);
10041 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10043 dictReleaseIterator(di
);
10047 /* Unsubscribe from all the patterns. Return the number of patterns the
10048 * client was subscribed from. */
10049 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10054 listRewind(c
->pubsub_patterns
,&li
);
10055 while ((ln
= listNext(&li
)) != NULL
) {
10056 robj
*pattern
= ln
->value
;
10058 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10063 /* Publish a message */
10064 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10066 struct dictEntry
*de
;
10070 /* Send to clients listening for that channel */
10071 de
= dictFind(server
.pubsub_channels
,channel
);
10073 list
*list
= dictGetEntryVal(de
);
10077 listRewind(list
,&li
);
10078 while ((ln
= listNext(&li
)) != NULL
) {
10079 redisClient
*c
= ln
->value
;
10081 addReply(c
,shared
.mbulk3
);
10082 addReply(c
,shared
.messagebulk
);
10083 addReplyBulk(c
,channel
);
10084 addReplyBulk(c
,message
);
10088 /* Send to clients listening to matching channels */
10089 if (listLength(server
.pubsub_patterns
)) {
10090 listRewind(server
.pubsub_patterns
,&li
);
10091 channel
= getDecodedObject(channel
);
10092 while ((ln
= listNext(&li
)) != NULL
) {
10093 pubsubPattern
*pat
= ln
->value
;
10095 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10096 sdslen(pat
->pattern
->ptr
),
10097 (char*)channel
->ptr
,
10098 sdslen(channel
->ptr
),0)) {
10099 addReply(pat
->client
,shared
.mbulk4
);
10100 addReply(pat
->client
,shared
.pmessagebulk
);
10101 addReplyBulk(pat
->client
,pat
->pattern
);
10102 addReplyBulk(pat
->client
,channel
);
10103 addReplyBulk(pat
->client
,message
);
10107 decrRefCount(channel
);
10112 static void subscribeCommand(redisClient
*c
) {
10115 for (j
= 1; j
< c
->argc
; j
++)
10116 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10119 static void unsubscribeCommand(redisClient
*c
) {
10120 if (c
->argc
== 1) {
10121 pubsubUnsubscribeAllChannels(c
,1);
10126 for (j
= 1; j
< c
->argc
; j
++)
10127 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10131 static void psubscribeCommand(redisClient
*c
) {
10134 for (j
= 1; j
< c
->argc
; j
++)
10135 pubsubSubscribePattern(c
,c
->argv
[j
]);
10138 static void punsubscribeCommand(redisClient
*c
) {
10139 if (c
->argc
== 1) {
10140 pubsubUnsubscribeAllPatterns(c
,1);
10145 for (j
= 1; j
< c
->argc
; j
++)
10146 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10150 static void publishCommand(redisClient
*c
) {
10151 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10152 addReplyLong(c
,receivers
);
10155 /* ================================= Debugging ============================== */
10157 static void debugCommand(redisClient
*c
) {
10158 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10159 *((char*)-1) = 'x';
10160 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10161 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10162 addReply(c
,shared
.err
);
10166 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10167 addReply(c
,shared
.err
);
10170 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10171 addReply(c
,shared
.ok
);
10172 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10174 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10175 addReply(c
,shared
.err
);
10178 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10179 addReply(c
,shared
.ok
);
10180 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10181 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10185 addReply(c
,shared
.nokeyerr
);
10188 key
= dictGetEntryKey(de
);
10189 val
= dictGetEntryVal(de
);
10190 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10191 key
->storage
== REDIS_VM_SWAPPING
)) {
10195 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10196 strenc
= strencoding
[val
->encoding
];
10198 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10201 addReplySds(c
,sdscatprintf(sdsempty(),
10202 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10203 "encoding:%s serializedlength:%lld\r\n",
10204 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10205 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10207 addReplySds(c
,sdscatprintf(sdsempty(),
10208 "+Key at:%p refcount:%d, value swapped at: page %llu "
10209 "using %llu pages\r\n",
10210 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10211 (unsigned long long) key
->vm
.usedpages
));
10213 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10214 lookupKeyRead(c
->db
,c
->argv
[2]);
10215 addReply(c
,shared
.ok
);
10216 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10217 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10220 if (!server
.vm_enabled
) {
10221 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10225 addReply(c
,shared
.nokeyerr
);
10228 key
= dictGetEntryKey(de
);
10229 val
= dictGetEntryVal(de
);
10230 /* If the key is shared we want to create a copy */
10231 if (key
->refcount
> 1) {
10232 robj
*newkey
= dupStringObject(key
);
10234 key
= dictGetEntryKey(de
) = newkey
;
10237 if (key
->storage
!= REDIS_VM_MEMORY
) {
10238 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10239 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10240 dictGetEntryVal(de
) = NULL
;
10241 addReply(c
,shared
.ok
);
10243 addReply(c
,shared
.err
);
10245 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10250 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10252 for (j
= 0; j
< keys
; j
++) {
10253 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10254 key
= createStringObject(buf
,strlen(buf
));
10255 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10259 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10260 val
= createStringObject(buf
,strlen(buf
));
10261 dictAdd(c
->db
->dict
,key
,val
);
10263 addReply(c
,shared
.ok
);
10265 addReplySds(c
,sdsnew(
10266 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10270 static void _redisAssert(char *estr
, char *file
, int line
) {
10271 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10272 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10273 #ifdef HAVE_BACKTRACE
10274 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10275 *((char*)-1) = 'x';
10279 static void _redisPanic(char *msg
, char *file
, int line
) {
10280 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10281 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10282 #ifdef HAVE_BACKTRACE
10283 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10284 *((char*)-1) = 'x';
10288 /* =================================== Main! ================================ */
10291 int linuxOvercommitMemoryValue(void) {
10292 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10295 if (!fp
) return -1;
10296 if (fgets(buf
,64,fp
) == NULL
) {
10305 void linuxOvercommitMemoryWarning(void) {
10306 if (linuxOvercommitMemoryValue() == 0) {
10307 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.");
10310 #endif /* __linux__ */
10312 static void daemonize(void) {
10316 if (fork() != 0) exit(0); /* parent exits */
10317 setsid(); /* create a new session */
10319 /* Every output goes to /dev/null. If Redis is daemonized but
10320 * the 'logfile' is set to 'stdout' in the configuration file
10321 * it will not log at all. */
10322 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10323 dup2(fd
, STDIN_FILENO
);
10324 dup2(fd
, STDOUT_FILENO
);
10325 dup2(fd
, STDERR_FILENO
);
10326 if (fd
> STDERR_FILENO
) close(fd
);
10328 /* Try to write the pid file */
10329 fp
= fopen(server
.pidfile
,"w");
10331 fprintf(fp
,"%d\n",getpid());
10336 static void version() {
10337 printf("Redis server version %s\n", REDIS_VERSION
);
10341 static void usage() {
10342 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10343 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10347 int main(int argc
, char **argv
) {
10350 initServerConfig();
10352 if (strcmp(argv
[1], "-v") == 0 ||
10353 strcmp(argv
[1], "--version") == 0) version();
10354 if (strcmp(argv
[1], "--help") == 0) usage();
10355 resetServerSaveParams();
10356 loadServerConfig(argv
[1]);
10357 } else if ((argc
> 2)) {
10360 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'");
10362 if (server
.daemonize
) daemonize();
10364 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10366 linuxOvercommitMemoryWarning();
10368 start
= time(NULL
);
10369 if (server
.appendonly
) {
10370 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10371 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10373 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10374 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10376 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10377 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10379 aeDeleteEventLoop(server
.el
);
10383 /* ============================= Backtrace support ========================= */
10385 #ifdef HAVE_BACKTRACE
10386 static char *findFuncName(void *pointer
, unsigned long *offset
);
10388 static void *getMcontextEip(ucontext_t
*uc
) {
10389 #if defined(__FreeBSD__)
10390 return (void*) uc
->uc_mcontext
.mc_eip
;
10391 #elif defined(__dietlibc__)
10392 return (void*) uc
->uc_mcontext
.eip
;
10393 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10395 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10397 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10399 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10400 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10401 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10403 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10405 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10406 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10407 #elif defined(__ia64__) /* Linux IA64 */
10408 return (void*) uc
->uc_mcontext
.sc_ip
;
10414 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10416 char **messages
= NULL
;
10417 int i
, trace_size
= 0;
10418 unsigned long offset
=0;
10419 ucontext_t
*uc
= (ucontext_t
*) secret
;
10421 REDIS_NOTUSED(info
);
10423 redisLog(REDIS_WARNING
,
10424 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10425 infostring
= genRedisInfoString();
10426 redisLog(REDIS_WARNING
, "%s",infostring
);
10427 /* It's not safe to sdsfree() the returned string under memory
10428 * corruption conditions. Let it leak as we are going to abort */
10430 trace_size
= backtrace(trace
, 100);
10431 /* overwrite sigaction with caller's address */
10432 if (getMcontextEip(uc
) != NULL
) {
10433 trace
[1] = getMcontextEip(uc
);
10435 messages
= backtrace_symbols(trace
, trace_size
);
10437 for (i
=1; i
<trace_size
; ++i
) {
10438 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10440 p
= strchr(messages
[i
],'+');
10441 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10442 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10444 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10447 /* free(messages); Don't call free() with possibly corrupted memory. */
10451 static void setupSigSegvAction(void) {
10452 struct sigaction act
;
10454 sigemptyset (&act
.sa_mask
);
10455 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10456 * is used. Otherwise, sa_handler is used */
10457 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10458 act
.sa_sigaction
= segvHandler
;
10459 sigaction (SIGSEGV
, &act
, NULL
);
10460 sigaction (SIGBUS
, &act
, NULL
);
10461 sigaction (SIGFPE
, &act
, NULL
);
10462 sigaction (SIGILL
, &act
, NULL
);
10463 sigaction (SIGBUS
, &act
, NULL
);
10467 #include "staticsymbols.h"
10468 /* This function try to convert a pointer into a function name. It's used in
10469 * oreder to provide a backtrace under segmentation fault that's able to
10470 * display functions declared as static (otherwise the backtrace is useless). */
10471 static char *findFuncName(void *pointer
, unsigned long *offset
){
10473 unsigned long off
, minoff
= 0;
10475 /* Try to match against the Symbol with the smallest offset */
10476 for (i
=0; symsTable
[i
].pointer
; i
++) {
10477 unsigned long lp
= (unsigned long) pointer
;
10479 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10480 off
=lp
-symsTable
[i
].pointer
;
10481 if (ret
< 0 || off
< minoff
) {
10487 if (ret
== -1) return NULL
;
10489 return symsTable
[ret
].name
;
10491 #else /* HAVE_BACKTRACE */
10492 static void setupSigSegvAction(void) {
10494 #endif /* HAVE_BACKTRACE */