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
);
626 static int rewriteAppendOnlyFileBackground(void);
627 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
629 static void authCommand(redisClient
*c
);
630 static void pingCommand(redisClient
*c
);
631 static void echoCommand(redisClient
*c
);
632 static void setCommand(redisClient
*c
);
633 static void setnxCommand(redisClient
*c
);
634 static void setexCommand(redisClient
*c
);
635 static void getCommand(redisClient
*c
);
636 static void delCommand(redisClient
*c
);
637 static void existsCommand(redisClient
*c
);
638 static void incrCommand(redisClient
*c
);
639 static void decrCommand(redisClient
*c
);
640 static void incrbyCommand(redisClient
*c
);
641 static void decrbyCommand(redisClient
*c
);
642 static void selectCommand(redisClient
*c
);
643 static void randomkeyCommand(redisClient
*c
);
644 static void keysCommand(redisClient
*c
);
645 static void dbsizeCommand(redisClient
*c
);
646 static void lastsaveCommand(redisClient
*c
);
647 static void saveCommand(redisClient
*c
);
648 static void bgsaveCommand(redisClient
*c
);
649 static void bgrewriteaofCommand(redisClient
*c
);
650 static void shutdownCommand(redisClient
*c
);
651 static void moveCommand(redisClient
*c
);
652 static void renameCommand(redisClient
*c
);
653 static void renamenxCommand(redisClient
*c
);
654 static void lpushCommand(redisClient
*c
);
655 static void rpushCommand(redisClient
*c
);
656 static void lpopCommand(redisClient
*c
);
657 static void rpopCommand(redisClient
*c
);
658 static void llenCommand(redisClient
*c
);
659 static void lindexCommand(redisClient
*c
);
660 static void lrangeCommand(redisClient
*c
);
661 static void ltrimCommand(redisClient
*c
);
662 static void typeCommand(redisClient
*c
);
663 static void lsetCommand(redisClient
*c
);
664 static void saddCommand(redisClient
*c
);
665 static void sremCommand(redisClient
*c
);
666 static void smoveCommand(redisClient
*c
);
667 static void sismemberCommand(redisClient
*c
);
668 static void scardCommand(redisClient
*c
);
669 static void spopCommand(redisClient
*c
);
670 static void srandmemberCommand(redisClient
*c
);
671 static void sinterCommand(redisClient
*c
);
672 static void sinterstoreCommand(redisClient
*c
);
673 static void sunionCommand(redisClient
*c
);
674 static void sunionstoreCommand(redisClient
*c
);
675 static void sdiffCommand(redisClient
*c
);
676 static void sdiffstoreCommand(redisClient
*c
);
677 static void syncCommand(redisClient
*c
);
678 static void flushdbCommand(redisClient
*c
);
679 static void flushallCommand(redisClient
*c
);
680 static void sortCommand(redisClient
*c
);
681 static void lremCommand(redisClient
*c
);
682 static void rpoplpushcommand(redisClient
*c
);
683 static void infoCommand(redisClient
*c
);
684 static void mgetCommand(redisClient
*c
);
685 static void monitorCommand(redisClient
*c
);
686 static void expireCommand(redisClient
*c
);
687 static void expireatCommand(redisClient
*c
);
688 static void getsetCommand(redisClient
*c
);
689 static void ttlCommand(redisClient
*c
);
690 static void slaveofCommand(redisClient
*c
);
691 static void debugCommand(redisClient
*c
);
692 static void msetCommand(redisClient
*c
);
693 static void msetnxCommand(redisClient
*c
);
694 static void zaddCommand(redisClient
*c
);
695 static void zincrbyCommand(redisClient
*c
);
696 static void zrangeCommand(redisClient
*c
);
697 static void zrangebyscoreCommand(redisClient
*c
);
698 static void zcountCommand(redisClient
*c
);
699 static void zrevrangeCommand(redisClient
*c
);
700 static void zcardCommand(redisClient
*c
);
701 static void zremCommand(redisClient
*c
);
702 static void zscoreCommand(redisClient
*c
);
703 static void zremrangebyscoreCommand(redisClient
*c
);
704 static void multiCommand(redisClient
*c
);
705 static void execCommand(redisClient
*c
);
706 static void discardCommand(redisClient
*c
);
707 static void blpopCommand(redisClient
*c
);
708 static void brpopCommand(redisClient
*c
);
709 static void appendCommand(redisClient
*c
);
710 static void substrCommand(redisClient
*c
);
711 static void zrankCommand(redisClient
*c
);
712 static void zrevrankCommand(redisClient
*c
);
713 static void hsetCommand(redisClient
*c
);
714 static void hsetnxCommand(redisClient
*c
);
715 static void hgetCommand(redisClient
*c
);
716 static void hmsetCommand(redisClient
*c
);
717 static void hmgetCommand(redisClient
*c
);
718 static void hdelCommand(redisClient
*c
);
719 static void hlenCommand(redisClient
*c
);
720 static void zremrangebyrankCommand(redisClient
*c
);
721 static void zunionCommand(redisClient
*c
);
722 static void zinterCommand(redisClient
*c
);
723 static void hkeysCommand(redisClient
*c
);
724 static void hvalsCommand(redisClient
*c
);
725 static void hgetallCommand(redisClient
*c
);
726 static void hexistsCommand(redisClient
*c
);
727 static void configCommand(redisClient
*c
);
728 static void hincrbyCommand(redisClient
*c
);
729 static void subscribeCommand(redisClient
*c
);
730 static void unsubscribeCommand(redisClient
*c
);
731 static void psubscribeCommand(redisClient
*c
);
732 static void punsubscribeCommand(redisClient
*c
);
733 static void publishCommand(redisClient
*c
);
735 /*================================= Globals ================================= */
738 static struct redisServer server
; /* server global state */
739 static struct redisCommand cmdTable
[] = {
740 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
742 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
743 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
744 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
747 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
749 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
750 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
751 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
752 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
753 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
755 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
760 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
763 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
764 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
766 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
767 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
768 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
769 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
770 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
771 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
772 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
773 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
774 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
775 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
776 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
777 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
779 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
780 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
781 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
784 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
785 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
786 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
791 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
792 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
796 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
797 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
798 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
801 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
805 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
806 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
807 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
808 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
809 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
810 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
813 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
814 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
815 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
822 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
828 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
830 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
835 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
838 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
841 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
842 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
846 {NULL
,NULL
,0,0,NULL
,0,0,0}
849 /*============================ Utility functions ============================ */
851 /* Glob-style pattern matching. */
852 static int stringmatchlen(const char *pattern
, int patternLen
,
853 const char *string
, int stringLen
, int nocase
)
858 while (pattern
[1] == '*') {
863 return 1; /* match */
865 if (stringmatchlen(pattern
+1, patternLen
-1,
866 string
, stringLen
, nocase
))
867 return 1; /* match */
871 return 0; /* no match */
875 return 0; /* no match */
885 not = pattern
[0] == '^';
892 if (pattern
[0] == '\\') {
895 if (pattern
[0] == string
[0])
897 } else if (pattern
[0] == ']') {
899 } else if (patternLen
== 0) {
903 } else if (pattern
[1] == '-' && patternLen
>= 3) {
904 int start
= pattern
[0];
905 int end
= pattern
[2];
913 start
= tolower(start
);
919 if (c
>= start
&& c
<= end
)
923 if (pattern
[0] == string
[0])
926 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
936 return 0; /* no match */
942 if (patternLen
>= 2) {
949 if (pattern
[0] != string
[0])
950 return 0; /* no match */
952 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
953 return 0; /* no match */
961 if (stringLen
== 0) {
962 while(*pattern
== '*') {
969 if (patternLen
== 0 && stringLen
== 0)
974 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
975 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
978 /* Convert a string representing an amount of memory into the number of
979 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
982 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
984 static long long memtoll(const char *p
, int *err
) {
987 long mul
; /* unit multiplier */
992 /* Search the first non digit character. */
995 while(*u
&& isdigit(*u
)) u
++;
996 if (*u
== '\0' || !strcasecmp(u
,"b")) {
998 } else if (!strcasecmp(u
,"k")) {
1000 } else if (!strcasecmp(u
,"kb")) {
1002 } else if (!strcasecmp(u
,"m")) {
1004 } else if (!strcasecmp(u
,"mb")) {
1006 } else if (!strcasecmp(u
,"g")) {
1007 mul
= 1000L*1000*1000;
1008 } else if (!strcasecmp(u
,"gb")) {
1009 mul
= 1024L*1024*1024;
1015 if (digits
>= sizeof(buf
)) {
1019 memcpy(buf
,p
,digits
);
1021 val
= strtoll(buf
,NULL
,10);
1025 static void redisLog(int level
, const char *fmt
, ...) {
1029 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1033 if (level
>= server
.verbosity
) {
1039 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1040 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1041 vfprintf(fp
, fmt
, ap
);
1047 if (server
.logfile
) fclose(fp
);
1050 /*====================== Hash table type implementation ==================== */
1052 /* This is an hash table type that uses the SDS dynamic strings libary as
1053 * keys and radis objects as values (objects can hold SDS strings,
1056 static void dictVanillaFree(void *privdata
, void *val
)
1058 DICT_NOTUSED(privdata
);
1062 static void dictListDestructor(void *privdata
, void *val
)
1064 DICT_NOTUSED(privdata
);
1065 listRelease((list
*)val
);
1068 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1072 DICT_NOTUSED(privdata
);
1074 l1
= sdslen((sds
)key1
);
1075 l2
= sdslen((sds
)key2
);
1076 if (l1
!= l2
) return 0;
1077 return memcmp(key1
, key2
, l1
) == 0;
1080 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1082 DICT_NOTUSED(privdata
);
1084 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1088 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1091 const robj
*o1
= key1
, *o2
= key2
;
1092 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1095 static unsigned int dictObjHash(const void *key
) {
1096 const robj
*o
= key
;
1097 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1100 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1103 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1106 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1107 o2
->encoding
== REDIS_ENCODING_INT
&&
1108 o1
->ptr
== o2
->ptr
) return 1;
1110 o1
= getDecodedObject(o1
);
1111 o2
= getDecodedObject(o2
);
1112 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1118 static unsigned int dictEncObjHash(const void *key
) {
1119 robj
*o
= (robj
*) key
;
1121 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1122 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1124 if (o
->encoding
== REDIS_ENCODING_INT
) {
1128 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1129 return dictGenHashFunction((unsigned char*)buf
, len
);
1133 o
= getDecodedObject(o
);
1134 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1141 /* Sets type and expires */
1142 static dictType setDictType
= {
1143 dictEncObjHash
, /* hash function */
1146 dictEncObjKeyCompare
, /* key compare */
1147 dictRedisObjectDestructor
, /* key destructor */
1148 NULL
/* val destructor */
1151 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1152 static dictType zsetDictType
= {
1153 dictEncObjHash
, /* hash function */
1156 dictEncObjKeyCompare
, /* key compare */
1157 dictRedisObjectDestructor
, /* key destructor */
1158 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1162 static dictType dbDictType
= {
1163 dictObjHash
, /* hash function */
1166 dictObjKeyCompare
, /* key compare */
1167 dictRedisObjectDestructor
, /* key destructor */
1168 dictRedisObjectDestructor
/* val destructor */
1172 static dictType keyptrDictType
= {
1173 dictObjHash
, /* hash function */
1176 dictObjKeyCompare
, /* key compare */
1177 dictRedisObjectDestructor
, /* key destructor */
1178 NULL
/* val destructor */
1181 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1182 static dictType hashDictType
= {
1183 dictEncObjHash
, /* hash function */
1186 dictEncObjKeyCompare
, /* key compare */
1187 dictRedisObjectDestructor
, /* key destructor */
1188 dictRedisObjectDestructor
/* val destructor */
1191 /* Keylist hash table type has unencoded redis objects as keys and
1192 * lists as values. It's used for blocking operations (BLPOP) and to
1193 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1194 static dictType keylistDictType
= {
1195 dictObjHash
, /* hash function */
1198 dictObjKeyCompare
, /* key compare */
1199 dictRedisObjectDestructor
, /* key destructor */
1200 dictListDestructor
/* val destructor */
1203 static void version();
1205 /* ========================= Random utility functions ======================= */
1207 /* Redis generally does not try to recover from out of memory conditions
1208 * when allocating objects or strings, it is not clear if it will be possible
1209 * to report this condition to the client since the networking layer itself
1210 * is based on heap allocation for send buffers, so we simply abort.
1211 * At least the code will be simpler to read... */
1212 static void oom(const char *msg
) {
1213 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1218 /* ====================== Redis server networking stuff ===================== */
1219 static void closeTimedoutClients(void) {
1222 time_t now
= time(NULL
);
1225 listRewind(server
.clients
,&li
);
1226 while ((ln
= listNext(&li
)) != NULL
) {
1227 c
= listNodeValue(ln
);
1228 if (server
.maxidletime
&&
1229 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1230 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1231 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1232 listLength(c
->pubsub_patterns
) == 0 &&
1233 (now
- c
->lastinteraction
> server
.maxidletime
))
1235 redisLog(REDIS_VERBOSE
,"Closing idle client");
1237 } else if (c
->flags
& REDIS_BLOCKED
) {
1238 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1239 addReply(c
,shared
.nullmultibulk
);
1240 unblockClientWaitingData(c
);
1246 static int htNeedsResize(dict
*dict
) {
1247 long long size
, used
;
1249 size
= dictSlots(dict
);
1250 used
= dictSize(dict
);
1251 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1252 (used
*100/size
< REDIS_HT_MINFILL
));
1255 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1256 * we resize the hash table to save memory */
1257 static void tryResizeHashTables(void) {
1260 for (j
= 0; j
< server
.dbnum
; j
++) {
1261 if (htNeedsResize(server
.db
[j
].dict
))
1262 dictResize(server
.db
[j
].dict
);
1263 if (htNeedsResize(server
.db
[j
].expires
))
1264 dictResize(server
.db
[j
].expires
);
1268 /* Our hash table implementation performs rehashing incrementally while
1269 * we write/read from the hash table. Still if the server is idle, the hash
1270 * table will use two tables for a long time. So we try to use 1 millisecond
1271 * of CPU time at every serverCron() loop in order to rehash some key. */
1272 static void incrementallyRehash(void) {
1275 for (j
= 0; j
< server
.dbnum
; j
++) {
1276 if (dictIsRehashing(server
.db
[j
].dict
)) {
1277 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1278 break; /* already used our millisecond for this loop... */
1283 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1284 void backgroundSaveDoneHandler(int statloc
) {
1285 int exitcode
= WEXITSTATUS(statloc
);
1286 int bysignal
= WIFSIGNALED(statloc
);
1288 if (!bysignal
&& exitcode
== 0) {
1289 redisLog(REDIS_NOTICE
,
1290 "Background saving terminated with success");
1292 server
.lastsave
= time(NULL
);
1293 } else if (!bysignal
&& exitcode
!= 0) {
1294 redisLog(REDIS_WARNING
, "Background saving error");
1296 redisLog(REDIS_WARNING
,
1297 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1298 rdbRemoveTempFile(server
.bgsavechildpid
);
1300 server
.bgsavechildpid
= -1;
1301 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1302 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1303 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1306 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1308 void backgroundRewriteDoneHandler(int statloc
) {
1309 int exitcode
= WEXITSTATUS(statloc
);
1310 int bysignal
= WIFSIGNALED(statloc
);
1312 if (!bysignal
&& exitcode
== 0) {
1316 redisLog(REDIS_NOTICE
,
1317 "Background append only file rewriting terminated with success");
1318 /* Now it's time to flush the differences accumulated by the parent */
1319 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1320 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1322 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1325 /* Flush our data... */
1326 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1327 (signed) sdslen(server
.bgrewritebuf
)) {
1328 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
));
1332 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1333 /* Now our work is to rename the temp file into the stable file. And
1334 * switch the file descriptor used by the server for append only. */
1335 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1336 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1340 /* Mission completed... almost */
1341 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1342 if (server
.appendfd
!= -1) {
1343 /* If append only is actually enabled... */
1344 close(server
.appendfd
);
1345 server
.appendfd
= fd
;
1347 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1348 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1350 /* If append only is disabled we just generate a dump in this
1351 * format. Why not? */
1354 } else if (!bysignal
&& exitcode
!= 0) {
1355 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1357 redisLog(REDIS_WARNING
,
1358 "Background append only file rewriting terminated by signal %d",
1362 sdsfree(server
.bgrewritebuf
);
1363 server
.bgrewritebuf
= sdsempty();
1364 aofRemoveTempFile(server
.bgrewritechildpid
);
1365 server
.bgrewritechildpid
= -1;
1368 /* This function is called once a background process of some kind terminates,
1369 * as we want to avoid resizing the hash tables when there is a child in order
1370 * to play well with copy-on-write (otherwise when a resize happens lots of
1371 * memory pages are copied). The goal of this function is to update the ability
1372 * for dict.c to resize the hash tables accordingly to the fact we have o not
1373 * running childs. */
1374 static void updateDictResizePolicy(void) {
1375 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1378 dictDisableResize();
1381 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1382 int j
, loops
= server
.cronloops
++;
1383 REDIS_NOTUSED(eventLoop
);
1385 REDIS_NOTUSED(clientData
);
1387 /* We take a cached value of the unix time in the global state because
1388 * with virtual memory and aging there is to store the current time
1389 * in objects at every object access, and accuracy is not needed.
1390 * To access a global var is faster than calling time(NULL) */
1391 server
.unixtime
= time(NULL
);
1393 /* Show some info about non-empty databases */
1394 for (j
= 0; j
< server
.dbnum
; j
++) {
1395 long long size
, used
, vkeys
;
1397 size
= dictSlots(server
.db
[j
].dict
);
1398 used
= dictSize(server
.db
[j
].dict
);
1399 vkeys
= dictSize(server
.db
[j
].expires
);
1400 if (!(loops
% 50) && (used
|| vkeys
)) {
1401 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1402 /* dictPrintStats(server.dict); */
1406 /* We don't want to resize the hash tables while a bacground saving
1407 * is in progress: the saving child is created using fork() that is
1408 * implemented with a copy-on-write semantic in most modern systems, so
1409 * if we resize the HT while there is the saving child at work actually
1410 * a lot of memory movements in the parent will cause a lot of pages
1412 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1413 if (!(loops
% 10)) tryResizeHashTables();
1414 if (server
.activerehashing
) incrementallyRehash();
1417 /* Show information about connected clients */
1418 if (!(loops
% 50)) {
1419 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1420 listLength(server
.clients
)-listLength(server
.slaves
),
1421 listLength(server
.slaves
),
1422 zmalloc_used_memory());
1425 /* Close connections of timedout clients */
1426 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1427 closeTimedoutClients();
1429 /* Check if a background saving or AOF rewrite in progress terminated */
1430 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1434 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1435 if (pid
== server
.bgsavechildpid
) {
1436 backgroundSaveDoneHandler(statloc
);
1438 backgroundRewriteDoneHandler(statloc
);
1440 updateDictResizePolicy();
1443 /* If there is not a background saving in progress check if
1444 * we have to save now */
1445 time_t now
= time(NULL
);
1446 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1447 struct saveparam
*sp
= server
.saveparams
+j
;
1449 if (server
.dirty
>= sp
->changes
&&
1450 now
-server
.lastsave
> sp
->seconds
) {
1451 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1452 sp
->changes
, sp
->seconds
);
1453 rdbSaveBackground(server
.dbfilename
);
1459 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1460 * will use few CPU cycles if there are few expiring keys, otherwise
1461 * it will get more aggressive to avoid that too much memory is used by
1462 * keys that can be removed from the keyspace. */
1463 for (j
= 0; j
< server
.dbnum
; j
++) {
1465 redisDb
*db
= server
.db
+j
;
1467 /* Continue to expire if at the end of the cycle more than 25%
1468 * of the keys were expired. */
1470 long num
= dictSize(db
->expires
);
1471 time_t now
= time(NULL
);
1474 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1475 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1480 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1481 t
= (time_t) dictGetEntryVal(de
);
1483 deleteKey(db
,dictGetEntryKey(de
));
1485 server
.stat_expiredkeys
++;
1488 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1491 /* Swap a few keys on disk if we are over the memory limit and VM
1492 * is enbled. Try to free objects from the free list first. */
1493 if (vmCanSwapOut()) {
1494 while (server
.vm_enabled
&& zmalloc_used_memory() >
1495 server
.vm_max_memory
)
1499 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1500 retval
= (server
.vm_max_threads
== 0) ?
1501 vmSwapOneObjectBlocking() :
1502 vmSwapOneObjectThreaded();
1503 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1504 zmalloc_used_memory() >
1505 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1507 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1509 /* Note that when using threade I/O we free just one object,
1510 * because anyway when the I/O thread in charge to swap this
1511 * object out will finish, the handler of completed jobs
1512 * will try to swap more objects if we are still out of memory. */
1513 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1517 /* Check if we should connect to a MASTER */
1518 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1519 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1520 if (syncWithMaster() == REDIS_OK
) {
1521 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1522 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1528 /* This function gets called every time Redis is entering the
1529 * main loop of the event driven library, that is, before to sleep
1530 * for ready file descriptors. */
1531 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1532 REDIS_NOTUSED(eventLoop
);
1534 /* Awake clients that got all the swapped keys they requested */
1535 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1539 listRewind(server
.io_ready_clients
,&li
);
1540 while((ln
= listNext(&li
))) {
1541 redisClient
*c
= ln
->value
;
1542 struct redisCommand
*cmd
;
1544 /* Resume the client. */
1545 listDelNode(server
.io_ready_clients
,ln
);
1546 c
->flags
&= (~REDIS_IO_WAIT
);
1547 server
.vm_blocked_clients
--;
1548 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1549 readQueryFromClient
, c
);
1550 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1551 assert(cmd
!= NULL
);
1554 /* There may be more data to process in the input buffer. */
1555 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1556 processInputBuffer(c
);
1559 /* Write the AOF buffer on disk */
1560 flushAppendOnlyFile();
1563 static void createSharedObjects(void) {
1566 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1567 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1568 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1569 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1570 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1571 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1572 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1573 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1574 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1575 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1576 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1577 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1578 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1579 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1580 "-ERR no such key\r\n"));
1581 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1582 "-ERR syntax error\r\n"));
1583 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1584 "-ERR source and destination objects are the same\r\n"));
1585 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1586 "-ERR index out of range\r\n"));
1587 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1588 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1589 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1590 shared
.select0
= createStringObject("select 0\r\n",10);
1591 shared
.select1
= createStringObject("select 1\r\n",10);
1592 shared
.select2
= createStringObject("select 2\r\n",10);
1593 shared
.select3
= createStringObject("select 3\r\n",10);
1594 shared
.select4
= createStringObject("select 4\r\n",10);
1595 shared
.select5
= createStringObject("select 5\r\n",10);
1596 shared
.select6
= createStringObject("select 6\r\n",10);
1597 shared
.select7
= createStringObject("select 7\r\n",10);
1598 shared
.select8
= createStringObject("select 8\r\n",10);
1599 shared
.select9
= createStringObject("select 9\r\n",10);
1600 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1601 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1602 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1603 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1604 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1605 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1606 shared
.mbulk3
= createStringObject("*3\r\n",4);
1607 shared
.mbulk4
= createStringObject("*4\r\n",4);
1608 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1609 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1610 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1614 static void appendServerSaveParams(time_t seconds
, int changes
) {
1615 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1616 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1617 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1618 server
.saveparamslen
++;
1621 static void resetServerSaveParams() {
1622 zfree(server
.saveparams
);
1623 server
.saveparams
= NULL
;
1624 server
.saveparamslen
= 0;
1627 static void initServerConfig() {
1628 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1629 server
.port
= REDIS_SERVERPORT
;
1630 server
.verbosity
= REDIS_VERBOSE
;
1631 server
.maxidletime
= REDIS_MAXIDLETIME
;
1632 server
.saveparams
= NULL
;
1633 server
.logfile
= NULL
; /* NULL = log on standard output */
1634 server
.bindaddr
= NULL
;
1635 server
.glueoutputbuf
= 1;
1636 server
.daemonize
= 0;
1637 server
.appendonly
= 0;
1638 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1639 server
.lastfsync
= time(NULL
);
1640 server
.appendfd
= -1;
1641 server
.appendseldb
= -1; /* Make sure the first time will not match */
1642 server
.pidfile
= zstrdup("/var/run/redis.pid");
1643 server
.dbfilename
= zstrdup("dump.rdb");
1644 server
.appendfilename
= zstrdup("appendonly.aof");
1645 server
.requirepass
= NULL
;
1646 server
.rdbcompression
= 1;
1647 server
.activerehashing
= 1;
1648 server
.maxclients
= 0;
1649 server
.blpop_blocked_clients
= 0;
1650 server
.maxmemory
= 0;
1651 server
.vm_enabled
= 0;
1652 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1653 server
.vm_page_size
= 256; /* 256 bytes per page */
1654 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1655 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1656 server
.vm_max_threads
= 4;
1657 server
.vm_blocked_clients
= 0;
1658 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1659 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1661 resetServerSaveParams();
1663 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1664 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1665 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1666 /* Replication related */
1668 server
.masterauth
= NULL
;
1669 server
.masterhost
= NULL
;
1670 server
.masterport
= 6379;
1671 server
.master
= NULL
;
1672 server
.replstate
= REDIS_REPL_NONE
;
1674 /* Double constants initialization */
1676 R_PosInf
= 1.0/R_Zero
;
1677 R_NegInf
= -1.0/R_Zero
;
1678 R_Nan
= R_Zero
/R_Zero
;
1681 static void initServer() {
1684 signal(SIGHUP
, SIG_IGN
);
1685 signal(SIGPIPE
, SIG_IGN
);
1686 setupSigSegvAction();
1688 server
.devnull
= fopen("/dev/null","w");
1689 if (server
.devnull
== NULL
) {
1690 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1693 server
.clients
= listCreate();
1694 server
.slaves
= listCreate();
1695 server
.monitors
= listCreate();
1696 server
.objfreelist
= listCreate();
1697 createSharedObjects();
1698 server
.el
= aeCreateEventLoop();
1699 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1700 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1701 if (server
.fd
== -1) {
1702 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1705 for (j
= 0; j
< server
.dbnum
; j
++) {
1706 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1707 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1708 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1709 if (server
.vm_enabled
)
1710 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1711 server
.db
[j
].id
= j
;
1713 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1714 server
.pubsub_patterns
= listCreate();
1715 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1716 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1717 server
.cronloops
= 0;
1718 server
.bgsavechildpid
= -1;
1719 server
.bgrewritechildpid
= -1;
1720 server
.bgrewritebuf
= sdsempty();
1721 server
.aofbuf
= sdsempty();
1722 server
.lastsave
= time(NULL
);
1724 server
.stat_numcommands
= 0;
1725 server
.stat_numconnections
= 0;
1726 server
.stat_expiredkeys
= 0;
1727 server
.stat_starttime
= time(NULL
);
1728 server
.unixtime
= time(NULL
);
1729 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1730 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1731 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1733 if (server
.appendonly
) {
1734 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1735 if (server
.appendfd
== -1) {
1736 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1742 if (server
.vm_enabled
) vmInit();
1745 /* Empty the whole database */
1746 static long long emptyDb() {
1748 long long removed
= 0;
1750 for (j
= 0; j
< server
.dbnum
; j
++) {
1751 removed
+= dictSize(server
.db
[j
].dict
);
1752 dictEmpty(server
.db
[j
].dict
);
1753 dictEmpty(server
.db
[j
].expires
);
1758 static int yesnotoi(char *s
) {
1759 if (!strcasecmp(s
,"yes")) return 1;
1760 else if (!strcasecmp(s
,"no")) return 0;
1764 /* I agree, this is a very rudimental way to load a configuration...
1765 will improve later if the config gets more complex */
1766 static void loadServerConfig(char *filename
) {
1768 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1772 if (filename
[0] == '-' && filename
[1] == '\0')
1775 if ((fp
= fopen(filename
,"r")) == NULL
) {
1776 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1781 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1787 line
= sdstrim(line
," \t\r\n");
1789 /* Skip comments and blank lines*/
1790 if (line
[0] == '#' || line
[0] == '\0') {
1795 /* Split into arguments */
1796 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1797 sdstolower(argv
[0]);
1799 /* Execute config directives */
1800 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1801 server
.maxidletime
= atoi(argv
[1]);
1802 if (server
.maxidletime
< 0) {
1803 err
= "Invalid timeout value"; goto loaderr
;
1805 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1806 server
.port
= atoi(argv
[1]);
1807 if (server
.port
< 1 || server
.port
> 65535) {
1808 err
= "Invalid port"; goto loaderr
;
1810 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1811 server
.bindaddr
= zstrdup(argv
[1]);
1812 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1813 int seconds
= atoi(argv
[1]);
1814 int changes
= atoi(argv
[2]);
1815 if (seconds
< 1 || changes
< 0) {
1816 err
= "Invalid save parameters"; goto loaderr
;
1818 appendServerSaveParams(seconds
,changes
);
1819 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1820 if (chdir(argv
[1]) == -1) {
1821 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1822 argv
[1], strerror(errno
));
1825 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1826 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1827 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1828 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1829 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1831 err
= "Invalid log level. Must be one of debug, notice, warning";
1834 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1837 server
.logfile
= zstrdup(argv
[1]);
1838 if (!strcasecmp(server
.logfile
,"stdout")) {
1839 zfree(server
.logfile
);
1840 server
.logfile
= NULL
;
1842 if (server
.logfile
) {
1843 /* Test if we are able to open the file. The server will not
1844 * be able to abort just for this problem later... */
1845 logfp
= fopen(server
.logfile
,"a");
1846 if (logfp
== NULL
) {
1847 err
= sdscatprintf(sdsempty(),
1848 "Can't open the log file: %s", strerror(errno
));
1853 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1854 server
.dbnum
= atoi(argv
[1]);
1855 if (server
.dbnum
< 1) {
1856 err
= "Invalid number of databases"; goto loaderr
;
1858 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1859 loadServerConfig(argv
[1]);
1860 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1861 server
.maxclients
= atoi(argv
[1]);
1862 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1863 server
.maxmemory
= memtoll(argv
[1],NULL
);
1864 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1865 server
.masterhost
= sdsnew(argv
[1]);
1866 server
.masterport
= atoi(argv
[2]);
1867 server
.replstate
= REDIS_REPL_CONNECT
;
1868 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1869 server
.masterauth
= zstrdup(argv
[1]);
1870 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1871 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1872 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1874 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1875 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1876 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1878 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1879 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1880 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1882 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1883 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1884 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1886 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1887 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1888 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1890 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1891 if (!strcasecmp(argv
[1],"no")) {
1892 server
.appendfsync
= APPENDFSYNC_NO
;
1893 } else if (!strcasecmp(argv
[1],"always")) {
1894 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1895 } else if (!strcasecmp(argv
[1],"everysec")) {
1896 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1898 err
= "argument must be 'no', 'always' or 'everysec'";
1901 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1902 server
.requirepass
= zstrdup(argv
[1]);
1903 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1904 zfree(server
.pidfile
);
1905 server
.pidfile
= zstrdup(argv
[1]);
1906 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1907 zfree(server
.dbfilename
);
1908 server
.dbfilename
= zstrdup(argv
[1]);
1909 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1910 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1911 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1913 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1914 zfree(server
.vm_swap_file
);
1915 server
.vm_swap_file
= zstrdup(argv
[1]);
1916 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1917 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1918 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1919 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1920 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1921 server
.vm_pages
= memtoll(argv
[1], NULL
);
1922 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1923 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1924 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1925 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1926 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1927 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1929 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1931 for (j
= 0; j
< argc
; j
++)
1936 if (fp
!= stdin
) fclose(fp
);
1940 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1941 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1942 fprintf(stderr
, ">>> '%s'\n", line
);
1943 fprintf(stderr
, "%s\n", err
);
1947 static void freeClientArgv(redisClient
*c
) {
1950 for (j
= 0; j
< c
->argc
; j
++)
1951 decrRefCount(c
->argv
[j
]);
1952 for (j
= 0; j
< c
->mbargc
; j
++)
1953 decrRefCount(c
->mbargv
[j
]);
1958 static void freeClient(redisClient
*c
) {
1961 /* Note that if the client we are freeing is blocked into a blocking
1962 * call, we have to set querybuf to NULL *before* to call
1963 * unblockClientWaitingData() to avoid processInputBuffer() will get
1964 * called. Also it is important to remove the file events after
1965 * this, because this call adds the READABLE event. */
1966 sdsfree(c
->querybuf
);
1968 if (c
->flags
& REDIS_BLOCKED
)
1969 unblockClientWaitingData(c
);
1971 /* Unsubscribe from all the pubsub channels */
1972 pubsubUnsubscribeAllChannels(c
,0);
1973 pubsubUnsubscribeAllPatterns(c
,0);
1974 dictRelease(c
->pubsub_channels
);
1975 listRelease(c
->pubsub_patterns
);
1976 /* Obvious cleanup */
1977 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1978 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1979 listRelease(c
->reply
);
1982 /* Remove from the list of clients */
1983 ln
= listSearchKey(server
.clients
,c
);
1984 redisAssert(ln
!= NULL
);
1985 listDelNode(server
.clients
,ln
);
1986 /* Remove from the list of clients waiting for swapped keys */
1987 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1988 ln
= listSearchKey(server
.io_ready_clients
,c
);
1990 listDelNode(server
.io_ready_clients
,ln
);
1991 server
.vm_blocked_clients
--;
1994 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1995 ln
= listFirst(c
->io_keys
);
1996 dontWaitForSwappedKey(c
,ln
->value
);
1998 listRelease(c
->io_keys
);
1999 /* Master/slave cleanup */
2000 if (c
->flags
& REDIS_SLAVE
) {
2001 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2003 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2004 ln
= listSearchKey(l
,c
);
2005 redisAssert(ln
!= NULL
);
2008 if (c
->flags
& REDIS_MASTER
) {
2009 server
.master
= NULL
;
2010 server
.replstate
= REDIS_REPL_CONNECT
;
2012 /* Release memory */
2015 freeClientMultiState(c
);
2019 #define GLUEREPLY_UP_TO (1024)
2020 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2022 char buf
[GLUEREPLY_UP_TO
];
2027 listRewind(c
->reply
,&li
);
2028 while((ln
= listNext(&li
))) {
2032 objlen
= sdslen(o
->ptr
);
2033 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2034 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2036 listDelNode(c
->reply
,ln
);
2038 if (copylen
== 0) return;
2042 /* Now the output buffer is empty, add the new single element */
2043 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2044 listAddNodeHead(c
->reply
,o
);
2047 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2048 redisClient
*c
= privdata
;
2049 int nwritten
= 0, totwritten
= 0, objlen
;
2052 REDIS_NOTUSED(mask
);
2054 /* Use writev() if we have enough buffers to send */
2055 if (!server
.glueoutputbuf
&&
2056 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2057 !(c
->flags
& REDIS_MASTER
))
2059 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2063 while(listLength(c
->reply
)) {
2064 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2065 glueReplyBuffersIfNeeded(c
);
2067 o
= listNodeValue(listFirst(c
->reply
));
2068 objlen
= sdslen(o
->ptr
);
2071 listDelNode(c
->reply
,listFirst(c
->reply
));
2075 if (c
->flags
& REDIS_MASTER
) {
2076 /* Don't reply to a master */
2077 nwritten
= objlen
- c
->sentlen
;
2079 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2080 if (nwritten
<= 0) break;
2082 c
->sentlen
+= nwritten
;
2083 totwritten
+= nwritten
;
2084 /* If we fully sent the object on head go to the next one */
2085 if (c
->sentlen
== objlen
) {
2086 listDelNode(c
->reply
,listFirst(c
->reply
));
2089 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2090 * bytes, in a single threaded server it's a good idea to serve
2091 * other clients as well, even if a very large request comes from
2092 * super fast link that is always able to accept data (in real world
2093 * scenario think about 'KEYS *' against the loopback interfae) */
2094 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2096 if (nwritten
== -1) {
2097 if (errno
== EAGAIN
) {
2100 redisLog(REDIS_VERBOSE
,
2101 "Error writing to client: %s", strerror(errno
));
2106 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2107 if (listLength(c
->reply
) == 0) {
2109 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2113 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2115 redisClient
*c
= privdata
;
2116 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2118 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2119 int offset
, ion
= 0;
2121 REDIS_NOTUSED(mask
);
2124 while (listLength(c
->reply
)) {
2125 offset
= c
->sentlen
;
2129 /* fill-in the iov[] array */
2130 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2131 o
= listNodeValue(node
);
2132 objlen
= sdslen(o
->ptr
);
2134 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2137 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2138 break; /* no more iovecs */
2140 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2141 iov
[ion
].iov_len
= objlen
- offset
;
2142 willwrite
+= objlen
- offset
;
2143 offset
= 0; /* just for the first item */
2150 /* write all collected blocks at once */
2151 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2152 if (errno
!= EAGAIN
) {
2153 redisLog(REDIS_VERBOSE
,
2154 "Error writing to client: %s", strerror(errno
));
2161 totwritten
+= nwritten
;
2162 offset
= c
->sentlen
;
2164 /* remove written robjs from c->reply */
2165 while (nwritten
&& listLength(c
->reply
)) {
2166 o
= listNodeValue(listFirst(c
->reply
));
2167 objlen
= sdslen(o
->ptr
);
2169 if(nwritten
>= objlen
- offset
) {
2170 listDelNode(c
->reply
, listFirst(c
->reply
));
2171 nwritten
-= objlen
- offset
;
2175 c
->sentlen
+= nwritten
;
2183 c
->lastinteraction
= time(NULL
);
2185 if (listLength(c
->reply
) == 0) {
2187 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2191 static struct redisCommand
*lookupCommand(char *name
) {
2193 while(cmdTable
[j
].name
!= NULL
) {
2194 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2200 /* resetClient prepare the client to process the next command */
2201 static void resetClient(redisClient
*c
) {
2207 /* Call() is the core of Redis execution of a command */
2208 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2211 dirty
= server
.dirty
;
2213 dirty
= server
.dirty
-dirty
;
2215 if (server
.appendonly
&& dirty
)
2216 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2217 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2218 listLength(server
.slaves
))
2219 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2220 if (listLength(server
.monitors
))
2221 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2222 server
.stat_numcommands
++;
2225 /* If this function gets called we already read a whole
2226 * command, argments are in the client argv/argc fields.
2227 * processCommand() execute the command or prepare the
2228 * server for a bulk read from the client.
2230 * If 1 is returned the client is still alive and valid and
2231 * and other operations can be performed by the caller. Otherwise
2232 * if 0 is returned the client was destroied (i.e. after QUIT). */
2233 static int processCommand(redisClient
*c
) {
2234 struct redisCommand
*cmd
;
2236 /* Free some memory if needed (maxmemory setting) */
2237 if (server
.maxmemory
) freeMemoryIfNeeded();
2239 /* Handle the multi bulk command type. This is an alternative protocol
2240 * supported by Redis in order to receive commands that are composed of
2241 * multiple binary-safe "bulk" arguments. The latency of processing is
2242 * a bit higher but this allows things like multi-sets, so if this
2243 * protocol is used only for MSET and similar commands this is a big win. */
2244 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2245 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2246 if (c
->multibulk
<= 0) {
2250 decrRefCount(c
->argv
[c
->argc
-1]);
2254 } else if (c
->multibulk
) {
2255 if (c
->bulklen
== -1) {
2256 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2257 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2261 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2262 decrRefCount(c
->argv
[0]);
2263 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2265 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2270 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2274 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2275 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2279 if (c
->multibulk
== 0) {
2283 /* Here we need to swap the multi-bulk argc/argv with the
2284 * normal argc/argv of the client structure. */
2286 c
->argv
= c
->mbargv
;
2287 c
->mbargv
= auxargv
;
2290 c
->argc
= c
->mbargc
;
2291 c
->mbargc
= auxargc
;
2293 /* We need to set bulklen to something different than -1
2294 * in order for the code below to process the command without
2295 * to try to read the last argument of a bulk command as
2296 * a special argument. */
2298 /* continue below and process the command */
2305 /* -- end of multi bulk commands processing -- */
2307 /* The QUIT command is handled as a special case. Normal command
2308 * procs are unable to close the client connection safely */
2309 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2314 /* Now lookup the command and check ASAP about trivial error conditions
2315 * such wrong arity, bad command name and so forth. */
2316 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2319 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2320 (char*)c
->argv
[0]->ptr
));
2323 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2324 (c
->argc
< -cmd
->arity
)) {
2326 sdscatprintf(sdsempty(),
2327 "-ERR wrong number of arguments for '%s' command\r\n",
2331 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2332 /* This is a bulk command, we have to read the last argument yet. */
2333 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2335 decrRefCount(c
->argv
[c
->argc
-1]);
2336 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2338 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2343 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2344 /* It is possible that the bulk read is already in the
2345 * buffer. Check this condition and handle it accordingly.
2346 * This is just a fast path, alternative to call processInputBuffer().
2347 * It's a good idea since the code is small and this condition
2348 * happens most of the times. */
2349 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2350 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2352 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2354 /* Otherwise return... there is to read the last argument
2355 * from the socket. */
2359 /* Let's try to encode the bulk object to save space. */
2360 if (cmd
->flags
& REDIS_CMD_BULK
)
2361 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2363 /* Check if the user is authenticated */
2364 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2365 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2370 /* Handle the maxmemory directive */
2371 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2372 zmalloc_used_memory() > server
.maxmemory
)
2374 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2379 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2380 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2382 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2383 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2384 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2389 /* Exec the command */
2390 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2391 queueMultiCommand(c
,cmd
);
2392 addReply(c
,shared
.queued
);
2394 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2395 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2399 /* Prepare the client for the next command */
2404 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2409 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2410 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2411 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2412 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2415 if (argc
<= REDIS_STATIC_ARGS
) {
2418 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2421 lenobj
= createObject(REDIS_STRING
,
2422 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2423 lenobj
->refcount
= 0;
2424 outv
[outc
++] = lenobj
;
2425 for (j
= 0; j
< argc
; j
++) {
2426 lenobj
= createObject(REDIS_STRING
,
2427 sdscatprintf(sdsempty(),"$%lu\r\n",
2428 (unsigned long) stringObjectLen(argv
[j
])));
2429 lenobj
->refcount
= 0;
2430 outv
[outc
++] = lenobj
;
2431 outv
[outc
++] = argv
[j
];
2432 outv
[outc
++] = shared
.crlf
;
2435 /* Increment all the refcounts at start and decrement at end in order to
2436 * be sure to free objects if there is no slave in a replication state
2437 * able to be feed with commands */
2438 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2439 listRewind(slaves
,&li
);
2440 while((ln
= listNext(&li
))) {
2441 redisClient
*slave
= ln
->value
;
2443 /* Don't feed slaves that are still waiting for BGSAVE to start */
2444 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2446 /* Feed all the other slaves, MONITORs and so on */
2447 if (slave
->slaveseldb
!= dictid
) {
2451 case 0: selectcmd
= shared
.select0
; break;
2452 case 1: selectcmd
= shared
.select1
; break;
2453 case 2: selectcmd
= shared
.select2
; break;
2454 case 3: selectcmd
= shared
.select3
; break;
2455 case 4: selectcmd
= shared
.select4
; break;
2456 case 5: selectcmd
= shared
.select5
; break;
2457 case 6: selectcmd
= shared
.select6
; break;
2458 case 7: selectcmd
= shared
.select7
; break;
2459 case 8: selectcmd
= shared
.select8
; break;
2460 case 9: selectcmd
= shared
.select9
; break;
2462 selectcmd
= createObject(REDIS_STRING
,
2463 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2464 selectcmd
->refcount
= 0;
2467 addReply(slave
,selectcmd
);
2468 slave
->slaveseldb
= dictid
;
2470 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2472 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2473 if (outv
!= static_outv
) zfree(outv
);
2476 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2477 s
= sdscatlen(s
,"\"",1);
2482 s
= sdscatprintf(s
,"\\%c",*p
);
2484 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2485 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2486 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2487 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2488 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2491 s
= sdscatprintf(s
,"%c",*p
);
2493 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2498 return sdscatlen(s
,"\"",1);
2501 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2505 sds cmdrepr
= sdsnew("+");
2509 gettimeofday(&tv
,NULL
);
2510 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2511 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2513 for (j
= 0; j
< argc
; j
++) {
2514 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2515 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2517 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2518 sdslen(argv
[j
]->ptr
));
2521 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2523 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2524 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2526 listRewind(monitors
,&li
);
2527 while((ln
= listNext(&li
))) {
2528 redisClient
*monitor
= ln
->value
;
2529 addReply(monitor
,cmdobj
);
2531 decrRefCount(cmdobj
);
2534 static void processInputBuffer(redisClient
*c
) {
2536 /* Before to process the input buffer, make sure the client is not
2537 * waitig for a blocking operation such as BLPOP. Note that the first
2538 * iteration the client is never blocked, otherwise the processInputBuffer
2539 * would not be called at all, but after the execution of the first commands
2540 * in the input buffer the client may be blocked, and the "goto again"
2541 * will try to reiterate. The following line will make it return asap. */
2542 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2543 if (c
->bulklen
== -1) {
2544 /* Read the first line of the query */
2545 char *p
= strchr(c
->querybuf
,'\n');
2552 query
= c
->querybuf
;
2553 c
->querybuf
= sdsempty();
2554 querylen
= 1+(p
-(query
));
2555 if (sdslen(query
) > querylen
) {
2556 /* leave data after the first line of the query in the buffer */
2557 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2559 *p
= '\0'; /* remove "\n" */
2560 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2561 sdsupdatelen(query
);
2563 /* Now we can split the query in arguments */
2564 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2567 if (c
->argv
) zfree(c
->argv
);
2568 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2570 for (j
= 0; j
< argc
; j
++) {
2571 if (sdslen(argv
[j
])) {
2572 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2580 /* Execute the command. If the client is still valid
2581 * after processCommand() return and there is something
2582 * on the query buffer try to process the next command. */
2583 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2585 /* Nothing to process, argc == 0. Just process the query
2586 * buffer if it's not empty or return to the caller */
2587 if (sdslen(c
->querybuf
)) goto again
;
2590 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2591 redisLog(REDIS_VERBOSE
, "Client protocol error");
2596 /* Bulk read handling. Note that if we are at this point
2597 the client already sent a command terminated with a newline,
2598 we are reading the bulk data that is actually the last
2599 argument of the command. */
2600 int qbl
= sdslen(c
->querybuf
);
2602 if (c
->bulklen
<= qbl
) {
2603 /* Copy everything but the final CRLF as final argument */
2604 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2606 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2607 /* Process the command. If the client is still valid after
2608 * the processing and there is more data in the buffer
2609 * try to parse it. */
2610 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2616 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2617 redisClient
*c
= (redisClient
*) privdata
;
2618 char buf
[REDIS_IOBUF_LEN
];
2621 REDIS_NOTUSED(mask
);
2623 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2625 if (errno
== EAGAIN
) {
2628 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2632 } else if (nread
== 0) {
2633 redisLog(REDIS_VERBOSE
, "Client closed connection");
2638 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2639 c
->lastinteraction
= time(NULL
);
2643 processInputBuffer(c
);
2646 static int selectDb(redisClient
*c
, int id
) {
2647 if (id
< 0 || id
>= server
.dbnum
)
2649 c
->db
= &server
.db
[id
];
2653 static void *dupClientReplyValue(void *o
) {
2654 incrRefCount((robj
*)o
);
2658 static int listMatchObjects(void *a
, void *b
) {
2659 return compareStringObjects(a
,b
) == 0;
2662 static redisClient
*createClient(int fd
) {
2663 redisClient
*c
= zmalloc(sizeof(*c
));
2665 anetNonBlock(NULL
,fd
);
2666 anetTcpNoDelay(NULL
,fd
);
2667 if (!c
) return NULL
;
2670 c
->querybuf
= sdsempty();
2679 c
->lastinteraction
= time(NULL
);
2680 c
->authenticated
= 0;
2681 c
->replstate
= REDIS_REPL_NONE
;
2682 c
->reply
= listCreate();
2683 listSetFreeMethod(c
->reply
,decrRefCount
);
2684 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2685 c
->blockingkeys
= NULL
;
2686 c
->blockingkeysnum
= 0;
2687 c
->io_keys
= listCreate();
2688 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2689 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2690 c
->pubsub_patterns
= listCreate();
2691 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2692 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2693 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2694 readQueryFromClient
, c
) == AE_ERR
) {
2698 listAddNodeTail(server
.clients
,c
);
2699 initClientMultiState(c
);
2703 static void addReply(redisClient
*c
, robj
*obj
) {
2704 if (listLength(c
->reply
) == 0 &&
2705 (c
->replstate
== REDIS_REPL_NONE
||
2706 c
->replstate
== REDIS_REPL_ONLINE
) &&
2707 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2708 sendReplyToClient
, c
) == AE_ERR
) return;
2710 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2711 obj
= dupStringObject(obj
);
2712 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2714 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2717 static void addReplySds(redisClient
*c
, sds s
) {
2718 robj
*o
= createObject(REDIS_STRING
,s
);
2723 static void addReplyDouble(redisClient
*c
, double d
) {
2726 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2727 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2728 (unsigned long) strlen(buf
),buf
));
2731 static void addReplyLong(redisClient
*c
, long l
) {
2736 addReply(c
,shared
.czero
);
2738 } else if (l
== 1) {
2739 addReply(c
,shared
.cone
);
2742 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2743 addReplySds(c
,sdsnewlen(buf
,len
));
2746 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2751 addReply(c
,shared
.czero
);
2753 } else if (ll
== 1) {
2754 addReply(c
,shared
.cone
);
2757 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2758 addReplySds(c
,sdsnewlen(buf
,len
));
2761 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2766 addReply(c
,shared
.czero
);
2768 } else if (ul
== 1) {
2769 addReply(c
,shared
.cone
);
2772 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2773 addReplySds(c
,sdsnewlen(buf
,len
));
2776 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2779 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2780 len
= sdslen(obj
->ptr
);
2782 long n
= (long)obj
->ptr
;
2784 /* Compute how many bytes will take this integer as a radix 10 string */
2790 while((n
= n
/10) != 0) {
2794 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2797 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2798 addReplyBulkLen(c
,obj
);
2800 addReply(c
,shared
.crlf
);
2803 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2804 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2806 addReply(c
,shared
.nullbulk
);
2808 robj
*o
= createStringObject(s
,strlen(s
));
2814 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2819 REDIS_NOTUSED(mask
);
2820 REDIS_NOTUSED(privdata
);
2822 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2823 if (cfd
== AE_ERR
) {
2824 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2827 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2828 if ((c
= createClient(cfd
)) == NULL
) {
2829 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2830 close(cfd
); /* May be already closed, just ingore errors */
2833 /* If maxclient directive is set and this is one client more... close the
2834 * connection. Note that we create the client instead to check before
2835 * for this condition, since now the socket is already set in nonblocking
2836 * mode and we can send an error for free using the Kernel I/O */
2837 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2838 char *err
= "-ERR max number of clients reached\r\n";
2840 /* That's a best effort error message, don't check write errors */
2841 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2842 /* Nothing to do, Just to avoid the warning... */
2847 server
.stat_numconnections
++;
2850 /* ======================= Redis objects implementation ===================== */
2852 static robj
*createObject(int type
, void *ptr
) {
2855 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2856 if (listLength(server
.objfreelist
)) {
2857 listNode
*head
= listFirst(server
.objfreelist
);
2858 o
= listNodeValue(head
);
2859 listDelNode(server
.objfreelist
,head
);
2860 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2862 if (server
.vm_enabled
) {
2863 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2864 o
= zmalloc(sizeof(*o
));
2866 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2870 o
->encoding
= REDIS_ENCODING_RAW
;
2873 if (server
.vm_enabled
) {
2874 /* Note that this code may run in the context of an I/O thread
2875 * and accessing to server.unixtime in theory is an error
2876 * (no locks). But in practice this is safe, and even if we read
2877 * garbage Redis will not fail, as it's just a statistical info */
2878 o
->vm
.atime
= server
.unixtime
;
2879 o
->storage
= REDIS_VM_MEMORY
;
2884 static robj
*createStringObject(char *ptr
, size_t len
) {
2885 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2888 static robj
*createStringObjectFromLongLong(long long value
) {
2890 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2891 incrRefCount(shared
.integers
[value
]);
2892 o
= shared
.integers
[value
];
2894 o
= createObject(REDIS_STRING
, NULL
);
2895 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2896 o
->encoding
= REDIS_ENCODING_INT
;
2897 o
->ptr
= (void*)((long)value
);
2899 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2905 static robj
*dupStringObject(robj
*o
) {
2906 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2907 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2910 static robj
*createListObject(void) {
2911 list
*l
= listCreate();
2913 listSetFreeMethod(l
,decrRefCount
);
2914 return createObject(REDIS_LIST
,l
);
2917 static robj
*createSetObject(void) {
2918 dict
*d
= dictCreate(&setDictType
,NULL
);
2919 return createObject(REDIS_SET
,d
);
2922 static robj
*createHashObject(void) {
2923 /* All the Hashes start as zipmaps. Will be automatically converted
2924 * into hash tables if there are enough elements or big elements
2926 unsigned char *zm
= zipmapNew();
2927 robj
*o
= createObject(REDIS_HASH
,zm
);
2928 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2932 static robj
*createZsetObject(void) {
2933 zset
*zs
= zmalloc(sizeof(*zs
));
2935 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2936 zs
->zsl
= zslCreate();
2937 return createObject(REDIS_ZSET
,zs
);
2940 static void freeStringObject(robj
*o
) {
2941 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2946 static void freeListObject(robj
*o
) {
2947 listRelease((list
*) o
->ptr
);
2950 static void freeSetObject(robj
*o
) {
2951 dictRelease((dict
*) o
->ptr
);
2954 static void freeZsetObject(robj
*o
) {
2957 dictRelease(zs
->dict
);
2962 static void freeHashObject(robj
*o
) {
2963 switch (o
->encoding
) {
2964 case REDIS_ENCODING_HT
:
2965 dictRelease((dict
*) o
->ptr
);
2967 case REDIS_ENCODING_ZIPMAP
:
2971 redisPanic("Unknown hash encoding type");
2976 static void incrRefCount(robj
*o
) {
2980 static void decrRefCount(void *obj
) {
2983 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2984 /* Object is a key of a swapped out value, or in the process of being
2986 if (server
.vm_enabled
&&
2987 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2989 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2990 redisAssert(o
->type
== REDIS_STRING
);
2991 freeStringObject(o
);
2992 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2993 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2994 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2995 !listAddNodeHead(server
.objfreelist
,o
))
2997 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2998 server
.vm_stats_swapped_objects
--;
3001 /* Object is in memory, or in the process of being swapped out. */
3002 if (--(o
->refcount
) == 0) {
3003 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3004 vmCancelThreadedIOJob(obj
);
3006 case REDIS_STRING
: freeStringObject(o
); break;
3007 case REDIS_LIST
: freeListObject(o
); break;
3008 case REDIS_SET
: freeSetObject(o
); break;
3009 case REDIS_ZSET
: freeZsetObject(o
); break;
3010 case REDIS_HASH
: freeHashObject(o
); break;
3011 default: redisPanic("Unknown object type"); break;
3013 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3014 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3015 !listAddNodeHead(server
.objfreelist
,o
))
3017 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3021 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3022 dictEntry
*de
= dictFind(db
->dict
,key
);
3024 robj
*key
= dictGetEntryKey(de
);
3025 robj
*val
= dictGetEntryVal(de
);
3027 if (server
.vm_enabled
) {
3028 if (key
->storage
== REDIS_VM_MEMORY
||
3029 key
->storage
== REDIS_VM_SWAPPING
)
3031 /* If we were swapping the object out, stop it, this key
3033 if (key
->storage
== REDIS_VM_SWAPPING
)
3034 vmCancelThreadedIOJob(key
);
3035 /* Update the access time of the key for the aging algorithm. */
3036 key
->vm
.atime
= server
.unixtime
;
3038 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3040 /* Our value was swapped on disk. Bring it at home. */
3041 redisAssert(val
== NULL
);
3042 val
= vmLoadObject(key
);
3043 dictGetEntryVal(de
) = val
;
3045 /* Clients blocked by the VM subsystem may be waiting for
3047 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3056 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3057 expireIfNeeded(db
,key
);
3058 return lookupKey(db
,key
);
3061 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3062 deleteIfVolatile(db
,key
);
3063 return lookupKey(db
,key
);
3066 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3067 robj
*o
= lookupKeyRead(c
->db
, key
);
3068 if (!o
) addReply(c
,reply
);
3072 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3073 robj
*o
= lookupKeyWrite(c
->db
, key
);
3074 if (!o
) addReply(c
,reply
);
3078 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3079 if (o
->type
!= type
) {
3080 addReply(c
,shared
.wrongtypeerr
);
3086 static int deleteKey(redisDb
*db
, robj
*key
) {
3089 /* We need to protect key from destruction: after the first dictDelete()
3090 * it may happen that 'key' is no longer valid if we don't increment
3091 * it's count. This may happen when we get the object reference directly
3092 * from the hash table with dictRandomKey() or dict iterators */
3094 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3095 retval
= dictDelete(db
->dict
,key
);
3098 return retval
== DICT_OK
;
3101 /* Check if the nul-terminated string 's' can be represented by a long
3102 * (that is, is a number that fits into long without any other space or
3103 * character before or after the digits).
3105 * If so, the function returns REDIS_OK and *longval is set to the value
3106 * of the number. Otherwise REDIS_ERR is returned */
3107 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3108 char buf
[32], *endptr
;
3112 value
= strtol(s
, &endptr
, 10);
3113 if (endptr
[0] != '\0') return REDIS_ERR
;
3114 slen
= snprintf(buf
,32,"%ld",value
);
3116 /* If the number converted back into a string is not identical
3117 * then it's not possible to encode the string as integer */
3118 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3119 if (longval
) *longval
= value
;
3123 /* Try to encode a string object in order to save space */
3124 static robj
*tryObjectEncoding(robj
*o
) {
3128 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3129 return o
; /* Already encoded */
3131 /* It's not safe to encode shared objects: shared objects can be shared
3132 * everywhere in the "object space" of Redis. Encoded objects can only
3133 * appear as "values" (and not, for instance, as keys) */
3134 if (o
->refcount
> 1) return o
;
3136 /* Currently we try to encode only strings */
3137 redisAssert(o
->type
== REDIS_STRING
);
3139 /* Check if we can represent this string as a long integer */
3140 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3142 /* Ok, this object can be encoded */
3143 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3145 incrRefCount(shared
.integers
[value
]);
3146 return shared
.integers
[value
];
3148 o
->encoding
= REDIS_ENCODING_INT
;
3150 o
->ptr
= (void*) value
;
3155 /* Get a decoded version of an encoded object (returned as a new object).
3156 * If the object is already raw-encoded just increment the ref count. */
3157 static robj
*getDecodedObject(robj
*o
) {
3160 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3164 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3167 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3168 dec
= createStringObject(buf
,strlen(buf
));
3171 redisPanic("Unknown encoding type");
3175 /* Compare two string objects via strcmp() or alike.
3176 * Note that the objects may be integer-encoded. In such a case we
3177 * use snprintf() to get a string representation of the numbers on the stack
3178 * and compare the strings, it's much faster than calling getDecodedObject().
3180 * Important note: if objects are not integer encoded, but binary-safe strings,
3181 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3183 static int compareStringObjects(robj
*a
, robj
*b
) {
3184 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3185 char bufa
[128], bufb
[128], *astr
, *bstr
;
3188 if (a
== b
) return 0;
3189 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3190 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3196 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3197 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3203 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3206 static size_t stringObjectLen(robj
*o
) {
3207 redisAssert(o
->type
== REDIS_STRING
);
3208 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3209 return sdslen(o
->ptr
);
3213 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3217 static int getDoubleFromObject(robj
*o
, double *target
) {
3224 redisAssert(o
->type
== REDIS_STRING
);
3225 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3226 value
= strtod(o
->ptr
, &eptr
);
3227 if (eptr
[0] != '\0') return REDIS_ERR
;
3228 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3229 value
= (long)o
->ptr
;
3231 redisPanic("Unknown string encoding");
3239 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3241 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3243 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3245 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3254 static int getLongLongFromObject(robj
*o
, long long *target
) {
3261 redisAssert(o
->type
== REDIS_STRING
);
3262 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3263 value
= strtoll(o
->ptr
, &eptr
, 10);
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 getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3278 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3280 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3282 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3291 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3294 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3295 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3297 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3299 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3308 /*============================ RDB saving/loading =========================== */
3310 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3311 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3315 static int rdbSaveTime(FILE *fp
, time_t t
) {
3316 int32_t t32
= (int32_t) t
;
3317 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3321 /* check rdbLoadLen() comments for more info */
3322 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3323 unsigned char buf
[2];
3326 /* Save a 6 bit len */
3327 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3328 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3329 } else if (len
< (1<<14)) {
3330 /* Save a 14 bit len */
3331 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3333 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3335 /* Save a 32 bit len */
3336 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3337 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3339 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3344 /* String objects in the form "2391" "-100" without any space and with a
3345 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3346 * encoded as integers to save space */
3347 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3349 char *endptr
, buf
[32];
3351 /* Check if it's possible to encode this value as a number */
3352 value
= strtoll(s
, &endptr
, 10);
3353 if (endptr
[0] != '\0') return 0;
3354 snprintf(buf
,32,"%lld",value
);
3356 /* If the number converted back into a string is not identical
3357 * then it's not possible to encode the string as integer */
3358 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3360 /* Finally check if it fits in our ranges */
3361 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3362 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3363 enc
[1] = value
&0xFF;
3365 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3366 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3367 enc
[1] = value
&0xFF;
3368 enc
[2] = (value
>>8)&0xFF;
3370 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3371 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3372 enc
[1] = value
&0xFF;
3373 enc
[2] = (value
>>8)&0xFF;
3374 enc
[3] = (value
>>16)&0xFF;
3375 enc
[4] = (value
>>24)&0xFF;
3382 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3383 size_t comprlen
, outlen
;
3387 /* We require at least four bytes compression for this to be worth it */
3388 if (len
<= 4) return 0;
3390 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3391 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3392 if (comprlen
== 0) {
3396 /* Data compressed! Let's save it on disk */
3397 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3398 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3399 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3400 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3401 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3410 /* Save a string objet as [len][data] on disk. If the object is a string
3411 * representation of an integer value we try to safe it in a special form */
3412 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3415 /* Try integer encoding */
3417 unsigned char buf
[5];
3418 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3419 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3424 /* Try LZF compression - under 20 bytes it's unable to compress even
3425 * aaaaaaaaaaaaaaaaaa so skip it */
3426 if (server
.rdbcompression
&& len
> 20) {
3429 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3430 if (retval
== -1) return -1;
3431 if (retval
> 0) return 0;
3432 /* retval == 0 means data can't be compressed, save the old way */
3435 /* Store verbatim */
3436 if (rdbSaveLen(fp
,len
) == -1) return -1;
3437 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3441 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3442 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3445 /* Avoid incr/decr ref count business when possible.
3446 * This plays well with copy-on-write given that we are probably
3447 * in a child process (BGSAVE). Also this makes sure key objects
3448 * of swapped objects are not incRefCount-ed (an assert does not allow
3449 * this in order to avoid bugs) */
3450 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3451 obj
= getDecodedObject(obj
);
3452 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3455 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3460 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3461 * 8 bit integer specifing the length of the representation.
3462 * This 8 bit integer has special values in order to specify the following
3468 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3469 unsigned char buf
[128];
3475 } else if (!isfinite(val
)) {
3477 buf
[0] = (val
< 0) ? 255 : 254;
3479 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3480 buf
[0] = strlen((char*)buf
+1);
3483 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3487 /* Save a Redis object. */
3488 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3489 if (o
->type
== REDIS_STRING
) {
3490 /* Save a string value */
3491 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3492 } else if (o
->type
== REDIS_LIST
) {
3493 /* Save a list value */
3494 list
*list
= o
->ptr
;
3498 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3499 listRewind(list
,&li
);
3500 while((ln
= listNext(&li
))) {
3501 robj
*eleobj
= listNodeValue(ln
);
3503 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3505 } else if (o
->type
== REDIS_SET
) {
3506 /* Save a set value */
3508 dictIterator
*di
= dictGetIterator(set
);
3511 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3512 while((de
= dictNext(di
)) != NULL
) {
3513 robj
*eleobj
= dictGetEntryKey(de
);
3515 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3517 dictReleaseIterator(di
);
3518 } else if (o
->type
== REDIS_ZSET
) {
3519 /* Save a set value */
3521 dictIterator
*di
= dictGetIterator(zs
->dict
);
3524 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3525 while((de
= dictNext(di
)) != NULL
) {
3526 robj
*eleobj
= dictGetEntryKey(de
);
3527 double *score
= dictGetEntryVal(de
);
3529 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3530 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3532 dictReleaseIterator(di
);
3533 } else if (o
->type
== REDIS_HASH
) {
3534 /* Save a hash value */
3535 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3536 unsigned char *p
= zipmapRewind(o
->ptr
);
3537 unsigned int count
= zipmapLen(o
->ptr
);
3538 unsigned char *key
, *val
;
3539 unsigned int klen
, vlen
;
3541 if (rdbSaveLen(fp
,count
) == -1) return -1;
3542 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3543 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3544 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3547 dictIterator
*di
= dictGetIterator(o
->ptr
);
3550 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3551 while((de
= dictNext(di
)) != NULL
) {
3552 robj
*key
= dictGetEntryKey(de
);
3553 robj
*val
= dictGetEntryVal(de
);
3555 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3556 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3558 dictReleaseIterator(di
);
3561 redisPanic("Unknown object type");
3566 /* Return the length the object will have on disk if saved with
3567 * the rdbSaveObject() function. Currently we use a trick to get
3568 * this length with very little changes to the code. In the future
3569 * we could switch to a faster solution. */
3570 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3571 if (fp
== NULL
) fp
= server
.devnull
;
3573 assert(rdbSaveObject(fp
,o
) != 1);
3577 /* Return the number of pages required to save this object in the swap file */
3578 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3579 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3581 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3584 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3585 static int rdbSave(char *filename
) {
3586 dictIterator
*di
= NULL
;
3591 time_t now
= time(NULL
);
3593 /* Wait for I/O therads to terminate, just in case this is a
3594 * foreground-saving, to avoid seeking the swap file descriptor at the
3596 if (server
.vm_enabled
)
3597 waitEmptyIOJobsQueue();
3599 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3600 fp
= fopen(tmpfile
,"w");
3602 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3605 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3606 for (j
= 0; j
< server
.dbnum
; j
++) {
3607 redisDb
*db
= server
.db
+j
;
3609 if (dictSize(d
) == 0) continue;
3610 di
= dictGetIterator(d
);
3616 /* Write the SELECT DB opcode */
3617 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3618 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3620 /* Iterate this DB writing every entry */
3621 while((de
= dictNext(di
)) != NULL
) {
3622 robj
*key
= dictGetEntryKey(de
);
3623 robj
*o
= dictGetEntryVal(de
);
3624 time_t expiretime
= getExpire(db
,key
);
3626 /* Save the expire time */
3627 if (expiretime
!= -1) {
3628 /* If this key is already expired skip it */
3629 if (expiretime
< now
) continue;
3630 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3631 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3633 /* Save the key and associated value. This requires special
3634 * handling if the value is swapped out. */
3635 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3636 key
->storage
== REDIS_VM_SWAPPING
) {
3637 /* Save type, key, value */
3638 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3639 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3640 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3642 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3644 /* Get a preview of the object in memory */
3645 po
= vmPreviewObject(key
);
3646 /* Save type, key, value */
3647 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3648 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3649 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3650 /* Remove the loaded object from memory */
3654 dictReleaseIterator(di
);
3657 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3659 /* Make sure data will not remain on the OS's output buffers */
3664 /* Use RENAME to make sure the DB file is changed atomically only
3665 * if the generate DB file is ok. */
3666 if (rename(tmpfile
,filename
) == -1) {
3667 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3671 redisLog(REDIS_NOTICE
,"DB saved on disk");
3673 server
.lastsave
= time(NULL
);
3679 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3680 if (di
) dictReleaseIterator(di
);
3684 static int rdbSaveBackground(char *filename
) {
3687 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3688 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3689 if ((childpid
= fork()) == 0) {
3691 if (server
.vm_enabled
) vmReopenSwapFile();
3693 if (rdbSave(filename
) == REDIS_OK
) {
3700 if (childpid
== -1) {
3701 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3705 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3706 server
.bgsavechildpid
= childpid
;
3707 updateDictResizePolicy();
3710 return REDIS_OK
; /* unreached */
3713 static void rdbRemoveTempFile(pid_t childpid
) {
3716 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3720 static int rdbLoadType(FILE *fp
) {
3722 if (fread(&type
,1,1,fp
) == 0) return -1;
3726 static time_t rdbLoadTime(FILE *fp
) {
3728 if (fread(&t32
,4,1,fp
) == 0) return -1;
3729 return (time_t) t32
;
3732 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3733 * of this file for a description of how this are stored on disk.
3735 * isencoded is set to 1 if the readed length is not actually a length but
3736 * an "encoding type", check the above comments for more info */
3737 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3738 unsigned char buf
[2];
3742 if (isencoded
) *isencoded
= 0;
3743 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3744 type
= (buf
[0]&0xC0)>>6;
3745 if (type
== REDIS_RDB_6BITLEN
) {
3746 /* Read a 6 bit len */
3748 } else if (type
== REDIS_RDB_ENCVAL
) {
3749 /* Read a 6 bit len encoding type */
3750 if (isencoded
) *isencoded
= 1;
3752 } else if (type
== REDIS_RDB_14BITLEN
) {
3753 /* Read a 14 bit len */
3754 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3755 return ((buf
[0]&0x3F)<<8)|buf
[1];
3757 /* Read a 32 bit len */
3758 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3763 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3764 unsigned char enc
[4];
3767 if (enctype
== REDIS_RDB_ENC_INT8
) {
3768 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3769 val
= (signed char)enc
[0];
3770 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3772 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3773 v
= enc
[0]|(enc
[1]<<8);
3775 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3777 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3778 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3781 val
= 0; /* anti-warning */
3782 redisPanic("Unknown RDB integer encoding type");
3784 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3787 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3788 unsigned int len
, clen
;
3789 unsigned char *c
= NULL
;
3792 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3793 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3794 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3795 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3796 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3797 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3799 return createObject(REDIS_STRING
,val
);
3806 static robj
*rdbLoadStringObject(FILE*fp
) {
3811 len
= rdbLoadLen(fp
,&isencoded
);
3814 case REDIS_RDB_ENC_INT8
:
3815 case REDIS_RDB_ENC_INT16
:
3816 case REDIS_RDB_ENC_INT32
:
3817 return rdbLoadIntegerObject(fp
,len
);
3818 case REDIS_RDB_ENC_LZF
:
3819 return rdbLoadLzfStringObject(fp
);
3821 redisPanic("Unknown RDB encoding type");
3825 if (len
== REDIS_RDB_LENERR
) return NULL
;
3826 val
= sdsnewlen(NULL
,len
);
3827 if (len
&& fread(val
,len
,1,fp
) == 0) {
3831 return createObject(REDIS_STRING
,val
);
3834 /* For information about double serialization check rdbSaveDoubleValue() */
3835 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3839 if (fread(&len
,1,1,fp
) == 0) return -1;
3841 case 255: *val
= R_NegInf
; return 0;
3842 case 254: *val
= R_PosInf
; return 0;
3843 case 253: *val
= R_Nan
; return 0;
3845 if (fread(buf
,len
,1,fp
) == 0) return -1;
3847 sscanf(buf
, "%lg", val
);
3852 /* Load a Redis object of the specified type from the specified file.
3853 * On success a newly allocated object is returned, otherwise NULL. */
3854 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3857 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3858 if (type
== REDIS_STRING
) {
3859 /* Read string value */
3860 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3861 o
= tryObjectEncoding(o
);
3862 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3863 /* Read list/set value */
3866 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3867 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3868 /* It's faster to expand the dict to the right size asap in order
3869 * to avoid rehashing */
3870 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3871 dictExpand(o
->ptr
,listlen
);
3872 /* Load every single element of the list/set */
3876 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3877 ele
= tryObjectEncoding(ele
);
3878 if (type
== REDIS_LIST
) {
3879 listAddNodeTail((list
*)o
->ptr
,ele
);
3881 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3884 } else if (type
== REDIS_ZSET
) {
3885 /* Read list/set value */
3889 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3890 o
= createZsetObject();
3892 /* Load every single element of the list/set */
3895 double *score
= zmalloc(sizeof(double));
3897 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3898 ele
= tryObjectEncoding(ele
);
3899 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3900 dictAdd(zs
->dict
,ele
,score
);
3901 zslInsert(zs
->zsl
,*score
,ele
);
3902 incrRefCount(ele
); /* added to skiplist */
3904 } else if (type
== REDIS_HASH
) {
3907 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3908 o
= createHashObject();
3909 /* Too many entries? Use an hash table. */
3910 if (hashlen
> server
.hash_max_zipmap_entries
)
3911 convertToRealHash(o
);
3912 /* Load every key/value, then set it into the zipmap or hash
3913 * table, as needed. */
3917 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3918 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3919 /* If we are using a zipmap and there are too big values
3920 * the object is converted to real hash table encoding. */
3921 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3922 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3923 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3925 convertToRealHash(o
);
3928 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3929 unsigned char *zm
= o
->ptr
;
3931 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3932 val
->ptr
,sdslen(val
->ptr
),NULL
);
3937 key
= tryObjectEncoding(key
);
3938 val
= tryObjectEncoding(val
);
3939 dictAdd((dict
*)o
->ptr
,key
,val
);
3943 redisPanic("Unknown object type");
3948 static int rdbLoad(char *filename
) {
3950 robj
*keyobj
= NULL
;
3952 int type
, retval
, rdbver
;
3953 int dataset_too_big
= 0;
3954 dict
*d
= server
.db
[0].dict
;
3955 redisDb
*db
= server
.db
+0;
3957 time_t expiretime
, now
= time(NULL
);
3958 long long loadedkeys
= 0;
3960 fp
= fopen(filename
,"r");
3961 if (!fp
) return REDIS_ERR
;
3962 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3964 if (memcmp(buf
,"REDIS",5) != 0) {
3966 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3969 rdbver
= atoi(buf
+5);
3972 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3980 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3981 if (type
== REDIS_EXPIRETIME
) {
3982 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3983 /* We read the time so we need to read the object type again */
3984 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3986 if (type
== REDIS_EOF
) break;
3987 /* Handle SELECT DB opcode as a special case */
3988 if (type
== REDIS_SELECTDB
) {
3989 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3991 if (dbid
>= (unsigned)server
.dbnum
) {
3992 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3995 db
= server
.db
+dbid
;
4000 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4002 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4003 /* Add the new object in the hash table */
4004 retval
= dictAdd(d
,keyobj
,o
);
4005 if (retval
== DICT_ERR
) {
4006 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
4010 /* Set the expire time if needed */
4011 if (expiretime
!= -1) {
4012 setExpire(db
,keyobj
,expiretime
);
4013 /* Delete this key if already expired */
4014 if (expiretime
< now
) {
4015 deleteKey(db
,keyobj
);
4016 continue; /* don't try to swap this out */
4020 /* Handle swapping while loading big datasets when VM is on */
4022 /* If we detecter we are hopeless about fitting something in memory
4023 * we just swap every new key on disk. Directly...
4024 * Note that's important to check for this condition before resorting
4025 * to random sampling, otherwise we may try to swap already
4027 if (dataset_too_big
) {
4028 dictEntry
*de
= dictFind(d
,keyobj
);
4030 /* de may be NULL since the key already expired */
4032 keyobj
= dictGetEntryKey(de
);
4033 o
= dictGetEntryVal(de
);
4035 if (vmSwapObjectBlocking(keyobj
,o
) == REDIS_OK
) {
4036 dictGetEntryVal(de
) = NULL
;
4042 /* If we have still some hope of having some value fitting memory
4043 * then we try random sampling. */
4044 if (!dataset_too_big
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4045 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4046 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4048 if (zmalloc_used_memory() > server
.vm_max_memory
)
4049 dataset_too_big
= 1;
4055 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4056 if (keyobj
) decrRefCount(keyobj
);
4057 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4059 return REDIS_ERR
; /* Just to avoid warning */
4062 /*================================== Commands =============================== */
4064 static void authCommand(redisClient
*c
) {
4065 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4066 c
->authenticated
= 1;
4067 addReply(c
,shared
.ok
);
4069 c
->authenticated
= 0;
4070 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4074 static void pingCommand(redisClient
*c
) {
4075 addReply(c
,shared
.pong
);
4078 static void echoCommand(redisClient
*c
) {
4079 addReplyBulk(c
,c
->argv
[1]);
4082 /*=================================== Strings =============================== */
4084 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4086 long seconds
= 0; /* initialized to avoid an harmness warning */
4089 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4092 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4097 if (nx
) deleteIfVolatile(c
->db
,key
);
4098 retval
= dictAdd(c
->db
->dict
,key
,val
);
4099 if (retval
== DICT_ERR
) {
4101 /* If the key is about a swapped value, we want a new key object
4102 * to overwrite the old. So we delete the old key in the database.
4103 * This will also make sure that swap pages about the old object
4104 * will be marked as free. */
4105 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4107 dictReplace(c
->db
->dict
,key
,val
);
4110 addReply(c
,shared
.czero
);
4118 removeExpire(c
->db
,key
);
4119 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4120 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4123 static void setCommand(redisClient
*c
) {
4124 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4127 static void setnxCommand(redisClient
*c
) {
4128 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4131 static void setexCommand(redisClient
*c
) {
4132 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4135 static int getGenericCommand(redisClient
*c
) {
4138 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4141 if (o
->type
!= REDIS_STRING
) {
4142 addReply(c
,shared
.wrongtypeerr
);
4150 static void getCommand(redisClient
*c
) {
4151 getGenericCommand(c
);
4154 static void getsetCommand(redisClient
*c
) {
4155 if (getGenericCommand(c
) == REDIS_ERR
) return;
4156 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4157 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4159 incrRefCount(c
->argv
[1]);
4161 incrRefCount(c
->argv
[2]);
4163 removeExpire(c
->db
,c
->argv
[1]);
4166 static void mgetCommand(redisClient
*c
) {
4169 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4170 for (j
= 1; j
< c
->argc
; j
++) {
4171 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4173 addReply(c
,shared
.nullbulk
);
4175 if (o
->type
!= REDIS_STRING
) {
4176 addReply(c
,shared
.nullbulk
);
4184 static void msetGenericCommand(redisClient
*c
, int nx
) {
4185 int j
, busykeys
= 0;
4187 if ((c
->argc
% 2) == 0) {
4188 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4191 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4192 * set nothing at all if at least one already key exists. */
4194 for (j
= 1; j
< c
->argc
; j
+= 2) {
4195 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4201 addReply(c
, shared
.czero
);
4205 for (j
= 1; j
< c
->argc
; j
+= 2) {
4208 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4209 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4210 if (retval
== DICT_ERR
) {
4211 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4212 incrRefCount(c
->argv
[j
+1]);
4214 incrRefCount(c
->argv
[j
]);
4215 incrRefCount(c
->argv
[j
+1]);
4217 removeExpire(c
->db
,c
->argv
[j
]);
4219 server
.dirty
+= (c
->argc
-1)/2;
4220 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4223 static void msetCommand(redisClient
*c
) {
4224 msetGenericCommand(c
,0);
4227 static void msetnxCommand(redisClient
*c
) {
4228 msetGenericCommand(c
,1);
4231 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4236 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4238 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4241 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4242 o
= tryObjectEncoding(o
);
4243 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4244 if (retval
== DICT_ERR
) {
4245 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4246 removeExpire(c
->db
,c
->argv
[1]);
4248 incrRefCount(c
->argv
[1]);
4251 addReply(c
,shared
.colon
);
4253 addReply(c
,shared
.crlf
);
4256 static void incrCommand(redisClient
*c
) {
4257 incrDecrCommand(c
,1);
4260 static void decrCommand(redisClient
*c
) {
4261 incrDecrCommand(c
,-1);
4264 static void incrbyCommand(redisClient
*c
) {
4267 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4268 incrDecrCommand(c
,incr
);
4271 static void decrbyCommand(redisClient
*c
) {
4274 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4275 incrDecrCommand(c
,-incr
);
4278 static void appendCommand(redisClient
*c
) {
4283 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4285 /* Create the key */
4286 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4287 incrRefCount(c
->argv
[1]);
4288 incrRefCount(c
->argv
[2]);
4289 totlen
= stringObjectLen(c
->argv
[2]);
4293 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4296 o
= dictGetEntryVal(de
);
4297 if (o
->type
!= REDIS_STRING
) {
4298 addReply(c
,shared
.wrongtypeerr
);
4301 /* If the object is specially encoded or shared we have to make
4303 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4304 robj
*decoded
= getDecodedObject(o
);
4306 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4307 decrRefCount(decoded
);
4308 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4311 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4312 o
->ptr
= sdscatlen(o
->ptr
,
4313 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4315 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4316 (unsigned long) c
->argv
[2]->ptr
);
4318 totlen
= sdslen(o
->ptr
);
4321 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4324 static void substrCommand(redisClient
*c
) {
4326 long start
= atoi(c
->argv
[2]->ptr
);
4327 long end
= atoi(c
->argv
[3]->ptr
);
4328 size_t rangelen
, strlen
;
4331 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4332 checkType(c
,o
,REDIS_STRING
)) return;
4334 o
= getDecodedObject(o
);
4335 strlen
= sdslen(o
->ptr
);
4337 /* convert negative indexes */
4338 if (start
< 0) start
= strlen
+start
;
4339 if (end
< 0) end
= strlen
+end
;
4340 if (start
< 0) start
= 0;
4341 if (end
< 0) end
= 0;
4343 /* indexes sanity checks */
4344 if (start
> end
|| (size_t)start
>= strlen
) {
4345 /* Out of range start or start > end result in null reply */
4346 addReply(c
,shared
.nullbulk
);
4350 if ((size_t)end
>= strlen
) end
= strlen
-1;
4351 rangelen
= (end
-start
)+1;
4353 /* Return the result */
4354 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4355 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4356 addReplySds(c
,range
);
4357 addReply(c
,shared
.crlf
);
4361 /* ========================= Type agnostic commands ========================= */
4363 static void delCommand(redisClient
*c
) {
4366 for (j
= 1; j
< c
->argc
; j
++) {
4367 if (deleteKey(c
->db
,c
->argv
[j
])) {
4372 addReplyLong(c
,deleted
);
4375 static void existsCommand(redisClient
*c
) {
4376 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4379 static void selectCommand(redisClient
*c
) {
4380 int id
= atoi(c
->argv
[1]->ptr
);
4382 if (selectDb(c
,id
) == REDIS_ERR
) {
4383 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4385 addReply(c
,shared
.ok
);
4389 static void randomkeyCommand(redisClient
*c
) {
4394 de
= dictGetRandomKey(c
->db
->dict
);
4395 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4399 addReply(c
,shared
.nullbulk
);
4403 key
= dictGetEntryKey(de
);
4404 if (server
.vm_enabled
) {
4405 key
= dupStringObject(key
);
4406 addReplyBulk(c
,key
);
4409 addReplyBulk(c
,key
);
4413 static void keysCommand(redisClient
*c
) {
4416 sds pattern
= c
->argv
[1]->ptr
;
4417 int plen
= sdslen(pattern
);
4418 unsigned long numkeys
= 0;
4419 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4421 di
= dictGetIterator(c
->db
->dict
);
4423 decrRefCount(lenobj
);
4424 while((de
= dictNext(di
)) != NULL
) {
4425 robj
*keyobj
= dictGetEntryKey(de
);
4427 sds key
= keyobj
->ptr
;
4428 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4429 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4430 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4431 addReplyBulk(c
,keyobj
);
4436 dictReleaseIterator(di
);
4437 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4440 static void dbsizeCommand(redisClient
*c
) {
4442 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4445 static void lastsaveCommand(redisClient
*c
) {
4447 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4450 static void typeCommand(redisClient
*c
) {
4454 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4459 case REDIS_STRING
: type
= "+string"; break;
4460 case REDIS_LIST
: type
= "+list"; break;
4461 case REDIS_SET
: type
= "+set"; break;
4462 case REDIS_ZSET
: type
= "+zset"; break;
4463 case REDIS_HASH
: type
= "+hash"; break;
4464 default: type
= "+unknown"; break;
4467 addReplySds(c
,sdsnew(type
));
4468 addReply(c
,shared
.crlf
);
4471 static void saveCommand(redisClient
*c
) {
4472 if (server
.bgsavechildpid
!= -1) {
4473 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4476 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4477 addReply(c
,shared
.ok
);
4479 addReply(c
,shared
.err
);
4483 static void bgsaveCommand(redisClient
*c
) {
4484 if (server
.bgsavechildpid
!= -1) {
4485 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4488 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4489 char *status
= "+Background saving started\r\n";
4490 addReplySds(c
,sdsnew(status
));
4492 addReply(c
,shared
.err
);
4496 static void shutdownCommand(redisClient
*c
) {
4497 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4498 /* Kill the saving child if there is a background saving in progress.
4499 We want to avoid race conditions, for instance our saving child may
4500 overwrite the synchronous saving did by SHUTDOWN. */
4501 if (server
.bgsavechildpid
!= -1) {
4502 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4503 kill(server
.bgsavechildpid
,SIGKILL
);
4504 rdbRemoveTempFile(server
.bgsavechildpid
);
4506 if (server
.appendonly
) {
4507 /* Append only file: fsync() the AOF and exit */
4508 fsync(server
.appendfd
);
4509 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4512 /* Snapshotting. Perform a SYNC SAVE and exit */
4513 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4514 if (server
.daemonize
)
4515 unlink(server
.pidfile
);
4516 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4517 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4520 /* Ooops.. error saving! The best we can do is to continue
4521 * operating. Note that if there was a background saving process,
4522 * in the next cron() Redis will be notified that the background
4523 * saving aborted, handling special stuff like slaves pending for
4524 * synchronization... */
4525 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4527 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4532 static void renameGenericCommand(redisClient
*c
, int nx
) {
4535 /* To use the same key as src and dst is probably an error */
4536 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4537 addReply(c
,shared
.sameobjecterr
);
4541 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4545 deleteIfVolatile(c
->db
,c
->argv
[2]);
4546 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4549 addReply(c
,shared
.czero
);
4552 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4554 incrRefCount(c
->argv
[2]);
4556 deleteKey(c
->db
,c
->argv
[1]);
4558 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4561 static void renameCommand(redisClient
*c
) {
4562 renameGenericCommand(c
,0);
4565 static void renamenxCommand(redisClient
*c
) {
4566 renameGenericCommand(c
,1);
4569 static void moveCommand(redisClient
*c
) {
4574 /* Obtain source and target DB pointers */
4577 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4578 addReply(c
,shared
.outofrangeerr
);
4582 selectDb(c
,srcid
); /* Back to the source DB */
4584 /* If the user is moving using as target the same
4585 * DB as the source DB it is probably an error. */
4587 addReply(c
,shared
.sameobjecterr
);
4591 /* Check if the element exists and get a reference */
4592 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4594 addReply(c
,shared
.czero
);
4598 /* Try to add the element to the target DB */
4599 deleteIfVolatile(dst
,c
->argv
[1]);
4600 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4601 addReply(c
,shared
.czero
);
4604 incrRefCount(c
->argv
[1]);
4607 /* OK! key moved, free the entry in the source DB */
4608 deleteKey(src
,c
->argv
[1]);
4610 addReply(c
,shared
.cone
);
4613 /* =================================== Lists ================================ */
4614 static void pushGenericCommand(redisClient
*c
, int where
) {
4618 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4620 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4621 addReply(c
,shared
.cone
);
4624 lobj
= createListObject();
4626 if (where
== REDIS_HEAD
) {
4627 listAddNodeHead(list
,c
->argv
[2]);
4629 listAddNodeTail(list
,c
->argv
[2]);
4631 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4632 incrRefCount(c
->argv
[1]);
4633 incrRefCount(c
->argv
[2]);
4635 if (lobj
->type
!= REDIS_LIST
) {
4636 addReply(c
,shared
.wrongtypeerr
);
4639 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4640 addReply(c
,shared
.cone
);
4644 if (where
== REDIS_HEAD
) {
4645 listAddNodeHead(list
,c
->argv
[2]);
4647 listAddNodeTail(list
,c
->argv
[2]);
4649 incrRefCount(c
->argv
[2]);
4652 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4655 static void lpushCommand(redisClient
*c
) {
4656 pushGenericCommand(c
,REDIS_HEAD
);
4659 static void rpushCommand(redisClient
*c
) {
4660 pushGenericCommand(c
,REDIS_TAIL
);
4663 static void llenCommand(redisClient
*c
) {
4667 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4668 checkType(c
,o
,REDIS_LIST
)) return;
4671 addReplyUlong(c
,listLength(l
));
4674 static void lindexCommand(redisClient
*c
) {
4676 int index
= atoi(c
->argv
[2]->ptr
);
4680 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4681 checkType(c
,o
,REDIS_LIST
)) return;
4684 ln
= listIndex(list
, index
);
4686 addReply(c
,shared
.nullbulk
);
4688 robj
*ele
= listNodeValue(ln
);
4689 addReplyBulk(c
,ele
);
4693 static void lsetCommand(redisClient
*c
) {
4695 int index
= atoi(c
->argv
[2]->ptr
);
4699 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4700 checkType(c
,o
,REDIS_LIST
)) return;
4703 ln
= listIndex(list
, index
);
4705 addReply(c
,shared
.outofrangeerr
);
4707 robj
*ele
= listNodeValue(ln
);
4710 listNodeValue(ln
) = c
->argv
[3];
4711 incrRefCount(c
->argv
[3]);
4712 addReply(c
,shared
.ok
);
4717 static void popGenericCommand(redisClient
*c
, int where
) {
4722 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4723 checkType(c
,o
,REDIS_LIST
)) return;
4726 if (where
== REDIS_HEAD
)
4727 ln
= listFirst(list
);
4729 ln
= listLast(list
);
4732 addReply(c
,shared
.nullbulk
);
4734 robj
*ele
= listNodeValue(ln
);
4735 addReplyBulk(c
,ele
);
4736 listDelNode(list
,ln
);
4737 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4742 static void lpopCommand(redisClient
*c
) {
4743 popGenericCommand(c
,REDIS_HEAD
);
4746 static void rpopCommand(redisClient
*c
) {
4747 popGenericCommand(c
,REDIS_TAIL
);
4750 static void lrangeCommand(redisClient
*c
) {
4752 int start
= atoi(c
->argv
[2]->ptr
);
4753 int end
= atoi(c
->argv
[3]->ptr
);
4760 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4761 || checkType(c
,o
,REDIS_LIST
)) return;
4763 llen
= listLength(list
);
4765 /* convert negative indexes */
4766 if (start
< 0) start
= llen
+start
;
4767 if (end
< 0) end
= llen
+end
;
4768 if (start
< 0) start
= 0;
4769 if (end
< 0) end
= 0;
4771 /* indexes sanity checks */
4772 if (start
> end
|| start
>= llen
) {
4773 /* Out of range start or start > end result in empty list */
4774 addReply(c
,shared
.emptymultibulk
);
4777 if (end
>= llen
) end
= llen
-1;
4778 rangelen
= (end
-start
)+1;
4780 /* Return the result in form of a multi-bulk reply */
4781 ln
= listIndex(list
, start
);
4782 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4783 for (j
= 0; j
< rangelen
; j
++) {
4784 ele
= listNodeValue(ln
);
4785 addReplyBulk(c
,ele
);
4790 static void ltrimCommand(redisClient
*c
) {
4792 int start
= atoi(c
->argv
[2]->ptr
);
4793 int end
= atoi(c
->argv
[3]->ptr
);
4795 int j
, ltrim
, rtrim
;
4799 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4800 checkType(c
,o
,REDIS_LIST
)) return;
4802 llen
= listLength(list
);
4804 /* convert negative indexes */
4805 if (start
< 0) start
= llen
+start
;
4806 if (end
< 0) end
= llen
+end
;
4807 if (start
< 0) start
= 0;
4808 if (end
< 0) end
= 0;
4810 /* indexes sanity checks */
4811 if (start
> end
|| start
>= llen
) {
4812 /* Out of range start or start > end result in empty list */
4816 if (end
>= llen
) end
= llen
-1;
4821 /* Remove list elements to perform the trim */
4822 for (j
= 0; j
< ltrim
; j
++) {
4823 ln
= listFirst(list
);
4824 listDelNode(list
,ln
);
4826 for (j
= 0; j
< rtrim
; j
++) {
4827 ln
= listLast(list
);
4828 listDelNode(list
,ln
);
4830 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4832 addReply(c
,shared
.ok
);
4835 static void lremCommand(redisClient
*c
) {
4838 listNode
*ln
, *next
;
4839 int toremove
= atoi(c
->argv
[2]->ptr
);
4843 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4844 checkType(c
,o
,REDIS_LIST
)) return;
4848 toremove
= -toremove
;
4851 ln
= fromtail
? list
->tail
: list
->head
;
4853 robj
*ele
= listNodeValue(ln
);
4855 next
= fromtail
? ln
->prev
: ln
->next
;
4856 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4857 listDelNode(list
,ln
);
4860 if (toremove
&& removed
== toremove
) break;
4864 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4865 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4868 /* This is the semantic of this command:
4869 * RPOPLPUSH srclist dstlist:
4870 * IF LLEN(srclist) > 0
4871 * element = RPOP srclist
4872 * LPUSH dstlist element
4879 * The idea is to be able to get an element from a list in a reliable way
4880 * since the element is not just returned but pushed against another list
4881 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4883 static void rpoplpushcommand(redisClient
*c
) {
4888 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4889 checkType(c
,sobj
,REDIS_LIST
)) return;
4890 srclist
= sobj
->ptr
;
4891 ln
= listLast(srclist
);
4894 addReply(c
,shared
.nullbulk
);
4896 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4897 robj
*ele
= listNodeValue(ln
);
4900 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4901 addReply(c
,shared
.wrongtypeerr
);
4905 /* Add the element to the target list (unless it's directly
4906 * passed to some BLPOP-ing client */
4907 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4909 /* Create the list if the key does not exist */
4910 dobj
= createListObject();
4911 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4912 incrRefCount(c
->argv
[2]);
4914 dstlist
= dobj
->ptr
;
4915 listAddNodeHead(dstlist
,ele
);
4919 /* Send the element to the client as reply as well */
4920 addReplyBulk(c
,ele
);
4922 /* Finally remove the element from the source list */
4923 listDelNode(srclist
,ln
);
4924 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4929 /* ==================================== Sets ================================ */
4931 static void saddCommand(redisClient
*c
) {
4934 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4936 set
= createSetObject();
4937 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4938 incrRefCount(c
->argv
[1]);
4940 if (set
->type
!= REDIS_SET
) {
4941 addReply(c
,shared
.wrongtypeerr
);
4945 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4946 incrRefCount(c
->argv
[2]);
4948 addReply(c
,shared
.cone
);
4950 addReply(c
,shared
.czero
);
4954 static void sremCommand(redisClient
*c
) {
4957 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4958 checkType(c
,set
,REDIS_SET
)) return;
4960 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4962 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4963 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4964 addReply(c
,shared
.cone
);
4966 addReply(c
,shared
.czero
);
4970 static void smoveCommand(redisClient
*c
) {
4971 robj
*srcset
, *dstset
;
4973 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4974 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4976 /* If the source key does not exist return 0, if it's of the wrong type
4978 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4979 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4982 /* Error if the destination key is not a set as well */
4983 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4984 addReply(c
,shared
.wrongtypeerr
);
4987 /* Remove the element from the source set */
4988 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4989 /* Key not found in the src set! return zero */
4990 addReply(c
,shared
.czero
);
4993 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4994 deleteKey(c
->db
,c
->argv
[1]);
4996 /* Add the element to the destination set */
4998 dstset
= createSetObject();
4999 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5000 incrRefCount(c
->argv
[2]);
5002 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5003 incrRefCount(c
->argv
[3]);
5004 addReply(c
,shared
.cone
);
5007 static void sismemberCommand(redisClient
*c
) {
5010 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5011 checkType(c
,set
,REDIS_SET
)) return;
5013 if (dictFind(set
->ptr
,c
->argv
[2]))
5014 addReply(c
,shared
.cone
);
5016 addReply(c
,shared
.czero
);
5019 static void scardCommand(redisClient
*c
) {
5023 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5024 checkType(c
,o
,REDIS_SET
)) return;
5027 addReplyUlong(c
,dictSize(s
));
5030 static void spopCommand(redisClient
*c
) {
5034 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5035 checkType(c
,set
,REDIS_SET
)) return;
5037 de
= dictGetRandomKey(set
->ptr
);
5039 addReply(c
,shared
.nullbulk
);
5041 robj
*ele
= dictGetEntryKey(de
);
5043 addReplyBulk(c
,ele
);
5044 dictDelete(set
->ptr
,ele
);
5045 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5046 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5051 static void srandmemberCommand(redisClient
*c
) {
5055 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5056 checkType(c
,set
,REDIS_SET
)) return;
5058 de
= dictGetRandomKey(set
->ptr
);
5060 addReply(c
,shared
.nullbulk
);
5062 robj
*ele
= dictGetEntryKey(de
);
5064 addReplyBulk(c
,ele
);
5068 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5069 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5071 return dictSize(*d1
)-dictSize(*d2
);
5074 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5075 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5078 robj
*lenobj
= NULL
, *dstset
= NULL
;
5079 unsigned long j
, cardinality
= 0;
5081 for (j
= 0; j
< setsnum
; j
++) {
5085 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5086 lookupKeyRead(c
->db
,setskeys
[j
]);
5090 if (deleteKey(c
->db
,dstkey
))
5092 addReply(c
,shared
.czero
);
5094 addReply(c
,shared
.emptymultibulk
);
5098 if (setobj
->type
!= REDIS_SET
) {
5100 addReply(c
,shared
.wrongtypeerr
);
5103 dv
[j
] = setobj
->ptr
;
5105 /* Sort sets from the smallest to largest, this will improve our
5106 * algorithm's performace */
5107 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5109 /* The first thing we should output is the total number of elements...
5110 * since this is a multi-bulk write, but at this stage we don't know
5111 * the intersection set size, so we use a trick, append an empty object
5112 * to the output list and save the pointer to later modify it with the
5115 lenobj
= createObject(REDIS_STRING
,NULL
);
5117 decrRefCount(lenobj
);
5119 /* If we have a target key where to store the resulting set
5120 * create this key with an empty set inside */
5121 dstset
= createSetObject();
5124 /* Iterate all the elements of the first (smallest) set, and test
5125 * the element against all the other sets, if at least one set does
5126 * not include the element it is discarded */
5127 di
= dictGetIterator(dv
[0]);
5129 while((de
= dictNext(di
)) != NULL
) {
5132 for (j
= 1; j
< setsnum
; j
++)
5133 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5135 continue; /* at least one set does not contain the member */
5136 ele
= dictGetEntryKey(de
);
5138 addReplyBulk(c
,ele
);
5141 dictAdd(dstset
->ptr
,ele
,NULL
);
5145 dictReleaseIterator(di
);
5148 /* Store the resulting set into the target, if the intersection
5149 * is not an empty set. */
5150 deleteKey(c
->db
,dstkey
);
5151 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5152 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5153 incrRefCount(dstkey
);
5154 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5156 decrRefCount(dstset
);
5157 addReply(c
,shared
.czero
);
5161 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5166 static void sinterCommand(redisClient
*c
) {
5167 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5170 static void sinterstoreCommand(redisClient
*c
) {
5171 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5174 #define REDIS_OP_UNION 0
5175 #define REDIS_OP_DIFF 1
5176 #define REDIS_OP_INTER 2
5178 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5179 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5182 robj
*dstset
= NULL
;
5183 int j
, cardinality
= 0;
5185 for (j
= 0; j
< setsnum
; j
++) {
5189 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5190 lookupKeyRead(c
->db
,setskeys
[j
]);
5195 if (setobj
->type
!= REDIS_SET
) {
5197 addReply(c
,shared
.wrongtypeerr
);
5200 dv
[j
] = setobj
->ptr
;
5203 /* We need a temp set object to store our union. If the dstkey
5204 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5205 * this set object will be the resulting object to set into the target key*/
5206 dstset
= createSetObject();
5208 /* Iterate all the elements of all the sets, add every element a single
5209 * time to the result set */
5210 for (j
= 0; j
< setsnum
; j
++) {
5211 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5212 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5214 di
= dictGetIterator(dv
[j
]);
5216 while((de
= dictNext(di
)) != NULL
) {
5219 /* dictAdd will not add the same element multiple times */
5220 ele
= dictGetEntryKey(de
);
5221 if (op
== REDIS_OP_UNION
|| j
== 0) {
5222 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5226 } else if (op
== REDIS_OP_DIFF
) {
5227 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5232 dictReleaseIterator(di
);
5234 /* result set is empty? Exit asap. */
5235 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5238 /* Output the content of the resulting set, if not in STORE mode */
5240 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5241 di
= dictGetIterator(dstset
->ptr
);
5242 while((de
= dictNext(di
)) != NULL
) {
5245 ele
= dictGetEntryKey(de
);
5246 addReplyBulk(c
,ele
);
5248 dictReleaseIterator(di
);
5249 decrRefCount(dstset
);
5251 /* If we have a target key where to store the resulting set
5252 * create this key with the result set inside */
5253 deleteKey(c
->db
,dstkey
);
5254 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5255 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5256 incrRefCount(dstkey
);
5257 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5259 decrRefCount(dstset
);
5260 addReply(c
,shared
.czero
);
5267 static void sunionCommand(redisClient
*c
) {
5268 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5271 static void sunionstoreCommand(redisClient
*c
) {
5272 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5275 static void sdiffCommand(redisClient
*c
) {
5276 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5279 static void sdiffstoreCommand(redisClient
*c
) {
5280 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5283 /* ==================================== ZSets =============================== */
5285 /* ZSETs are ordered sets using two data structures to hold the same elements
5286 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5289 * The elements are added to an hash table mapping Redis objects to scores.
5290 * At the same time the elements are added to a skip list mapping scores
5291 * to Redis objects (so objects are sorted by scores in this "view"). */
5293 /* This skiplist implementation is almost a C translation of the original
5294 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5295 * Alternative to Balanced Trees", modified in three ways:
5296 * a) this implementation allows for repeated values.
5297 * b) the comparison is not just by key (our 'score') but by satellite data.
5298 * c) there is a back pointer, so it's a doubly linked list with the back
5299 * pointers being only at "level 1". This allows to traverse the list
5300 * from tail to head, useful for ZREVRANGE. */
5302 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5303 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5305 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5307 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5313 static zskiplist
*zslCreate(void) {
5317 zsl
= zmalloc(sizeof(*zsl
));
5320 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5321 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5322 zsl
->header
->forward
[j
] = NULL
;
5324 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5325 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5326 zsl
->header
->span
[j
] = 0;
5328 zsl
->header
->backward
= NULL
;
5333 static void zslFreeNode(zskiplistNode
*node
) {
5334 decrRefCount(node
->obj
);
5335 zfree(node
->forward
);
5340 static void zslFree(zskiplist
*zsl
) {
5341 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5343 zfree(zsl
->header
->forward
);
5344 zfree(zsl
->header
->span
);
5347 next
= node
->forward
[0];
5354 static int zslRandomLevel(void) {
5356 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5358 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5361 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5362 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5363 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5367 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5368 /* store rank that is crossed to reach the insert position */
5369 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5371 while (x
->forward
[i
] &&
5372 (x
->forward
[i
]->score
< score
||
5373 (x
->forward
[i
]->score
== score
&&
5374 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5375 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5380 /* we assume the key is not already inside, since we allow duplicated
5381 * scores, and the re-insertion of score and redis object should never
5382 * happpen since the caller of zslInsert() should test in the hash table
5383 * if the element is already inside or not. */
5384 level
= zslRandomLevel();
5385 if (level
> zsl
->level
) {
5386 for (i
= zsl
->level
; i
< level
; i
++) {
5388 update
[i
] = zsl
->header
;
5389 update
[i
]->span
[i
-1] = zsl
->length
;
5393 x
= zslCreateNode(level
,score
,obj
);
5394 for (i
= 0; i
< level
; i
++) {
5395 x
->forward
[i
] = update
[i
]->forward
[i
];
5396 update
[i
]->forward
[i
] = x
;
5398 /* update span covered by update[i] as x is inserted here */
5400 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5401 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5405 /* increment span for untouched levels */
5406 for (i
= level
; i
< zsl
->level
; i
++) {
5407 update
[i
]->span
[i
-1]++;
5410 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5412 x
->forward
[0]->backward
= x
;
5418 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5419 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5421 for (i
= 0; i
< zsl
->level
; i
++) {
5422 if (update
[i
]->forward
[i
] == x
) {
5424 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5426 update
[i
]->forward
[i
] = x
->forward
[i
];
5428 /* invariant: i > 0, because update[0]->forward[0]
5429 * is always equal to x */
5430 update
[i
]->span
[i
-1] -= 1;
5433 if (x
->forward
[0]) {
5434 x
->forward
[0]->backward
= x
->backward
;
5436 zsl
->tail
= x
->backward
;
5438 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5443 /* Delete an element with matching score/object from the skiplist. */
5444 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5445 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5449 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5450 while (x
->forward
[i
] &&
5451 (x
->forward
[i
]->score
< score
||
5452 (x
->forward
[i
]->score
== score
&&
5453 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5457 /* We may have multiple elements with the same score, what we need
5458 * is to find the element with both the right score and object. */
5460 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5461 zslDeleteNode(zsl
, x
, update
);
5465 return 0; /* not found */
5467 return 0; /* not found */
5470 /* Delete all the elements with score between min and max from the skiplist.
5471 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5472 * Note that this function takes the reference to the hash table view of the
5473 * sorted set, in order to remove the elements from the hash table too. */
5474 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5475 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5476 unsigned long removed
= 0;
5480 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5481 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5485 /* We may have multiple elements with the same score, what we need
5486 * is to find the element with both the right score and object. */
5488 while (x
&& x
->score
<= max
) {
5489 zskiplistNode
*next
= x
->forward
[0];
5490 zslDeleteNode(zsl
, x
, update
);
5491 dictDelete(dict
,x
->obj
);
5496 return removed
; /* not found */
5499 /* Delete all the elements with rank between start and end from the skiplist.
5500 * Start and end are inclusive. Note that start and end need to be 1-based */
5501 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5502 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5503 unsigned long traversed
= 0, removed
= 0;
5507 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5508 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5509 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5517 while (x
&& traversed
<= end
) {
5518 zskiplistNode
*next
= x
->forward
[0];
5519 zslDeleteNode(zsl
, x
, update
);
5520 dictDelete(dict
,x
->obj
);
5529 /* Find the first node having a score equal or greater than the specified one.
5530 * Returns NULL if there is no match. */
5531 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5536 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5537 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5540 /* We may have multiple elements with the same score, what we need
5541 * is to find the element with both the right score and object. */
5542 return x
->forward
[0];
5545 /* Find the rank for an element by both score and key.
5546 * Returns 0 when the element cannot be found, rank otherwise.
5547 * Note that the rank is 1-based due to the span of zsl->header to the
5549 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5551 unsigned long rank
= 0;
5555 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5556 while (x
->forward
[i
] &&
5557 (x
->forward
[i
]->score
< score
||
5558 (x
->forward
[i
]->score
== score
&&
5559 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5560 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5564 /* x might be equal to zsl->header, so test if obj is non-NULL */
5565 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5572 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5573 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5575 unsigned long traversed
= 0;
5579 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5580 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5582 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5585 if (traversed
== rank
) {
5592 /* The actual Z-commands implementations */
5594 /* This generic command implements both ZADD and ZINCRBY.
5595 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5596 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5597 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5602 zsetobj
= lookupKeyWrite(c
->db
,key
);
5603 if (zsetobj
== NULL
) {
5604 zsetobj
= createZsetObject();
5605 dictAdd(c
->db
->dict
,key
,zsetobj
);
5608 if (zsetobj
->type
!= REDIS_ZSET
) {
5609 addReply(c
,shared
.wrongtypeerr
);
5615 /* Ok now since we implement both ZADD and ZINCRBY here the code
5616 * needs to handle the two different conditions. It's all about setting
5617 * '*score', that is, the new score to set, to the right value. */
5618 score
= zmalloc(sizeof(double));
5622 /* Read the old score. If the element was not present starts from 0 */
5623 de
= dictFind(zs
->dict
,ele
);
5625 double *oldscore
= dictGetEntryVal(de
);
5626 *score
= *oldscore
+ scoreval
;
5634 /* What follows is a simple remove and re-insert operation that is common
5635 * to both ZADD and ZINCRBY... */
5636 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5637 /* case 1: New element */
5638 incrRefCount(ele
); /* added to hash */
5639 zslInsert(zs
->zsl
,*score
,ele
);
5640 incrRefCount(ele
); /* added to skiplist */
5643 addReplyDouble(c
,*score
);
5645 addReply(c
,shared
.cone
);
5650 /* case 2: Score update operation */
5651 de
= dictFind(zs
->dict
,ele
);
5652 redisAssert(de
!= NULL
);
5653 oldscore
= dictGetEntryVal(de
);
5654 if (*score
!= *oldscore
) {
5657 /* Remove and insert the element in the skip list with new score */
5658 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5659 redisAssert(deleted
!= 0);
5660 zslInsert(zs
->zsl
,*score
,ele
);
5662 /* Update the score in the hash table */
5663 dictReplace(zs
->dict
,ele
,score
);
5669 addReplyDouble(c
,*score
);
5671 addReply(c
,shared
.czero
);
5675 static void zaddCommand(redisClient
*c
) {
5678 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5679 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5682 static void zincrbyCommand(redisClient
*c
) {
5685 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5686 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5689 static void zremCommand(redisClient
*c
) {
5696 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5697 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5700 de
= dictFind(zs
->dict
,c
->argv
[2]);
5702 addReply(c
,shared
.czero
);
5705 /* Delete from the skiplist */
5706 oldscore
= dictGetEntryVal(de
);
5707 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5708 redisAssert(deleted
!= 0);
5710 /* Delete from the hash table */
5711 dictDelete(zs
->dict
,c
->argv
[2]);
5712 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5713 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5715 addReply(c
,shared
.cone
);
5718 static void zremrangebyscoreCommand(redisClient
*c
) {
5725 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5726 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5728 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5729 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5732 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5733 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5734 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5735 server
.dirty
+= deleted
;
5736 addReplyLong(c
,deleted
);
5739 static void zremrangebyrankCommand(redisClient
*c
) {
5747 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5748 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5750 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5751 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5753 llen
= zs
->zsl
->length
;
5755 /* convert negative indexes */
5756 if (start
< 0) start
= llen
+start
;
5757 if (end
< 0) end
= llen
+end
;
5758 if (start
< 0) start
= 0;
5759 if (end
< 0) end
= 0;
5761 /* indexes sanity checks */
5762 if (start
> end
|| start
>= llen
) {
5763 addReply(c
,shared
.czero
);
5766 if (end
>= llen
) end
= llen
-1;
5768 /* increment start and end because zsl*Rank functions
5769 * use 1-based rank */
5770 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5771 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5772 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5773 server
.dirty
+= deleted
;
5774 addReplyLong(c
, deleted
);
5782 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5783 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5784 unsigned long size1
, size2
;
5785 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5786 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5787 return size1
- size2
;
5790 #define REDIS_AGGR_SUM 1
5791 #define REDIS_AGGR_MIN 2
5792 #define REDIS_AGGR_MAX 3
5794 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5795 if (aggregate
== REDIS_AGGR_SUM
) {
5796 *target
= *target
+ val
;
5797 } else if (aggregate
== REDIS_AGGR_MIN
) {
5798 *target
= val
< *target
? val
: *target
;
5799 } else if (aggregate
== REDIS_AGGR_MAX
) {
5800 *target
= val
> *target
? val
: *target
;
5803 redisPanic("Unknown ZUNION/INTER aggregate type");
5807 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5809 int aggregate
= REDIS_AGGR_SUM
;
5816 /* expect zsetnum input keys to be given */
5817 zsetnum
= atoi(c
->argv
[2]->ptr
);
5819 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5823 /* test if the expected number of keys would overflow */
5824 if (3+zsetnum
> c
->argc
) {
5825 addReply(c
,shared
.syntaxerr
);
5829 /* read keys to be used for input */
5830 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5831 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5832 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5836 if (zsetobj
->type
!= REDIS_ZSET
) {
5838 addReply(c
,shared
.wrongtypeerr
);
5841 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5844 /* default all weights to 1 */
5845 src
[i
].weight
= 1.0;
5848 /* parse optional extra arguments */
5850 int remaining
= c
->argc
- j
;
5853 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5855 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5856 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5859 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5861 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5862 aggregate
= REDIS_AGGR_SUM
;
5863 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5864 aggregate
= REDIS_AGGR_MIN
;
5865 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5866 aggregate
= REDIS_AGGR_MAX
;
5869 addReply(c
,shared
.syntaxerr
);
5875 addReply(c
,shared
.syntaxerr
);
5881 /* sort sets from the smallest to largest, this will improve our
5882 * algorithm's performance */
5883 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5885 dstobj
= createZsetObject();
5886 dstzset
= dstobj
->ptr
;
5888 if (op
== REDIS_OP_INTER
) {
5889 /* skip going over all entries if the smallest zset is NULL or empty */
5890 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5891 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5892 * from small to large, all src[i > 0].dict are non-empty too */
5893 di
= dictGetIterator(src
[0].dict
);
5894 while((de
= dictNext(di
)) != NULL
) {
5895 double *score
= zmalloc(sizeof(double)), value
;
5896 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5898 for (j
= 1; j
< zsetnum
; j
++) {
5899 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5901 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5902 zunionInterAggregate(score
, value
, aggregate
);
5908 /* skip entry when not present in every source dict */
5912 robj
*o
= dictGetEntryKey(de
);
5913 dictAdd(dstzset
->dict
,o
,score
);
5914 incrRefCount(o
); /* added to dictionary */
5915 zslInsert(dstzset
->zsl
,*score
,o
);
5916 incrRefCount(o
); /* added to skiplist */
5919 dictReleaseIterator(di
);
5921 } else if (op
== REDIS_OP_UNION
) {
5922 for (i
= 0; i
< zsetnum
; i
++) {
5923 if (!src
[i
].dict
) continue;
5925 di
= dictGetIterator(src
[i
].dict
);
5926 while((de
= dictNext(di
)) != NULL
) {
5927 /* skip key when already processed */
5928 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5930 double *score
= zmalloc(sizeof(double)), value
;
5931 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5933 /* because the zsets are sorted by size, its only possible
5934 * for sets at larger indices to hold this entry */
5935 for (j
= (i
+1); j
< zsetnum
; j
++) {
5936 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5938 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5939 zunionInterAggregate(score
, value
, aggregate
);
5943 robj
*o
= dictGetEntryKey(de
);
5944 dictAdd(dstzset
->dict
,o
,score
);
5945 incrRefCount(o
); /* added to dictionary */
5946 zslInsert(dstzset
->zsl
,*score
,o
);
5947 incrRefCount(o
); /* added to skiplist */
5949 dictReleaseIterator(di
);
5952 /* unknown operator */
5953 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5956 deleteKey(c
->db
,dstkey
);
5957 if (dstzset
->zsl
->length
) {
5958 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5959 incrRefCount(dstkey
);
5960 addReplyLong(c
, dstzset
->zsl
->length
);
5963 decrRefCount(dstobj
);
5964 addReply(c
, shared
.czero
);
5969 static void zunionCommand(redisClient
*c
) {
5970 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5973 static void zinterCommand(redisClient
*c
) {
5974 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5977 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5989 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5990 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5992 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5994 } else if (c
->argc
>= 5) {
5995 addReply(c
,shared
.syntaxerr
);
5999 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6000 || checkType(c
,o
,REDIS_ZSET
)) return;
6005 /* convert negative indexes */
6006 if (start
< 0) start
= llen
+start
;
6007 if (end
< 0) end
= llen
+end
;
6008 if (start
< 0) start
= 0;
6009 if (end
< 0) end
= 0;
6011 /* indexes sanity checks */
6012 if (start
> end
|| start
>= llen
) {
6013 /* Out of range start or start > end result in empty list */
6014 addReply(c
,shared
.emptymultibulk
);
6017 if (end
>= llen
) end
= llen
-1;
6018 rangelen
= (end
-start
)+1;
6020 /* check if starting point is trivial, before searching
6021 * the element in log(N) time */
6023 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6026 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6029 /* Return the result in form of a multi-bulk reply */
6030 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6031 withscores
? (rangelen
*2) : rangelen
));
6032 for (j
= 0; j
< rangelen
; j
++) {
6034 addReplyBulk(c
,ele
);
6036 addReplyDouble(c
,ln
->score
);
6037 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6041 static void zrangeCommand(redisClient
*c
) {
6042 zrangeGenericCommand(c
,0);
6045 static void zrevrangeCommand(redisClient
*c
) {
6046 zrangeGenericCommand(c
,1);
6049 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6050 * If justcount is non-zero, just the count is returned. */
6051 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6054 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6055 int offset
= 0, limit
= -1;
6059 /* Parse the min-max interval. If one of the values is prefixed
6060 * by the "(" character, it's considered "open". For instance
6061 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6062 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6063 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6064 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6067 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6069 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6070 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6073 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6076 /* Parse "WITHSCORES": note that if the command was called with
6077 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6078 * enter the following paths to parse WITHSCORES and LIMIT. */
6079 if (c
->argc
== 5 || c
->argc
== 8) {
6080 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6085 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6089 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6094 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6095 addReply(c
,shared
.syntaxerr
);
6097 } else if (c
->argc
== (7 + withscores
)) {
6098 offset
= atoi(c
->argv
[5]->ptr
);
6099 limit
= atoi(c
->argv
[6]->ptr
);
6100 if (offset
< 0) offset
= 0;
6103 /* Ok, lookup the key and get the range */
6104 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6106 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6108 if (o
->type
!= REDIS_ZSET
) {
6109 addReply(c
,shared
.wrongtypeerr
);
6111 zset
*zsetobj
= o
->ptr
;
6112 zskiplist
*zsl
= zsetobj
->zsl
;
6114 robj
*ele
, *lenobj
= NULL
;
6115 unsigned long rangelen
= 0;
6117 /* Get the first node with the score >= min, or with
6118 * score > min if 'minex' is true. */
6119 ln
= zslFirstWithScore(zsl
,min
);
6120 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6123 /* No element matching the speciifed interval */
6124 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6128 /* We don't know in advance how many matching elements there
6129 * are in the list, so we push this object that will represent
6130 * the multi-bulk length in the output buffer, and will "fix"
6133 lenobj
= createObject(REDIS_STRING
,NULL
);
6135 decrRefCount(lenobj
);
6138 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6141 ln
= ln
->forward
[0];
6144 if (limit
== 0) break;
6147 addReplyBulk(c
,ele
);
6149 addReplyDouble(c
,ln
->score
);
6151 ln
= ln
->forward
[0];
6153 if (limit
> 0) limit
--;
6156 addReplyLong(c
,(long)rangelen
);
6158 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6159 withscores
? (rangelen
*2) : rangelen
);
6165 static void zrangebyscoreCommand(redisClient
*c
) {
6166 genericZrangebyscoreCommand(c
,0);
6169 static void zcountCommand(redisClient
*c
) {
6170 genericZrangebyscoreCommand(c
,1);
6173 static void zcardCommand(redisClient
*c
) {
6177 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6178 checkType(c
,o
,REDIS_ZSET
)) return;
6181 addReplyUlong(c
,zs
->zsl
->length
);
6184 static void zscoreCommand(redisClient
*c
) {
6189 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6190 checkType(c
,o
,REDIS_ZSET
)) return;
6193 de
= dictFind(zs
->dict
,c
->argv
[2]);
6195 addReply(c
,shared
.nullbulk
);
6197 double *score
= dictGetEntryVal(de
);
6199 addReplyDouble(c
,*score
);
6203 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6211 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6212 checkType(c
,o
,REDIS_ZSET
)) return;
6216 de
= dictFind(zs
->dict
,c
->argv
[2]);
6218 addReply(c
,shared
.nullbulk
);
6222 score
= dictGetEntryVal(de
);
6223 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6226 addReplyLong(c
, zsl
->length
- rank
);
6228 addReplyLong(c
, rank
-1);
6231 addReply(c
,shared
.nullbulk
);
6235 static void zrankCommand(redisClient
*c
) {
6236 zrankGenericCommand(c
, 0);
6239 static void zrevrankCommand(redisClient
*c
) {
6240 zrankGenericCommand(c
, 1);
6243 /* ========================= Hashes utility functions ======================= */
6244 #define REDIS_HASH_KEY 1
6245 #define REDIS_HASH_VALUE 2
6247 /* Check the length of a number of objects to see if we need to convert a
6248 * zipmap to a real hash. Note that we only check string encoded objects
6249 * as their string length can be queried in constant time. */
6250 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6252 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6254 for (i
= start
; i
<= end
; i
++) {
6255 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6256 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6258 convertToRealHash(subject
);
6264 /* Encode given objects in-place when the hash uses a dict. */
6265 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6266 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6267 if (o1
) *o1
= tryObjectEncoding(*o1
);
6268 if (o2
) *o2
= tryObjectEncoding(*o2
);
6272 /* Get the value from a hash identified by key. Returns either a string
6273 * object or NULL if the value cannot be found. The refcount of the object
6274 * is always increased by 1 when the value was found. */
6275 static robj
*hashGet(robj
*o
, robj
*key
) {
6277 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6280 key
= getDecodedObject(key
);
6281 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6282 value
= createStringObject((char*)v
,vlen
);
6286 dictEntry
*de
= dictFind(o
->ptr
,key
);
6288 value
= dictGetEntryVal(de
);
6289 incrRefCount(value
);
6295 /* Test if the key exists in the given hash. Returns 1 if the key
6296 * exists and 0 when it doesn't. */
6297 static int hashExists(robj
*o
, robj
*key
) {
6298 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6299 key
= getDecodedObject(key
);
6300 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6306 if (dictFind(o
->ptr
,key
) != NULL
) {
6313 /* Add an element, discard the old if the key already exists.
6314 * Return 0 on insert and 1 on update. */
6315 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6317 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6318 key
= getDecodedObject(key
);
6319 value
= getDecodedObject(value
);
6320 o
->ptr
= zipmapSet(o
->ptr
,
6321 key
->ptr
,sdslen(key
->ptr
),
6322 value
->ptr
,sdslen(value
->ptr
), &update
);
6324 decrRefCount(value
);
6326 /* Check if the zipmap needs to be upgraded to a real hash table */
6327 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6328 convertToRealHash(o
);
6330 if (dictReplace(o
->ptr
,key
,value
)) {
6337 incrRefCount(value
);
6342 /* Delete an element from a hash.
6343 * Return 1 on deleted and 0 on not found. */
6344 static int hashDelete(robj
*o
, robj
*key
) {
6346 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6347 key
= getDecodedObject(key
);
6348 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6351 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6352 /* Always check if the dictionary needs a resize after a delete. */
6353 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6358 /* Return the number of elements in a hash. */
6359 static unsigned long hashLength(robj
*o
) {
6360 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6361 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6364 /* Structure to hold hash iteration abstration. Note that iteration over
6365 * hashes involves both fields and values. Because it is possible that
6366 * not both are required, store pointers in the iterator to avoid
6367 * unnecessary memory allocation for fields/values. */
6371 unsigned char *zk
, *zv
;
6372 unsigned int zklen
, zvlen
;
6378 static hashIterator
*hashInitIterator(robj
*subject
) {
6379 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6380 hi
->encoding
= subject
->encoding
;
6381 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6382 hi
->zi
= zipmapRewind(subject
->ptr
);
6383 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6384 hi
->di
= dictGetIterator(subject
->ptr
);
6391 static void hashReleaseIterator(hashIterator
*hi
) {
6392 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6393 dictReleaseIterator(hi
->di
);
6398 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6399 * could be found and REDIS_ERR when the iterator reaches the end. */
6400 static int hashNext(hashIterator
*hi
) {
6401 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6402 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6403 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6405 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6410 /* Get key or value object at current iteration position.
6411 * This increases the refcount of the field object by 1. */
6412 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6414 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6415 if (what
& REDIS_HASH_KEY
) {
6416 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6418 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6421 if (what
& REDIS_HASH_KEY
) {
6422 o
= dictGetEntryKey(hi
->de
);
6424 o
= dictGetEntryVal(hi
->de
);
6431 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6432 robj
*o
= lookupKeyWrite(c
->db
,key
);
6434 o
= createHashObject();
6435 dictAdd(c
->db
->dict
,key
,o
);
6438 if (o
->type
!= REDIS_HASH
) {
6439 addReply(c
,shared
.wrongtypeerr
);
6446 /* ============================= Hash commands ============================== */
6447 static void hsetCommand(redisClient
*c
) {
6451 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6452 hashTryConversion(o
,c
->argv
,2,3);
6453 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6454 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6455 addReply(c
, update
? shared
.czero
: shared
.cone
);
6459 static void hsetnxCommand(redisClient
*c
) {
6461 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6462 hashTryConversion(o
,c
->argv
,2,3);
6464 if (hashExists(o
, c
->argv
[2])) {
6465 addReply(c
, shared
.czero
);
6467 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6468 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6469 addReply(c
, shared
.cone
);
6474 static void hmsetCommand(redisClient
*c
) {
6478 if ((c
->argc
% 2) == 1) {
6479 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6483 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6484 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6485 for (i
= 2; i
< c
->argc
; i
+= 2) {
6486 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6487 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6489 addReply(c
, shared
.ok
);
6493 static void hincrbyCommand(redisClient
*c
) {
6494 long long value
, incr
;
6495 robj
*o
, *current
, *new;
6497 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6498 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6499 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6500 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6501 "hash value is not an integer") != REDIS_OK
) {
6502 decrRefCount(current
);
6505 decrRefCount(current
);
6511 new = createStringObjectFromLongLong(value
);
6512 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6513 hashSet(o
,c
->argv
[2],new);
6515 addReplyLongLong(c
,value
);
6519 static void hgetCommand(redisClient
*c
) {
6521 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6522 checkType(c
,o
,REDIS_HASH
)) return;
6524 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6525 addReplyBulk(c
,value
);
6526 decrRefCount(value
);
6528 addReply(c
,shared
.nullbulk
);
6532 static void hmgetCommand(redisClient
*c
) {
6535 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6536 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6537 addReply(c
,shared
.wrongtypeerr
);
6540 /* Note the check for o != NULL happens inside the loop. This is
6541 * done because objects that cannot be found are considered to be
6542 * an empty hash. The reply should then be a series of NULLs. */
6543 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6544 for (i
= 2; i
< c
->argc
; i
++) {
6545 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6546 addReplyBulk(c
,value
);
6547 decrRefCount(value
);
6549 addReply(c
,shared
.nullbulk
);
6554 static void hdelCommand(redisClient
*c
) {
6556 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6557 checkType(c
,o
,REDIS_HASH
)) return;
6559 if (hashDelete(o
,c
->argv
[2])) {
6560 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6561 addReply(c
,shared
.cone
);
6564 addReply(c
,shared
.czero
);
6568 static void hlenCommand(redisClient
*c
) {
6570 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6571 checkType(c
,o
,REDIS_HASH
)) return;
6573 addReplyUlong(c
,hashLength(o
));
6576 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6577 robj
*o
, *lenobj
, *obj
;
6578 unsigned long count
= 0;
6581 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6582 || checkType(c
,o
,REDIS_HASH
)) return;
6584 lenobj
= createObject(REDIS_STRING
,NULL
);
6586 decrRefCount(lenobj
);
6588 hi
= hashInitIterator(o
);
6589 while (hashNext(hi
) != REDIS_ERR
) {
6590 if (flags
& REDIS_HASH_KEY
) {
6591 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6592 addReplyBulk(c
,obj
);
6596 if (flags
& REDIS_HASH_VALUE
) {
6597 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6598 addReplyBulk(c
,obj
);
6603 hashReleaseIterator(hi
);
6605 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6608 static void hkeysCommand(redisClient
*c
) {
6609 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6612 static void hvalsCommand(redisClient
*c
) {
6613 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6616 static void hgetallCommand(redisClient
*c
) {
6617 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6620 static void hexistsCommand(redisClient
*c
) {
6622 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6623 checkType(c
,o
,REDIS_HASH
)) return;
6625 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6628 static void convertToRealHash(robj
*o
) {
6629 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6630 unsigned int klen
, vlen
;
6631 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6633 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6634 p
= zipmapRewind(zm
);
6635 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6636 robj
*keyobj
, *valobj
;
6638 keyobj
= createStringObject((char*)key
,klen
);
6639 valobj
= createStringObject((char*)val
,vlen
);
6640 keyobj
= tryObjectEncoding(keyobj
);
6641 valobj
= tryObjectEncoding(valobj
);
6642 dictAdd(dict
,keyobj
,valobj
);
6644 o
->encoding
= REDIS_ENCODING_HT
;
6649 /* ========================= Non type-specific commands ==================== */
6651 static void flushdbCommand(redisClient
*c
) {
6652 server
.dirty
+= dictSize(c
->db
->dict
);
6653 dictEmpty(c
->db
->dict
);
6654 dictEmpty(c
->db
->expires
);
6655 addReply(c
,shared
.ok
);
6658 static void flushallCommand(redisClient
*c
) {
6659 server
.dirty
+= emptyDb();
6660 addReply(c
,shared
.ok
);
6661 if (server
.bgsavechildpid
!= -1) {
6662 kill(server
.bgsavechildpid
,SIGKILL
);
6663 rdbRemoveTempFile(server
.bgsavechildpid
);
6665 rdbSave(server
.dbfilename
);
6669 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6670 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6672 so
->pattern
= pattern
;
6676 /* Return the value associated to the key with a name obtained
6677 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6678 * The returned object will always have its refcount increased by 1
6679 * when it is non-NULL. */
6680 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6683 robj keyobj
, fieldobj
, *o
;
6684 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6685 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6689 char buf
[REDIS_SORTKEY_MAX
+1];
6690 } keyname
, fieldname
;
6692 /* If the pattern is "#" return the substitution object itself in order
6693 * to implement the "SORT ... GET #" feature. */
6694 spat
= pattern
->ptr
;
6695 if (spat
[0] == '#' && spat
[1] == '\0') {
6696 incrRefCount(subst
);
6700 /* The substitution object may be specially encoded. If so we create
6701 * a decoded object on the fly. Otherwise getDecodedObject will just
6702 * increment the ref count, that we'll decrement later. */
6703 subst
= getDecodedObject(subst
);
6706 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6707 p
= strchr(spat
,'*');
6709 decrRefCount(subst
);
6713 /* Find out if we're dealing with a hash dereference. */
6714 if ((f
= strstr(p
+1, "->")) != NULL
) {
6715 fieldlen
= sdslen(spat
)-(f
-spat
);
6716 /* this also copies \0 character */
6717 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6718 fieldname
.len
= fieldlen
-2;
6724 sublen
= sdslen(ssub
);
6725 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6726 memcpy(keyname
.buf
,spat
,prefixlen
);
6727 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6728 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6729 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6730 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6731 decrRefCount(subst
);
6733 /* Lookup substituted key */
6734 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6735 o
= lookupKeyRead(db
,&keyobj
);
6736 if (o
== NULL
) return NULL
;
6739 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6741 /* Retrieve value from hash by the field name. This operation
6742 * already increases the refcount of the returned object. */
6743 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6744 o
= hashGet(o
, &fieldobj
);
6746 if (o
->type
!= REDIS_STRING
) return NULL
;
6748 /* Every object that this function returns needs to have its refcount
6749 * increased. sortCommand decreases it again. */
6756 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6757 * the additional parameter is not standard but a BSD-specific we have to
6758 * pass sorting parameters via the global 'server' structure */
6759 static int sortCompare(const void *s1
, const void *s2
) {
6760 const redisSortObject
*so1
= s1
, *so2
= s2
;
6763 if (!server
.sort_alpha
) {
6764 /* Numeric sorting. Here it's trivial as we precomputed scores */
6765 if (so1
->u
.score
> so2
->u
.score
) {
6767 } else if (so1
->u
.score
< so2
->u
.score
) {
6773 /* Alphanumeric sorting */
6774 if (server
.sort_bypattern
) {
6775 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6776 /* At least one compare object is NULL */
6777 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6779 else if (so1
->u
.cmpobj
== NULL
)
6784 /* We have both the objects, use strcoll */
6785 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6788 /* Compare elements directly. */
6789 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6792 return server
.sort_desc
? -cmp
: cmp
;
6795 /* The SORT command is the most complex command in Redis. Warning: this code
6796 * is optimized for speed and a bit less for readability */
6797 static void sortCommand(redisClient
*c
) {
6800 int desc
= 0, alpha
= 0;
6801 int limit_start
= 0, limit_count
= -1, start
, end
;
6802 int j
, dontsort
= 0, vectorlen
;
6803 int getop
= 0; /* GET operation counter */
6804 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6805 redisSortObject
*vector
; /* Resulting vector to sort */
6807 /* Lookup the key to sort. It must be of the right types */
6808 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6809 if (sortval
== NULL
) {
6810 addReply(c
,shared
.emptymultibulk
);
6813 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6814 sortval
->type
!= REDIS_ZSET
)
6816 addReply(c
,shared
.wrongtypeerr
);
6820 /* Create a list of operations to perform for every sorted element.
6821 * Operations can be GET/DEL/INCR/DECR */
6822 operations
= listCreate();
6823 listSetFreeMethod(operations
,zfree
);
6826 /* Now we need to protect sortval incrementing its count, in the future
6827 * SORT may have options able to overwrite/delete keys during the sorting
6828 * and the sorted key itself may get destroied */
6829 incrRefCount(sortval
);
6831 /* The SORT command has an SQL-alike syntax, parse it */
6832 while(j
< c
->argc
) {
6833 int leftargs
= c
->argc
-j
-1;
6834 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6836 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6838 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6840 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6841 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6842 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6844 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6845 storekey
= c
->argv
[j
+1];
6847 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6848 sortby
= c
->argv
[j
+1];
6849 /* If the BY pattern does not contain '*', i.e. it is constant,
6850 * we don't need to sort nor to lookup the weight keys. */
6851 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6853 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6854 listAddNodeTail(operations
,createSortOperation(
6855 REDIS_SORT_GET
,c
->argv
[j
+1]));
6859 decrRefCount(sortval
);
6860 listRelease(operations
);
6861 addReply(c
,shared
.syntaxerr
);
6867 /* Load the sorting vector with all the objects to sort */
6868 switch(sortval
->type
) {
6869 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6870 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6871 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6872 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6874 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6877 if (sortval
->type
== REDIS_LIST
) {
6878 list
*list
= sortval
->ptr
;
6882 listRewind(list
,&li
);
6883 while((ln
= listNext(&li
))) {
6884 robj
*ele
= ln
->value
;
6885 vector
[j
].obj
= ele
;
6886 vector
[j
].u
.score
= 0;
6887 vector
[j
].u
.cmpobj
= NULL
;
6895 if (sortval
->type
== REDIS_SET
) {
6898 zset
*zs
= sortval
->ptr
;
6902 di
= dictGetIterator(set
);
6903 while((setele
= dictNext(di
)) != NULL
) {
6904 vector
[j
].obj
= dictGetEntryKey(setele
);
6905 vector
[j
].u
.score
= 0;
6906 vector
[j
].u
.cmpobj
= NULL
;
6909 dictReleaseIterator(di
);
6911 redisAssert(j
== vectorlen
);
6913 /* Now it's time to load the right scores in the sorting vector */
6914 if (dontsort
== 0) {
6915 for (j
= 0; j
< vectorlen
; j
++) {
6918 /* lookup value to sort by */
6919 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6920 if (!byval
) continue;
6922 /* use object itself to sort by */
6923 byval
= vector
[j
].obj
;
6927 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6929 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6930 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6931 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6932 /* Don't need to decode the object if it's
6933 * integer-encoded (the only encoding supported) so
6934 * far. We can just cast it */
6935 vector
[j
].u
.score
= (long)byval
->ptr
;
6937 redisAssert(1 != 1);
6941 /* when the object was retrieved using lookupKeyByPattern,
6942 * its refcount needs to be decreased. */
6944 decrRefCount(byval
);
6949 /* We are ready to sort the vector... perform a bit of sanity check
6950 * on the LIMIT option too. We'll use a partial version of quicksort. */
6951 start
= (limit_start
< 0) ? 0 : limit_start
;
6952 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6953 if (start
>= vectorlen
) {
6954 start
= vectorlen
-1;
6957 if (end
>= vectorlen
) end
= vectorlen
-1;
6959 if (dontsort
== 0) {
6960 server
.sort_desc
= desc
;
6961 server
.sort_alpha
= alpha
;
6962 server
.sort_bypattern
= sortby
? 1 : 0;
6963 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6964 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6966 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6969 /* Send command output to the output buffer, performing the specified
6970 * GET/DEL/INCR/DECR operations if any. */
6971 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6972 if (storekey
== NULL
) {
6973 /* STORE option not specified, sent the sorting result to client */
6974 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6975 for (j
= start
; j
<= end
; j
++) {
6979 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6980 listRewind(operations
,&li
);
6981 while((ln
= listNext(&li
))) {
6982 redisSortOperation
*sop
= ln
->value
;
6983 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6986 if (sop
->type
== REDIS_SORT_GET
) {
6988 addReply(c
,shared
.nullbulk
);
6990 addReplyBulk(c
,val
);
6994 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6999 robj
*listObject
= createListObject();
7000 list
*listPtr
= (list
*) listObject
->ptr
;
7002 /* STORE option specified, set the sorting result as a List object */
7003 for (j
= start
; j
<= end
; j
++) {
7008 listAddNodeTail(listPtr
,vector
[j
].obj
);
7009 incrRefCount(vector
[j
].obj
);
7011 listRewind(operations
,&li
);
7012 while((ln
= listNext(&li
))) {
7013 redisSortOperation
*sop
= ln
->value
;
7014 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7017 if (sop
->type
== REDIS_SORT_GET
) {
7019 listAddNodeTail(listPtr
,createStringObject("",0));
7021 /* We should do a incrRefCount on val because it is
7022 * added to the list, but also a decrRefCount because
7023 * it is returned by lookupKeyByPattern. This results
7024 * in doing nothing at all. */
7025 listAddNodeTail(listPtr
,val
);
7028 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7032 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7033 incrRefCount(storekey
);
7035 /* Note: we add 1 because the DB is dirty anyway since even if the
7036 * SORT result is empty a new key is set and maybe the old content
7038 server
.dirty
+= 1+outputlen
;
7039 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7043 decrRefCount(sortval
);
7044 listRelease(operations
);
7045 for (j
= 0; j
< vectorlen
; j
++) {
7046 if (alpha
&& vector
[j
].u
.cmpobj
)
7047 decrRefCount(vector
[j
].u
.cmpobj
);
7052 /* Convert an amount of bytes into a human readable string in the form
7053 * of 100B, 2G, 100M, 4K, and so forth. */
7054 static void bytesToHuman(char *s
, unsigned long long n
) {
7059 sprintf(s
,"%lluB",n
);
7061 } else if (n
< (1024*1024)) {
7062 d
= (double)n
/(1024);
7063 sprintf(s
,"%.2fK",d
);
7064 } else if (n
< (1024LL*1024*1024)) {
7065 d
= (double)n
/(1024*1024);
7066 sprintf(s
,"%.2fM",d
);
7067 } else if (n
< (1024LL*1024*1024*1024)) {
7068 d
= (double)n
/(1024LL*1024*1024);
7069 sprintf(s
,"%.2fG",d
);
7073 /* Create the string returned by the INFO command. This is decoupled
7074 * by the INFO command itself as we need to report the same information
7075 * on memory corruption problems. */
7076 static sds
genRedisInfoString(void) {
7078 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7082 bytesToHuman(hmem
,zmalloc_used_memory());
7083 info
= sdscatprintf(sdsempty(),
7084 "redis_version:%s\r\n"
7086 "multiplexing_api:%s\r\n"
7087 "process_id:%ld\r\n"
7088 "uptime_in_seconds:%ld\r\n"
7089 "uptime_in_days:%ld\r\n"
7090 "connected_clients:%d\r\n"
7091 "connected_slaves:%d\r\n"
7092 "blocked_clients:%d\r\n"
7093 "used_memory:%zu\r\n"
7094 "used_memory_human:%s\r\n"
7095 "changes_since_last_save:%lld\r\n"
7096 "bgsave_in_progress:%d\r\n"
7097 "last_save_time:%ld\r\n"
7098 "bgrewriteaof_in_progress:%d\r\n"
7099 "total_connections_received:%lld\r\n"
7100 "total_commands_processed:%lld\r\n"
7101 "expired_keys:%lld\r\n"
7102 "hash_max_zipmap_entries:%ld\r\n"
7103 "hash_max_zipmap_value:%ld\r\n"
7104 "pubsub_channels:%ld\r\n"
7105 "pubsub_patterns:%u\r\n"
7109 (sizeof(long) == 8) ? "64" : "32",
7114 listLength(server
.clients
)-listLength(server
.slaves
),
7115 listLength(server
.slaves
),
7116 server
.blpop_blocked_clients
,
7117 zmalloc_used_memory(),
7120 server
.bgsavechildpid
!= -1,
7122 server
.bgrewritechildpid
!= -1,
7123 server
.stat_numconnections
,
7124 server
.stat_numcommands
,
7125 server
.stat_expiredkeys
,
7126 server
.hash_max_zipmap_entries
,
7127 server
.hash_max_zipmap_value
,
7128 dictSize(server
.pubsub_channels
),
7129 listLength(server
.pubsub_patterns
),
7130 server
.vm_enabled
!= 0,
7131 server
.masterhost
== NULL
? "master" : "slave"
7133 if (server
.masterhost
) {
7134 info
= sdscatprintf(info
,
7135 "master_host:%s\r\n"
7136 "master_port:%d\r\n"
7137 "master_link_status:%s\r\n"
7138 "master_last_io_seconds_ago:%d\r\n"
7141 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7143 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7146 if (server
.vm_enabled
) {
7148 info
= sdscatprintf(info
,
7149 "vm_conf_max_memory:%llu\r\n"
7150 "vm_conf_page_size:%llu\r\n"
7151 "vm_conf_pages:%llu\r\n"
7152 "vm_stats_used_pages:%llu\r\n"
7153 "vm_stats_swapped_objects:%llu\r\n"
7154 "vm_stats_swappin_count:%llu\r\n"
7155 "vm_stats_swappout_count:%llu\r\n"
7156 "vm_stats_io_newjobs_len:%lu\r\n"
7157 "vm_stats_io_processing_len:%lu\r\n"
7158 "vm_stats_io_processed_len:%lu\r\n"
7159 "vm_stats_io_active_threads:%lu\r\n"
7160 "vm_stats_blocked_clients:%lu\r\n"
7161 ,(unsigned long long) server
.vm_max_memory
,
7162 (unsigned long long) server
.vm_page_size
,
7163 (unsigned long long) server
.vm_pages
,
7164 (unsigned long long) server
.vm_stats_used_pages
,
7165 (unsigned long long) server
.vm_stats_swapped_objects
,
7166 (unsigned long long) server
.vm_stats_swapins
,
7167 (unsigned long long) server
.vm_stats_swapouts
,
7168 (unsigned long) listLength(server
.io_newjobs
),
7169 (unsigned long) listLength(server
.io_processing
),
7170 (unsigned long) listLength(server
.io_processed
),
7171 (unsigned long) server
.io_active_threads
,
7172 (unsigned long) server
.vm_blocked_clients
7176 for (j
= 0; j
< server
.dbnum
; j
++) {
7177 long long keys
, vkeys
;
7179 keys
= dictSize(server
.db
[j
].dict
);
7180 vkeys
= dictSize(server
.db
[j
].expires
);
7181 if (keys
|| vkeys
) {
7182 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7189 static void infoCommand(redisClient
*c
) {
7190 sds info
= genRedisInfoString();
7191 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7192 (unsigned long)sdslen(info
)));
7193 addReplySds(c
,info
);
7194 addReply(c
,shared
.crlf
);
7197 static void monitorCommand(redisClient
*c
) {
7198 /* ignore MONITOR if aleady slave or in monitor mode */
7199 if (c
->flags
& REDIS_SLAVE
) return;
7201 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7203 listAddNodeTail(server
.monitors
,c
);
7204 addReply(c
,shared
.ok
);
7207 /* ================================= Expire ================================= */
7208 static int removeExpire(redisDb
*db
, robj
*key
) {
7209 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7216 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7217 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7225 /* Return the expire time of the specified key, or -1 if no expire
7226 * is associated with this key (i.e. the key is non volatile) */
7227 static time_t getExpire(redisDb
*db
, robj
*key
) {
7230 /* No expire? return ASAP */
7231 if (dictSize(db
->expires
) == 0 ||
7232 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7234 return (time_t) dictGetEntryVal(de
);
7237 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7241 /* No expire? return ASAP */
7242 if (dictSize(db
->expires
) == 0 ||
7243 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7245 /* Lookup the expire */
7246 when
= (time_t) dictGetEntryVal(de
);
7247 if (time(NULL
) <= when
) return 0;
7249 /* Delete the key */
7250 dictDelete(db
->expires
,key
);
7251 server
.stat_expiredkeys
++;
7252 return dictDelete(db
->dict
,key
) == DICT_OK
;
7255 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7258 /* No expire? return ASAP */
7259 if (dictSize(db
->expires
) == 0 ||
7260 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7262 /* Delete the key */
7264 server
.stat_expiredkeys
++;
7265 dictDelete(db
->expires
,key
);
7266 return dictDelete(db
->dict
,key
) == DICT_OK
;
7269 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7273 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7277 de
= dictFind(c
->db
->dict
,key
);
7279 addReply(c
,shared
.czero
);
7283 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7284 addReply(c
, shared
.cone
);
7287 time_t when
= time(NULL
)+seconds
;
7288 if (setExpire(c
->db
,key
,when
)) {
7289 addReply(c
,shared
.cone
);
7292 addReply(c
,shared
.czero
);
7298 static void expireCommand(redisClient
*c
) {
7299 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7302 static void expireatCommand(redisClient
*c
) {
7303 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7306 static void ttlCommand(redisClient
*c
) {
7310 expire
= getExpire(c
->db
,c
->argv
[1]);
7312 ttl
= (int) (expire
-time(NULL
));
7313 if (ttl
< 0) ttl
= -1;
7315 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7318 /* ================================ MULTI/EXEC ============================== */
7320 /* Client state initialization for MULTI/EXEC */
7321 static void initClientMultiState(redisClient
*c
) {
7322 c
->mstate
.commands
= NULL
;
7323 c
->mstate
.count
= 0;
7326 /* Release all the resources associated with MULTI/EXEC state */
7327 static void freeClientMultiState(redisClient
*c
) {
7330 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7332 multiCmd
*mc
= c
->mstate
.commands
+j
;
7334 for (i
= 0; i
< mc
->argc
; i
++)
7335 decrRefCount(mc
->argv
[i
]);
7338 zfree(c
->mstate
.commands
);
7341 /* Add a new command into the MULTI commands queue */
7342 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7346 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7347 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7348 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7351 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7352 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7353 for (j
= 0; j
< c
->argc
; j
++)
7354 incrRefCount(mc
->argv
[j
]);
7358 static void multiCommand(redisClient
*c
) {
7359 c
->flags
|= REDIS_MULTI
;
7360 addReply(c
,shared
.ok
);
7363 static void discardCommand(redisClient
*c
) {
7364 if (!(c
->flags
& REDIS_MULTI
)) {
7365 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7369 freeClientMultiState(c
);
7370 initClientMultiState(c
);
7371 c
->flags
&= (~REDIS_MULTI
);
7372 addReply(c
,shared
.ok
);
7375 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7376 * implememntation for more information. */
7377 static void execCommandReplicateMulti(redisClient
*c
) {
7378 struct redisCommand
*cmd
;
7379 robj
*multistring
= createStringObject("MULTI",5);
7381 cmd
= lookupCommand("multi");
7382 if (server
.appendonly
)
7383 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7384 if (listLength(server
.slaves
))
7385 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7386 decrRefCount(multistring
);
7389 static void execCommand(redisClient
*c
) {
7394 if (!(c
->flags
& REDIS_MULTI
)) {
7395 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7399 /* Replicate a MULTI request now that we are sure the block is executed.
7400 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7401 * both the AOF and the replication link will have the same consistency
7402 * and atomicity guarantees. */
7403 execCommandReplicateMulti(c
);
7405 /* Exec all the queued commands */
7406 orig_argv
= c
->argv
;
7407 orig_argc
= c
->argc
;
7408 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7409 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7410 c
->argc
= c
->mstate
.commands
[j
].argc
;
7411 c
->argv
= c
->mstate
.commands
[j
].argv
;
7412 call(c
,c
->mstate
.commands
[j
].cmd
);
7414 c
->argv
= orig_argv
;
7415 c
->argc
= orig_argc
;
7416 freeClientMultiState(c
);
7417 initClientMultiState(c
);
7418 c
->flags
&= (~REDIS_MULTI
);
7419 /* Make sure the EXEC command is always replicated / AOF, since we
7420 * always send the MULTI command (we can't know beforehand if the
7421 * next operations will contain at least a modification to the DB). */
7425 /* =========================== Blocking Operations ========================= */
7427 /* Currently Redis blocking operations support is limited to list POP ops,
7428 * so the current implementation is not fully generic, but it is also not
7429 * completely specific so it will not require a rewrite to support new
7430 * kind of blocking operations in the future.
7432 * Still it's important to note that list blocking operations can be already
7433 * used as a notification mechanism in order to implement other blocking
7434 * operations at application level, so there must be a very strong evidence
7435 * of usefulness and generality before new blocking operations are implemented.
7437 * This is how the current blocking POP works, we use BLPOP as example:
7438 * - If the user calls BLPOP and the key exists and contains a non empty list
7439 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7440 * if there is not to block.
7441 * - If instead BLPOP is called and the key does not exists or the list is
7442 * empty we need to block. In order to do so we remove the notification for
7443 * new data to read in the client socket (so that we'll not serve new
7444 * requests if the blocking request is not served). Also we put the client
7445 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7446 * blocking for this keys.
7447 * - If a PUSH operation against a key with blocked clients waiting is
7448 * performed, we serve the first in the list: basically instead to push
7449 * the new element inside the list we return it to the (first / oldest)
7450 * blocking client, unblock the client, and remove it form the list.
7452 * The above comment and the source code should be enough in order to understand
7453 * the implementation and modify / fix it later.
7456 /* Set a client in blocking mode for the specified key, with the specified
7458 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7463 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7464 c
->blockingkeysnum
= numkeys
;
7465 c
->blockingto
= timeout
;
7466 for (j
= 0; j
< numkeys
; j
++) {
7467 /* Add the key in the client structure, to map clients -> keys */
7468 c
->blockingkeys
[j
] = keys
[j
];
7469 incrRefCount(keys
[j
]);
7471 /* And in the other "side", to map keys -> clients */
7472 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7476 /* For every key we take a list of clients blocked for it */
7478 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7479 incrRefCount(keys
[j
]);
7480 assert(retval
== DICT_OK
);
7482 l
= dictGetEntryVal(de
);
7484 listAddNodeTail(l
,c
);
7486 /* Mark the client as a blocked client */
7487 c
->flags
|= REDIS_BLOCKED
;
7488 server
.blpop_blocked_clients
++;
7491 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7492 static void unblockClientWaitingData(redisClient
*c
) {
7497 assert(c
->blockingkeys
!= NULL
);
7498 /* The client may wait for multiple keys, so unblock it for every key. */
7499 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7500 /* Remove this client from the list of clients waiting for this key. */
7501 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7503 l
= dictGetEntryVal(de
);
7504 listDelNode(l
,listSearchKey(l
,c
));
7505 /* If the list is empty we need to remove it to avoid wasting memory */
7506 if (listLength(l
) == 0)
7507 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7508 decrRefCount(c
->blockingkeys
[j
]);
7510 /* Cleanup the client structure */
7511 zfree(c
->blockingkeys
);
7512 c
->blockingkeys
= NULL
;
7513 c
->flags
&= (~REDIS_BLOCKED
);
7514 server
.blpop_blocked_clients
--;
7515 /* We want to process data if there is some command waiting
7516 * in the input buffer. Note that this is safe even if
7517 * unblockClientWaitingData() gets called from freeClient() because
7518 * freeClient() will be smart enough to call this function
7519 * *after* c->querybuf was set to NULL. */
7520 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7523 /* This should be called from any function PUSHing into lists.
7524 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7525 * 'ele' is the element pushed.
7527 * If the function returns 0 there was no client waiting for a list push
7530 * If the function returns 1 there was a client waiting for a list push
7531 * against this key, the element was passed to this client thus it's not
7532 * needed to actually add it to the list and the caller should return asap. */
7533 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7534 struct dictEntry
*de
;
7535 redisClient
*receiver
;
7539 de
= dictFind(c
->db
->blockingkeys
,key
);
7540 if (de
== NULL
) return 0;
7541 l
= dictGetEntryVal(de
);
7544 receiver
= ln
->value
;
7546 addReplySds(receiver
,sdsnew("*2\r\n"));
7547 addReplyBulk(receiver
,key
);
7548 addReplyBulk(receiver
,ele
);
7549 unblockClientWaitingData(receiver
);
7553 /* Blocking RPOP/LPOP */
7554 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7559 for (j
= 1; j
< c
->argc
-1; j
++) {
7560 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7562 if (o
->type
!= REDIS_LIST
) {
7563 addReply(c
,shared
.wrongtypeerr
);
7566 list
*list
= o
->ptr
;
7567 if (listLength(list
) != 0) {
7568 /* If the list contains elements fall back to the usual
7569 * non-blocking POP operation */
7570 robj
*argv
[2], **orig_argv
;
7573 /* We need to alter the command arguments before to call
7574 * popGenericCommand() as the command takes a single key. */
7575 orig_argv
= c
->argv
;
7576 orig_argc
= c
->argc
;
7577 argv
[1] = c
->argv
[j
];
7581 /* Also the return value is different, we need to output
7582 * the multi bulk reply header and the key name. The
7583 * "real" command will add the last element (the value)
7584 * for us. If this souds like an hack to you it's just
7585 * because it is... */
7586 addReplySds(c
,sdsnew("*2\r\n"));
7587 addReplyBulk(c
,argv
[1]);
7588 popGenericCommand(c
,where
);
7590 /* Fix the client structure with the original stuff */
7591 c
->argv
= orig_argv
;
7592 c
->argc
= orig_argc
;
7598 /* If the list is empty or the key does not exists we must block */
7599 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7600 if (timeout
> 0) timeout
+= time(NULL
);
7601 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7604 static void blpopCommand(redisClient
*c
) {
7605 blockingPopGenericCommand(c
,REDIS_HEAD
);
7608 static void brpopCommand(redisClient
*c
) {
7609 blockingPopGenericCommand(c
,REDIS_TAIL
);
7612 /* =============================== Replication ============================= */
7614 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7615 ssize_t nwritten
, ret
= size
;
7616 time_t start
= time(NULL
);
7620 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7621 nwritten
= write(fd
,ptr
,size
);
7622 if (nwritten
== -1) return -1;
7626 if ((time(NULL
)-start
) > timeout
) {
7634 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7635 ssize_t nread
, totread
= 0;
7636 time_t start
= time(NULL
);
7640 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7641 nread
= read(fd
,ptr
,size
);
7642 if (nread
== -1) return -1;
7647 if ((time(NULL
)-start
) > timeout
) {
7655 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7662 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7665 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7676 static void syncCommand(redisClient
*c
) {
7677 /* ignore SYNC if aleady slave or in monitor mode */
7678 if (c
->flags
& REDIS_SLAVE
) return;
7680 /* SYNC can't be issued when the server has pending data to send to
7681 * the client about already issued commands. We need a fresh reply
7682 * buffer registering the differences between the BGSAVE and the current
7683 * dataset, so that we can copy to other slaves if needed. */
7684 if (listLength(c
->reply
) != 0) {
7685 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7689 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7690 /* Here we need to check if there is a background saving operation
7691 * in progress, or if it is required to start one */
7692 if (server
.bgsavechildpid
!= -1) {
7693 /* Ok a background save is in progress. Let's check if it is a good
7694 * one for replication, i.e. if there is another slave that is
7695 * registering differences since the server forked to save */
7700 listRewind(server
.slaves
,&li
);
7701 while((ln
= listNext(&li
))) {
7703 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7706 /* Perfect, the server is already registering differences for
7707 * another slave. Set the right state, and copy the buffer. */
7708 listRelease(c
->reply
);
7709 c
->reply
= listDup(slave
->reply
);
7710 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7711 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7713 /* No way, we need to wait for the next BGSAVE in order to
7714 * register differences */
7715 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7716 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7719 /* Ok we don't have a BGSAVE in progress, let's start one */
7720 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7721 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7722 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7723 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7726 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7729 c
->flags
|= REDIS_SLAVE
;
7731 listAddNodeTail(server
.slaves
,c
);
7735 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7736 redisClient
*slave
= privdata
;
7738 REDIS_NOTUSED(mask
);
7739 char buf
[REDIS_IOBUF_LEN
];
7740 ssize_t nwritten
, buflen
;
7742 if (slave
->repldboff
== 0) {
7743 /* Write the bulk write count before to transfer the DB. In theory here
7744 * we don't know how much room there is in the output buffer of the
7745 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7746 * operations) will never be smaller than the few bytes we need. */
7749 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7751 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7759 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7760 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7762 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7763 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7767 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7768 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7773 slave
->repldboff
+= nwritten
;
7774 if (slave
->repldboff
== slave
->repldbsize
) {
7775 close(slave
->repldbfd
);
7776 slave
->repldbfd
= -1;
7777 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7778 slave
->replstate
= REDIS_REPL_ONLINE
;
7779 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7780 sendReplyToClient
, slave
) == AE_ERR
) {
7784 addReplySds(slave
,sdsempty());
7785 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7789 /* This function is called at the end of every backgrond saving.
7790 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7791 * otherwise REDIS_ERR is passed to the function.
7793 * The goal of this function is to handle slaves waiting for a successful
7794 * background saving in order to perform non-blocking synchronization. */
7795 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7797 int startbgsave
= 0;
7800 listRewind(server
.slaves
,&li
);
7801 while((ln
= listNext(&li
))) {
7802 redisClient
*slave
= ln
->value
;
7804 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7806 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7807 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7808 struct redis_stat buf
;
7810 if (bgsaveerr
!= REDIS_OK
) {
7812 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7815 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7816 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7818 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7821 slave
->repldboff
= 0;
7822 slave
->repldbsize
= buf
.st_size
;
7823 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7824 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7825 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7832 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7835 listRewind(server
.slaves
,&li
);
7836 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7837 while((ln
= listNext(&li
))) {
7838 redisClient
*slave
= ln
->value
;
7840 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7847 static int syncWithMaster(void) {
7848 char buf
[1024], tmpfile
[256], authcmd
[1024];
7850 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7851 int dfd
, maxtries
= 5;
7854 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7859 /* AUTH with the master if required. */
7860 if(server
.masterauth
) {
7861 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7862 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7864 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7868 /* Read the AUTH result. */
7869 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7871 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7875 if (buf
[0] != '+') {
7877 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7882 /* Issue the SYNC command */
7883 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7885 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7889 /* Read the bulk write count */
7890 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7892 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7896 if (buf
[0] != '$') {
7898 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7901 dumpsize
= strtol(buf
+1,NULL
,10);
7902 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7903 /* Read the bulk write data on a temp file */
7905 snprintf(tmpfile
,256,
7906 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7907 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7908 if (dfd
!= -1) break;
7913 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7917 int nread
, nwritten
;
7919 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7921 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7927 nwritten
= write(dfd
,buf
,nread
);
7928 if (nwritten
== -1) {
7929 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7937 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7938 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7944 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7945 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7949 server
.master
= createClient(fd
);
7950 server
.master
->flags
|= REDIS_MASTER
;
7951 server
.master
->authenticated
= 1;
7952 server
.replstate
= REDIS_REPL_CONNECTED
;
7956 static void slaveofCommand(redisClient
*c
) {
7957 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7958 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7959 if (server
.masterhost
) {
7960 sdsfree(server
.masterhost
);
7961 server
.masterhost
= NULL
;
7962 if (server
.master
) freeClient(server
.master
);
7963 server
.replstate
= REDIS_REPL_NONE
;
7964 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7967 sdsfree(server
.masterhost
);
7968 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7969 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7970 if (server
.master
) freeClient(server
.master
);
7971 server
.replstate
= REDIS_REPL_CONNECT
;
7972 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7973 server
.masterhost
, server
.masterport
);
7975 addReply(c
,shared
.ok
);
7978 /* ============================ Maxmemory directive ======================== */
7980 /* Try to free one object form the pre-allocated objects free list.
7981 * This is useful under low mem conditions as by default we take 1 million
7982 * free objects allocated. On success REDIS_OK is returned, otherwise
7984 static int tryFreeOneObjectFromFreelist(void) {
7987 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7988 if (listLength(server
.objfreelist
)) {
7989 listNode
*head
= listFirst(server
.objfreelist
);
7990 o
= listNodeValue(head
);
7991 listDelNode(server
.objfreelist
,head
);
7992 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7996 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8001 /* This function gets called when 'maxmemory' is set on the config file to limit
8002 * the max memory used by the server, and we are out of memory.
8003 * This function will try to, in order:
8005 * - Free objects from the free list
8006 * - Try to remove keys with an EXPIRE set
8008 * It is not possible to free enough memory to reach used-memory < maxmemory
8009 * the server will start refusing commands that will enlarge even more the
8012 static void freeMemoryIfNeeded(void) {
8013 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8014 int j
, k
, freed
= 0;
8016 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8017 for (j
= 0; j
< server
.dbnum
; j
++) {
8019 robj
*minkey
= NULL
;
8020 struct dictEntry
*de
;
8022 if (dictSize(server
.db
[j
].expires
)) {
8024 /* From a sample of three keys drop the one nearest to
8025 * the natural expire */
8026 for (k
= 0; k
< 3; k
++) {
8029 de
= dictGetRandomKey(server
.db
[j
].expires
);
8030 t
= (time_t) dictGetEntryVal(de
);
8031 if (minttl
== -1 || t
< minttl
) {
8032 minkey
= dictGetEntryKey(de
);
8036 deleteKey(server
.db
+j
,minkey
);
8039 if (!freed
) return; /* nothing to free... */
8043 /* ============================== Append Only file ========================== */
8045 /* Write the append only file buffer on disk.
8047 * Since we are required to write the AOF before replying to the client,
8048 * and the only way the client socket can get a write is entering when the
8049 * the event loop, we accumulate all the AOF writes in a memory
8050 * buffer and write it on disk using this function just before entering
8051 * the event loop again. */
8052 static void flushAppendOnlyFile(void) {
8056 if (sdslen(server
.aofbuf
) == 0) return;
8058 /* We want to perform a single write. This should be guaranteed atomic
8059 * at least if the filesystem we are writing is a real physical one.
8060 * While this will save us against the server being killed I don't think
8061 * there is much to do about the whole server stopping for power problems
8063 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8064 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8065 /* Ooops, we are in troubles. The best thing to do for now is
8066 * aborting instead of giving the illusion that everything is
8067 * working as expected. */
8068 if (nwritten
== -1) {
8069 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8071 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8075 sdsfree(server
.aofbuf
);
8076 server
.aofbuf
= sdsempty();
8078 /* Fsync if needed */
8080 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8081 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8082 now
-server
.lastfsync
> 1))
8084 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8085 * flushing metadata. */
8086 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8087 server
.lastfsync
= now
;
8091 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8092 sds buf
= sdsempty();
8096 /* The DB this command was targetting is not the same as the last command
8097 * we appendend. To issue a SELECT command is needed. */
8098 if (dictid
!= server
.appendseldb
) {
8101 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8102 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8103 (unsigned long)strlen(seldb
),seldb
);
8104 server
.appendseldb
= dictid
;
8107 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8108 * EXPIREs into EXPIREATs calls */
8109 if (cmd
->proc
== expireCommand
) {
8112 tmpargv
[0] = createStringObject("EXPIREAT",8);
8113 tmpargv
[1] = argv
[1];
8114 incrRefCount(argv
[1]);
8115 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8116 tmpargv
[2] = createObject(REDIS_STRING
,
8117 sdscatprintf(sdsempty(),"%ld",when
));
8121 /* Append the actual command */
8122 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8123 for (j
= 0; j
< argc
; j
++) {
8126 o
= getDecodedObject(o
);
8127 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8128 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8129 buf
= sdscatlen(buf
,"\r\n",2);
8133 /* Free the objects from the modified argv for EXPIREAT */
8134 if (cmd
->proc
== expireCommand
) {
8135 for (j
= 0; j
< 3; j
++)
8136 decrRefCount(argv
[j
]);
8139 /* Append to the AOF buffer. This will be flushed on disk just before
8140 * of re-entering the event loop, so before the client will get a
8141 * positive reply about the operation performed. */
8142 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8144 /* If a background append only file rewriting is in progress we want to
8145 * accumulate the differences between the child DB and the current one
8146 * in a buffer, so that when the child process will do its work we
8147 * can append the differences to the new append only file. */
8148 if (server
.bgrewritechildpid
!= -1)
8149 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8154 /* In Redis commands are always executed in the context of a client, so in
8155 * order to load the append only file we need to create a fake client. */
8156 static struct redisClient
*createFakeClient(void) {
8157 struct redisClient
*c
= zmalloc(sizeof(*c
));
8161 c
->querybuf
= sdsempty();
8165 /* We set the fake client as a slave waiting for the synchronization
8166 * so that Redis will not try to send replies to this client. */
8167 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8168 c
->reply
= listCreate();
8169 listSetFreeMethod(c
->reply
,decrRefCount
);
8170 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8171 initClientMultiState(c
);
8175 static void freeFakeClient(struct redisClient
*c
) {
8176 sdsfree(c
->querybuf
);
8177 listRelease(c
->reply
);
8178 freeClientMultiState(c
);
8182 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8183 * error (the append only file is zero-length) REDIS_ERR is returned. On
8184 * fatal error an error message is logged and the program exists. */
8185 int loadAppendOnlyFile(char *filename
) {
8186 struct redisClient
*fakeClient
;
8187 FILE *fp
= fopen(filename
,"r");
8188 struct redis_stat sb
;
8189 unsigned long long loadedkeys
= 0;
8190 int appendonly
= server
.appendonly
;
8192 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8196 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8200 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8201 * to the same file we're about to read. */
8202 server
.appendonly
= 0;
8204 fakeClient
= createFakeClient();
8211 struct redisCommand
*cmd
;
8213 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8219 if (buf
[0] != '*') goto fmterr
;
8221 argv
= zmalloc(sizeof(robj
*)*argc
);
8222 for (j
= 0; j
< argc
; j
++) {
8223 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8224 if (buf
[0] != '$') goto fmterr
;
8225 len
= strtol(buf
+1,NULL
,10);
8226 argsds
= sdsnewlen(NULL
,len
);
8227 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8228 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8229 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8232 /* Command lookup */
8233 cmd
= lookupCommand(argv
[0]->ptr
);
8235 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8238 /* Try object encoding */
8239 if (cmd
->flags
& REDIS_CMD_BULK
)
8240 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8241 /* Run the command in the context of a fake client */
8242 fakeClient
->argc
= argc
;
8243 fakeClient
->argv
= argv
;
8244 cmd
->proc(fakeClient
);
8245 /* Discard the reply objects list from the fake client */
8246 while(listLength(fakeClient
->reply
))
8247 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8248 /* Clean up, ready for the next command */
8249 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8251 /* Handle swapping while loading big datasets when VM is on */
8253 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8254 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8255 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8260 /* This point can only be reached when EOF is reached without errors.
8261 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8262 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8265 freeFakeClient(fakeClient
);
8266 server
.appendonly
= appendonly
;
8271 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8273 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8277 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8281 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8282 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8286 /* Avoid the incr/decr ref count business if possible to help
8287 * copy-on-write (we are often in a child process when this function
8289 * Also makes sure that key objects don't get incrRefCount-ed when VM
8291 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8292 obj
= getDecodedObject(obj
);
8295 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8296 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8297 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8299 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8300 if (decrrc
) decrRefCount(obj
);
8303 if (decrrc
) decrRefCount(obj
);
8307 /* Write binary-safe string into a file in the bulkformat
8308 * $<count>\r\n<payload>\r\n */
8309 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8312 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8313 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8314 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8315 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8319 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8320 static int fwriteBulkDouble(FILE *fp
, double d
) {
8321 char buf
[128], dbuf
[128];
8323 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8324 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8325 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8326 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8330 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8331 static int fwriteBulkLong(FILE *fp
, long l
) {
8332 char buf
[128], lbuf
[128];
8334 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8335 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8336 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8337 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8341 /* Write a sequence of commands able to fully rebuild the dataset into
8342 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8343 static int rewriteAppendOnlyFile(char *filename
) {
8344 dictIterator
*di
= NULL
;
8349 time_t now
= time(NULL
);
8351 /* Note that we have to use a different temp name here compared to the
8352 * one used by rewriteAppendOnlyFileBackground() function. */
8353 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8354 fp
= fopen(tmpfile
,"w");
8356 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8359 for (j
= 0; j
< server
.dbnum
; j
++) {
8360 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8361 redisDb
*db
= server
.db
+j
;
8363 if (dictSize(d
) == 0) continue;
8364 di
= dictGetIterator(d
);
8370 /* SELECT the new DB */
8371 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8372 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8374 /* Iterate this DB writing every entry */
8375 while((de
= dictNext(di
)) != NULL
) {
8380 key
= dictGetEntryKey(de
);
8381 /* If the value for this key is swapped, load a preview in memory.
8382 * We use a "swapped" flag to remember if we need to free the
8383 * value object instead to just increment the ref count anyway
8384 * in order to avoid copy-on-write of pages if we are forked() */
8385 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8386 key
->storage
== REDIS_VM_SWAPPING
) {
8387 o
= dictGetEntryVal(de
);
8390 o
= vmPreviewObject(key
);
8393 expiretime
= getExpire(db
,key
);
8395 /* Save the key and associated value */
8396 if (o
->type
== REDIS_STRING
) {
8397 /* Emit a SET command */
8398 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8399 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8401 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8402 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8403 } else if (o
->type
== REDIS_LIST
) {
8404 /* Emit the RPUSHes needed to rebuild the list */
8405 list
*list
= o
->ptr
;
8409 listRewind(list
,&li
);
8410 while((ln
= listNext(&li
))) {
8411 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8412 robj
*eleobj
= listNodeValue(ln
);
8414 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8415 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8416 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8418 } else if (o
->type
== REDIS_SET
) {
8419 /* Emit the SADDs needed to rebuild the set */
8421 dictIterator
*di
= dictGetIterator(set
);
8424 while((de
= dictNext(di
)) != NULL
) {
8425 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8426 robj
*eleobj
= dictGetEntryKey(de
);
8428 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8429 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8430 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8432 dictReleaseIterator(di
);
8433 } else if (o
->type
== REDIS_ZSET
) {
8434 /* Emit the ZADDs needed to rebuild the sorted set */
8436 dictIterator
*di
= dictGetIterator(zs
->dict
);
8439 while((de
= dictNext(di
)) != NULL
) {
8440 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8441 robj
*eleobj
= dictGetEntryKey(de
);
8442 double *score
= dictGetEntryVal(de
);
8444 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8445 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8446 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8447 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8449 dictReleaseIterator(di
);
8450 } else if (o
->type
== REDIS_HASH
) {
8451 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8453 /* Emit the HSETs needed to rebuild the hash */
8454 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8455 unsigned char *p
= zipmapRewind(o
->ptr
);
8456 unsigned char *field
, *val
;
8457 unsigned int flen
, vlen
;
8459 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8460 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8461 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8462 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8464 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8468 dictIterator
*di
= dictGetIterator(o
->ptr
);
8471 while((de
= dictNext(di
)) != NULL
) {
8472 robj
*field
= dictGetEntryKey(de
);
8473 robj
*val
= dictGetEntryVal(de
);
8475 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8476 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8477 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8478 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8480 dictReleaseIterator(di
);
8483 redisPanic("Unknown object type");
8485 /* Save the expire time */
8486 if (expiretime
!= -1) {
8487 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8488 /* If this key is already expired skip it */
8489 if (expiretime
< now
) continue;
8490 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8491 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8492 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8494 if (swapped
) decrRefCount(o
);
8496 dictReleaseIterator(di
);
8499 /* Make sure data will not remain on the OS's output buffers */
8504 /* Use RENAME to make sure the DB file is changed atomically only
8505 * if the generate DB file is ok. */
8506 if (rename(tmpfile
,filename
) == -1) {
8507 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8511 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8517 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8518 if (di
) dictReleaseIterator(di
);
8522 /* This is how rewriting of the append only file in background works:
8524 * 1) The user calls BGREWRITEAOF
8525 * 2) Redis calls this function, that forks():
8526 * 2a) the child rewrite the append only file in a temp file.
8527 * 2b) the parent accumulates differences in server.bgrewritebuf.
8528 * 3) When the child finished '2a' exists.
8529 * 4) The parent will trap the exit code, if it's OK, will append the
8530 * data accumulated into server.bgrewritebuf into the temp file, and
8531 * finally will rename(2) the temp file in the actual file name.
8532 * The the new file is reopened as the new append only file. Profit!
8534 static int rewriteAppendOnlyFileBackground(void) {
8537 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8538 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8539 if ((childpid
= fork()) == 0) {
8543 if (server
.vm_enabled
) vmReopenSwapFile();
8545 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8546 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8553 if (childpid
== -1) {
8554 redisLog(REDIS_WARNING
,
8555 "Can't rewrite append only file in background: fork: %s",
8559 redisLog(REDIS_NOTICE
,
8560 "Background append only file rewriting started by pid %d",childpid
);
8561 server
.bgrewritechildpid
= childpid
;
8562 updateDictResizePolicy();
8563 /* We set appendseldb to -1 in order to force the next call to the
8564 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8565 * accumulated by the parent into server.bgrewritebuf will start
8566 * with a SELECT statement and it will be safe to merge. */
8567 server
.appendseldb
= -1;
8570 return REDIS_OK
; /* unreached */
8573 static void bgrewriteaofCommand(redisClient
*c
) {
8574 if (server
.bgrewritechildpid
!= -1) {
8575 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8578 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8579 char *status
= "+Background append only file rewriting started\r\n";
8580 addReplySds(c
,sdsnew(status
));
8582 addReply(c
,shared
.err
);
8586 static void aofRemoveTempFile(pid_t childpid
) {
8589 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8593 /* Virtual Memory is composed mainly of two subsystems:
8594 * - Blocking Virutal Memory
8595 * - Threaded Virtual Memory I/O
8596 * The two parts are not fully decoupled, but functions are split among two
8597 * different sections of the source code (delimited by comments) in order to
8598 * make more clear what functionality is about the blocking VM and what about
8599 * the threaded (not blocking) VM.
8603 * Redis VM is a blocking VM (one that blocks reading swapped values from
8604 * disk into memory when a value swapped out is needed in memory) that is made
8605 * unblocking by trying to examine the command argument vector in order to
8606 * load in background values that will likely be needed in order to exec
8607 * the command. The command is executed only once all the relevant keys
8608 * are loaded into memory.
8610 * This basically is almost as simple of a blocking VM, but almost as parallel
8611 * as a fully non-blocking VM.
8614 /* =================== Virtual Memory - Blocking Side ====================== */
8616 static void vmInit(void) {
8622 if (server
.vm_max_threads
!= 0)
8623 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8625 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8626 /* Try to open the old swap file, otherwise create it */
8627 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8628 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8630 if (server
.vm_fp
== NULL
) {
8631 redisLog(REDIS_WARNING
,
8632 "Can't open the swap file: %s. Exiting.",
8636 server
.vm_fd
= fileno(server
.vm_fp
);
8637 /* Lock the swap file for writing, this is useful in order to avoid
8638 * another instance to use the same swap file for a config error. */
8639 fl
.l_type
= F_WRLCK
;
8640 fl
.l_whence
= SEEK_SET
;
8641 fl
.l_start
= fl
.l_len
= 0;
8642 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8643 redisLog(REDIS_WARNING
,
8644 "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
));
8648 server
.vm_next_page
= 0;
8649 server
.vm_near_pages
= 0;
8650 server
.vm_stats_used_pages
= 0;
8651 server
.vm_stats_swapped_objects
= 0;
8652 server
.vm_stats_swapouts
= 0;
8653 server
.vm_stats_swapins
= 0;
8654 totsize
= server
.vm_pages
*server
.vm_page_size
;
8655 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8656 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8657 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8661 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8663 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8664 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8665 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8666 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8668 /* Initialize threaded I/O (used by Virtual Memory) */
8669 server
.io_newjobs
= listCreate();
8670 server
.io_processing
= listCreate();
8671 server
.io_processed
= listCreate();
8672 server
.io_ready_clients
= listCreate();
8673 pthread_mutex_init(&server
.io_mutex
,NULL
);
8674 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8675 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8676 server
.io_active_threads
= 0;
8677 if (pipe(pipefds
) == -1) {
8678 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8682 server
.io_ready_pipe_read
= pipefds
[0];
8683 server
.io_ready_pipe_write
= pipefds
[1];
8684 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8685 /* LZF requires a lot of stack */
8686 pthread_attr_init(&server
.io_threads_attr
);
8687 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8688 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8689 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8690 /* Listen for events in the threaded I/O pipe */
8691 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8692 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8693 oom("creating file event");
8696 /* Mark the page as used */
8697 static void vmMarkPageUsed(off_t page
) {
8698 off_t byte
= page
/8;
8700 redisAssert(vmFreePage(page
) == 1);
8701 server
.vm_bitmap
[byte
] |= 1<<bit
;
8704 /* Mark N contiguous pages as used, with 'page' being the first. */
8705 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8708 for (j
= 0; j
< count
; j
++)
8709 vmMarkPageUsed(page
+j
);
8710 server
.vm_stats_used_pages
+= count
;
8711 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8712 (long long)count
, (long long)page
);
8715 /* Mark the page as free */
8716 static void vmMarkPageFree(off_t page
) {
8717 off_t byte
= page
/8;
8719 redisAssert(vmFreePage(page
) == 0);
8720 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8723 /* Mark N contiguous pages as free, with 'page' being the first. */
8724 static void vmMarkPagesFree(off_t page
, off_t count
) {
8727 for (j
= 0; j
< count
; j
++)
8728 vmMarkPageFree(page
+j
);
8729 server
.vm_stats_used_pages
-= count
;
8730 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8731 (long long)count
, (long long)page
);
8734 /* Test if the page is free */
8735 static int vmFreePage(off_t page
) {
8736 off_t byte
= page
/8;
8738 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8741 /* Find N contiguous free pages storing the first page of the cluster in *first.
8742 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8743 * REDIS_ERR is returned.
8745 * This function uses a simple algorithm: we try to allocate
8746 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8747 * again from the start of the swap file searching for free spaces.
8749 * If it looks pretty clear that there are no free pages near our offset
8750 * we try to find less populated places doing a forward jump of
8751 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8752 * without hurry, and then we jump again and so forth...
8754 * This function can be improved using a free list to avoid to guess
8755 * too much, since we could collect data about freed pages.
8757 * note: I implemented this function just after watching an episode of
8758 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8760 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8761 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8763 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8764 server
.vm_near_pages
= 0;
8765 server
.vm_next_page
= 0;
8767 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8768 base
= server
.vm_next_page
;
8770 while(offset
< server
.vm_pages
) {
8771 off_t
this = base
+offset
;
8773 /* If we overflow, restart from page zero */
8774 if (this >= server
.vm_pages
) {
8775 this -= server
.vm_pages
;
8777 /* Just overflowed, what we found on tail is no longer
8778 * interesting, as it's no longer contiguous. */
8782 if (vmFreePage(this)) {
8783 /* This is a free page */
8785 /* Already got N free pages? Return to the caller, with success */
8787 *first
= this-(n
-1);
8788 server
.vm_next_page
= this+1;
8789 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8793 /* The current one is not a free page */
8797 /* Fast-forward if the current page is not free and we already
8798 * searched enough near this place. */
8800 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8801 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8803 /* Note that even if we rewind after the jump, we are don't need
8804 * to make sure numfree is set to zero as we only jump *if* it
8805 * is set to zero. */
8807 /* Otherwise just check the next page */
8814 /* Write the specified object at the specified page of the swap file */
8815 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8816 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8817 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8818 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8819 redisLog(REDIS_WARNING
,
8820 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8824 rdbSaveObject(server
.vm_fp
,o
);
8825 fflush(server
.vm_fp
);
8826 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8830 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8831 * needed to later retrieve the object into the key object.
8832 * If we can't find enough contiguous empty pages to swap the object on disk
8833 * REDIS_ERR is returned. */
8834 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8835 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8838 assert(key
->storage
== REDIS_VM_MEMORY
);
8839 assert(key
->refcount
== 1);
8840 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8841 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8842 key
->vm
.page
= page
;
8843 key
->vm
.usedpages
= pages
;
8844 key
->storage
= REDIS_VM_SWAPPED
;
8845 key
->vtype
= val
->type
;
8846 decrRefCount(val
); /* Deallocate the object from memory. */
8847 vmMarkPagesUsed(page
,pages
);
8848 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8849 (unsigned char*) key
->ptr
,
8850 (unsigned long long) page
, (unsigned long long) pages
);
8851 server
.vm_stats_swapped_objects
++;
8852 server
.vm_stats_swapouts
++;
8856 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8859 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8860 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8861 redisLog(REDIS_WARNING
,
8862 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8866 o
= rdbLoadObject(type
,server
.vm_fp
);
8868 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8871 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8875 /* Load the value object relative to the 'key' object from swap to memory.
8876 * The newly allocated object is returned.
8878 * If preview is true the unserialized object is returned to the caller but
8879 * no changes are made to the key object, nor the pages are marked as freed */
8880 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8883 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8884 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8886 key
->storage
= REDIS_VM_MEMORY
;
8887 key
->vm
.atime
= server
.unixtime
;
8888 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8889 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8890 (unsigned char*) key
->ptr
);
8891 server
.vm_stats_swapped_objects
--;
8893 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8894 (unsigned char*) key
->ptr
);
8896 server
.vm_stats_swapins
++;
8900 /* Plain object loading, from swap to memory */
8901 static robj
*vmLoadObject(robj
*key
) {
8902 /* If we are loading the object in background, stop it, we
8903 * need to load this object synchronously ASAP. */
8904 if (key
->storage
== REDIS_VM_LOADING
)
8905 vmCancelThreadedIOJob(key
);
8906 return vmGenericLoadObject(key
,0);
8909 /* Just load the value on disk, without to modify the key.
8910 * This is useful when we want to perform some operation on the value
8911 * without to really bring it from swap to memory, like while saving the
8912 * dataset or rewriting the append only log. */
8913 static robj
*vmPreviewObject(robj
*key
) {
8914 return vmGenericLoadObject(key
,1);
8917 /* How a good candidate is this object for swapping?
8918 * The better candidate it is, the greater the returned value.
8920 * Currently we try to perform a fast estimation of the object size in
8921 * memory, and combine it with aging informations.
8923 * Basically swappability = idle-time * log(estimated size)
8925 * Bigger objects are preferred over smaller objects, but not
8926 * proportionally, this is why we use the logarithm. This algorithm is
8927 * just a first try and will probably be tuned later. */
8928 static double computeObjectSwappability(robj
*o
) {
8929 time_t age
= server
.unixtime
- o
->vm
.atime
;
8933 struct dictEntry
*de
;
8936 if (age
<= 0) return 0;
8939 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8942 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8947 listNode
*ln
= listFirst(l
);
8949 asize
= sizeof(list
);
8951 robj
*ele
= ln
->value
;
8954 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8955 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8957 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8962 z
= (o
->type
== REDIS_ZSET
);
8963 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8965 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8966 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8971 de
= dictGetRandomKey(d
);
8972 ele
= dictGetEntryKey(de
);
8973 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8974 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8976 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8977 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8981 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8982 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8983 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8984 unsigned int klen
, vlen
;
8985 unsigned char *key
, *val
;
8987 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8991 asize
= len
*(klen
+vlen
+3);
8992 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8994 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8999 de
= dictGetRandomKey(d
);
9000 ele
= dictGetEntryKey(de
);
9001 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9002 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9004 ele
= dictGetEntryVal(de
);
9005 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9006 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9008 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9013 return (double)age
*log(1+asize
);
9016 /* Try to swap an object that's a good candidate for swapping.
9017 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9018 * to swap any object at all.
9020 * If 'usethreaded' is true, Redis will try to swap the object in background
9021 * using I/O threads. */
9022 static int vmSwapOneObject(int usethreads
) {
9024 struct dictEntry
*best
= NULL
;
9025 double best_swappability
= 0;
9026 redisDb
*best_db
= NULL
;
9029 for (j
= 0; j
< server
.dbnum
; j
++) {
9030 redisDb
*db
= server
.db
+j
;
9031 /* Why maxtries is set to 100?
9032 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9033 * are swappable objects */
9036 if (dictSize(db
->dict
) == 0) continue;
9037 for (i
= 0; i
< 5; i
++) {
9039 double swappability
;
9041 if (maxtries
) maxtries
--;
9042 de
= dictGetRandomKey(db
->dict
);
9043 key
= dictGetEntryKey(de
);
9044 val
= dictGetEntryVal(de
);
9045 /* Only swap objects that are currently in memory.
9047 * Also don't swap shared objects if threaded VM is on, as we
9048 * try to ensure that the main thread does not touch the
9049 * object while the I/O thread is using it, but we can't
9050 * control other keys without adding additional mutex. */
9051 if (key
->storage
!= REDIS_VM_MEMORY
||
9052 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9053 if (maxtries
) i
--; /* don't count this try */
9056 swappability
= computeObjectSwappability(val
);
9057 if (!best
|| swappability
> best_swappability
) {
9059 best_swappability
= swappability
;
9064 if (best
== NULL
) return REDIS_ERR
;
9065 key
= dictGetEntryKey(best
);
9066 val
= dictGetEntryVal(best
);
9068 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9069 key
->ptr
, best_swappability
);
9071 /* Unshare the key if needed */
9072 if (key
->refcount
> 1) {
9073 robj
*newkey
= dupStringObject(key
);
9075 key
= dictGetEntryKey(best
) = newkey
;
9079 vmSwapObjectThreaded(key
,val
,best_db
);
9082 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9083 dictGetEntryVal(best
) = NULL
;
9091 static int vmSwapOneObjectBlocking() {
9092 return vmSwapOneObject(0);
9095 static int vmSwapOneObjectThreaded() {
9096 return vmSwapOneObject(1);
9099 /* Return true if it's safe to swap out objects in a given moment.
9100 * Basically we don't want to swap objects out while there is a BGSAVE
9101 * or a BGAEOREWRITE running in backgroud. */
9102 static int vmCanSwapOut(void) {
9103 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9106 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9107 * and was deleted. Otherwise 0 is returned. */
9108 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9112 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9113 foundkey
= dictGetEntryKey(de
);
9114 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9119 /* =================== Virtual Memory - Threaded I/O ======================= */
9121 static void freeIOJob(iojob
*j
) {
9122 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9123 j
->type
== REDIS_IOJOB_DO_SWAP
||
9124 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9125 decrRefCount(j
->val
);
9126 /* We don't decrRefCount the j->key field as we did't incremented
9127 * the count creating IO Jobs. This is because the key field here is
9128 * just used as an indentifier and if a key is removed the Job should
9129 * never be touched again. */
9133 /* Every time a thread finished a Job, it writes a byte into the write side
9134 * of an unix pipe in order to "awake" the main thread, and this function
9136 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9140 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9142 REDIS_NOTUSED(mask
);
9143 REDIS_NOTUSED(privdata
);
9145 /* For every byte we read in the read side of the pipe, there is one
9146 * I/O job completed to process. */
9147 while((retval
= read(fd
,buf
,1)) == 1) {
9151 struct dictEntry
*de
;
9153 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9155 /* Get the processed element (the oldest one) */
9157 assert(listLength(server
.io_processed
) != 0);
9158 if (toprocess
== -1) {
9159 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9160 if (toprocess
<= 0) toprocess
= 1;
9162 ln
= listFirst(server
.io_processed
);
9164 listDelNode(server
.io_processed
,ln
);
9166 /* If this job is marked as canceled, just ignore it */
9171 /* Post process it in the main thread, as there are things we
9172 * can do just here to avoid race conditions and/or invasive locks */
9173 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
);
9174 de
= dictFind(j
->db
->dict
,j
->key
);
9176 key
= dictGetEntryKey(de
);
9177 if (j
->type
== REDIS_IOJOB_LOAD
) {
9180 /* Key loaded, bring it at home */
9181 key
->storage
= REDIS_VM_MEMORY
;
9182 key
->vm
.atime
= server
.unixtime
;
9183 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9184 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9185 (unsigned char*) key
->ptr
);
9186 server
.vm_stats_swapped_objects
--;
9187 server
.vm_stats_swapins
++;
9188 dictGetEntryVal(de
) = j
->val
;
9189 incrRefCount(j
->val
);
9192 /* Handle clients waiting for this key to be loaded. */
9193 handleClientsBlockedOnSwappedKey(db
,key
);
9194 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9195 /* Now we know the amount of pages required to swap this object.
9196 * Let's find some space for it, and queue this task again
9197 * rebranded as REDIS_IOJOB_DO_SWAP. */
9198 if (!vmCanSwapOut() ||
9199 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9201 /* Ooops... no space or we can't swap as there is
9202 * a fork()ed Redis trying to save stuff on disk. */
9204 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9206 /* Note that we need to mark this pages as used now,
9207 * if the job will be canceled, we'll mark them as freed
9209 vmMarkPagesUsed(j
->page
,j
->pages
);
9210 j
->type
= REDIS_IOJOB_DO_SWAP
;
9215 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9218 /* Key swapped. We can finally free some memory. */
9219 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9220 printf("key->storage: %d\n",key
->storage
);
9221 printf("key->name: %s\n",(char*)key
->ptr
);
9222 printf("key->refcount: %d\n",key
->refcount
);
9223 printf("val: %p\n",(void*)j
->val
);
9224 printf("val->type: %d\n",j
->val
->type
);
9225 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9227 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9228 val
= dictGetEntryVal(de
);
9229 key
->vm
.page
= j
->page
;
9230 key
->vm
.usedpages
= j
->pages
;
9231 key
->storage
= REDIS_VM_SWAPPED
;
9232 key
->vtype
= j
->val
->type
;
9233 decrRefCount(val
); /* Deallocate the object from memory. */
9234 dictGetEntryVal(de
) = NULL
;
9235 redisLog(REDIS_DEBUG
,
9236 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9237 (unsigned char*) key
->ptr
,
9238 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9239 server
.vm_stats_swapped_objects
++;
9240 server
.vm_stats_swapouts
++;
9242 /* Put a few more swap requests in queue if we are still
9244 if (trytoswap
&& vmCanSwapOut() &&
9245 zmalloc_used_memory() > server
.vm_max_memory
)
9250 more
= listLength(server
.io_newjobs
) <
9251 (unsigned) server
.vm_max_threads
;
9253 /* Don't waste CPU time if swappable objects are rare. */
9254 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9262 if (processed
== toprocess
) return;
9264 if (retval
< 0 && errno
!= EAGAIN
) {
9265 redisLog(REDIS_WARNING
,
9266 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9271 static void lockThreadedIO(void) {
9272 pthread_mutex_lock(&server
.io_mutex
);
9275 static void unlockThreadedIO(void) {
9276 pthread_mutex_unlock(&server
.io_mutex
);
9279 /* Remove the specified object from the threaded I/O queue if still not
9280 * processed, otherwise make sure to flag it as canceled. */
9281 static void vmCancelThreadedIOJob(robj
*o
) {
9283 server
.io_newjobs
, /* 0 */
9284 server
.io_processing
, /* 1 */
9285 server
.io_processed
/* 2 */
9289 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9292 /* Search for a matching key in one of the queues */
9293 for (i
= 0; i
< 3; i
++) {
9297 listRewind(lists
[i
],&li
);
9298 while ((ln
= listNext(&li
)) != NULL
) {
9299 iojob
*job
= ln
->value
;
9301 if (job
->canceled
) continue; /* Skip this, already canceled. */
9302 if (job
->key
== o
) {
9303 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9304 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9305 /* Mark the pages as free since the swap didn't happened
9306 * or happened but is now discarded. */
9307 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9308 vmMarkPagesFree(job
->page
,job
->pages
);
9309 /* Cancel the job. It depends on the list the job is
9312 case 0: /* io_newjobs */
9313 /* If the job was yet not processed the best thing to do
9314 * is to remove it from the queue at all */
9316 listDelNode(lists
[i
],ln
);
9318 case 1: /* io_processing */
9319 /* Oh Shi- the thread is messing with the Job:
9321 * Probably it's accessing the object if this is a
9322 * PREPARE_SWAP or DO_SWAP job.
9323 * If it's a LOAD job it may be reading from disk and
9324 * if we don't wait for the job to terminate before to
9325 * cancel it, maybe in a few microseconds data can be
9326 * corrupted in this pages. So the short story is:
9328 * Better to wait for the job to move into the
9329 * next queue (processed)... */
9331 /* We try again and again until the job is completed. */
9333 /* But let's wait some time for the I/O thread
9334 * to finish with this job. After all this condition
9335 * should be very rare. */
9338 case 2: /* io_processed */
9339 /* The job was already processed, that's easy...
9340 * just mark it as canceled so that we'll ignore it
9341 * when processing completed jobs. */
9345 /* Finally we have to adjust the storage type of the object
9346 * in order to "UNDO" the operaiton. */
9347 if (o
->storage
== REDIS_VM_LOADING
)
9348 o
->storage
= REDIS_VM_SWAPPED
;
9349 else if (o
->storage
== REDIS_VM_SWAPPING
)
9350 o
->storage
= REDIS_VM_MEMORY
;
9357 assert(1 != 1); /* We should never reach this */
9360 static void *IOThreadEntryPoint(void *arg
) {
9365 pthread_detach(pthread_self());
9367 /* Get a new job to process */
9369 if (listLength(server
.io_newjobs
) == 0) {
9370 /* No new jobs in queue, exit. */
9371 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9372 (long) pthread_self());
9373 server
.io_active_threads
--;
9377 ln
= listFirst(server
.io_newjobs
);
9379 listDelNode(server
.io_newjobs
,ln
);
9380 /* Add the job in the processing queue */
9381 j
->thread
= pthread_self();
9382 listAddNodeTail(server
.io_processing
,j
);
9383 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9385 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9386 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9388 /* Process the Job */
9389 if (j
->type
== REDIS_IOJOB_LOAD
) {
9390 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9391 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9392 FILE *fp
= fopen("/dev/null","w+");
9393 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9395 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9396 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9400 /* Done: insert the job into the processed queue */
9401 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9402 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9404 listDelNode(server
.io_processing
,ln
);
9405 listAddNodeTail(server
.io_processed
,j
);
9408 /* Signal the main thread there is new stuff to process */
9409 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9411 return NULL
; /* never reached */
9414 static void spawnIOThread(void) {
9416 sigset_t mask
, omask
;
9420 sigaddset(&mask
,SIGCHLD
);
9421 sigaddset(&mask
,SIGHUP
);
9422 sigaddset(&mask
,SIGPIPE
);
9423 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9424 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9425 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9429 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9430 server
.io_active_threads
++;
9433 /* We need to wait for the last thread to exit before we are able to
9434 * fork() in order to BGSAVE or BGREWRITEAOF. */
9435 static void waitEmptyIOJobsQueue(void) {
9437 int io_processed_len
;
9440 if (listLength(server
.io_newjobs
) == 0 &&
9441 listLength(server
.io_processing
) == 0 &&
9442 server
.io_active_threads
== 0)
9447 /* While waiting for empty jobs queue condition we post-process some
9448 * finshed job, as I/O threads may be hanging trying to write against
9449 * the io_ready_pipe_write FD but there are so much pending jobs that
9451 io_processed_len
= listLength(server
.io_processed
);
9453 if (io_processed_len
) {
9454 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9455 usleep(1000); /* 1 millisecond */
9457 usleep(10000); /* 10 milliseconds */
9462 static void vmReopenSwapFile(void) {
9463 /* Note: we don't close the old one as we are in the child process
9464 * and don't want to mess at all with the original file object. */
9465 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9466 if (server
.vm_fp
== NULL
) {
9467 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9468 server
.vm_swap_file
);
9471 server
.vm_fd
= fileno(server
.vm_fp
);
9474 /* This function must be called while with threaded IO locked */
9475 static void queueIOJob(iojob
*j
) {
9476 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9477 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9478 listAddNodeTail(server
.io_newjobs
,j
);
9479 if (server
.io_active_threads
< server
.vm_max_threads
)
9483 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9486 assert(key
->storage
== REDIS_VM_MEMORY
);
9487 assert(key
->refcount
== 1);
9489 j
= zmalloc(sizeof(*j
));
9490 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9496 j
->thread
= (pthread_t
) -1;
9497 key
->storage
= REDIS_VM_SWAPPING
;
9505 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9507 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9508 * If there is not already a job loading the key, it is craeted.
9509 * The key is added to the io_keys list in the client structure, and also
9510 * in the hash table mapping swapped keys to waiting clients, that is,
9511 * server.io_waited_keys. */
9512 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9513 struct dictEntry
*de
;
9517 /* If the key does not exist or is already in RAM we don't need to
9518 * block the client at all. */
9519 de
= dictFind(c
->db
->dict
,key
);
9520 if (de
== NULL
) return 0;
9521 o
= dictGetEntryKey(de
);
9522 if (o
->storage
== REDIS_VM_MEMORY
) {
9524 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9525 /* We were swapping the key, undo it! */
9526 vmCancelThreadedIOJob(o
);
9530 /* OK: the key is either swapped, or being loaded just now. */
9532 /* Add the key to the list of keys this client is waiting for.
9533 * This maps clients to keys they are waiting for. */
9534 listAddNodeTail(c
->io_keys
,key
);
9537 /* Add the client to the swapped keys => clients waiting map. */
9538 de
= dictFind(c
->db
->io_keys
,key
);
9542 /* For every key we take a list of clients blocked for it */
9544 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9546 assert(retval
== DICT_OK
);
9548 l
= dictGetEntryVal(de
);
9550 listAddNodeTail(l
,c
);
9552 /* Are we already loading the key from disk? If not create a job */
9553 if (o
->storage
== REDIS_VM_SWAPPED
) {
9556 o
->storage
= REDIS_VM_LOADING
;
9557 j
= zmalloc(sizeof(*j
));
9558 j
->type
= REDIS_IOJOB_LOAD
;
9561 j
->key
->vtype
= o
->vtype
;
9562 j
->page
= o
->vm
.page
;
9565 j
->thread
= (pthread_t
) -1;
9573 /* Preload keys needed for the ZUNION and ZINTER commands. */
9574 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9576 num
= atoi(c
->argv
[2]->ptr
);
9577 for (i
= 0; i
< num
; i
++) {
9578 waitForSwappedKey(c
,c
->argv
[3+i
]);
9582 /* Is this client attempting to run a command against swapped keys?
9583 * If so, block it ASAP, load the keys in background, then resume it.
9585 * The important idea about this function is that it can fail! If keys will
9586 * still be swapped when the client is resumed, this key lookups will
9587 * just block loading keys from disk. In practical terms this should only
9588 * happen with SORT BY command or if there is a bug in this function.
9590 * Return 1 if the client is marked as blocked, 0 if the client can
9591 * continue as the keys it is going to access appear to be in memory. */
9592 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9595 if (cmd
->vm_preload_proc
!= NULL
) {
9596 cmd
->vm_preload_proc(c
);
9598 if (cmd
->vm_firstkey
== 0) return 0;
9599 last
= cmd
->vm_lastkey
;
9600 if (last
< 0) last
= c
->argc
+last
;
9601 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9602 waitForSwappedKey(c
,c
->argv
[j
]);
9605 /* If the client was blocked for at least one key, mark it as blocked. */
9606 if (listLength(c
->io_keys
)) {
9607 c
->flags
|= REDIS_IO_WAIT
;
9608 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9609 server
.vm_blocked_clients
++;
9616 /* Remove the 'key' from the list of blocked keys for a given client.
9618 * The function returns 1 when there are no longer blocking keys after
9619 * the current one was removed (and the client can be unblocked). */
9620 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9624 struct dictEntry
*de
;
9626 /* Remove the key from the list of keys this client is waiting for. */
9627 listRewind(c
->io_keys
,&li
);
9628 while ((ln
= listNext(&li
)) != NULL
) {
9629 if (compareStringObjects(ln
->value
,key
) == 0) {
9630 listDelNode(c
->io_keys
,ln
);
9636 /* Remove the client form the key => waiting clients map. */
9637 de
= dictFind(c
->db
->io_keys
,key
);
9639 l
= dictGetEntryVal(de
);
9640 ln
= listSearchKey(l
,c
);
9643 if (listLength(l
) == 0)
9644 dictDelete(c
->db
->io_keys
,key
);
9646 return listLength(c
->io_keys
) == 0;
9649 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9650 struct dictEntry
*de
;
9655 de
= dictFind(db
->io_keys
,key
);
9658 l
= dictGetEntryVal(de
);
9659 len
= listLength(l
);
9660 /* Note: we can't use something like while(listLength(l)) as the list
9661 * can be freed by the calling function when we remove the last element. */
9664 redisClient
*c
= ln
->value
;
9666 if (dontWaitForSwappedKey(c
,key
)) {
9667 /* Put the client in the list of clients ready to go as we
9668 * loaded all the keys about it. */
9669 listAddNodeTail(server
.io_ready_clients
,c
);
9674 /* =========================== Remote Configuration ========================= */
9676 static void configSetCommand(redisClient
*c
) {
9677 robj
*o
= getDecodedObject(c
->argv
[3]);
9678 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9679 zfree(server
.dbfilename
);
9680 server
.dbfilename
= zstrdup(o
->ptr
);
9681 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9682 zfree(server
.requirepass
);
9683 server
.requirepass
= zstrdup(o
->ptr
);
9684 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9685 zfree(server
.masterauth
);
9686 server
.masterauth
= zstrdup(o
->ptr
);
9687 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9688 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9690 addReplySds(c
,sdscatprintf(sdsempty(),
9691 "-ERR not supported CONFIG parameter %s\r\n",
9692 (char*)c
->argv
[2]->ptr
));
9697 addReply(c
,shared
.ok
);
9700 static void configGetCommand(redisClient
*c
) {
9701 robj
*o
= getDecodedObject(c
->argv
[2]);
9702 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9703 char *pattern
= o
->ptr
;
9707 decrRefCount(lenobj
);
9709 if (stringmatch(pattern
,"dbfilename",0)) {
9710 addReplyBulkCString(c
,"dbfilename");
9711 addReplyBulkCString(c
,server
.dbfilename
);
9714 if (stringmatch(pattern
,"requirepass",0)) {
9715 addReplyBulkCString(c
,"requirepass");
9716 addReplyBulkCString(c
,server
.requirepass
);
9719 if (stringmatch(pattern
,"masterauth",0)) {
9720 addReplyBulkCString(c
,"masterauth");
9721 addReplyBulkCString(c
,server
.masterauth
);
9724 if (stringmatch(pattern
,"maxmemory",0)) {
9727 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9728 addReplyBulkCString(c
,"maxmemory");
9729 addReplyBulkCString(c
,buf
);
9733 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9736 static void configCommand(redisClient
*c
) {
9737 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9738 if (c
->argc
!= 4) goto badarity
;
9739 configSetCommand(c
);
9740 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9741 if (c
->argc
!= 3) goto badarity
;
9742 configGetCommand(c
);
9743 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9744 if (c
->argc
!= 2) goto badarity
;
9745 server
.stat_numcommands
= 0;
9746 server
.stat_numconnections
= 0;
9747 server
.stat_expiredkeys
= 0;
9748 server
.stat_starttime
= time(NULL
);
9749 addReply(c
,shared
.ok
);
9751 addReplySds(c
,sdscatprintf(sdsempty(),
9752 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9757 addReplySds(c
,sdscatprintf(sdsempty(),
9758 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9759 (char*) c
->argv
[1]->ptr
));
9762 /* =========================== Pubsub implementation ======================== */
9764 static void freePubsubPattern(void *p
) {
9765 pubsubPattern
*pat
= p
;
9767 decrRefCount(pat
->pattern
);
9771 static int listMatchPubsubPattern(void *a
, void *b
) {
9772 pubsubPattern
*pa
= a
, *pb
= b
;
9774 return (pa
->client
== pb
->client
) &&
9775 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9778 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9779 * 0 if the client was already subscribed to that channel. */
9780 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9781 struct dictEntry
*de
;
9782 list
*clients
= NULL
;
9785 /* Add the channel to the client -> channels hash table */
9786 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9788 incrRefCount(channel
);
9789 /* Add the client to the channel -> list of clients hash table */
9790 de
= dictFind(server
.pubsub_channels
,channel
);
9792 clients
= listCreate();
9793 dictAdd(server
.pubsub_channels
,channel
,clients
);
9794 incrRefCount(channel
);
9796 clients
= dictGetEntryVal(de
);
9798 listAddNodeTail(clients
,c
);
9800 /* Notify the client */
9801 addReply(c
,shared
.mbulk3
);
9802 addReply(c
,shared
.subscribebulk
);
9803 addReplyBulk(c
,channel
);
9804 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9808 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9809 * 0 if the client was not subscribed to the specified channel. */
9810 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9811 struct dictEntry
*de
;
9816 /* Remove the channel from the client -> channels hash table */
9817 incrRefCount(channel
); /* channel may be just a pointer to the same object
9818 we have in the hash tables. Protect it... */
9819 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9821 /* Remove the client from the channel -> clients list hash table */
9822 de
= dictFind(server
.pubsub_channels
,channel
);
9824 clients
= dictGetEntryVal(de
);
9825 ln
= listSearchKey(clients
,c
);
9827 listDelNode(clients
,ln
);
9828 if (listLength(clients
) == 0) {
9829 /* Free the list and associated hash entry at all if this was
9830 * the latest client, so that it will be possible to abuse
9831 * Redis PUBSUB creating millions of channels. */
9832 dictDelete(server
.pubsub_channels
,channel
);
9835 /* Notify the client */
9837 addReply(c
,shared
.mbulk3
);
9838 addReply(c
,shared
.unsubscribebulk
);
9839 addReplyBulk(c
,channel
);
9840 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9841 listLength(c
->pubsub_patterns
));
9844 decrRefCount(channel
); /* it is finally safe to release it */
9848 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9849 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9852 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9855 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9856 incrRefCount(pattern
);
9857 pat
= zmalloc(sizeof(*pat
));
9858 pat
->pattern
= getDecodedObject(pattern
);
9860 listAddNodeTail(server
.pubsub_patterns
,pat
);
9862 /* Notify the client */
9863 addReply(c
,shared
.mbulk3
);
9864 addReply(c
,shared
.psubscribebulk
);
9865 addReplyBulk(c
,pattern
);
9866 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9870 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9871 * 0 if the client was not subscribed to the specified channel. */
9872 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9877 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9878 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9880 listDelNode(c
->pubsub_patterns
,ln
);
9882 pat
.pattern
= pattern
;
9883 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9884 listDelNode(server
.pubsub_patterns
,ln
);
9886 /* Notify the client */
9888 addReply(c
,shared
.mbulk3
);
9889 addReply(c
,shared
.punsubscribebulk
);
9890 addReplyBulk(c
,pattern
);
9891 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9892 listLength(c
->pubsub_patterns
));
9894 decrRefCount(pattern
);
9898 /* Unsubscribe from all the channels. Return the number of channels the
9899 * client was subscribed from. */
9900 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9901 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9905 while((de
= dictNext(di
)) != NULL
) {
9906 robj
*channel
= dictGetEntryKey(de
);
9908 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9910 dictReleaseIterator(di
);
9914 /* Unsubscribe from all the patterns. Return the number of patterns the
9915 * client was subscribed from. */
9916 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9921 listRewind(c
->pubsub_patterns
,&li
);
9922 while ((ln
= listNext(&li
)) != NULL
) {
9923 robj
*pattern
= ln
->value
;
9925 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9930 /* Publish a message */
9931 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9933 struct dictEntry
*de
;
9937 /* Send to clients listening for that channel */
9938 de
= dictFind(server
.pubsub_channels
,channel
);
9940 list
*list
= dictGetEntryVal(de
);
9944 listRewind(list
,&li
);
9945 while ((ln
= listNext(&li
)) != NULL
) {
9946 redisClient
*c
= ln
->value
;
9948 addReply(c
,shared
.mbulk3
);
9949 addReply(c
,shared
.messagebulk
);
9950 addReplyBulk(c
,channel
);
9951 addReplyBulk(c
,message
);
9955 /* Send to clients listening to matching channels */
9956 if (listLength(server
.pubsub_patterns
)) {
9957 listRewind(server
.pubsub_patterns
,&li
);
9958 channel
= getDecodedObject(channel
);
9959 while ((ln
= listNext(&li
)) != NULL
) {
9960 pubsubPattern
*pat
= ln
->value
;
9962 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9963 sdslen(pat
->pattern
->ptr
),
9964 (char*)channel
->ptr
,
9965 sdslen(channel
->ptr
),0)) {
9966 addReply(pat
->client
,shared
.mbulk4
);
9967 addReply(pat
->client
,shared
.pmessagebulk
);
9968 addReplyBulk(pat
->client
,pat
->pattern
);
9969 addReplyBulk(pat
->client
,channel
);
9970 addReplyBulk(pat
->client
,message
);
9974 decrRefCount(channel
);
9979 static void subscribeCommand(redisClient
*c
) {
9982 for (j
= 1; j
< c
->argc
; j
++)
9983 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9986 static void unsubscribeCommand(redisClient
*c
) {
9988 pubsubUnsubscribeAllChannels(c
,1);
9993 for (j
= 1; j
< c
->argc
; j
++)
9994 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9998 static void psubscribeCommand(redisClient
*c
) {
10001 for (j
= 1; j
< c
->argc
; j
++)
10002 pubsubSubscribePattern(c
,c
->argv
[j
]);
10005 static void punsubscribeCommand(redisClient
*c
) {
10006 if (c
->argc
== 1) {
10007 pubsubUnsubscribeAllPatterns(c
,1);
10012 for (j
= 1; j
< c
->argc
; j
++)
10013 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10017 static void publishCommand(redisClient
*c
) {
10018 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10019 addReplyLong(c
,receivers
);
10022 /* ================================= Debugging ============================== */
10024 static void debugCommand(redisClient
*c
) {
10025 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10026 *((char*)-1) = 'x';
10027 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10028 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10029 addReply(c
,shared
.err
);
10033 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10034 addReply(c
,shared
.err
);
10037 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10038 addReply(c
,shared
.ok
);
10039 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10041 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10042 addReply(c
,shared
.err
);
10045 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10046 addReply(c
,shared
.ok
);
10047 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10048 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10052 addReply(c
,shared
.nokeyerr
);
10055 key
= dictGetEntryKey(de
);
10056 val
= dictGetEntryVal(de
);
10057 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10058 key
->storage
== REDIS_VM_SWAPPING
)) {
10062 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10063 strenc
= strencoding
[val
->encoding
];
10065 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10068 addReplySds(c
,sdscatprintf(sdsempty(),
10069 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10070 "encoding:%s serializedlength:%lld\r\n",
10071 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10072 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10074 addReplySds(c
,sdscatprintf(sdsempty(),
10075 "+Key at:%p refcount:%d, value swapped at: page %llu "
10076 "using %llu pages\r\n",
10077 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10078 (unsigned long long) key
->vm
.usedpages
));
10080 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10081 lookupKeyRead(c
->db
,c
->argv
[2]);
10082 addReply(c
,shared
.ok
);
10083 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10084 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10087 if (!server
.vm_enabled
) {
10088 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10092 addReply(c
,shared
.nokeyerr
);
10095 key
= dictGetEntryKey(de
);
10096 val
= dictGetEntryVal(de
);
10097 /* If the key is shared we want to create a copy */
10098 if (key
->refcount
> 1) {
10099 robj
*newkey
= dupStringObject(key
);
10101 key
= dictGetEntryKey(de
) = newkey
;
10104 if (key
->storage
!= REDIS_VM_MEMORY
) {
10105 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10106 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10107 dictGetEntryVal(de
) = NULL
;
10108 addReply(c
,shared
.ok
);
10110 addReply(c
,shared
.err
);
10112 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10117 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10119 for (j
= 0; j
< keys
; j
++) {
10120 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10121 key
= createStringObject(buf
,strlen(buf
));
10122 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10126 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10127 val
= createStringObject(buf
,strlen(buf
));
10128 dictAdd(c
->db
->dict
,key
,val
);
10130 addReply(c
,shared
.ok
);
10132 addReplySds(c
,sdsnew(
10133 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10137 static void _redisAssert(char *estr
, char *file
, int line
) {
10138 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10139 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10140 #ifdef HAVE_BACKTRACE
10141 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10142 *((char*)-1) = 'x';
10146 static void _redisPanic(char *msg
, char *file
, int line
) {
10147 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10148 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10149 #ifdef HAVE_BACKTRACE
10150 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10151 *((char*)-1) = 'x';
10155 /* =================================== Main! ================================ */
10158 int linuxOvercommitMemoryValue(void) {
10159 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10162 if (!fp
) return -1;
10163 if (fgets(buf
,64,fp
) == NULL
) {
10172 void linuxOvercommitMemoryWarning(void) {
10173 if (linuxOvercommitMemoryValue() == 0) {
10174 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.");
10177 #endif /* __linux__ */
10179 static void daemonize(void) {
10183 if (fork() != 0) exit(0); /* parent exits */
10184 setsid(); /* create a new session */
10186 /* Every output goes to /dev/null. If Redis is daemonized but
10187 * the 'logfile' is set to 'stdout' in the configuration file
10188 * it will not log at all. */
10189 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10190 dup2(fd
, STDIN_FILENO
);
10191 dup2(fd
, STDOUT_FILENO
);
10192 dup2(fd
, STDERR_FILENO
);
10193 if (fd
> STDERR_FILENO
) close(fd
);
10195 /* Try to write the pid file */
10196 fp
= fopen(server
.pidfile
,"w");
10198 fprintf(fp
,"%d\n",getpid());
10203 static void version() {
10204 printf("Redis server version %s\n", REDIS_VERSION
);
10208 static void usage() {
10209 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10210 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10214 int main(int argc
, char **argv
) {
10217 initServerConfig();
10219 if (strcmp(argv
[1], "-v") == 0 ||
10220 strcmp(argv
[1], "--version") == 0) version();
10221 if (strcmp(argv
[1], "--help") == 0) usage();
10222 resetServerSaveParams();
10223 loadServerConfig(argv
[1]);
10224 } else if ((argc
> 2)) {
10227 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'");
10229 if (server
.daemonize
) daemonize();
10231 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10233 linuxOvercommitMemoryWarning();
10235 start
= time(NULL
);
10236 if (server
.appendonly
) {
10237 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10238 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10240 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10241 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10243 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10244 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10246 aeDeleteEventLoop(server
.el
);
10250 /* ============================= Backtrace support ========================= */
10252 #ifdef HAVE_BACKTRACE
10253 static char *findFuncName(void *pointer
, unsigned long *offset
);
10255 static void *getMcontextEip(ucontext_t
*uc
) {
10256 #if defined(__FreeBSD__)
10257 return (void*) uc
->uc_mcontext
.mc_eip
;
10258 #elif defined(__dietlibc__)
10259 return (void*) uc
->uc_mcontext
.eip
;
10260 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10262 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10264 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10266 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10267 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10268 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10270 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10272 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10273 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10274 #elif defined(__ia64__) /* Linux IA64 */
10275 return (void*) uc
->uc_mcontext
.sc_ip
;
10281 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10283 char **messages
= NULL
;
10284 int i
, trace_size
= 0;
10285 unsigned long offset
=0;
10286 ucontext_t
*uc
= (ucontext_t
*) secret
;
10288 REDIS_NOTUSED(info
);
10290 redisLog(REDIS_WARNING
,
10291 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10292 infostring
= genRedisInfoString();
10293 redisLog(REDIS_WARNING
, "%s",infostring
);
10294 /* It's not safe to sdsfree() the returned string under memory
10295 * corruption conditions. Let it leak as we are going to abort */
10297 trace_size
= backtrace(trace
, 100);
10298 /* overwrite sigaction with caller's address */
10299 if (getMcontextEip(uc
) != NULL
) {
10300 trace
[1] = getMcontextEip(uc
);
10302 messages
= backtrace_symbols(trace
, trace_size
);
10304 for (i
=1; i
<trace_size
; ++i
) {
10305 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10307 p
= strchr(messages
[i
],'+');
10308 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10309 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10311 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10314 /* free(messages); Don't call free() with possibly corrupted memory. */
10318 static void setupSigSegvAction(void) {
10319 struct sigaction act
;
10321 sigemptyset (&act
.sa_mask
);
10322 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10323 * is used. Otherwise, sa_handler is used */
10324 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10325 act
.sa_sigaction
= segvHandler
;
10326 sigaction (SIGSEGV
, &act
, NULL
);
10327 sigaction (SIGBUS
, &act
, NULL
);
10328 sigaction (SIGFPE
, &act
, NULL
);
10329 sigaction (SIGILL
, &act
, NULL
);
10330 sigaction (SIGBUS
, &act
, NULL
);
10334 #include "staticsymbols.h"
10335 /* This function try to convert a pointer into a function name. It's used in
10336 * oreder to provide a backtrace under segmentation fault that's able to
10337 * display functions declared as static (otherwise the backtrace is useless). */
10338 static char *findFuncName(void *pointer
, unsigned long *offset
){
10340 unsigned long off
, minoff
= 0;
10342 /* Try to match against the Symbol with the smallest offset */
10343 for (i
=0; symsTable
[i
].pointer
; i
++) {
10344 unsigned long lp
= (unsigned long) pointer
;
10346 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10347 off
=lp
-symsTable
[i
].pointer
;
10348 if (ret
< 0 || off
< minoff
) {
10354 if (ret
== -1) return NULL
;
10356 return symsTable
[ret
].name
;
10358 #else /* HAVE_BACKTRACE */
10359 static void setupSigSegvAction(void) {
10361 #endif /* HAVE_BACKTRACE */