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 "2.1.1"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
65 #include "solarisfixes.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
77 #include "zipmap.h" /* Compact dictionary-alike data structure */
78 #include "ziplist.h" /* Compact list data structure */
79 #include "sha1.h" /* SHA1 is used for DEBUG DIGEST */
80 #include "release.h" /* Release and/or git repository information */
86 /* Static server configuration */
87 #define REDIS_SERVERPORT 6379 /* TCP port */
88 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
89 #define REDIS_IOBUF_LEN 1024
90 #define REDIS_LOADBUF_LEN 1024
91 #define REDIS_STATIC_ARGS 8
92 #define REDIS_DEFAULT_DBNUM 16
93 #define REDIS_CONFIGLINE_MAX 1024
94 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
95 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
96 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
97 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
98 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
100 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
101 #define REDIS_WRITEV_THRESHOLD 3
102 /* Max number of iovecs used for each writev call */
103 #define REDIS_WRITEV_IOVEC_COUNT 256
105 /* Hash table parameters */
106 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
109 #define REDIS_CMD_BULK 1 /* Bulk write command */
110 #define REDIS_CMD_INLINE 2 /* Inline command */
111 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
112 this flags will return an error when the 'maxmemory' option is set in the
113 config file and the server is using more than maxmemory bytes of memory.
114 In short this commands are denied on low memory conditions. */
115 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
119 #define REDIS_STRING 0
125 /* Objects encoding. Some kind of objects like Strings and Hashes can be
126 * internally represented in multiple ways. The 'encoding' field of the object
127 * is set to one of this fields for this object. */
128 #define REDIS_ENCODING_RAW 0 /* Raw representation */
129 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
130 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
131 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
132 #define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
133 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
135 static char* strencoding
[] = {
136 "raw", "int", "zipmap", "hashtable"
139 /* Object types only used for dumping to disk */
140 #define REDIS_EXPIRETIME 253
141 #define REDIS_SELECTDB 254
142 #define REDIS_EOF 255
144 /* Defines related to the dump file format. To store 32 bits lengths for short
145 * keys requires a lot of space, so we check the most significant 2 bits of
146 * the first byte to interpreter the length:
148 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
149 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
150 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
151 * 11|000000 this means: specially encoded object will follow. The six bits
152 * number specify the kind of object that follows.
153 * See the REDIS_RDB_ENC_* defines.
155 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
156 * values, will fit inside. */
157 #define REDIS_RDB_6BITLEN 0
158 #define REDIS_RDB_14BITLEN 1
159 #define REDIS_RDB_32BITLEN 2
160 #define REDIS_RDB_ENCVAL 3
161 #define REDIS_RDB_LENERR UINT_MAX
163 /* When a length of a string object stored on disk has the first two bits
164 * set, the remaining two bits specify a special encoding for the object
165 * accordingly to the following defines: */
166 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
167 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
168 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
169 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
171 /* Virtual memory object->where field. */
172 #define REDIS_VM_MEMORY 0 /* The object is on memory */
173 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
174 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
175 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
177 /* Virtual memory static configuration stuff.
178 * Check vmFindContiguousPages() to know more about this magic numbers. */
179 #define REDIS_VM_MAX_NEAR_PAGES 65536
180 #define REDIS_VM_MAX_RANDOM_JUMP 4096
181 #define REDIS_VM_MAX_THREADS 32
182 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
183 /* The following is the *percentage* of completed I/O jobs to process when the
184 * handelr is called. While Virtual Memory I/O operations are performed by
185 * threads, this operations must be processed by the main thread when completed
186 * in order to take effect. */
187 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
190 #define REDIS_SLAVE 1 /* This client is a slave server */
191 #define REDIS_MASTER 2 /* This client is a master server */
192 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
193 #define REDIS_MULTI 8 /* This client is in a MULTI context */
194 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
195 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
196 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
198 /* Slave replication state - slave side */
199 #define REDIS_REPL_NONE 0 /* No active replication */
200 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
201 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
203 /* Slave replication state - from the point of view of master
204 * Note that in SEND_BULK and ONLINE state the slave receives new updates
205 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
206 * to start the next background saving in order to send updates to it. */
207 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
208 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
209 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
210 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
212 /* List related stuff */
216 /* Sort operations */
217 #define REDIS_SORT_GET 0
218 #define REDIS_SORT_ASC 1
219 #define REDIS_SORT_DESC 2
220 #define REDIS_SORTKEY_MAX 1024
223 #define REDIS_DEBUG 0
224 #define REDIS_VERBOSE 1
225 #define REDIS_NOTICE 2
226 #define REDIS_WARNING 3
228 /* Anti-warning macro... */
229 #define REDIS_NOTUSED(V) ((void) V)
231 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
232 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
234 /* Append only defines */
235 #define APPENDFSYNC_NO 0
236 #define APPENDFSYNC_ALWAYS 1
237 #define APPENDFSYNC_EVERYSEC 2
239 /* Hashes related defaults */
240 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
241 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
243 /* We can print the stacktrace, so our assert is defined this way: */
244 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
245 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
246 static void _redisAssert(char *estr
, char *file
, int line
);
247 static void _redisPanic(char *msg
, char *file
, int line
);
249 /*================================= Data types ============================== */
251 /* A redis object, that is a type able to hold a string / list / set */
253 /* The VM object structure */
254 struct redisObjectVM
{
255 off_t page
; /* the page at witch the object is stored on disk */
256 off_t usedpages
; /* number of pages used on disk */
257 time_t atime
; /* Last access time */
260 /* The actual Redis Object */
261 typedef struct redisObject
{
264 unsigned char encoding
;
265 unsigned char storage
; /* If this object is a key, where is the value?
266 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
267 unsigned char vtype
; /* If this object is a key, and value is swapped out,
268 * this is the type of the swapped out object. */
270 /* VM fields, this are only allocated if VM is active, otherwise the
271 * object allocation function will just allocate
272 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
273 * Redis without VM active will not have any overhead. */
274 struct redisObjectVM vm
;
277 /* Macro used to initalize a Redis object allocated on the stack.
278 * Note that this macro is taken near the structure definition to make sure
279 * we'll update it when the structure is changed, to avoid bugs like
280 * bug #85 introduced exactly in this way. */
281 #define initStaticStringObject(_var,_ptr) do { \
283 _var.type = REDIS_STRING; \
284 _var.encoding = REDIS_ENCODING_RAW; \
286 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
289 typedef struct redisDb
{
290 dict
*dict
; /* The keyspace for this DB */
291 dict
*expires
; /* Timeout of keys with a timeout set */
292 dict
*blocking_keys
; /* Keys with clients waiting for data (BLPOP) */
293 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
294 dict
*watched_keys
; /* WATCHED keys for MULTI/EXEC CAS */
298 /* Client MULTI/EXEC state */
299 typedef struct multiCmd
{
302 struct redisCommand
*cmd
;
305 typedef struct multiState
{
306 multiCmd
*commands
; /* Array of MULTI commands */
307 int count
; /* Total number of MULTI commands */
310 /* With multiplexing we need to take per-clinet state.
311 * Clients are taken in a liked list. */
312 typedef struct redisClient
{
317 robj
**argv
, **mbargv
;
319 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
320 int multibulk
; /* multi bulk command format active */
323 time_t lastinteraction
; /* time of the last interaction, used for timeout */
324 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
325 int slaveseldb
; /* slave selected db, if this client is a slave */
326 int authenticated
; /* when requirepass is non-NULL */
327 int replstate
; /* replication state if this is a slave */
328 int repldbfd
; /* replication DB file descriptor */
329 long repldboff
; /* replication DB file offset */
330 off_t repldbsize
; /* replication DB file size */
331 multiState mstate
; /* MULTI/EXEC state */
332 robj
**blocking_keys
; /* The key we are waiting to terminate a blocking
333 * operation such as BLPOP. Otherwise NULL. */
334 int blocking_keys_num
; /* Number of blocking keys */
335 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
336 * is >= blockingto then the operation timed out. */
337 list
*io_keys
; /* Keys this client is waiting to be loaded from the
338 * swap file in order to continue. */
339 list
*watched_keys
; /* Keys WATCHED for MULTI/EXEC CAS */
340 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
341 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
349 /* Global server state structure */
354 long long dirty
; /* changes to DB from the last save */
356 list
*slaves
, *monitors
;
357 char neterr
[ANET_ERR_LEN
];
359 int cronloops
; /* number of times the cron function run */
360 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
361 time_t lastsave
; /* Unix time of last save succeeede */
362 /* Fields used only for stats */
363 time_t stat_starttime
; /* server start time */
364 long long stat_numcommands
; /* number of processed commands */
365 long long stat_numconnections
; /* number of connections received */
366 long long stat_expiredkeys
; /* number of expired keys */
380 pid_t bgsavechildpid
;
381 pid_t bgrewritechildpid
;
382 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
383 sds aofbuf
; /* AOF buffer, written before entering the event loop */
384 struct saveparam
*saveparams
;
389 char *appendfilename
;
393 /* Replication related */
398 redisClient
*master
; /* client that is master for this slave */
400 unsigned int maxclients
;
401 unsigned long long maxmemory
;
402 unsigned int blpop_blocked_clients
;
403 unsigned int vm_blocked_clients
;
404 /* Sort parameters - qsort_r() is only available under BSD so we
405 * have to take this state global, in order to pass it to sortCompare() */
409 /* Virtual memory configuration */
414 unsigned long long vm_max_memory
;
416 size_t hash_max_zipmap_entries
;
417 size_t hash_max_zipmap_value
;
418 /* Virtual memory state */
421 off_t vm_next_page
; /* Next probably empty page */
422 off_t vm_near_pages
; /* Number of pages allocated sequentially */
423 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
424 time_t unixtime
; /* Unix time sampled every second. */
425 /* Virtual memory I/O threads stuff */
426 /* An I/O thread process an element taken from the io_jobs queue and
427 * put the result of the operation in the io_done list. While the
428 * job is being processed, it's put on io_processing queue. */
429 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
430 list
*io_processing
; /* List of VM I/O jobs being processed */
431 list
*io_processed
; /* List of VM I/O jobs already processed */
432 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
433 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
434 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
435 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
436 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
437 int io_active_threads
; /* Number of running I/O threads */
438 int vm_max_threads
; /* Max number of I/O threads running at the same time */
439 /* Our main thread is blocked on the event loop, locking for sockets ready
440 * to be read or written, so when a threaded I/O operation is ready to be
441 * processed by the main thread, the I/O thread will use a unix pipe to
442 * awake the main thread. The followings are the two pipe FDs. */
443 int io_ready_pipe_read
;
444 int io_ready_pipe_write
;
445 /* Virtual memory stats */
446 unsigned long long vm_stats_used_pages
;
447 unsigned long long vm_stats_swapped_objects
;
448 unsigned long long vm_stats_swapouts
;
449 unsigned long long vm_stats_swapins
;
451 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
452 list
*pubsub_patterns
; /* A list of pubsub_patterns */
457 typedef struct pubsubPattern
{
462 typedef void redisCommandProc(redisClient
*c
);
463 typedef void redisVmPreloadProc(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
464 struct redisCommand
{
466 redisCommandProc
*proc
;
469 /* Use a function to determine which keys need to be loaded
470 * in the background prior to executing this command. Takes precedence
471 * over vm_firstkey and others, ignored when NULL */
472 redisVmPreloadProc
*vm_preload_proc
;
473 /* What keys should be loaded in background when calling this command? */
474 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
475 int vm_lastkey
; /* THe last argument that's a key */
476 int vm_keystep
; /* The step between first and last key */
479 struct redisFunctionSym
{
481 unsigned long pointer
;
484 typedef struct _redisSortObject
{
492 typedef struct _redisSortOperation
{
495 } redisSortOperation
;
497 /* ZSETs use a specialized version of Skiplists */
499 typedef struct zskiplistNode
{
500 struct zskiplistNode
**forward
;
501 struct zskiplistNode
*backward
;
507 typedef struct zskiplist
{
508 struct zskiplistNode
*header
, *tail
;
509 unsigned long length
;
513 typedef struct zset
{
518 /* Our shared "common" objects */
520 #define REDIS_SHARED_INTEGERS 10000
521 struct sharedObjectsStruct
{
522 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
523 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
524 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
525 *outofrangeerr
, *plus
,
526 *select0
, *select1
, *select2
, *select3
, *select4
,
527 *select5
, *select6
, *select7
, *select8
, *select9
,
528 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
529 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
530 *integers
[REDIS_SHARED_INTEGERS
];
533 /* Global vars that are actally used as constants. The following double
534 * values are used for double on-disk serialization, and are initialized
535 * at runtime to avoid strange compiler optimizations. */
537 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
539 /* VM threaded I/O request message */
540 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
541 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
542 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
543 typedef struct iojob
{
544 int type
; /* Request type, REDIS_IOJOB_* */
545 redisDb
*db
;/* Redis database */
546 robj
*key
; /* This I/O request is about swapping this key */
547 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
548 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
549 off_t page
; /* Swap page where to read/write the object */
550 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
551 int canceled
; /* True if this command was canceled by blocking side of VM */
552 pthread_t thread
; /* ID of the thread processing this entry */
555 /*================================ Prototypes =============================== */
557 static void freeStringObject(robj
*o
);
558 static void freeListObject(robj
*o
);
559 static void freeSetObject(robj
*o
);
560 static void decrRefCount(void *o
);
561 static robj
*createObject(int type
, void *ptr
);
562 static void freeClient(redisClient
*c
);
563 static int rdbLoad(char *filename
);
564 static void addReply(redisClient
*c
, robj
*obj
);
565 static void addReplySds(redisClient
*c
, sds s
);
566 static void incrRefCount(robj
*o
);
567 static int rdbSaveBackground(char *filename
);
568 static robj
*createStringObject(char *ptr
, size_t len
);
569 static robj
*dupStringObject(robj
*o
);
570 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
571 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
572 static void flushAppendOnlyFile(void);
573 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
574 static int syncWithMaster(void);
575 static robj
*tryObjectEncoding(robj
*o
);
576 static robj
*getDecodedObject(robj
*o
);
577 static int removeExpire(redisDb
*db
, robj
*key
);
578 static int expireIfNeeded(redisDb
*db
, robj
*key
);
579 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
580 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
581 static int deleteKey(redisDb
*db
, robj
*key
);
582 static time_t getExpire(redisDb
*db
, robj
*key
);
583 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
584 static void updateSlavesWaitingBgsave(int bgsaveerr
);
585 static void freeMemoryIfNeeded(void);
586 static int processCommand(redisClient
*c
);
587 static void setupSigSegvAction(void);
588 static void rdbRemoveTempFile(pid_t childpid
);
589 static void aofRemoveTempFile(pid_t childpid
);
590 static size_t stringObjectLen(robj
*o
);
591 static void processInputBuffer(redisClient
*c
);
592 static zskiplist
*zslCreate(void);
593 static void zslFree(zskiplist
*zsl
);
594 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
595 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
596 static void initClientMultiState(redisClient
*c
);
597 static void freeClientMultiState(redisClient
*c
);
598 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
599 static void unblockClientWaitingData(redisClient
*c
);
600 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
601 static void vmInit(void);
602 static void vmMarkPagesFree(off_t page
, off_t count
);
603 static robj
*vmLoadObject(robj
*key
);
604 static robj
*vmPreviewObject(robj
*key
);
605 static int vmSwapOneObjectBlocking(void);
606 static int vmSwapOneObjectThreaded(void);
607 static int vmCanSwapOut(void);
608 static int tryFreeOneObjectFromFreelist(void);
609 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
610 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
611 static void vmCancelThreadedIOJob(robj
*o
);
612 static void lockThreadedIO(void);
613 static void unlockThreadedIO(void);
614 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
615 static void freeIOJob(iojob
*j
);
616 static void queueIOJob(iojob
*j
);
617 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
618 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
619 static void waitEmptyIOJobsQueue(void);
620 static void vmReopenSwapFile(void);
621 static int vmFreePage(off_t page
);
622 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
623 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
624 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
);
625 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
626 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
627 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
628 static struct redisCommand
*lookupCommand(char *name
);
629 static void call(redisClient
*c
, struct redisCommand
*cmd
);
630 static void resetClient(redisClient
*c
);
631 static void convertToRealHash(robj
*o
);
632 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
633 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
634 static void freePubsubPattern(void *p
);
635 static int listMatchPubsubPattern(void *a
, void *b
);
636 static int compareStringObjects(robj
*a
, robj
*b
);
637 static int equalStringObjects(robj
*a
, robj
*b
);
639 static int rewriteAppendOnlyFileBackground(void);
640 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
641 static int prepareForShutdown();
642 static void touchWatchedKey(redisDb
*db
, robj
*key
);
643 static void touchWatchedKeysOnFlush(int dbid
);
644 static void unwatchAllKeys(redisClient
*c
);
646 static void authCommand(redisClient
*c
);
647 static void pingCommand(redisClient
*c
);
648 static void echoCommand(redisClient
*c
);
649 static void setCommand(redisClient
*c
);
650 static void setnxCommand(redisClient
*c
);
651 static void setexCommand(redisClient
*c
);
652 static void getCommand(redisClient
*c
);
653 static void delCommand(redisClient
*c
);
654 static void existsCommand(redisClient
*c
);
655 static void incrCommand(redisClient
*c
);
656 static void decrCommand(redisClient
*c
);
657 static void incrbyCommand(redisClient
*c
);
658 static void decrbyCommand(redisClient
*c
);
659 static void selectCommand(redisClient
*c
);
660 static void randomkeyCommand(redisClient
*c
);
661 static void keysCommand(redisClient
*c
);
662 static void dbsizeCommand(redisClient
*c
);
663 static void lastsaveCommand(redisClient
*c
);
664 static void saveCommand(redisClient
*c
);
665 static void bgsaveCommand(redisClient
*c
);
666 static void bgrewriteaofCommand(redisClient
*c
);
667 static void shutdownCommand(redisClient
*c
);
668 static void moveCommand(redisClient
*c
);
669 static void renameCommand(redisClient
*c
);
670 static void renamenxCommand(redisClient
*c
);
671 static void lpushCommand(redisClient
*c
);
672 static void rpushCommand(redisClient
*c
);
673 static void lpopCommand(redisClient
*c
);
674 static void rpopCommand(redisClient
*c
);
675 static void llenCommand(redisClient
*c
);
676 static void lindexCommand(redisClient
*c
);
677 static void lrangeCommand(redisClient
*c
);
678 static void ltrimCommand(redisClient
*c
);
679 static void typeCommand(redisClient
*c
);
680 static void lsetCommand(redisClient
*c
);
681 static void saddCommand(redisClient
*c
);
682 static void sremCommand(redisClient
*c
);
683 static void smoveCommand(redisClient
*c
);
684 static void sismemberCommand(redisClient
*c
);
685 static void scardCommand(redisClient
*c
);
686 static void spopCommand(redisClient
*c
);
687 static void srandmemberCommand(redisClient
*c
);
688 static void sinterCommand(redisClient
*c
);
689 static void sinterstoreCommand(redisClient
*c
);
690 static void sunionCommand(redisClient
*c
);
691 static void sunionstoreCommand(redisClient
*c
);
692 static void sdiffCommand(redisClient
*c
);
693 static void sdiffstoreCommand(redisClient
*c
);
694 static void syncCommand(redisClient
*c
);
695 static void flushdbCommand(redisClient
*c
);
696 static void flushallCommand(redisClient
*c
);
697 static void sortCommand(redisClient
*c
);
698 static void lremCommand(redisClient
*c
);
699 static void rpoplpushcommand(redisClient
*c
);
700 static void infoCommand(redisClient
*c
);
701 static void mgetCommand(redisClient
*c
);
702 static void monitorCommand(redisClient
*c
);
703 static void expireCommand(redisClient
*c
);
704 static void expireatCommand(redisClient
*c
);
705 static void getsetCommand(redisClient
*c
);
706 static void ttlCommand(redisClient
*c
);
707 static void slaveofCommand(redisClient
*c
);
708 static void debugCommand(redisClient
*c
);
709 static void msetCommand(redisClient
*c
);
710 static void msetnxCommand(redisClient
*c
);
711 static void zaddCommand(redisClient
*c
);
712 static void zincrbyCommand(redisClient
*c
);
713 static void zrangeCommand(redisClient
*c
);
714 static void zrangebyscoreCommand(redisClient
*c
);
715 static void zcountCommand(redisClient
*c
);
716 static void zrevrangeCommand(redisClient
*c
);
717 static void zcardCommand(redisClient
*c
);
718 static void zremCommand(redisClient
*c
);
719 static void zscoreCommand(redisClient
*c
);
720 static void zremrangebyscoreCommand(redisClient
*c
);
721 static void multiCommand(redisClient
*c
);
722 static void execCommand(redisClient
*c
);
723 static void discardCommand(redisClient
*c
);
724 static void blpopCommand(redisClient
*c
);
725 static void brpopCommand(redisClient
*c
);
726 static void appendCommand(redisClient
*c
);
727 static void substrCommand(redisClient
*c
);
728 static void zrankCommand(redisClient
*c
);
729 static void zrevrankCommand(redisClient
*c
);
730 static void hsetCommand(redisClient
*c
);
731 static void hsetnxCommand(redisClient
*c
);
732 static void hgetCommand(redisClient
*c
);
733 static void hmsetCommand(redisClient
*c
);
734 static void hmgetCommand(redisClient
*c
);
735 static void hdelCommand(redisClient
*c
);
736 static void hlenCommand(redisClient
*c
);
737 static void zremrangebyrankCommand(redisClient
*c
);
738 static void zunionstoreCommand(redisClient
*c
);
739 static void zinterstoreCommand(redisClient
*c
);
740 static void hkeysCommand(redisClient
*c
);
741 static void hvalsCommand(redisClient
*c
);
742 static void hgetallCommand(redisClient
*c
);
743 static void hexistsCommand(redisClient
*c
);
744 static void configCommand(redisClient
*c
);
745 static void hincrbyCommand(redisClient
*c
);
746 static void subscribeCommand(redisClient
*c
);
747 static void unsubscribeCommand(redisClient
*c
);
748 static void psubscribeCommand(redisClient
*c
);
749 static void punsubscribeCommand(redisClient
*c
);
750 static void publishCommand(redisClient
*c
);
751 static void watchCommand(redisClient
*c
);
752 static void unwatchCommand(redisClient
*c
);
754 /*================================= Globals ================================= */
757 static struct redisServer server
; /* server global state */
758 static struct redisCommand
*commandTable
;
759 static struct redisCommand readonlyCommandTable
[] = {
760 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
762 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
763 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
764 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
766 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
767 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
768 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
769 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
770 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
771 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
772 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
773 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
775 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
776 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
780 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
783 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
784 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
785 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
786 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
787 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
788 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
792 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
793 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
794 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
795 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
796 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
797 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
798 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
800 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
801 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"zunionstore",zunionstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
804 {"zinterstore",zinterstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
805 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
807 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
809 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
810 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
811 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
812 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
813 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
814 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
815 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
816 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
817 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
818 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
819 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
820 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
821 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
822 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
823 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
824 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
825 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
826 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
827 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
828 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
829 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
830 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
833 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
834 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
835 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
842 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
846 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
847 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
848 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
849 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,execBlockClientOnSwappedKeys
,0,0,0},
850 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
851 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
852 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
853 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
854 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
855 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
856 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
857 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
858 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
859 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
860 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
861 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
862 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
863 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
864 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
865 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
866 {"watch",watchCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
867 {"unwatch",unwatchCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0}
870 /*============================ Utility functions ============================ */
872 /* Glob-style pattern matching. */
873 static int stringmatchlen(const char *pattern
, int patternLen
,
874 const char *string
, int stringLen
, int nocase
)
879 while (pattern
[1] == '*') {
884 return 1; /* match */
886 if (stringmatchlen(pattern
+1, patternLen
-1,
887 string
, stringLen
, nocase
))
888 return 1; /* match */
892 return 0; /* no match */
896 return 0; /* no match */
906 not = pattern
[0] == '^';
913 if (pattern
[0] == '\\') {
916 if (pattern
[0] == string
[0])
918 } else if (pattern
[0] == ']') {
920 } else if (patternLen
== 0) {
924 } else if (pattern
[1] == '-' && patternLen
>= 3) {
925 int start
= pattern
[0];
926 int end
= pattern
[2];
934 start
= tolower(start
);
940 if (c
>= start
&& c
<= end
)
944 if (pattern
[0] == string
[0])
947 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
957 return 0; /* no match */
963 if (patternLen
>= 2) {
970 if (pattern
[0] != string
[0])
971 return 0; /* no match */
973 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
974 return 0; /* no match */
982 if (stringLen
== 0) {
983 while(*pattern
== '*') {
990 if (patternLen
== 0 && stringLen
== 0)
995 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
996 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
999 /* Convert a string representing an amount of memory into the number of
1000 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1003 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1005 static long long memtoll(const char *p
, int *err
) {
1008 long mul
; /* unit multiplier */
1010 unsigned int digits
;
1013 /* Search the first non digit character. */
1016 while(*u
&& isdigit(*u
)) u
++;
1017 if (*u
== '\0' || !strcasecmp(u
,"b")) {
1019 } else if (!strcasecmp(u
,"k")) {
1021 } else if (!strcasecmp(u
,"kb")) {
1023 } else if (!strcasecmp(u
,"m")) {
1025 } else if (!strcasecmp(u
,"mb")) {
1027 } else if (!strcasecmp(u
,"g")) {
1028 mul
= 1000L*1000*1000;
1029 } else if (!strcasecmp(u
,"gb")) {
1030 mul
= 1024L*1024*1024;
1036 if (digits
>= sizeof(buf
)) {
1040 memcpy(buf
,p
,digits
);
1042 val
= strtoll(buf
,NULL
,10);
1046 /* Convert a long long into a string. Returns the number of
1047 * characters needed to represent the number, that can be shorter if passed
1048 * buffer length is not enough to store the whole number. */
1049 static int ll2string(char *s
, size_t len
, long long value
) {
1051 unsigned long long v
;
1054 if (len
== 0) return 0;
1055 v
= (value
< 0) ? -value
: value
;
1056 p
= buf
+31; /* point to the last character */
1061 if (value
< 0) *p
-- = '-';
1064 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1070 static void redisLog(int level
, const char *fmt
, ...) {
1074 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1078 if (level
>= server
.verbosity
) {
1084 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1085 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1086 vfprintf(fp
, fmt
, ap
);
1092 if (server
.logfile
) fclose(fp
);
1095 /*====================== Hash table type implementation ==================== */
1097 /* This is an hash table type that uses the SDS dynamic strings libary as
1098 * keys and radis objects as values (objects can hold SDS strings,
1101 static void dictVanillaFree(void *privdata
, void *val
)
1103 DICT_NOTUSED(privdata
);
1107 static void dictListDestructor(void *privdata
, void *val
)
1109 DICT_NOTUSED(privdata
);
1110 listRelease((list
*)val
);
1113 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1117 DICT_NOTUSED(privdata
);
1119 l1
= sdslen((sds
)key1
);
1120 l2
= sdslen((sds
)key2
);
1121 if (l1
!= l2
) return 0;
1122 return memcmp(key1
, key2
, l1
) == 0;
1125 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1127 DICT_NOTUSED(privdata
);
1129 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1133 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1136 const robj
*o1
= key1
, *o2
= key2
;
1137 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1140 static unsigned int dictObjHash(const void *key
) {
1141 const robj
*o
= key
;
1142 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1145 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1148 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1151 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1152 o2
->encoding
== REDIS_ENCODING_INT
)
1153 return o1
->ptr
== o2
->ptr
;
1155 o1
= getDecodedObject(o1
);
1156 o2
= getDecodedObject(o2
);
1157 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1163 static unsigned int dictEncObjHash(const void *key
) {
1164 robj
*o
= (robj
*) key
;
1166 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1167 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1169 if (o
->encoding
== REDIS_ENCODING_INT
) {
1173 len
= ll2string(buf
,32,(long)o
->ptr
);
1174 return dictGenHashFunction((unsigned char*)buf
, len
);
1178 o
= getDecodedObject(o
);
1179 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1186 /* Sets type and expires */
1187 static dictType setDictType
= {
1188 dictEncObjHash
, /* hash function */
1191 dictEncObjKeyCompare
, /* key compare */
1192 dictRedisObjectDestructor
, /* key destructor */
1193 NULL
/* val destructor */
1196 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1197 static dictType zsetDictType
= {
1198 dictEncObjHash
, /* hash function */
1201 dictEncObjKeyCompare
, /* key compare */
1202 dictRedisObjectDestructor
, /* key destructor */
1203 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1207 static dictType dbDictType
= {
1208 dictObjHash
, /* hash function */
1211 dictObjKeyCompare
, /* key compare */
1212 dictRedisObjectDestructor
, /* key destructor */
1213 dictRedisObjectDestructor
/* val destructor */
1217 static dictType keyptrDictType
= {
1218 dictObjHash
, /* hash function */
1221 dictObjKeyCompare
, /* key compare */
1222 dictRedisObjectDestructor
, /* key destructor */
1223 NULL
/* val destructor */
1226 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1227 static dictType hashDictType
= {
1228 dictEncObjHash
, /* hash function */
1231 dictEncObjKeyCompare
, /* key compare */
1232 dictRedisObjectDestructor
, /* key destructor */
1233 dictRedisObjectDestructor
/* val destructor */
1236 /* Keylist hash table type has unencoded redis objects as keys and
1237 * lists as values. It's used for blocking operations (BLPOP) and to
1238 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1239 static dictType keylistDictType
= {
1240 dictObjHash
, /* hash function */
1243 dictObjKeyCompare
, /* key compare */
1244 dictRedisObjectDestructor
, /* key destructor */
1245 dictListDestructor
/* val destructor */
1248 static void version();
1250 /* ========================= Random utility functions ======================= */
1252 /* Redis generally does not try to recover from out of memory conditions
1253 * when allocating objects or strings, it is not clear if it will be possible
1254 * to report this condition to the client since the networking layer itself
1255 * is based on heap allocation for send buffers, so we simply abort.
1256 * At least the code will be simpler to read... */
1257 static void oom(const char *msg
) {
1258 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1263 /* ====================== Redis server networking stuff ===================== */
1264 static void closeTimedoutClients(void) {
1267 time_t now
= time(NULL
);
1270 listRewind(server
.clients
,&li
);
1271 while ((ln
= listNext(&li
)) != NULL
) {
1272 c
= listNodeValue(ln
);
1273 if (server
.maxidletime
&&
1274 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1275 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1276 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1277 listLength(c
->pubsub_patterns
) == 0 &&
1278 (now
- c
->lastinteraction
> server
.maxidletime
))
1280 redisLog(REDIS_VERBOSE
,"Closing idle client");
1282 } else if (c
->flags
& REDIS_BLOCKED
) {
1283 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1284 addReply(c
,shared
.nullmultibulk
);
1285 unblockClientWaitingData(c
);
1291 static int htNeedsResize(dict
*dict
) {
1292 long long size
, used
;
1294 size
= dictSlots(dict
);
1295 used
= dictSize(dict
);
1296 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1297 (used
*100/size
< REDIS_HT_MINFILL
));
1300 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1301 * we resize the hash table to save memory */
1302 static void tryResizeHashTables(void) {
1305 for (j
= 0; j
< server
.dbnum
; j
++) {
1306 if (htNeedsResize(server
.db
[j
].dict
))
1307 dictResize(server
.db
[j
].dict
);
1308 if (htNeedsResize(server
.db
[j
].expires
))
1309 dictResize(server
.db
[j
].expires
);
1313 /* Our hash table implementation performs rehashing incrementally while
1314 * we write/read from the hash table. Still if the server is idle, the hash
1315 * table will use two tables for a long time. So we try to use 1 millisecond
1316 * of CPU time at every serverCron() loop in order to rehash some key. */
1317 static void incrementallyRehash(void) {
1320 for (j
= 0; j
< server
.dbnum
; j
++) {
1321 if (dictIsRehashing(server
.db
[j
].dict
)) {
1322 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1323 break; /* already used our millisecond for this loop... */
1328 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1329 void backgroundSaveDoneHandler(int statloc
) {
1330 int exitcode
= WEXITSTATUS(statloc
);
1331 int bysignal
= WIFSIGNALED(statloc
);
1333 if (!bysignal
&& exitcode
== 0) {
1334 redisLog(REDIS_NOTICE
,
1335 "Background saving terminated with success");
1337 server
.lastsave
= time(NULL
);
1338 } else if (!bysignal
&& exitcode
!= 0) {
1339 redisLog(REDIS_WARNING
, "Background saving error");
1341 redisLog(REDIS_WARNING
,
1342 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1343 rdbRemoveTempFile(server
.bgsavechildpid
);
1345 server
.bgsavechildpid
= -1;
1346 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1347 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1348 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1351 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1353 void backgroundRewriteDoneHandler(int statloc
) {
1354 int exitcode
= WEXITSTATUS(statloc
);
1355 int bysignal
= WIFSIGNALED(statloc
);
1357 if (!bysignal
&& exitcode
== 0) {
1361 redisLog(REDIS_NOTICE
,
1362 "Background append only file rewriting terminated with success");
1363 /* Now it's time to flush the differences accumulated by the parent */
1364 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1365 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1367 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1370 /* Flush our data... */
1371 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1372 (signed) sdslen(server
.bgrewritebuf
)) {
1373 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
));
1377 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1378 /* Now our work is to rename the temp file into the stable file. And
1379 * switch the file descriptor used by the server for append only. */
1380 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1381 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1385 /* Mission completed... almost */
1386 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1387 if (server
.appendfd
!= -1) {
1388 /* If append only is actually enabled... */
1389 close(server
.appendfd
);
1390 server
.appendfd
= fd
;
1392 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1393 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1395 /* If append only is disabled we just generate a dump in this
1396 * format. Why not? */
1399 } else if (!bysignal
&& exitcode
!= 0) {
1400 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1402 redisLog(REDIS_WARNING
,
1403 "Background append only file rewriting terminated by signal %d",
1407 sdsfree(server
.bgrewritebuf
);
1408 server
.bgrewritebuf
= sdsempty();
1409 aofRemoveTempFile(server
.bgrewritechildpid
);
1410 server
.bgrewritechildpid
= -1;
1413 /* This function is called once a background process of some kind terminates,
1414 * as we want to avoid resizing the hash tables when there is a child in order
1415 * to play well with copy-on-write (otherwise when a resize happens lots of
1416 * memory pages are copied). The goal of this function is to update the ability
1417 * for dict.c to resize the hash tables accordingly to the fact we have o not
1418 * running childs. */
1419 static void updateDictResizePolicy(void) {
1420 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1423 dictDisableResize();
1426 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1427 int j
, loops
= server
.cronloops
++;
1428 REDIS_NOTUSED(eventLoop
);
1430 REDIS_NOTUSED(clientData
);
1432 /* We take a cached value of the unix time in the global state because
1433 * with virtual memory and aging there is to store the current time
1434 * in objects at every object access, and accuracy is not needed.
1435 * To access a global var is faster than calling time(NULL) */
1436 server
.unixtime
= time(NULL
);
1438 /* We received a SIGTERM, shutting down here in a safe way, as it is
1439 * not ok doing so inside the signal handler. */
1440 if (server
.shutdown_asap
) {
1441 if (prepareForShutdown() == REDIS_OK
) exit(0);
1442 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1445 /* Show some info about non-empty databases */
1446 for (j
= 0; j
< server
.dbnum
; j
++) {
1447 long long size
, used
, vkeys
;
1449 size
= dictSlots(server
.db
[j
].dict
);
1450 used
= dictSize(server
.db
[j
].dict
);
1451 vkeys
= dictSize(server
.db
[j
].expires
);
1452 if (!(loops
% 50) && (used
|| vkeys
)) {
1453 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1454 /* dictPrintStats(server.dict); */
1458 /* We don't want to resize the hash tables while a bacground saving
1459 * is in progress: the saving child is created using fork() that is
1460 * implemented with a copy-on-write semantic in most modern systems, so
1461 * if we resize the HT while there is the saving child at work actually
1462 * a lot of memory movements in the parent will cause a lot of pages
1464 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1465 if (!(loops
% 10)) tryResizeHashTables();
1466 if (server
.activerehashing
) incrementallyRehash();
1469 /* Show information about connected clients */
1470 if (!(loops
% 50)) {
1471 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1472 listLength(server
.clients
)-listLength(server
.slaves
),
1473 listLength(server
.slaves
),
1474 zmalloc_used_memory());
1477 /* Close connections of timedout clients */
1478 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1479 closeTimedoutClients();
1481 /* Check if a background saving or AOF rewrite in progress terminated */
1482 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1486 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1487 if (pid
== server
.bgsavechildpid
) {
1488 backgroundSaveDoneHandler(statloc
);
1490 backgroundRewriteDoneHandler(statloc
);
1492 updateDictResizePolicy();
1495 /* If there is not a background saving in progress check if
1496 * we have to save now */
1497 time_t now
= time(NULL
);
1498 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1499 struct saveparam
*sp
= server
.saveparams
+j
;
1501 if (server
.dirty
>= sp
->changes
&&
1502 now
-server
.lastsave
> sp
->seconds
) {
1503 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1504 sp
->changes
, sp
->seconds
);
1505 rdbSaveBackground(server
.dbfilename
);
1511 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1512 * will use few CPU cycles if there are few expiring keys, otherwise
1513 * it will get more aggressive to avoid that too much memory is used by
1514 * keys that can be removed from the keyspace. */
1515 for (j
= 0; j
< server
.dbnum
; j
++) {
1517 redisDb
*db
= server
.db
+j
;
1519 /* Continue to expire if at the end of the cycle more than 25%
1520 * of the keys were expired. */
1522 long num
= dictSize(db
->expires
);
1523 time_t now
= time(NULL
);
1526 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1527 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1532 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1533 t
= (time_t) dictGetEntryVal(de
);
1535 deleteKey(db
,dictGetEntryKey(de
));
1537 server
.stat_expiredkeys
++;
1540 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1543 /* Swap a few keys on disk if we are over the memory limit and VM
1544 * is enbled. Try to free objects from the free list first. */
1545 if (vmCanSwapOut()) {
1546 while (server
.vm_enabled
&& zmalloc_used_memory() >
1547 server
.vm_max_memory
)
1551 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1552 retval
= (server
.vm_max_threads
== 0) ?
1553 vmSwapOneObjectBlocking() :
1554 vmSwapOneObjectThreaded();
1555 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1556 zmalloc_used_memory() >
1557 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1559 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1561 /* Note that when using threade I/O we free just one object,
1562 * because anyway when the I/O thread in charge to swap this
1563 * object out will finish, the handler of completed jobs
1564 * will try to swap more objects if we are still out of memory. */
1565 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1569 /* Check if we should connect to a MASTER */
1570 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1571 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1572 if (syncWithMaster() == REDIS_OK
) {
1573 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1574 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1580 /* This function gets called every time Redis is entering the
1581 * main loop of the event driven library, that is, before to sleep
1582 * for ready file descriptors. */
1583 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1584 REDIS_NOTUSED(eventLoop
);
1586 /* Awake clients that got all the swapped keys they requested */
1587 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1591 listRewind(server
.io_ready_clients
,&li
);
1592 while((ln
= listNext(&li
))) {
1593 redisClient
*c
= ln
->value
;
1594 struct redisCommand
*cmd
;
1596 /* Resume the client. */
1597 listDelNode(server
.io_ready_clients
,ln
);
1598 c
->flags
&= (~REDIS_IO_WAIT
);
1599 server
.vm_blocked_clients
--;
1600 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1601 readQueryFromClient
, c
);
1602 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1603 assert(cmd
!= NULL
);
1606 /* There may be more data to process in the input buffer. */
1607 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1608 processInputBuffer(c
);
1611 /* Write the AOF buffer on disk */
1612 flushAppendOnlyFile();
1615 static void createSharedObjects(void) {
1618 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1619 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1620 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1621 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1622 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1623 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1624 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1625 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1626 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1627 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1628 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1629 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1630 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1631 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1632 "-ERR no such key\r\n"));
1633 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1634 "-ERR syntax error\r\n"));
1635 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1636 "-ERR source and destination objects are the same\r\n"));
1637 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1638 "-ERR index out of range\r\n"));
1639 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1640 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1641 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1642 shared
.select0
= createStringObject("select 0\r\n",10);
1643 shared
.select1
= createStringObject("select 1\r\n",10);
1644 shared
.select2
= createStringObject("select 2\r\n",10);
1645 shared
.select3
= createStringObject("select 3\r\n",10);
1646 shared
.select4
= createStringObject("select 4\r\n",10);
1647 shared
.select5
= createStringObject("select 5\r\n",10);
1648 shared
.select6
= createStringObject("select 6\r\n",10);
1649 shared
.select7
= createStringObject("select 7\r\n",10);
1650 shared
.select8
= createStringObject("select 8\r\n",10);
1651 shared
.select9
= createStringObject("select 9\r\n",10);
1652 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1653 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1654 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1655 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1656 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1657 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1658 shared
.mbulk3
= createStringObject("*3\r\n",4);
1659 shared
.mbulk4
= createStringObject("*4\r\n",4);
1660 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1661 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1662 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1666 static void appendServerSaveParams(time_t seconds
, int changes
) {
1667 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1668 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1669 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1670 server
.saveparamslen
++;
1673 static void resetServerSaveParams() {
1674 zfree(server
.saveparams
);
1675 server
.saveparams
= NULL
;
1676 server
.saveparamslen
= 0;
1679 static void initServerConfig() {
1680 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1681 server
.port
= REDIS_SERVERPORT
;
1682 server
.verbosity
= REDIS_VERBOSE
;
1683 server
.maxidletime
= REDIS_MAXIDLETIME
;
1684 server
.saveparams
= NULL
;
1685 server
.logfile
= NULL
; /* NULL = log on standard output */
1686 server
.bindaddr
= NULL
;
1687 server
.glueoutputbuf
= 1;
1688 server
.daemonize
= 0;
1689 server
.appendonly
= 0;
1690 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1691 server
.lastfsync
= time(NULL
);
1692 server
.appendfd
= -1;
1693 server
.appendseldb
= -1; /* Make sure the first time will not match */
1694 server
.pidfile
= zstrdup("/var/run/redis.pid");
1695 server
.dbfilename
= zstrdup("dump.rdb");
1696 server
.appendfilename
= zstrdup("appendonly.aof");
1697 server
.requirepass
= NULL
;
1698 server
.rdbcompression
= 1;
1699 server
.activerehashing
= 1;
1700 server
.maxclients
= 0;
1701 server
.blpop_blocked_clients
= 0;
1702 server
.maxmemory
= 0;
1703 server
.vm_enabled
= 0;
1704 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1705 server
.vm_page_size
= 256; /* 256 bytes per page */
1706 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1707 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1708 server
.vm_max_threads
= 4;
1709 server
.vm_blocked_clients
= 0;
1710 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1711 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1712 server
.shutdown_asap
= 0;
1714 resetServerSaveParams();
1716 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1717 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1718 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1719 /* Replication related */
1721 server
.masterauth
= NULL
;
1722 server
.masterhost
= NULL
;
1723 server
.masterport
= 6379;
1724 server
.master
= NULL
;
1725 server
.replstate
= REDIS_REPL_NONE
;
1727 /* Double constants initialization */
1729 R_PosInf
= 1.0/R_Zero
;
1730 R_NegInf
= -1.0/R_Zero
;
1731 R_Nan
= R_Zero
/R_Zero
;
1734 static void initServer() {
1737 signal(SIGHUP
, SIG_IGN
);
1738 signal(SIGPIPE
, SIG_IGN
);
1739 setupSigSegvAction();
1741 server
.devnull
= fopen("/dev/null","w");
1742 if (server
.devnull
== NULL
) {
1743 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1746 server
.clients
= listCreate();
1747 server
.slaves
= listCreate();
1748 server
.monitors
= listCreate();
1749 server
.objfreelist
= listCreate();
1750 createSharedObjects();
1751 server
.el
= aeCreateEventLoop();
1752 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1753 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1754 if (server
.fd
== -1) {
1755 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1758 for (j
= 0; j
< server
.dbnum
; j
++) {
1759 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1760 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1761 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1762 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1763 if (server
.vm_enabled
)
1764 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1765 server
.db
[j
].id
= j
;
1767 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1768 server
.pubsub_patterns
= listCreate();
1769 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1770 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1771 server
.cronloops
= 0;
1772 server
.bgsavechildpid
= -1;
1773 server
.bgrewritechildpid
= -1;
1774 server
.bgrewritebuf
= sdsempty();
1775 server
.aofbuf
= sdsempty();
1776 server
.lastsave
= time(NULL
);
1778 server
.stat_numcommands
= 0;
1779 server
.stat_numconnections
= 0;
1780 server
.stat_expiredkeys
= 0;
1781 server
.stat_starttime
= time(NULL
);
1782 server
.unixtime
= time(NULL
);
1783 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1784 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1785 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1787 if (server
.appendonly
) {
1788 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1789 if (server
.appendfd
== -1) {
1790 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1796 if (server
.vm_enabled
) vmInit();
1799 /* Empty the whole database */
1800 static long long emptyDb() {
1802 long long removed
= 0;
1804 for (j
= 0; j
< server
.dbnum
; j
++) {
1805 removed
+= dictSize(server
.db
[j
].dict
);
1806 dictEmpty(server
.db
[j
].dict
);
1807 dictEmpty(server
.db
[j
].expires
);
1812 static int yesnotoi(char *s
) {
1813 if (!strcasecmp(s
,"yes")) return 1;
1814 else if (!strcasecmp(s
,"no")) return 0;
1818 /* I agree, this is a very rudimental way to load a configuration...
1819 will improve later if the config gets more complex */
1820 static void loadServerConfig(char *filename
) {
1822 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1826 if (filename
[0] == '-' && filename
[1] == '\0')
1829 if ((fp
= fopen(filename
,"r")) == NULL
) {
1830 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1835 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1841 line
= sdstrim(line
," \t\r\n");
1843 /* Skip comments and blank lines*/
1844 if (line
[0] == '#' || line
[0] == '\0') {
1849 /* Split into arguments */
1850 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1851 sdstolower(argv
[0]);
1853 /* Execute config directives */
1854 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1855 server
.maxidletime
= atoi(argv
[1]);
1856 if (server
.maxidletime
< 0) {
1857 err
= "Invalid timeout value"; goto loaderr
;
1859 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1860 server
.port
= atoi(argv
[1]);
1861 if (server
.port
< 1 || server
.port
> 65535) {
1862 err
= "Invalid port"; goto loaderr
;
1864 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1865 server
.bindaddr
= zstrdup(argv
[1]);
1866 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1867 int seconds
= atoi(argv
[1]);
1868 int changes
= atoi(argv
[2]);
1869 if (seconds
< 1 || changes
< 0) {
1870 err
= "Invalid save parameters"; goto loaderr
;
1872 appendServerSaveParams(seconds
,changes
);
1873 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1874 if (chdir(argv
[1]) == -1) {
1875 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1876 argv
[1], strerror(errno
));
1879 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1880 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1881 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1882 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1883 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1885 err
= "Invalid log level. Must be one of debug, notice, warning";
1888 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1891 server
.logfile
= zstrdup(argv
[1]);
1892 if (!strcasecmp(server
.logfile
,"stdout")) {
1893 zfree(server
.logfile
);
1894 server
.logfile
= NULL
;
1896 if (server
.logfile
) {
1897 /* Test if we are able to open the file. The server will not
1898 * be able to abort just for this problem later... */
1899 logfp
= fopen(server
.logfile
,"a");
1900 if (logfp
== NULL
) {
1901 err
= sdscatprintf(sdsempty(),
1902 "Can't open the log file: %s", strerror(errno
));
1907 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1908 server
.dbnum
= atoi(argv
[1]);
1909 if (server
.dbnum
< 1) {
1910 err
= "Invalid number of databases"; goto loaderr
;
1912 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1913 loadServerConfig(argv
[1]);
1914 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1915 server
.maxclients
= atoi(argv
[1]);
1916 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1917 server
.maxmemory
= memtoll(argv
[1],NULL
);
1918 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1919 server
.masterhost
= sdsnew(argv
[1]);
1920 server
.masterport
= atoi(argv
[2]);
1921 server
.replstate
= REDIS_REPL_CONNECT
;
1922 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1923 server
.masterauth
= zstrdup(argv
[1]);
1924 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1925 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1926 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1928 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1929 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1930 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1932 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1933 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1934 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1936 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1937 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1938 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1940 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1941 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1942 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1944 } else if (!strcasecmp(argv
[0],"appendfilename") && argc
== 2) {
1945 zfree(server
.appendfilename
);
1946 server
.appendfilename
= zstrdup(argv
[1]);
1947 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1948 if (!strcasecmp(argv
[1],"no")) {
1949 server
.appendfsync
= APPENDFSYNC_NO
;
1950 } else if (!strcasecmp(argv
[1],"always")) {
1951 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1952 } else if (!strcasecmp(argv
[1],"everysec")) {
1953 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1955 err
= "argument must be 'no', 'always' or 'everysec'";
1958 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1959 server
.requirepass
= zstrdup(argv
[1]);
1960 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1961 zfree(server
.pidfile
);
1962 server
.pidfile
= zstrdup(argv
[1]);
1963 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1964 zfree(server
.dbfilename
);
1965 server
.dbfilename
= zstrdup(argv
[1]);
1966 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1967 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1968 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1970 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1971 zfree(server
.vm_swap_file
);
1972 server
.vm_swap_file
= zstrdup(argv
[1]);
1973 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1974 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1975 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1976 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1977 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1978 server
.vm_pages
= memtoll(argv
[1], NULL
);
1979 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1980 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1981 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1982 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1983 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1984 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1986 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1988 for (j
= 0; j
< argc
; j
++)
1993 if (fp
!= stdin
) fclose(fp
);
1997 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1998 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1999 fprintf(stderr
, ">>> '%s'\n", line
);
2000 fprintf(stderr
, "%s\n", err
);
2004 static void freeClientArgv(redisClient
*c
) {
2007 for (j
= 0; j
< c
->argc
; j
++)
2008 decrRefCount(c
->argv
[j
]);
2009 for (j
= 0; j
< c
->mbargc
; j
++)
2010 decrRefCount(c
->mbargv
[j
]);
2015 static void freeClient(redisClient
*c
) {
2018 /* Note that if the client we are freeing is blocked into a blocking
2019 * call, we have to set querybuf to NULL *before* to call
2020 * unblockClientWaitingData() to avoid processInputBuffer() will get
2021 * called. Also it is important to remove the file events after
2022 * this, because this call adds the READABLE event. */
2023 sdsfree(c
->querybuf
);
2025 if (c
->flags
& REDIS_BLOCKED
)
2026 unblockClientWaitingData(c
);
2028 /* UNWATCH all the keys */
2030 listRelease(c
->watched_keys
);
2031 /* Unsubscribe from all the pubsub channels */
2032 pubsubUnsubscribeAllChannels(c
,0);
2033 pubsubUnsubscribeAllPatterns(c
,0);
2034 dictRelease(c
->pubsub_channels
);
2035 listRelease(c
->pubsub_patterns
);
2036 /* Obvious cleanup */
2037 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2038 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2039 listRelease(c
->reply
);
2042 /* Remove from the list of clients */
2043 ln
= listSearchKey(server
.clients
,c
);
2044 redisAssert(ln
!= NULL
);
2045 listDelNode(server
.clients
,ln
);
2046 /* Remove from the list of clients that are now ready to be restarted
2047 * after waiting for swapped keys */
2048 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2049 ln
= listSearchKey(server
.io_ready_clients
,c
);
2051 listDelNode(server
.io_ready_clients
,ln
);
2052 server
.vm_blocked_clients
--;
2055 /* Remove from the list of clients waiting for swapped keys */
2056 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2057 ln
= listFirst(c
->io_keys
);
2058 dontWaitForSwappedKey(c
,ln
->value
);
2060 listRelease(c
->io_keys
);
2061 /* Master/slave cleanup */
2062 if (c
->flags
& REDIS_SLAVE
) {
2063 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2065 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2066 ln
= listSearchKey(l
,c
);
2067 redisAssert(ln
!= NULL
);
2070 if (c
->flags
& REDIS_MASTER
) {
2071 server
.master
= NULL
;
2072 server
.replstate
= REDIS_REPL_CONNECT
;
2074 /* Release memory */
2077 freeClientMultiState(c
);
2081 #define GLUEREPLY_UP_TO (1024)
2082 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2084 char buf
[GLUEREPLY_UP_TO
];
2089 listRewind(c
->reply
,&li
);
2090 while((ln
= listNext(&li
))) {
2094 objlen
= sdslen(o
->ptr
);
2095 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2096 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2098 listDelNode(c
->reply
,ln
);
2100 if (copylen
== 0) return;
2104 /* Now the output buffer is empty, add the new single element */
2105 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2106 listAddNodeHead(c
->reply
,o
);
2109 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2110 redisClient
*c
= privdata
;
2111 int nwritten
= 0, totwritten
= 0, objlen
;
2114 REDIS_NOTUSED(mask
);
2116 /* Use writev() if we have enough buffers to send */
2117 if (!server
.glueoutputbuf
&&
2118 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2119 !(c
->flags
& REDIS_MASTER
))
2121 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2125 while(listLength(c
->reply
)) {
2126 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2127 glueReplyBuffersIfNeeded(c
);
2129 o
= listNodeValue(listFirst(c
->reply
));
2130 objlen
= sdslen(o
->ptr
);
2133 listDelNode(c
->reply
,listFirst(c
->reply
));
2137 if (c
->flags
& REDIS_MASTER
) {
2138 /* Don't reply to a master */
2139 nwritten
= objlen
- c
->sentlen
;
2141 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2142 if (nwritten
<= 0) break;
2144 c
->sentlen
+= nwritten
;
2145 totwritten
+= nwritten
;
2146 /* If we fully sent the object on head go to the next one */
2147 if (c
->sentlen
== objlen
) {
2148 listDelNode(c
->reply
,listFirst(c
->reply
));
2151 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2152 * bytes, in a single threaded server it's a good idea to serve
2153 * other clients as well, even if a very large request comes from
2154 * super fast link that is always able to accept data (in real world
2155 * scenario think about 'KEYS *' against the loopback interfae) */
2156 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2158 if (nwritten
== -1) {
2159 if (errno
== EAGAIN
) {
2162 redisLog(REDIS_VERBOSE
,
2163 "Error writing to client: %s", strerror(errno
));
2168 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2169 if (listLength(c
->reply
) == 0) {
2171 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2175 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2177 redisClient
*c
= privdata
;
2178 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2180 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2181 int offset
, ion
= 0;
2183 REDIS_NOTUSED(mask
);
2186 while (listLength(c
->reply
)) {
2187 offset
= c
->sentlen
;
2191 /* fill-in the iov[] array */
2192 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2193 o
= listNodeValue(node
);
2194 objlen
= sdslen(o
->ptr
);
2196 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2199 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2200 break; /* no more iovecs */
2202 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2203 iov
[ion
].iov_len
= objlen
- offset
;
2204 willwrite
+= objlen
- offset
;
2205 offset
= 0; /* just for the first item */
2212 /* write all collected blocks at once */
2213 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2214 if (errno
!= EAGAIN
) {
2215 redisLog(REDIS_VERBOSE
,
2216 "Error writing to client: %s", strerror(errno
));
2223 totwritten
+= nwritten
;
2224 offset
= c
->sentlen
;
2226 /* remove written robjs from c->reply */
2227 while (nwritten
&& listLength(c
->reply
)) {
2228 o
= listNodeValue(listFirst(c
->reply
));
2229 objlen
= sdslen(o
->ptr
);
2231 if(nwritten
>= objlen
- offset
) {
2232 listDelNode(c
->reply
, listFirst(c
->reply
));
2233 nwritten
-= objlen
- offset
;
2237 c
->sentlen
+= nwritten
;
2245 c
->lastinteraction
= time(NULL
);
2247 if (listLength(c
->reply
) == 0) {
2249 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2253 static int qsortRedisCommands(const void *r1
, const void *r2
) {
2255 ((struct redisCommand
*)r1
)->name
,
2256 ((struct redisCommand
*)r2
)->name
);
2259 static void sortCommandTable() {
2260 /* Copy and sort the read-only version of the command table */
2261 commandTable
= (struct redisCommand
*)malloc(sizeof(readonlyCommandTable
));
2262 memcpy(commandTable
,readonlyCommandTable
,sizeof(readonlyCommandTable
));
2264 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2265 sizeof(struct redisCommand
),qsortRedisCommands
);
2268 static struct redisCommand
*lookupCommand(char *name
) {
2269 struct redisCommand tmp
= {name
,NULL
,0,0,NULL
,0,0,0};
2273 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2274 sizeof(struct redisCommand
),
2275 qsortRedisCommands
);
2278 /* resetClient prepare the client to process the next command */
2279 static void resetClient(redisClient
*c
) {
2285 /* Call() is the core of Redis execution of a command */
2286 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2289 dirty
= server
.dirty
;
2291 dirty
= server
.dirty
-dirty
;
2293 if (server
.appendonly
&& dirty
)
2294 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2295 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2296 listLength(server
.slaves
))
2297 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2298 if (listLength(server
.monitors
))
2299 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2300 server
.stat_numcommands
++;
2303 /* If this function gets called we already read a whole
2304 * command, argments are in the client argv/argc fields.
2305 * processCommand() execute the command or prepare the
2306 * server for a bulk read from the client.
2308 * If 1 is returned the client is still alive and valid and
2309 * and other operations can be performed by the caller. Otherwise
2310 * if 0 is returned the client was destroied (i.e. after QUIT). */
2311 static int processCommand(redisClient
*c
) {
2312 struct redisCommand
*cmd
;
2314 /* Free some memory if needed (maxmemory setting) */
2315 if (server
.maxmemory
) freeMemoryIfNeeded();
2317 /* Handle the multi bulk command type. This is an alternative protocol
2318 * supported by Redis in order to receive commands that are composed of
2319 * multiple binary-safe "bulk" arguments. The latency of processing is
2320 * a bit higher but this allows things like multi-sets, so if this
2321 * protocol is used only for MSET and similar commands this is a big win. */
2322 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2323 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2324 if (c
->multibulk
<= 0) {
2328 decrRefCount(c
->argv
[c
->argc
-1]);
2332 } else if (c
->multibulk
) {
2333 if (c
->bulklen
== -1) {
2334 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2335 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2339 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2340 decrRefCount(c
->argv
[0]);
2341 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2343 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2348 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2352 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2353 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2357 if (c
->multibulk
== 0) {
2361 /* Here we need to swap the multi-bulk argc/argv with the
2362 * normal argc/argv of the client structure. */
2364 c
->argv
= c
->mbargv
;
2365 c
->mbargv
= auxargv
;
2368 c
->argc
= c
->mbargc
;
2369 c
->mbargc
= auxargc
;
2371 /* We need to set bulklen to something different than -1
2372 * in order for the code below to process the command without
2373 * to try to read the last argument of a bulk command as
2374 * a special argument. */
2376 /* continue below and process the command */
2383 /* -- end of multi bulk commands processing -- */
2385 /* The QUIT command is handled as a special case. Normal command
2386 * procs are unable to close the client connection safely */
2387 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2392 /* Now lookup the command and check ASAP about trivial error conditions
2393 * such wrong arity, bad command name and so forth. */
2394 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2397 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2398 (char*)c
->argv
[0]->ptr
));
2401 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2402 (c
->argc
< -cmd
->arity
)) {
2404 sdscatprintf(sdsempty(),
2405 "-ERR wrong number of arguments for '%s' command\r\n",
2409 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2410 /* This is a bulk command, we have to read the last argument yet. */
2411 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2413 decrRefCount(c
->argv
[c
->argc
-1]);
2414 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2416 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2421 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2422 /* It is possible that the bulk read is already in the
2423 * buffer. Check this condition and handle it accordingly.
2424 * This is just a fast path, alternative to call processInputBuffer().
2425 * It's a good idea since the code is small and this condition
2426 * happens most of the times. */
2427 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2428 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2430 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2432 /* Otherwise return... there is to read the last argument
2433 * from the socket. */
2437 /* Let's try to encode the bulk object to save space. */
2438 if (cmd
->flags
& REDIS_CMD_BULK
)
2439 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2441 /* Check if the user is authenticated */
2442 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2443 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2448 /* Handle the maxmemory directive */
2449 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2450 zmalloc_used_memory() > server
.maxmemory
)
2452 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2457 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2458 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2460 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2461 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2462 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2467 /* Exec the command */
2468 if (c
->flags
& REDIS_MULTI
&&
2469 cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
&&
2470 cmd
->proc
!= multiCommand
&& cmd
->proc
!= watchCommand
)
2472 queueMultiCommand(c
,cmd
);
2473 addReply(c
,shared
.queued
);
2475 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2476 blockClientOnSwappedKeys(c
,cmd
)) return 1;
2480 /* Prepare the client for the next command */
2485 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2490 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2491 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2492 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2493 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2496 if (argc
<= REDIS_STATIC_ARGS
) {
2499 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2502 lenobj
= createObject(REDIS_STRING
,
2503 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2504 lenobj
->refcount
= 0;
2505 outv
[outc
++] = lenobj
;
2506 for (j
= 0; j
< argc
; j
++) {
2507 lenobj
= createObject(REDIS_STRING
,
2508 sdscatprintf(sdsempty(),"$%lu\r\n",
2509 (unsigned long) stringObjectLen(argv
[j
])));
2510 lenobj
->refcount
= 0;
2511 outv
[outc
++] = lenobj
;
2512 outv
[outc
++] = argv
[j
];
2513 outv
[outc
++] = shared
.crlf
;
2516 /* Increment all the refcounts at start and decrement at end in order to
2517 * be sure to free objects if there is no slave in a replication state
2518 * able to be feed with commands */
2519 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2520 listRewind(slaves
,&li
);
2521 while((ln
= listNext(&li
))) {
2522 redisClient
*slave
= ln
->value
;
2524 /* Don't feed slaves that are still waiting for BGSAVE to start */
2525 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2527 /* Feed all the other slaves, MONITORs and so on */
2528 if (slave
->slaveseldb
!= dictid
) {
2532 case 0: selectcmd
= shared
.select0
; break;
2533 case 1: selectcmd
= shared
.select1
; break;
2534 case 2: selectcmd
= shared
.select2
; break;
2535 case 3: selectcmd
= shared
.select3
; break;
2536 case 4: selectcmd
= shared
.select4
; break;
2537 case 5: selectcmd
= shared
.select5
; break;
2538 case 6: selectcmd
= shared
.select6
; break;
2539 case 7: selectcmd
= shared
.select7
; break;
2540 case 8: selectcmd
= shared
.select8
; break;
2541 case 9: selectcmd
= shared
.select9
; break;
2543 selectcmd
= createObject(REDIS_STRING
,
2544 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2545 selectcmd
->refcount
= 0;
2548 addReply(slave
,selectcmd
);
2549 slave
->slaveseldb
= dictid
;
2551 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2553 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2554 if (outv
!= static_outv
) zfree(outv
);
2557 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2558 s
= sdscatlen(s
,"\"",1);
2563 s
= sdscatprintf(s
,"\\%c",*p
);
2565 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2566 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2567 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2568 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2569 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2572 s
= sdscatprintf(s
,"%c",*p
);
2574 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2579 return sdscatlen(s
,"\"",1);
2582 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2586 sds cmdrepr
= sdsnew("+");
2590 gettimeofday(&tv
,NULL
);
2591 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2592 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2594 for (j
= 0; j
< argc
; j
++) {
2595 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2596 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2598 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2599 sdslen(argv
[j
]->ptr
));
2602 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2604 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2605 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2607 listRewind(monitors
,&li
);
2608 while((ln
= listNext(&li
))) {
2609 redisClient
*monitor
= ln
->value
;
2610 addReply(monitor
,cmdobj
);
2612 decrRefCount(cmdobj
);
2615 static void processInputBuffer(redisClient
*c
) {
2617 /* Before to process the input buffer, make sure the client is not
2618 * waitig for a blocking operation such as BLPOP. Note that the first
2619 * iteration the client is never blocked, otherwise the processInputBuffer
2620 * would not be called at all, but after the execution of the first commands
2621 * in the input buffer the client may be blocked, and the "goto again"
2622 * will try to reiterate. The following line will make it return asap. */
2623 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2624 if (c
->bulklen
== -1) {
2625 /* Read the first line of the query */
2626 char *p
= strchr(c
->querybuf
,'\n');
2633 query
= c
->querybuf
;
2634 c
->querybuf
= sdsempty();
2635 querylen
= 1+(p
-(query
));
2636 if (sdslen(query
) > querylen
) {
2637 /* leave data after the first line of the query in the buffer */
2638 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2640 *p
= '\0'; /* remove "\n" */
2641 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2642 sdsupdatelen(query
);
2644 /* Now we can split the query in arguments */
2645 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2648 if (c
->argv
) zfree(c
->argv
);
2649 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2651 for (j
= 0; j
< argc
; j
++) {
2652 if (sdslen(argv
[j
])) {
2653 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2661 /* Execute the command. If the client is still valid
2662 * after processCommand() return and there is something
2663 * on the query buffer try to process the next command. */
2664 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2666 /* Nothing to process, argc == 0. Just process the query
2667 * buffer if it's not empty or return to the caller */
2668 if (sdslen(c
->querybuf
)) goto again
;
2671 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2672 redisLog(REDIS_VERBOSE
, "Client protocol error");
2677 /* Bulk read handling. Note that if we are at this point
2678 the client already sent a command terminated with a newline,
2679 we are reading the bulk data that is actually the last
2680 argument of the command. */
2681 int qbl
= sdslen(c
->querybuf
);
2683 if (c
->bulklen
<= qbl
) {
2684 /* Copy everything but the final CRLF as final argument */
2685 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2687 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2688 /* Process the command. If the client is still valid after
2689 * the processing and there is more data in the buffer
2690 * try to parse it. */
2691 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2697 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2698 redisClient
*c
= (redisClient
*) privdata
;
2699 char buf
[REDIS_IOBUF_LEN
];
2702 REDIS_NOTUSED(mask
);
2704 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2706 if (errno
== EAGAIN
) {
2709 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2713 } else if (nread
== 0) {
2714 redisLog(REDIS_VERBOSE
, "Client closed connection");
2719 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2720 c
->lastinteraction
= time(NULL
);
2724 processInputBuffer(c
);
2727 static int selectDb(redisClient
*c
, int id
) {
2728 if (id
< 0 || id
>= server
.dbnum
)
2730 c
->db
= &server
.db
[id
];
2734 static void *dupClientReplyValue(void *o
) {
2735 incrRefCount((robj
*)o
);
2739 static int listMatchObjects(void *a
, void *b
) {
2740 return equalStringObjects(a
,b
);
2743 static redisClient
*createClient(int fd
) {
2744 redisClient
*c
= zmalloc(sizeof(*c
));
2746 anetNonBlock(NULL
,fd
);
2747 anetTcpNoDelay(NULL
,fd
);
2748 if (!c
) return NULL
;
2751 c
->querybuf
= sdsempty();
2760 c
->lastinteraction
= time(NULL
);
2761 c
->authenticated
= 0;
2762 c
->replstate
= REDIS_REPL_NONE
;
2763 c
->reply
= listCreate();
2764 listSetFreeMethod(c
->reply
,decrRefCount
);
2765 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2766 c
->blocking_keys
= NULL
;
2767 c
->blocking_keys_num
= 0;
2768 c
->io_keys
= listCreate();
2769 c
->watched_keys
= listCreate();
2770 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2771 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2772 c
->pubsub_patterns
= listCreate();
2773 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2774 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2775 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2776 readQueryFromClient
, c
) == AE_ERR
) {
2780 listAddNodeTail(server
.clients
,c
);
2781 initClientMultiState(c
);
2785 static void addReply(redisClient
*c
, robj
*obj
) {
2786 if (listLength(c
->reply
) == 0 &&
2787 (c
->replstate
== REDIS_REPL_NONE
||
2788 c
->replstate
== REDIS_REPL_ONLINE
) &&
2789 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2790 sendReplyToClient
, c
) == AE_ERR
) return;
2792 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2793 obj
= dupStringObject(obj
);
2794 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2796 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2799 static void addReplySds(redisClient
*c
, sds s
) {
2800 robj
*o
= createObject(REDIS_STRING
,s
);
2805 static void addReplyDouble(redisClient
*c
, double d
) {
2808 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2809 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2810 (unsigned long) strlen(buf
),buf
));
2813 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2818 addReply(c
,shared
.czero
);
2820 } else if (ll
== 1) {
2821 addReply(c
,shared
.cone
);
2825 len
= ll2string(buf
+1,sizeof(buf
)-1,ll
);
2828 addReplySds(c
,sdsnewlen(buf
,len
+3));
2831 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2836 addReply(c
,shared
.czero
);
2838 } else if (ul
== 1) {
2839 addReply(c
,shared
.cone
);
2842 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2843 addReplySds(c
,sdsnewlen(buf
,len
));
2846 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2850 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2851 len
= sdslen(obj
->ptr
);
2853 long n
= (long)obj
->ptr
;
2855 /* Compute how many bytes will take this integer as a radix 10 string */
2861 while((n
= n
/10) != 0) {
2866 intlen
= ll2string(buf
+1,sizeof(buf
)-1,(long long)len
);
2867 buf
[intlen
+1] = '\r';
2868 buf
[intlen
+2] = '\n';
2869 addReplySds(c
,sdsnewlen(buf
,intlen
+3));
2872 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2873 addReplyBulkLen(c
,obj
);
2875 addReply(c
,shared
.crlf
);
2878 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2879 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2881 addReply(c
,shared
.nullbulk
);
2883 robj
*o
= createStringObject(s
,strlen(s
));
2889 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2894 REDIS_NOTUSED(mask
);
2895 REDIS_NOTUSED(privdata
);
2897 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2898 if (cfd
== AE_ERR
) {
2899 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2902 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2903 if ((c
= createClient(cfd
)) == NULL
) {
2904 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2905 close(cfd
); /* May be already closed, just ingore errors */
2908 /* If maxclient directive is set and this is one client more... close the
2909 * connection. Note that we create the client instead to check before
2910 * for this condition, since now the socket is already set in nonblocking
2911 * mode and we can send an error for free using the Kernel I/O */
2912 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2913 char *err
= "-ERR max number of clients reached\r\n";
2915 /* That's a best effort error message, don't check write errors */
2916 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2917 /* Nothing to do, Just to avoid the warning... */
2922 server
.stat_numconnections
++;
2925 /* ======================= Redis objects implementation ===================== */
2927 static robj
*createObject(int type
, void *ptr
) {
2930 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2931 if (listLength(server
.objfreelist
)) {
2932 listNode
*head
= listFirst(server
.objfreelist
);
2933 o
= listNodeValue(head
);
2934 listDelNode(server
.objfreelist
,head
);
2935 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2937 if (server
.vm_enabled
) {
2938 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2939 o
= zmalloc(sizeof(*o
));
2941 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2945 o
->encoding
= REDIS_ENCODING_RAW
;
2948 if (server
.vm_enabled
) {
2949 /* Note that this code may run in the context of an I/O thread
2950 * and accessing to server.unixtime in theory is an error
2951 * (no locks). But in practice this is safe, and even if we read
2952 * garbage Redis will not fail, as it's just a statistical info */
2953 o
->vm
.atime
= server
.unixtime
;
2954 o
->storage
= REDIS_VM_MEMORY
;
2959 static robj
*createStringObject(char *ptr
, size_t len
) {
2960 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2963 static robj
*createStringObjectFromLongLong(long long value
) {
2965 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2966 incrRefCount(shared
.integers
[value
]);
2967 o
= shared
.integers
[value
];
2969 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2970 o
= createObject(REDIS_STRING
, NULL
);
2971 o
->encoding
= REDIS_ENCODING_INT
;
2972 o
->ptr
= (void*)((long)value
);
2974 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
2980 static robj
*dupStringObject(robj
*o
) {
2981 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2982 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2985 static robj
*createListObject(void) {
2986 list
*l
= listCreate();
2988 listSetFreeMethod(l
,decrRefCount
);
2989 return createObject(REDIS_LIST
,l
);
2992 static robj
*createSetObject(void) {
2993 dict
*d
= dictCreate(&setDictType
,NULL
);
2994 return createObject(REDIS_SET
,d
);
2997 static robj
*createHashObject(void) {
2998 /* All the Hashes start as zipmaps. Will be automatically converted
2999 * into hash tables if there are enough elements or big elements
3001 unsigned char *zm
= zipmapNew();
3002 robj
*o
= createObject(REDIS_HASH
,zm
);
3003 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
3007 static robj
*createZsetObject(void) {
3008 zset
*zs
= zmalloc(sizeof(*zs
));
3010 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
3011 zs
->zsl
= zslCreate();
3012 return createObject(REDIS_ZSET
,zs
);
3015 static void freeStringObject(robj
*o
) {
3016 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3021 static void freeListObject(robj
*o
) {
3022 switch (o
->encoding
) {
3023 case REDIS_ENCODING_LIST
:
3024 listRelease((list
*) o
->ptr
);
3026 case REDIS_ENCODING_ZIPLIST
:
3030 redisPanic("Unknown list encoding type");
3034 static void freeSetObject(robj
*o
) {
3035 dictRelease((dict
*) o
->ptr
);
3038 static void freeZsetObject(robj
*o
) {
3041 dictRelease(zs
->dict
);
3046 static void freeHashObject(robj
*o
) {
3047 switch (o
->encoding
) {
3048 case REDIS_ENCODING_HT
:
3049 dictRelease((dict
*) o
->ptr
);
3051 case REDIS_ENCODING_ZIPMAP
:
3055 redisPanic("Unknown hash encoding type");
3060 static void incrRefCount(robj
*o
) {
3064 static void decrRefCount(void *obj
) {
3067 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3068 /* Object is a key of a swapped out value, or in the process of being
3070 if (server
.vm_enabled
&&
3071 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3073 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3074 redisAssert(o
->type
== REDIS_STRING
);
3075 freeStringObject(o
);
3076 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3077 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3078 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3079 !listAddNodeHead(server
.objfreelist
,o
))
3081 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3082 server
.vm_stats_swapped_objects
--;
3085 /* Object is in memory, or in the process of being swapped out. */
3086 if (--(o
->refcount
) == 0) {
3087 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3088 vmCancelThreadedIOJob(obj
);
3090 case REDIS_STRING
: freeStringObject(o
); break;
3091 case REDIS_LIST
: freeListObject(o
); break;
3092 case REDIS_SET
: freeSetObject(o
); break;
3093 case REDIS_ZSET
: freeZsetObject(o
); break;
3094 case REDIS_HASH
: freeHashObject(o
); break;
3095 default: redisPanic("Unknown object type"); break;
3097 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3098 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3099 !listAddNodeHead(server
.objfreelist
,o
))
3101 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3105 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3106 dictEntry
*de
= dictFind(db
->dict
,key
);
3108 robj
*key
= dictGetEntryKey(de
);
3109 robj
*val
= dictGetEntryVal(de
);
3111 if (server
.vm_enabled
) {
3112 if (key
->storage
== REDIS_VM_MEMORY
||
3113 key
->storage
== REDIS_VM_SWAPPING
)
3115 /* If we were swapping the object out, stop it, this key
3117 if (key
->storage
== REDIS_VM_SWAPPING
)
3118 vmCancelThreadedIOJob(key
);
3119 /* Update the access time of the key for the aging algorithm. */
3120 key
->vm
.atime
= server
.unixtime
;
3122 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3124 /* Our value was swapped on disk. Bring it at home. */
3125 redisAssert(val
== NULL
);
3126 val
= vmLoadObject(key
);
3127 dictGetEntryVal(de
) = val
;
3129 /* Clients blocked by the VM subsystem may be waiting for
3131 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3140 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3141 expireIfNeeded(db
,key
);
3142 return lookupKey(db
,key
);
3145 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3146 deleteIfVolatile(db
,key
);
3147 touchWatchedKey(db
,key
);
3148 return lookupKey(db
,key
);
3151 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3152 robj
*o
= lookupKeyRead(c
->db
, key
);
3153 if (!o
) addReply(c
,reply
);
3157 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3158 robj
*o
= lookupKeyWrite(c
->db
, key
);
3159 if (!o
) addReply(c
,reply
);
3163 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3164 if (o
->type
!= type
) {
3165 addReply(c
,shared
.wrongtypeerr
);
3171 static int deleteKey(redisDb
*db
, robj
*key
) {
3174 /* We need to protect key from destruction: after the first dictDelete()
3175 * it may happen that 'key' is no longer valid if we don't increment
3176 * it's count. This may happen when we get the object reference directly
3177 * from the hash table with dictRandomKey() or dict iterators */
3179 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3180 retval
= dictDelete(db
->dict
,key
);
3183 return retval
== DICT_OK
;
3186 /* Check if the nul-terminated string 's' can be represented by a long
3187 * (that is, is a number that fits into long without any other space or
3188 * character before or after the digits).
3190 * If so, the function returns REDIS_OK and *longval is set to the value
3191 * of the number. Otherwise REDIS_ERR is returned */
3192 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3193 char buf
[32], *endptr
;
3197 value
= strtol(s
, &endptr
, 10);
3198 if (endptr
[0] != '\0') return REDIS_ERR
;
3199 slen
= ll2string(buf
,32,value
);
3201 /* If the number converted back into a string is not identical
3202 * then it's not possible to encode the string as integer */
3203 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3204 if (longval
) *longval
= value
;
3208 /* Try to encode a string object in order to save space */
3209 static robj
*tryObjectEncoding(robj
*o
) {
3213 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3214 return o
; /* Already encoded */
3216 /* It's not safe to encode shared objects: shared objects can be shared
3217 * everywhere in the "object space" of Redis. Encoded objects can only
3218 * appear as "values" (and not, for instance, as keys) */
3219 if (o
->refcount
> 1) return o
;
3221 /* Currently we try to encode only strings */
3222 redisAssert(o
->type
== REDIS_STRING
);
3224 /* Check if we can represent this string as a long integer */
3225 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3227 /* Ok, this object can be encoded */
3228 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3230 incrRefCount(shared
.integers
[value
]);
3231 return shared
.integers
[value
];
3233 o
->encoding
= REDIS_ENCODING_INT
;
3235 o
->ptr
= (void*) value
;
3240 /* Get a decoded version of an encoded object (returned as a new object).
3241 * If the object is already raw-encoded just increment the ref count. */
3242 static robj
*getDecodedObject(robj
*o
) {
3245 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3249 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3252 ll2string(buf
,32,(long)o
->ptr
);
3253 dec
= createStringObject(buf
,strlen(buf
));
3256 redisPanic("Unknown encoding type");
3260 /* Compare two string objects via strcmp() or alike.
3261 * Note that the objects may be integer-encoded. In such a case we
3262 * use ll2string() to get a string representation of the numbers on the stack
3263 * and compare the strings, it's much faster than calling getDecodedObject().
3265 * Important note: if objects are not integer encoded, but binary-safe strings,
3266 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3268 static int compareStringObjects(robj
*a
, robj
*b
) {
3269 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3270 char bufa
[128], bufb
[128], *astr
, *bstr
;
3273 if (a
== b
) return 0;
3274 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3275 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3281 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3282 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3288 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3291 /* Equal string objects return 1 if the two objects are the same from the
3292 * point of view of a string comparison, otherwise 0 is returned. Note that
3293 * this function is faster then checking for (compareStringObject(a,b) == 0)
3294 * because it can perform some more optimization. */
3295 static int equalStringObjects(robj
*a
, robj
*b
) {
3296 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3297 return a
->ptr
== b
->ptr
;
3299 return compareStringObjects(a
,b
) == 0;
3303 static size_t stringObjectLen(robj
*o
) {
3304 redisAssert(o
->type
== REDIS_STRING
);
3305 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3306 return sdslen(o
->ptr
);
3310 return ll2string(buf
,32,(long)o
->ptr
);
3314 static int getDoubleFromObject(robj
*o
, double *target
) {
3321 redisAssert(o
->type
== REDIS_STRING
);
3322 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3323 value
= strtod(o
->ptr
, &eptr
);
3324 if (eptr
[0] != '\0') return REDIS_ERR
;
3325 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3326 value
= (long)o
->ptr
;
3328 redisPanic("Unknown string encoding");
3336 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3338 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3340 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3342 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3351 static int getLongLongFromObject(robj
*o
, long long *target
) {
3358 redisAssert(o
->type
== REDIS_STRING
);
3359 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3360 value
= strtoll(o
->ptr
, &eptr
, 10);
3361 if (eptr
[0] != '\0') return REDIS_ERR
;
3362 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3363 value
= (long)o
->ptr
;
3365 redisPanic("Unknown string encoding");
3373 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3375 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3377 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3379 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3388 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3391 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3392 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3394 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3396 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3405 /*============================ RDB saving/loading =========================== */
3407 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3408 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3412 static int rdbSaveTime(FILE *fp
, time_t t
) {
3413 int32_t t32
= (int32_t) t
;
3414 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3418 /* check rdbLoadLen() comments for more info */
3419 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3420 unsigned char buf
[2];
3423 /* Save a 6 bit len */
3424 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3425 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3426 } else if (len
< (1<<14)) {
3427 /* Save a 14 bit len */
3428 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3430 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3432 /* Save a 32 bit len */
3433 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3434 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3436 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3441 /* Encode 'value' as an integer if possible (if integer will fit the
3442 * supported range). If the function sucessful encoded the integer
3443 * then the (up to 5 bytes) encoded representation is written in the
3444 * string pointed by 'enc' and the length is returned. Otherwise
3446 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3447 /* Finally check if it fits in our ranges */
3448 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3449 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3450 enc
[1] = value
&0xFF;
3452 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3453 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3454 enc
[1] = value
&0xFF;
3455 enc
[2] = (value
>>8)&0xFF;
3457 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3458 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3459 enc
[1] = value
&0xFF;
3460 enc
[2] = (value
>>8)&0xFF;
3461 enc
[3] = (value
>>16)&0xFF;
3462 enc
[4] = (value
>>24)&0xFF;
3469 /* String objects in the form "2391" "-100" without any space and with a
3470 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3471 * encoded as integers to save space */
3472 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3474 char *endptr
, buf
[32];
3476 /* Check if it's possible to encode this value as a number */
3477 value
= strtoll(s
, &endptr
, 10);
3478 if (endptr
[0] != '\0') return 0;
3479 ll2string(buf
,32,value
);
3481 /* If the number converted back into a string is not identical
3482 * then it's not possible to encode the string as integer */
3483 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3485 return rdbEncodeInteger(value
,enc
);
3488 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3489 size_t comprlen
, outlen
;
3493 /* We require at least four bytes compression for this to be worth it */
3494 if (len
<= 4) return 0;
3496 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3497 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3498 if (comprlen
== 0) {
3502 /* Data compressed! Let's save it on disk */
3503 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3504 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3505 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3506 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3507 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3516 /* Save a string objet as [len][data] on disk. If the object is a string
3517 * representation of an integer value we try to safe it in a special form */
3518 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3521 /* Try integer encoding */
3523 unsigned char buf
[5];
3524 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3525 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3530 /* Try LZF compression - under 20 bytes it's unable to compress even
3531 * aaaaaaaaaaaaaaaaaa so skip it */
3532 if (server
.rdbcompression
&& len
> 20) {
3535 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3536 if (retval
== -1) return -1;
3537 if (retval
> 0) return 0;
3538 /* retval == 0 means data can't be compressed, save the old way */
3541 /* Store verbatim */
3542 if (rdbSaveLen(fp
,len
) == -1) return -1;
3543 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3547 /* Save a long long value as either an encoded string or a string. */
3548 static int rdbSaveLongLongAsStringObject(FILE *fp
, long long value
) {
3549 unsigned char buf
[32];
3550 int enclen
= rdbEncodeInteger(value
,buf
);
3552 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3554 /* Encode as string */
3555 enclen
= ll2string((char*)buf
,32,value
);
3556 redisAssert(enclen
< 32);
3557 if (rdbSaveLen(fp
,enclen
) == -1) return -1;
3558 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3563 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3564 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3565 /* Avoid to decode the object, then encode it again, if the
3566 * object is alrady integer encoded. */
3567 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3568 return rdbSaveLongLongAsStringObject(fp
,(long)obj
->ptr
);
3570 redisAssert(obj
->encoding
== REDIS_ENCODING_RAW
);
3571 return rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3575 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3576 * 8 bit integer specifing the length of the representation.
3577 * This 8 bit integer has special values in order to specify the following
3583 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3584 unsigned char buf
[128];
3590 } else if (!isfinite(val
)) {
3592 buf
[0] = (val
< 0) ? 255 : 254;
3594 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3595 /* Check if the float is in a safe range to be casted into a
3596 * long long. We are assuming that long long is 64 bit here.
3597 * Also we are assuming that there are no implementations around where
3598 * double has precision < 52 bit.
3600 * Under this assumptions we test if a double is inside an interval
3601 * where casting to long long is safe. Then using two castings we
3602 * make sure the decimal part is zero. If all this is true we use
3603 * integer printing function that is much faster. */
3604 double min
= -4503599627370495; /* (2^52)-1 */
3605 double max
= 4503599627370496; /* -(2^52) */
3606 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3607 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3610 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3611 buf
[0] = strlen((char*)buf
+1);
3614 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3618 /* Save a Redis object. */
3619 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3620 if (o
->type
== REDIS_STRING
) {
3621 /* Save a string value */
3622 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3623 } else if (o
->type
== REDIS_LIST
) {
3624 /* Save a list value */
3625 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
3627 unsigned char *vstr
;
3631 if (rdbSaveLen(fp
,ziplistLen(o
->ptr
)) == -1) return -1;
3632 p
= ziplistIndex(o
->ptr
,0);
3633 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
3635 if (rdbSaveRawString(fp
,vstr
,vlen
) == -1)
3638 if (rdbSaveLongLongAsStringObject(fp
,vlong
) == -1)
3641 p
= ziplistNext(o
->ptr
,p
);
3643 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
3644 list
*list
= o
->ptr
;
3648 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3649 listRewind(list
,&li
);
3650 while((ln
= listNext(&li
))) {
3651 robj
*eleobj
= listNodeValue(ln
);
3652 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3655 redisPanic("Unknown list encoding");
3657 } else if (o
->type
== REDIS_SET
) {
3658 /* Save a set value */
3660 dictIterator
*di
= dictGetIterator(set
);
3663 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3664 while((de
= dictNext(di
)) != NULL
) {
3665 robj
*eleobj
= dictGetEntryKey(de
);
3667 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3669 dictReleaseIterator(di
);
3670 } else if (o
->type
== REDIS_ZSET
) {
3671 /* Save a set value */
3673 dictIterator
*di
= dictGetIterator(zs
->dict
);
3676 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3677 while((de
= dictNext(di
)) != NULL
) {
3678 robj
*eleobj
= dictGetEntryKey(de
);
3679 double *score
= dictGetEntryVal(de
);
3681 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3682 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3684 dictReleaseIterator(di
);
3685 } else if (o
->type
== REDIS_HASH
) {
3686 /* Save a hash value */
3687 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3688 unsigned char *p
= zipmapRewind(o
->ptr
);
3689 unsigned int count
= zipmapLen(o
->ptr
);
3690 unsigned char *key
, *val
;
3691 unsigned int klen
, vlen
;
3693 if (rdbSaveLen(fp
,count
) == -1) return -1;
3694 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3695 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3696 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3699 dictIterator
*di
= dictGetIterator(o
->ptr
);
3702 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3703 while((de
= dictNext(di
)) != NULL
) {
3704 robj
*key
= dictGetEntryKey(de
);
3705 robj
*val
= dictGetEntryVal(de
);
3707 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3708 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3710 dictReleaseIterator(di
);
3713 redisPanic("Unknown object type");
3718 /* Return the length the object will have on disk if saved with
3719 * the rdbSaveObject() function. Currently we use a trick to get
3720 * this length with very little changes to the code. In the future
3721 * we could switch to a faster solution. */
3722 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3723 if (fp
== NULL
) fp
= server
.devnull
;
3725 assert(rdbSaveObject(fp
,o
) != 1);
3729 /* Return the number of pages required to save this object in the swap file */
3730 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3731 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3733 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3736 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3737 static int rdbSave(char *filename
) {
3738 dictIterator
*di
= NULL
;
3743 time_t now
= time(NULL
);
3745 /* Wait for I/O therads to terminate, just in case this is a
3746 * foreground-saving, to avoid seeking the swap file descriptor at the
3748 if (server
.vm_enabled
)
3749 waitEmptyIOJobsQueue();
3751 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3752 fp
= fopen(tmpfile
,"w");
3754 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3757 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3758 for (j
= 0; j
< server
.dbnum
; j
++) {
3759 redisDb
*db
= server
.db
+j
;
3761 if (dictSize(d
) == 0) continue;
3762 di
= dictGetIterator(d
);
3768 /* Write the SELECT DB opcode */
3769 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3770 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3772 /* Iterate this DB writing every entry */
3773 while((de
= dictNext(di
)) != NULL
) {
3774 robj
*key
= dictGetEntryKey(de
);
3775 robj
*o
= dictGetEntryVal(de
);
3776 time_t expiretime
= getExpire(db
,key
);
3778 /* Save the expire time */
3779 if (expiretime
!= -1) {
3780 /* If this key is already expired skip it */
3781 if (expiretime
< now
) continue;
3782 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3783 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3785 /* Save the key and associated value. This requires special
3786 * handling if the value is swapped out. */
3787 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3788 key
->storage
== REDIS_VM_SWAPPING
) {
3789 /* Save type, key, value */
3790 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3791 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3792 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3794 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3796 /* Get a preview of the object in memory */
3797 po
= vmPreviewObject(key
);
3798 /* Save type, key, value */
3799 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3800 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3801 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3802 /* Remove the loaded object from memory */
3806 dictReleaseIterator(di
);
3809 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3811 /* Make sure data will not remain on the OS's output buffers */
3816 /* Use RENAME to make sure the DB file is changed atomically only
3817 * if the generate DB file is ok. */
3818 if (rename(tmpfile
,filename
) == -1) {
3819 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3823 redisLog(REDIS_NOTICE
,"DB saved on disk");
3825 server
.lastsave
= time(NULL
);
3831 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3832 if (di
) dictReleaseIterator(di
);
3836 static int rdbSaveBackground(char *filename
) {
3839 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3840 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3841 if ((childpid
= fork()) == 0) {
3843 if (server
.vm_enabled
) vmReopenSwapFile();
3845 if (rdbSave(filename
) == REDIS_OK
) {
3852 if (childpid
== -1) {
3853 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3857 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3858 server
.bgsavechildpid
= childpid
;
3859 updateDictResizePolicy();
3862 return REDIS_OK
; /* unreached */
3865 static void rdbRemoveTempFile(pid_t childpid
) {
3868 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3872 static int rdbLoadType(FILE *fp
) {
3874 if (fread(&type
,1,1,fp
) == 0) return -1;
3878 static time_t rdbLoadTime(FILE *fp
) {
3880 if (fread(&t32
,4,1,fp
) == 0) return -1;
3881 return (time_t) t32
;
3884 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3885 * of this file for a description of how this are stored on disk.
3887 * isencoded is set to 1 if the readed length is not actually a length but
3888 * an "encoding type", check the above comments for more info */
3889 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3890 unsigned char buf
[2];
3894 if (isencoded
) *isencoded
= 0;
3895 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3896 type
= (buf
[0]&0xC0)>>6;
3897 if (type
== REDIS_RDB_6BITLEN
) {
3898 /* Read a 6 bit len */
3900 } else if (type
== REDIS_RDB_ENCVAL
) {
3901 /* Read a 6 bit len encoding type */
3902 if (isencoded
) *isencoded
= 1;
3904 } else if (type
== REDIS_RDB_14BITLEN
) {
3905 /* Read a 14 bit len */
3906 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3907 return ((buf
[0]&0x3F)<<8)|buf
[1];
3909 /* Read a 32 bit len */
3910 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3915 /* Load an integer-encoded object from file 'fp', with the specified
3916 * encoding type 'enctype'. If encode is true the function may return
3917 * an integer-encoded object as reply, otherwise the returned object
3918 * will always be encoded as a raw string. */
3919 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3920 unsigned char enc
[4];
3923 if (enctype
== REDIS_RDB_ENC_INT8
) {
3924 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3925 val
= (signed char)enc
[0];
3926 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3928 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3929 v
= enc
[0]|(enc
[1]<<8);
3931 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3933 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3934 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3937 val
= 0; /* anti-warning */
3938 redisPanic("Unknown RDB integer encoding type");
3941 return createStringObjectFromLongLong(val
);
3943 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3946 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3947 unsigned int len
, clen
;
3948 unsigned char *c
= NULL
;
3951 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3952 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3953 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3954 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3955 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3956 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3958 return createObject(REDIS_STRING
,val
);
3965 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3970 len
= rdbLoadLen(fp
,&isencoded
);
3973 case REDIS_RDB_ENC_INT8
:
3974 case REDIS_RDB_ENC_INT16
:
3975 case REDIS_RDB_ENC_INT32
:
3976 return rdbLoadIntegerObject(fp
,len
,encode
);
3977 case REDIS_RDB_ENC_LZF
:
3978 return rdbLoadLzfStringObject(fp
);
3980 redisPanic("Unknown RDB encoding type");
3984 if (len
== REDIS_RDB_LENERR
) return NULL
;
3985 val
= sdsnewlen(NULL
,len
);
3986 if (len
&& fread(val
,len
,1,fp
) == 0) {
3990 return createObject(REDIS_STRING
,val
);
3993 static robj
*rdbLoadStringObject(FILE *fp
) {
3994 return rdbGenericLoadStringObject(fp
,0);
3997 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3998 return rdbGenericLoadStringObject(fp
,1);
4001 /* For information about double serialization check rdbSaveDoubleValue() */
4002 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
4006 if (fread(&len
,1,1,fp
) == 0) return -1;
4008 case 255: *val
= R_NegInf
; return 0;
4009 case 254: *val
= R_PosInf
; return 0;
4010 case 253: *val
= R_Nan
; return 0;
4012 if (fread(buf
,len
,1,fp
) == 0) return -1;
4014 sscanf(buf
, "%lg", val
);
4019 /* Load a Redis object of the specified type from the specified file.
4020 * On success a newly allocated object is returned, otherwise NULL. */
4021 static robj
*rdbLoadObject(int type
, FILE *fp
) {
4022 robj
*o
, *ele
, *dec
;
4025 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
4026 if (type
== REDIS_STRING
) {
4027 /* Read string value */
4028 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4029 o
= tryObjectEncoding(o
);
4030 } else if (type
== REDIS_LIST
) {
4031 /* Read list value */
4032 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4034 o
= createObject(REDIS_LIST
,ziplistNew());
4035 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
4037 /* Load every single element of the list */
4039 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4041 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4042 dec
= getDecodedObject(ele
);
4043 o
->ptr
= ziplistPush(o
->ptr
,dec
->ptr
,sdslen(dec
->ptr
),REDIS_TAIL
);
4047 ele
= tryObjectEncoding(ele
);
4048 listAddNodeTail(o
->ptr
,ele
);
4052 } else if (type
== REDIS_SET
) {
4053 /* Read list/set value */
4054 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4055 o
= createSetObject();
4056 /* It's faster to expand the dict to the right size asap in order
4057 * to avoid rehashing */
4058 if (len
> DICT_HT_INITIAL_SIZE
)
4059 dictExpand(o
->ptr
,len
);
4060 /* Load every single element of the list/set */
4062 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4063 ele
= tryObjectEncoding(ele
);
4064 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
4066 } else if (type
== REDIS_ZSET
) {
4067 /* Read list/set value */
4071 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4072 o
= createZsetObject();
4074 /* Load every single element of the list/set */
4077 double *score
= zmalloc(sizeof(double));
4079 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4080 ele
= tryObjectEncoding(ele
);
4081 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
4082 dictAdd(zs
->dict
,ele
,score
);
4083 zslInsert(zs
->zsl
,*score
,ele
);
4084 incrRefCount(ele
); /* added to skiplist */
4086 } else if (type
== REDIS_HASH
) {
4089 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4090 o
= createHashObject();
4091 /* Too many entries? Use an hash table. */
4092 if (hashlen
> server
.hash_max_zipmap_entries
)
4093 convertToRealHash(o
);
4094 /* Load every key/value, then set it into the zipmap or hash
4095 * table, as needed. */
4099 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4100 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4101 /* If we are using a zipmap and there are too big values
4102 * the object is converted to real hash table encoding. */
4103 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4104 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
4105 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
4107 convertToRealHash(o
);
4110 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
4111 unsigned char *zm
= o
->ptr
;
4113 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4114 val
->ptr
,sdslen(val
->ptr
),NULL
);
4119 key
= tryObjectEncoding(key
);
4120 val
= tryObjectEncoding(val
);
4121 dictAdd((dict
*)o
->ptr
,key
,val
);
4125 redisPanic("Unknown object type");
4130 static int rdbLoad(char *filename
) {
4133 int type
, retval
, rdbver
;
4134 int swap_all_values
= 0;
4135 dict
*d
= server
.db
[0].dict
;
4136 redisDb
*db
= server
.db
+0;
4138 time_t expiretime
, now
= time(NULL
);
4139 long long loadedkeys
= 0;
4141 fp
= fopen(filename
,"r");
4142 if (!fp
) return REDIS_ERR
;
4143 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4145 if (memcmp(buf
,"REDIS",5) != 0) {
4147 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4150 rdbver
= atoi(buf
+5);
4153 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4161 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4162 if (type
== REDIS_EXPIRETIME
) {
4163 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4164 /* We read the time so we need to read the object type again */
4165 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4167 if (type
== REDIS_EOF
) break;
4168 /* Handle SELECT DB opcode as a special case */
4169 if (type
== REDIS_SELECTDB
) {
4170 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4172 if (dbid
>= (unsigned)server
.dbnum
) {
4173 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4176 db
= server
.db
+dbid
;
4181 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4183 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4184 /* Check if the key already expired */
4185 if (expiretime
!= -1 && expiretime
< now
) {
4190 /* Add the new object in the hash table */
4191 retval
= dictAdd(d
,key
,val
);
4192 if (retval
== DICT_ERR
) {
4193 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4197 /* Set the expire time if needed */
4198 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4200 /* Handle swapping while loading big datasets when VM is on */
4202 /* If we detecter we are hopeless about fitting something in memory
4203 * we just swap every new key on disk. Directly...
4204 * Note that's important to check for this condition before resorting
4205 * to random sampling, otherwise we may try to swap already
4207 if (swap_all_values
) {
4208 dictEntry
*de
= dictFind(d
,key
);
4210 /* de may be NULL since the key already expired */
4212 key
= dictGetEntryKey(de
);
4213 val
= dictGetEntryVal(de
);
4215 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4216 dictGetEntryVal(de
) = NULL
;
4222 /* If we have still some hope of having some value fitting memory
4223 * then we try random sampling. */
4224 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4225 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4226 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4228 if (zmalloc_used_memory() > server
.vm_max_memory
)
4229 swap_all_values
= 1; /* We are already using too much mem */
4235 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4236 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4238 return REDIS_ERR
; /* Just to avoid warning */
4241 /*================================== Shutdown =============================== */
4242 static int prepareForShutdown() {
4243 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4244 /* Kill the saving child if there is a background saving in progress.
4245 We want to avoid race conditions, for instance our saving child may
4246 overwrite the synchronous saving did by SHUTDOWN. */
4247 if (server
.bgsavechildpid
!= -1) {
4248 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4249 kill(server
.bgsavechildpid
,SIGKILL
);
4250 rdbRemoveTempFile(server
.bgsavechildpid
);
4252 if (server
.appendonly
) {
4253 /* Append only file: fsync() the AOF and exit */
4254 fsync(server
.appendfd
);
4255 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4257 /* Snapshotting. Perform a SYNC SAVE and exit */
4258 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4259 if (server
.daemonize
)
4260 unlink(server
.pidfile
);
4261 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4263 /* Ooops.. error saving! The best we can do is to continue
4264 * operating. Note that if there was a background saving process,
4265 * in the next cron() Redis will be notified that the background
4266 * saving aborted, handling special stuff like slaves pending for
4267 * synchronization... */
4268 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4272 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4276 /*================================== Commands =============================== */
4278 static void authCommand(redisClient
*c
) {
4279 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4280 c
->authenticated
= 1;
4281 addReply(c
,shared
.ok
);
4283 c
->authenticated
= 0;
4284 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4288 static void pingCommand(redisClient
*c
) {
4289 addReply(c
,shared
.pong
);
4292 static void echoCommand(redisClient
*c
) {
4293 addReplyBulk(c
,c
->argv
[1]);
4296 /*=================================== Strings =============================== */
4298 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4300 long seconds
= 0; /* initialized to avoid an harmness warning */
4303 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4306 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4311 touchWatchedKey(c
->db
,key
);
4312 if (nx
) deleteIfVolatile(c
->db
,key
);
4313 retval
= dictAdd(c
->db
->dict
,key
,val
);
4314 if (retval
== DICT_ERR
) {
4316 /* If the key is about a swapped value, we want a new key object
4317 * to overwrite the old. So we delete the old key in the database.
4318 * This will also make sure that swap pages about the old object
4319 * will be marked as free. */
4320 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4322 dictReplace(c
->db
->dict
,key
,val
);
4325 addReply(c
,shared
.czero
);
4333 removeExpire(c
->db
,key
);
4334 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4335 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4338 static void setCommand(redisClient
*c
) {
4339 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4342 static void setnxCommand(redisClient
*c
) {
4343 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4346 static void setexCommand(redisClient
*c
) {
4347 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4350 static int getGenericCommand(redisClient
*c
) {
4353 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4356 if (o
->type
!= REDIS_STRING
) {
4357 addReply(c
,shared
.wrongtypeerr
);
4365 static void getCommand(redisClient
*c
) {
4366 getGenericCommand(c
);
4369 static void getsetCommand(redisClient
*c
) {
4370 if (getGenericCommand(c
) == REDIS_ERR
) return;
4371 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4372 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4374 incrRefCount(c
->argv
[1]);
4376 incrRefCount(c
->argv
[2]);
4378 removeExpire(c
->db
,c
->argv
[1]);
4381 static void mgetCommand(redisClient
*c
) {
4384 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4385 for (j
= 1; j
< c
->argc
; j
++) {
4386 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4388 addReply(c
,shared
.nullbulk
);
4390 if (o
->type
!= REDIS_STRING
) {
4391 addReply(c
,shared
.nullbulk
);
4399 static void msetGenericCommand(redisClient
*c
, int nx
) {
4400 int j
, busykeys
= 0;
4402 if ((c
->argc
% 2) == 0) {
4403 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4406 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4407 * set nothing at all if at least one already key exists. */
4409 for (j
= 1; j
< c
->argc
; j
+= 2) {
4410 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4416 addReply(c
, shared
.czero
);
4420 for (j
= 1; j
< c
->argc
; j
+= 2) {
4423 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4424 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4425 if (retval
== DICT_ERR
) {
4426 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4427 incrRefCount(c
->argv
[j
+1]);
4429 incrRefCount(c
->argv
[j
]);
4430 incrRefCount(c
->argv
[j
+1]);
4432 removeExpire(c
->db
,c
->argv
[j
]);
4434 server
.dirty
+= (c
->argc
-1)/2;
4435 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4438 static void msetCommand(redisClient
*c
) {
4439 msetGenericCommand(c
,0);
4442 static void msetnxCommand(redisClient
*c
) {
4443 msetGenericCommand(c
,1);
4446 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4451 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4452 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4453 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4456 o
= createStringObjectFromLongLong(value
);
4457 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4458 if (retval
== DICT_ERR
) {
4459 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4460 removeExpire(c
->db
,c
->argv
[1]);
4462 incrRefCount(c
->argv
[1]);
4465 addReply(c
,shared
.colon
);
4467 addReply(c
,shared
.crlf
);
4470 static void incrCommand(redisClient
*c
) {
4471 incrDecrCommand(c
,1);
4474 static void decrCommand(redisClient
*c
) {
4475 incrDecrCommand(c
,-1);
4478 static void incrbyCommand(redisClient
*c
) {
4481 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4482 incrDecrCommand(c
,incr
);
4485 static void decrbyCommand(redisClient
*c
) {
4488 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4489 incrDecrCommand(c
,-incr
);
4492 static void appendCommand(redisClient
*c
) {
4497 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4499 /* Create the key */
4500 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4501 incrRefCount(c
->argv
[1]);
4502 incrRefCount(c
->argv
[2]);
4503 totlen
= stringObjectLen(c
->argv
[2]);
4507 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4510 o
= dictGetEntryVal(de
);
4511 if (o
->type
!= REDIS_STRING
) {
4512 addReply(c
,shared
.wrongtypeerr
);
4515 /* If the object is specially encoded or shared we have to make
4517 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4518 robj
*decoded
= getDecodedObject(o
);
4520 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4521 decrRefCount(decoded
);
4522 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4525 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4526 o
->ptr
= sdscatlen(o
->ptr
,
4527 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4529 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4530 (unsigned long) c
->argv
[2]->ptr
);
4532 totlen
= sdslen(o
->ptr
);
4535 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4538 static void substrCommand(redisClient
*c
) {
4540 long start
= atoi(c
->argv
[2]->ptr
);
4541 long end
= atoi(c
->argv
[3]->ptr
);
4542 size_t rangelen
, strlen
;
4545 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4546 checkType(c
,o
,REDIS_STRING
)) return;
4548 o
= getDecodedObject(o
);
4549 strlen
= sdslen(o
->ptr
);
4551 /* convert negative indexes */
4552 if (start
< 0) start
= strlen
+start
;
4553 if (end
< 0) end
= strlen
+end
;
4554 if (start
< 0) start
= 0;
4555 if (end
< 0) end
= 0;
4557 /* indexes sanity checks */
4558 if (start
> end
|| (size_t)start
>= strlen
) {
4559 /* Out of range start or start > end result in null reply */
4560 addReply(c
,shared
.nullbulk
);
4564 if ((size_t)end
>= strlen
) end
= strlen
-1;
4565 rangelen
= (end
-start
)+1;
4567 /* Return the result */
4568 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4569 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4570 addReplySds(c
,range
);
4571 addReply(c
,shared
.crlf
);
4575 /* ========================= Type agnostic commands ========================= */
4577 static void delCommand(redisClient
*c
) {
4580 for (j
= 1; j
< c
->argc
; j
++) {
4581 if (deleteKey(c
->db
,c
->argv
[j
])) {
4582 touchWatchedKey(c
->db
,c
->argv
[j
]);
4587 addReplyLongLong(c
,deleted
);
4590 static void existsCommand(redisClient
*c
) {
4591 expireIfNeeded(c
->db
,c
->argv
[1]);
4592 if (dictFind(c
->db
->dict
,c
->argv
[1])) {
4593 addReply(c
, shared
.cone
);
4595 addReply(c
, shared
.czero
);
4599 static void selectCommand(redisClient
*c
) {
4600 int id
= atoi(c
->argv
[1]->ptr
);
4602 if (selectDb(c
,id
) == REDIS_ERR
) {
4603 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4605 addReply(c
,shared
.ok
);
4609 static void randomkeyCommand(redisClient
*c
) {
4614 de
= dictGetRandomKey(c
->db
->dict
);
4615 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4619 addReply(c
,shared
.nullbulk
);
4623 key
= dictGetEntryKey(de
);
4624 if (server
.vm_enabled
) {
4625 key
= dupStringObject(key
);
4626 addReplyBulk(c
,key
);
4629 addReplyBulk(c
,key
);
4633 static void keysCommand(redisClient
*c
) {
4636 sds pattern
= c
->argv
[1]->ptr
;
4637 int plen
= sdslen(pattern
);
4638 unsigned long numkeys
= 0;
4639 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4641 di
= dictGetIterator(c
->db
->dict
);
4643 decrRefCount(lenobj
);
4644 while((de
= dictNext(di
)) != NULL
) {
4645 robj
*keyobj
= dictGetEntryKey(de
);
4647 sds key
= keyobj
->ptr
;
4648 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4649 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4650 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4651 addReplyBulk(c
,keyobj
);
4656 dictReleaseIterator(di
);
4657 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4660 static void dbsizeCommand(redisClient
*c
) {
4662 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4665 static void lastsaveCommand(redisClient
*c
) {
4667 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4670 static void typeCommand(redisClient
*c
) {
4674 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4679 case REDIS_STRING
: type
= "+string"; break;
4680 case REDIS_LIST
: type
= "+list"; break;
4681 case REDIS_SET
: type
= "+set"; break;
4682 case REDIS_ZSET
: type
= "+zset"; break;
4683 case REDIS_HASH
: type
= "+hash"; break;
4684 default: type
= "+unknown"; break;
4687 addReplySds(c
,sdsnew(type
));
4688 addReply(c
,shared
.crlf
);
4691 static void saveCommand(redisClient
*c
) {
4692 if (server
.bgsavechildpid
!= -1) {
4693 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4696 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4697 addReply(c
,shared
.ok
);
4699 addReply(c
,shared
.err
);
4703 static void bgsaveCommand(redisClient
*c
) {
4704 if (server
.bgsavechildpid
!= -1) {
4705 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4708 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4709 char *status
= "+Background saving started\r\n";
4710 addReplySds(c
,sdsnew(status
));
4712 addReply(c
,shared
.err
);
4716 static void shutdownCommand(redisClient
*c
) {
4717 if (prepareForShutdown() == REDIS_OK
)
4719 addReplySds(c
, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4722 static void renameGenericCommand(redisClient
*c
, int nx
) {
4725 /* To use the same key as src and dst is probably an error */
4726 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4727 addReply(c
,shared
.sameobjecterr
);
4731 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4735 deleteIfVolatile(c
->db
,c
->argv
[2]);
4736 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4739 addReply(c
,shared
.czero
);
4742 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4744 incrRefCount(c
->argv
[2]);
4746 deleteKey(c
->db
,c
->argv
[1]);
4747 touchWatchedKey(c
->db
,c
->argv
[2]);
4749 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4752 static void renameCommand(redisClient
*c
) {
4753 renameGenericCommand(c
,0);
4756 static void renamenxCommand(redisClient
*c
) {
4757 renameGenericCommand(c
,1);
4760 static void moveCommand(redisClient
*c
) {
4765 /* Obtain source and target DB pointers */
4768 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4769 addReply(c
,shared
.outofrangeerr
);
4773 selectDb(c
,srcid
); /* Back to the source DB */
4775 /* If the user is moving using as target the same
4776 * DB as the source DB it is probably an error. */
4778 addReply(c
,shared
.sameobjecterr
);
4782 /* Check if the element exists and get a reference */
4783 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4785 addReply(c
,shared
.czero
);
4789 /* Try to add the element to the target DB */
4790 deleteIfVolatile(dst
,c
->argv
[1]);
4791 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4792 addReply(c
,shared
.czero
);
4795 incrRefCount(c
->argv
[1]);
4798 /* OK! key moved, free the entry in the source DB */
4799 deleteKey(src
,c
->argv
[1]);
4801 addReply(c
,shared
.cone
);
4804 /* =================================== Lists ================================ */
4805 static void lPush(robj
*subject
, robj
*value
, int where
) {
4806 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4807 int pos
= (where
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4808 value
= getDecodedObject(value
);
4809 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),pos
);
4810 decrRefCount(value
);
4811 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4812 if (where
== REDIS_HEAD
) {
4813 listAddNodeHead(subject
->ptr
,value
);
4815 listAddNodeTail(subject
->ptr
,value
);
4817 incrRefCount(value
);
4819 redisPanic("Unknown list encoding");
4823 static robj
*lPop(robj
*subject
, int where
) {
4825 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4827 unsigned char *vstr
;
4830 int pos
= (where
== REDIS_HEAD
) ? 0 : -1;
4831 p
= ziplistIndex(subject
->ptr
,pos
);
4832 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
4834 value
= createStringObject((char*)vstr
,vlen
);
4836 value
= createStringObjectFromLongLong(vlong
);
4838 /* We only need to delete an element when it exists */
4839 subject
->ptr
= ziplistDelete(subject
->ptr
,&p
);
4841 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4842 list
*list
= subject
->ptr
;
4844 if (where
== REDIS_HEAD
) {
4845 ln
= listFirst(list
);
4847 ln
= listLast(list
);
4850 value
= listNodeValue(ln
);
4851 incrRefCount(value
);
4852 listDelNode(list
,ln
);
4855 redisPanic("Unknown list encoding");
4860 static unsigned long lLength(robj
*subject
) {
4861 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4862 return ziplistLen(subject
->ptr
);
4863 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4864 return listLength((list
*)subject
->ptr
);
4866 redisPanic("Unknown list encoding");
4870 /* Structure to hold set iteration abstraction. */
4873 unsigned char encoding
;
4874 unsigned char direction
; /* Iteration direction */
4879 /* Structure for an entry while iterating over a list. */
4882 unsigned char *zi
; /* Entry in ziplist */
4883 listNode
*ln
; /* Entry in linked list */
4886 /* Initialize an iterator at the specified index. */
4887 static lIterator
*lInitIterator(robj
*subject
, int index
, unsigned char direction
) {
4888 lIterator
*li
= zmalloc(sizeof(lIterator
));
4889 li
->subject
= subject
;
4890 li
->encoding
= subject
->encoding
;
4891 li
->direction
= direction
;
4892 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4893 li
->zi
= ziplistIndex(subject
->ptr
,index
);
4894 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4895 li
->ln
= listIndex(subject
->ptr
,index
);
4897 redisPanic("Unknown list encoding");
4902 /* Clean up the iterator. */
4903 static void lReleaseIterator(lIterator
*li
) {
4907 /* Stores pointer to current the entry in the provided entry structure
4908 * and advances the position of the iterator. Returns 1 when the current
4909 * entry is in fact an entry, 0 otherwise. */
4910 static int lNext(lIterator
*li
, lEntry
*entry
) {
4912 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4914 if (entry
->zi
!= NULL
) {
4915 if (li
->direction
== REDIS_TAIL
)
4916 li
->zi
= ziplistNext(li
->subject
->ptr
,li
->zi
);
4918 li
->zi
= ziplistPrev(li
->subject
->ptr
,li
->zi
);
4921 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4923 if (entry
->ln
!= NULL
) {
4924 if (li
->direction
== REDIS_TAIL
)
4925 li
->ln
= li
->ln
->next
;
4927 li
->ln
= li
->ln
->prev
;
4931 redisPanic("Unknown list encoding");
4936 /* Return entry or NULL at the current position of the iterator. */
4937 static robj
*lGet(lEntry
*entry
) {
4938 lIterator
*li
= entry
->li
;
4940 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4941 unsigned char *vstr
;
4944 redisAssert(entry
->zi
!= NULL
);
4945 if (ziplistGet(entry
->zi
,&vstr
,&vlen
,&vlong
)) {
4947 value
= createStringObject((char*)vstr
,vlen
);
4949 value
= createStringObjectFromLongLong(vlong
);
4952 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4953 redisAssert(entry
->ln
!= NULL
);
4954 value
= listNodeValue(entry
->ln
);
4955 incrRefCount(value
);
4957 redisPanic("Unknown list encoding");
4962 /* Compare the given object with the entry at the current position. */
4963 static int lEqual(lEntry
*entry
, robj
*o
) {
4964 lIterator
*li
= entry
->li
;
4965 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4966 redisAssert(o
->encoding
== REDIS_ENCODING_RAW
);
4967 return ziplistCompare(entry
->zi
,o
->ptr
,sdslen(o
->ptr
));
4968 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4969 return equalStringObjects(o
,listNodeValue(entry
->ln
));
4971 redisPanic("Unknown list encoding");
4975 /* Delete the element pointed to. */
4976 static void lDelete(lEntry
*entry
) {
4977 lIterator
*li
= entry
->li
;
4978 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4979 unsigned char *p
= entry
->zi
;
4980 li
->subject
->ptr
= ziplistDelete(li
->subject
->ptr
,&p
);
4982 /* Update position of the iterator depending on the direction */
4983 if (li
->direction
== REDIS_TAIL
)
4986 li
->zi
= ziplistPrev(li
->subject
->ptr
,p
);
4987 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
4989 if (li
->direction
== REDIS_TAIL
)
4990 next
= entry
->ln
->next
;
4992 next
= entry
->ln
->prev
;
4993 listDelNode(li
->subject
->ptr
,entry
->ln
);
4996 redisPanic("Unknown list encoding");
5000 static void pushGenericCommand(redisClient
*c
, int where
) {
5001 robj
*lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5003 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5004 addReply(c
,shared
.cone
);
5007 lobj
= createObject(REDIS_LIST
,ziplistNew());
5008 lobj
->encoding
= REDIS_ENCODING_ZIPLIST
;
5009 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
5010 incrRefCount(c
->argv
[1]);
5012 if (lobj
->type
!= REDIS_LIST
) {
5013 addReply(c
,shared
.wrongtypeerr
);
5016 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5017 addReply(c
,shared
.cone
);
5021 lPush(lobj
,c
->argv
[2],where
);
5022 addReplyLongLong(c
,lLength(lobj
));
5026 static void lpushCommand(redisClient
*c
) {
5027 pushGenericCommand(c
,REDIS_HEAD
);
5030 static void rpushCommand(redisClient
*c
) {
5031 pushGenericCommand(c
,REDIS_TAIL
);
5034 static void llenCommand(redisClient
*c
) {
5035 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
);
5036 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5037 addReplyUlong(c
,lLength(o
));
5040 static void lindexCommand(redisClient
*c
) {
5041 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5042 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5043 int index
= atoi(c
->argv
[2]->ptr
);
5046 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5048 unsigned char *vstr
;
5051 p
= ziplistIndex(o
->ptr
,index
);
5052 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
5054 value
= createStringObject((char*)vstr
,vlen
);
5056 value
= createStringObjectFromLongLong(vlong
);
5058 addReplyBulk(c
,value
);
5059 decrRefCount(value
);
5061 addReply(c
,shared
.nullbulk
);
5063 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5064 listNode
*ln
= listIndex(o
->ptr
,index
);
5066 value
= listNodeValue(ln
);
5067 addReplyBulk(c
,value
);
5069 addReply(c
,shared
.nullbulk
);
5072 redisPanic("Unknown list encoding");
5076 static void lsetCommand(redisClient
*c
) {
5077 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
);
5078 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5079 int index
= atoi(c
->argv
[2]->ptr
);
5080 robj
*value
= c
->argv
[3];
5082 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5083 unsigned char *p
, *zl
= o
->ptr
;
5084 p
= ziplistIndex(zl
,index
);
5086 addReply(c
,shared
.outofrangeerr
);
5088 o
->ptr
= ziplistDelete(o
->ptr
,&p
);
5089 value
= getDecodedObject(value
);
5090 o
->ptr
= ziplistInsert(o
->ptr
,p
,value
->ptr
,sdslen(value
->ptr
));
5091 decrRefCount(value
);
5092 addReply(c
,shared
.ok
);
5095 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5096 listNode
*ln
= listIndex(o
->ptr
,index
);
5098 addReply(c
,shared
.outofrangeerr
);
5100 decrRefCount((robj
*)listNodeValue(ln
));
5101 listNodeValue(ln
) = value
;
5102 incrRefCount(value
);
5103 addReply(c
,shared
.ok
);
5107 redisPanic("Unknown list encoding");
5111 static void popGenericCommand(redisClient
*c
, int where
) {
5112 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5113 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5115 robj
*value
= lPop(o
,where
);
5116 if (value
== NULL
) {
5117 addReply(c
,shared
.nullbulk
);
5119 addReplyBulk(c
,value
);
5120 decrRefCount(value
);
5121 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5126 static void lpopCommand(redisClient
*c
) {
5127 popGenericCommand(c
,REDIS_HEAD
);
5130 static void rpopCommand(redisClient
*c
) {
5131 popGenericCommand(c
,REDIS_TAIL
);
5134 static void lrangeCommand(redisClient
*c
) {
5136 int start
= atoi(c
->argv
[2]->ptr
);
5137 int end
= atoi(c
->argv
[3]->ptr
);
5142 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5143 || checkType(c
,o
,REDIS_LIST
)) return;
5146 /* convert negative indexes */
5147 if (start
< 0) start
= llen
+start
;
5148 if (end
< 0) end
= llen
+end
;
5149 if (start
< 0) start
= 0;
5150 if (end
< 0) end
= 0;
5152 /* indexes sanity checks */
5153 if (start
> end
|| start
>= llen
) {
5154 /* Out of range start or start > end result in empty list */
5155 addReply(c
,shared
.emptymultibulk
);
5158 if (end
>= llen
) end
= llen
-1;
5159 rangelen
= (end
-start
)+1;
5161 /* Return the result in form of a multi-bulk reply */
5162 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
5163 lIterator
*li
= lInitIterator(o
,start
,REDIS_TAIL
);
5164 for (j
= 0; j
< rangelen
; j
++) {
5165 redisAssert(lNext(li
,&entry
));
5166 value
= lGet(&entry
);
5167 addReplyBulk(c
,value
);
5168 decrRefCount(value
);
5170 lReleaseIterator(li
);
5173 static void ltrimCommand(redisClient
*c
) {
5175 int start
= atoi(c
->argv
[2]->ptr
);
5176 int end
= atoi(c
->argv
[3]->ptr
);
5178 int j
, ltrim
, rtrim
;
5182 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
5183 checkType(c
,o
,REDIS_LIST
)) return;
5186 /* convert negative indexes */
5187 if (start
< 0) start
= llen
+start
;
5188 if (end
< 0) end
= llen
+end
;
5189 if (start
< 0) start
= 0;
5190 if (end
< 0) end
= 0;
5192 /* indexes sanity checks */
5193 if (start
> end
|| start
>= llen
) {
5194 /* Out of range start or start > end result in empty list */
5198 if (end
>= llen
) end
= llen
-1;
5203 /* Remove list elements to perform the trim */
5204 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5205 o
->ptr
= ziplistDeleteRange(o
->ptr
,0,ltrim
);
5206 o
->ptr
= ziplistDeleteRange(o
->ptr
,-rtrim
,rtrim
);
5207 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5209 for (j
= 0; j
< ltrim
; j
++) {
5210 ln
= listFirst(list
);
5211 listDelNode(list
,ln
);
5213 for (j
= 0; j
< rtrim
; j
++) {
5214 ln
= listLast(list
);
5215 listDelNode(list
,ln
);
5218 redisPanic("Unknown list encoding");
5220 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5222 addReply(c
,shared
.ok
);
5225 static void lremCommand(redisClient
*c
) {
5226 robj
*subject
, *obj
= c
->argv
[3];
5227 int toremove
= atoi(c
->argv
[2]->ptr
);
5231 subject
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
);
5232 if (subject
== NULL
|| checkType(c
,subject
,REDIS_LIST
)) return;
5234 /* Make sure obj is raw when we're dealing with a ziplist */
5235 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5236 obj
= getDecodedObject(obj
);
5240 toremove
= -toremove
;
5241 li
= lInitIterator(subject
,-1,REDIS_HEAD
);
5243 li
= lInitIterator(subject
,0,REDIS_TAIL
);
5246 while (lNext(li
,&entry
)) {
5247 if (lEqual(&entry
,obj
)) {
5251 if (toremove
&& removed
== toremove
) break;
5254 lReleaseIterator(li
);
5256 /* Clean up raw encoded object */
5257 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5260 if (lLength(subject
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5261 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
5264 /* This is the semantic of this command:
5265 * RPOPLPUSH srclist dstlist:
5266 * IF LLEN(srclist) > 0
5267 * element = RPOP srclist
5268 * LPUSH dstlist element
5275 * The idea is to be able to get an element from a list in a reliable way
5276 * since the element is not just returned but pushed against another list
5277 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5279 static void rpoplpushcommand(redisClient
*c
) {
5281 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5282 checkType(c
,sobj
,REDIS_LIST
)) return;
5284 if (lLength(sobj
) == 0) {
5285 addReply(c
,shared
.nullbulk
);
5287 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5288 if (dobj
&& checkType(c
,dobj
,REDIS_LIST
)) return;
5289 value
= lPop(sobj
,REDIS_TAIL
);
5291 /* Add the element to the target list (unless it's directly
5292 * passed to some BLPOP-ing client */
5293 if (!handleClientsWaitingListPush(c
,c
->argv
[2],value
)) {
5294 /* Create the list if the key does not exist */
5296 dobj
= createObject(REDIS_LIST
,ziplistNew());
5297 dobj
->encoding
= REDIS_ENCODING_ZIPLIST
;
5298 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
5299 incrRefCount(c
->argv
[2]);
5301 lPush(dobj
,value
,REDIS_HEAD
);
5304 /* Send the element to the client as reply as well */
5305 addReplyBulk(c
,value
);
5307 /* lPop returns an object with its refcount incremented */
5308 decrRefCount(value
);
5310 /* Delete the source list when it is empty */
5311 if (lLength(sobj
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5316 /* ==================================== Sets ================================ */
5318 static void saddCommand(redisClient
*c
) {
5321 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5323 set
= createSetObject();
5324 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5325 incrRefCount(c
->argv
[1]);
5327 if (set
->type
!= REDIS_SET
) {
5328 addReply(c
,shared
.wrongtypeerr
);
5332 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5333 incrRefCount(c
->argv
[2]);
5335 addReply(c
,shared
.cone
);
5337 addReply(c
,shared
.czero
);
5341 static void sremCommand(redisClient
*c
) {
5344 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5345 checkType(c
,set
,REDIS_SET
)) return;
5347 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5349 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5350 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5351 addReply(c
,shared
.cone
);
5353 addReply(c
,shared
.czero
);
5357 static void smoveCommand(redisClient
*c
) {
5358 robj
*srcset
, *dstset
;
5360 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5361 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5363 /* If the source key does not exist return 0, if it's of the wrong type
5365 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5366 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5369 /* Error if the destination key is not a set as well */
5370 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5371 addReply(c
,shared
.wrongtypeerr
);
5374 /* Remove the element from the source set */
5375 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5376 /* Key not found in the src set! return zero */
5377 addReply(c
,shared
.czero
);
5380 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5381 deleteKey(c
->db
,c
->argv
[1]);
5383 /* Add the element to the destination set */
5385 dstset
= createSetObject();
5386 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5387 incrRefCount(c
->argv
[2]);
5389 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5390 incrRefCount(c
->argv
[3]);
5391 addReply(c
,shared
.cone
);
5394 static void sismemberCommand(redisClient
*c
) {
5397 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5398 checkType(c
,set
,REDIS_SET
)) return;
5400 if (dictFind(set
->ptr
,c
->argv
[2]))
5401 addReply(c
,shared
.cone
);
5403 addReply(c
,shared
.czero
);
5406 static void scardCommand(redisClient
*c
) {
5410 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5411 checkType(c
,o
,REDIS_SET
)) return;
5414 addReplyUlong(c
,dictSize(s
));
5417 static void spopCommand(redisClient
*c
) {
5421 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5422 checkType(c
,set
,REDIS_SET
)) return;
5424 de
= dictGetRandomKey(set
->ptr
);
5426 addReply(c
,shared
.nullbulk
);
5428 robj
*ele
= dictGetEntryKey(de
);
5430 addReplyBulk(c
,ele
);
5431 dictDelete(set
->ptr
,ele
);
5432 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5433 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5438 static void srandmemberCommand(redisClient
*c
) {
5442 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5443 checkType(c
,set
,REDIS_SET
)) return;
5445 de
= dictGetRandomKey(set
->ptr
);
5447 addReply(c
,shared
.nullbulk
);
5449 robj
*ele
= dictGetEntryKey(de
);
5451 addReplyBulk(c
,ele
);
5455 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5456 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5458 return dictSize(*d1
)-dictSize(*d2
);
5461 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5462 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5465 robj
*lenobj
= NULL
, *dstset
= NULL
;
5466 unsigned long j
, cardinality
= 0;
5468 for (j
= 0; j
< setsnum
; j
++) {
5472 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5473 lookupKeyRead(c
->db
,setskeys
[j
]);
5477 if (deleteKey(c
->db
,dstkey
))
5479 addReply(c
,shared
.czero
);
5481 addReply(c
,shared
.emptymultibulk
);
5485 if (setobj
->type
!= REDIS_SET
) {
5487 addReply(c
,shared
.wrongtypeerr
);
5490 dv
[j
] = setobj
->ptr
;
5492 /* Sort sets from the smallest to largest, this will improve our
5493 * algorithm's performace */
5494 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5496 /* The first thing we should output is the total number of elements...
5497 * since this is a multi-bulk write, but at this stage we don't know
5498 * the intersection set size, so we use a trick, append an empty object
5499 * to the output list and save the pointer to later modify it with the
5502 lenobj
= createObject(REDIS_STRING
,NULL
);
5504 decrRefCount(lenobj
);
5506 /* If we have a target key where to store the resulting set
5507 * create this key with an empty set inside */
5508 dstset
= createSetObject();
5511 /* Iterate all the elements of the first (smallest) set, and test
5512 * the element against all the other sets, if at least one set does
5513 * not include the element it is discarded */
5514 di
= dictGetIterator(dv
[0]);
5516 while((de
= dictNext(di
)) != NULL
) {
5519 for (j
= 1; j
< setsnum
; j
++)
5520 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5522 continue; /* at least one set does not contain the member */
5523 ele
= dictGetEntryKey(de
);
5525 addReplyBulk(c
,ele
);
5528 dictAdd(dstset
->ptr
,ele
,NULL
);
5532 dictReleaseIterator(di
);
5535 /* Store the resulting set into the target, if the intersection
5536 * is not an empty set. */
5537 deleteKey(c
->db
,dstkey
);
5538 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5539 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5540 incrRefCount(dstkey
);
5541 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5543 decrRefCount(dstset
);
5544 addReply(c
,shared
.czero
);
5548 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5553 static void sinterCommand(redisClient
*c
) {
5554 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5557 static void sinterstoreCommand(redisClient
*c
) {
5558 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5561 #define REDIS_OP_UNION 0
5562 #define REDIS_OP_DIFF 1
5563 #define REDIS_OP_INTER 2
5565 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5566 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5569 robj
*dstset
= NULL
;
5570 int j
, cardinality
= 0;
5572 for (j
= 0; j
< setsnum
; j
++) {
5576 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5577 lookupKeyRead(c
->db
,setskeys
[j
]);
5582 if (setobj
->type
!= REDIS_SET
) {
5584 addReply(c
,shared
.wrongtypeerr
);
5587 dv
[j
] = setobj
->ptr
;
5590 /* We need a temp set object to store our union. If the dstkey
5591 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5592 * this set object will be the resulting object to set into the target key*/
5593 dstset
= createSetObject();
5595 /* Iterate all the elements of all the sets, add every element a single
5596 * time to the result set */
5597 for (j
= 0; j
< setsnum
; j
++) {
5598 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5599 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5601 di
= dictGetIterator(dv
[j
]);
5603 while((de
= dictNext(di
)) != NULL
) {
5606 /* dictAdd will not add the same element multiple times */
5607 ele
= dictGetEntryKey(de
);
5608 if (op
== REDIS_OP_UNION
|| j
== 0) {
5609 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5613 } else if (op
== REDIS_OP_DIFF
) {
5614 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5619 dictReleaseIterator(di
);
5621 /* result set is empty? Exit asap. */
5622 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5625 /* Output the content of the resulting set, if not in STORE mode */
5627 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5628 di
= dictGetIterator(dstset
->ptr
);
5629 while((de
= dictNext(di
)) != NULL
) {
5632 ele
= dictGetEntryKey(de
);
5633 addReplyBulk(c
,ele
);
5635 dictReleaseIterator(di
);
5636 decrRefCount(dstset
);
5638 /* If we have a target key where to store the resulting set
5639 * create this key with the result set inside */
5640 deleteKey(c
->db
,dstkey
);
5641 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5642 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5643 incrRefCount(dstkey
);
5644 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5646 decrRefCount(dstset
);
5647 addReply(c
,shared
.czero
);
5654 static void sunionCommand(redisClient
*c
) {
5655 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5658 static void sunionstoreCommand(redisClient
*c
) {
5659 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5662 static void sdiffCommand(redisClient
*c
) {
5663 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5666 static void sdiffstoreCommand(redisClient
*c
) {
5667 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5670 /* ==================================== ZSets =============================== */
5672 /* ZSETs are ordered sets using two data structures to hold the same elements
5673 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5676 * The elements are added to an hash table mapping Redis objects to scores.
5677 * At the same time the elements are added to a skip list mapping scores
5678 * to Redis objects (so objects are sorted by scores in this "view"). */
5680 /* This skiplist implementation is almost a C translation of the original
5681 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5682 * Alternative to Balanced Trees", modified in three ways:
5683 * a) this implementation allows for repeated values.
5684 * b) the comparison is not just by key (our 'score') but by satellite data.
5685 * c) there is a back pointer, so it's a doubly linked list with the back
5686 * pointers being only at "level 1". This allows to traverse the list
5687 * from tail to head, useful for ZREVRANGE. */
5689 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5690 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5692 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5694 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5702 static zskiplist
*zslCreate(void) {
5706 zsl
= zmalloc(sizeof(*zsl
));
5709 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5710 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5711 zsl
->header
->forward
[j
] = NULL
;
5713 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5714 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5715 zsl
->header
->span
[j
] = 0;
5717 zsl
->header
->backward
= NULL
;
5722 static void zslFreeNode(zskiplistNode
*node
) {
5723 decrRefCount(node
->obj
);
5724 zfree(node
->forward
);
5729 static void zslFree(zskiplist
*zsl
) {
5730 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5732 zfree(zsl
->header
->forward
);
5733 zfree(zsl
->header
->span
);
5736 next
= node
->forward
[0];
5743 static int zslRandomLevel(void) {
5745 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5747 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5750 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5751 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5752 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5756 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5757 /* store rank that is crossed to reach the insert position */
5758 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5760 while (x
->forward
[i
] &&
5761 (x
->forward
[i
]->score
< score
||
5762 (x
->forward
[i
]->score
== score
&&
5763 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5764 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5769 /* we assume the key is not already inside, since we allow duplicated
5770 * scores, and the re-insertion of score and redis object should never
5771 * happpen since the caller of zslInsert() should test in the hash table
5772 * if the element is already inside or not. */
5773 level
= zslRandomLevel();
5774 if (level
> zsl
->level
) {
5775 for (i
= zsl
->level
; i
< level
; i
++) {
5777 update
[i
] = zsl
->header
;
5778 update
[i
]->span
[i
-1] = zsl
->length
;
5782 x
= zslCreateNode(level
,score
,obj
);
5783 for (i
= 0; i
< level
; i
++) {
5784 x
->forward
[i
] = update
[i
]->forward
[i
];
5785 update
[i
]->forward
[i
] = x
;
5787 /* update span covered by update[i] as x is inserted here */
5789 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5790 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5794 /* increment span for untouched levels */
5795 for (i
= level
; i
< zsl
->level
; i
++) {
5796 update
[i
]->span
[i
-1]++;
5799 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5801 x
->forward
[0]->backward
= x
;
5807 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5808 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5810 for (i
= 0; i
< zsl
->level
; i
++) {
5811 if (update
[i
]->forward
[i
] == x
) {
5813 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5815 update
[i
]->forward
[i
] = x
->forward
[i
];
5817 /* invariant: i > 0, because update[0]->forward[0]
5818 * is always equal to x */
5819 update
[i
]->span
[i
-1] -= 1;
5822 if (x
->forward
[0]) {
5823 x
->forward
[0]->backward
= x
->backward
;
5825 zsl
->tail
= x
->backward
;
5827 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5832 /* Delete an element with matching score/object from the skiplist. */
5833 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5834 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5838 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5839 while (x
->forward
[i
] &&
5840 (x
->forward
[i
]->score
< score
||
5841 (x
->forward
[i
]->score
== score
&&
5842 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5846 /* We may have multiple elements with the same score, what we need
5847 * is to find the element with both the right score and object. */
5849 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5850 zslDeleteNode(zsl
, x
, update
);
5854 return 0; /* not found */
5856 return 0; /* not found */
5859 /* Delete all the elements with score between min and max from the skiplist.
5860 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5861 * Note that this function takes the reference to the hash table view of the
5862 * sorted set, in order to remove the elements from the hash table too. */
5863 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5864 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5865 unsigned long removed
= 0;
5869 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5870 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5874 /* We may have multiple elements with the same score, what we need
5875 * is to find the element with both the right score and object. */
5877 while (x
&& x
->score
<= max
) {
5878 zskiplistNode
*next
= x
->forward
[0];
5879 zslDeleteNode(zsl
, x
, update
);
5880 dictDelete(dict
,x
->obj
);
5885 return removed
; /* not found */
5888 /* Delete all the elements with rank between start and end from the skiplist.
5889 * Start and end are inclusive. Note that start and end need to be 1-based */
5890 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5891 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5892 unsigned long traversed
= 0, removed
= 0;
5896 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5897 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5898 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5906 while (x
&& traversed
<= end
) {
5907 zskiplistNode
*next
= x
->forward
[0];
5908 zslDeleteNode(zsl
, x
, update
);
5909 dictDelete(dict
,x
->obj
);
5918 /* Find the first node having a score equal or greater than the specified one.
5919 * Returns NULL if there is no match. */
5920 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5925 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5926 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5929 /* We may have multiple elements with the same score, what we need
5930 * is to find the element with both the right score and object. */
5931 return x
->forward
[0];
5934 /* Find the rank for an element by both score and key.
5935 * Returns 0 when the element cannot be found, rank otherwise.
5936 * Note that the rank is 1-based due to the span of zsl->header to the
5938 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5940 unsigned long rank
= 0;
5944 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5945 while (x
->forward
[i
] &&
5946 (x
->forward
[i
]->score
< score
||
5947 (x
->forward
[i
]->score
== score
&&
5948 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5949 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5953 /* x might be equal to zsl->header, so test if obj is non-NULL */
5954 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5961 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5962 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5964 unsigned long traversed
= 0;
5968 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5969 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5971 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5974 if (traversed
== rank
) {
5981 /* The actual Z-commands implementations */
5983 /* This generic command implements both ZADD and ZINCRBY.
5984 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5985 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5986 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5991 if (isnan(scoreval
)) {
5992 addReplySds(c
,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
5996 zsetobj
= lookupKeyWrite(c
->db
,key
);
5997 if (zsetobj
== NULL
) {
5998 zsetobj
= createZsetObject();
5999 dictAdd(c
->db
->dict
,key
,zsetobj
);
6002 if (zsetobj
->type
!= REDIS_ZSET
) {
6003 addReply(c
,shared
.wrongtypeerr
);
6009 /* Ok now since we implement both ZADD and ZINCRBY here the code
6010 * needs to handle the two different conditions. It's all about setting
6011 * '*score', that is, the new score to set, to the right value. */
6012 score
= zmalloc(sizeof(double));
6016 /* Read the old score. If the element was not present starts from 0 */
6017 de
= dictFind(zs
->dict
,ele
);
6019 double *oldscore
= dictGetEntryVal(de
);
6020 *score
= *oldscore
+ scoreval
;
6024 if (isnan(*score
)) {
6026 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6028 /* Note that we don't need to check if the zset may be empty and
6029 * should be removed here, as we can only obtain Nan as score if
6030 * there was already an element in the sorted set. */
6037 /* What follows is a simple remove and re-insert operation that is common
6038 * to both ZADD and ZINCRBY... */
6039 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
6040 /* case 1: New element */
6041 incrRefCount(ele
); /* added to hash */
6042 zslInsert(zs
->zsl
,*score
,ele
);
6043 incrRefCount(ele
); /* added to skiplist */
6046 addReplyDouble(c
,*score
);
6048 addReply(c
,shared
.cone
);
6053 /* case 2: Score update operation */
6054 de
= dictFind(zs
->dict
,ele
);
6055 redisAssert(de
!= NULL
);
6056 oldscore
= dictGetEntryVal(de
);
6057 if (*score
!= *oldscore
) {
6060 /* Remove and insert the element in the skip list with new score */
6061 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
6062 redisAssert(deleted
!= 0);
6063 zslInsert(zs
->zsl
,*score
,ele
);
6065 /* Update the score in the hash table */
6066 dictReplace(zs
->dict
,ele
,score
);
6072 addReplyDouble(c
,*score
);
6074 addReply(c
,shared
.czero
);
6078 static void zaddCommand(redisClient
*c
) {
6081 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6082 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
6085 static void zincrbyCommand(redisClient
*c
) {
6088 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6089 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
6092 static void zremCommand(redisClient
*c
) {
6099 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6100 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6103 de
= dictFind(zs
->dict
,c
->argv
[2]);
6105 addReply(c
,shared
.czero
);
6108 /* Delete from the skiplist */
6109 oldscore
= dictGetEntryVal(de
);
6110 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
6111 redisAssert(deleted
!= 0);
6113 /* Delete from the hash table */
6114 dictDelete(zs
->dict
,c
->argv
[2]);
6115 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6116 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6118 addReply(c
,shared
.cone
);
6121 static void zremrangebyscoreCommand(redisClient
*c
) {
6128 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
6129 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
6131 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6132 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6135 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
6136 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6137 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6138 server
.dirty
+= deleted
;
6139 addReplyLongLong(c
,deleted
);
6142 static void zremrangebyrankCommand(redisClient
*c
) {
6150 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6151 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6153 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6154 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6156 llen
= zs
->zsl
->length
;
6158 /* convert negative indexes */
6159 if (start
< 0) start
= llen
+start
;
6160 if (end
< 0) end
= llen
+end
;
6161 if (start
< 0) start
= 0;
6162 if (end
< 0) end
= 0;
6164 /* indexes sanity checks */
6165 if (start
> end
|| start
>= llen
) {
6166 addReply(c
,shared
.czero
);
6169 if (end
>= llen
) end
= llen
-1;
6171 /* increment start and end because zsl*Rank functions
6172 * use 1-based rank */
6173 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
6174 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6175 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6176 server
.dirty
+= deleted
;
6177 addReplyLongLong(c
, deleted
);
6185 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
6186 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
6187 unsigned long size1
, size2
;
6188 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
6189 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
6190 return size1
- size2
;
6193 #define REDIS_AGGR_SUM 1
6194 #define REDIS_AGGR_MIN 2
6195 #define REDIS_AGGR_MAX 3
6196 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6198 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
6199 if (aggregate
== REDIS_AGGR_SUM
) {
6200 *target
= *target
+ val
;
6201 } else if (aggregate
== REDIS_AGGR_MIN
) {
6202 *target
= val
< *target
? val
: *target
;
6203 } else if (aggregate
== REDIS_AGGR_MAX
) {
6204 *target
= val
> *target
? val
: *target
;
6207 redisPanic("Unknown ZUNION/INTER aggregate type");
6211 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
6213 int aggregate
= REDIS_AGGR_SUM
;
6220 /* expect setnum input keys to be given */
6221 setnum
= atoi(c
->argv
[2]->ptr
);
6223 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6227 /* test if the expected number of keys would overflow */
6228 if (3+setnum
> c
->argc
) {
6229 addReply(c
,shared
.syntaxerr
);
6233 /* read keys to be used for input */
6234 src
= zmalloc(sizeof(zsetopsrc
) * setnum
);
6235 for (i
= 0, j
= 3; i
< setnum
; i
++, j
++) {
6236 robj
*obj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6240 if (obj
->type
== REDIS_ZSET
) {
6241 src
[i
].dict
= ((zset
*)obj
->ptr
)->dict
;
6242 } else if (obj
->type
== REDIS_SET
) {
6243 src
[i
].dict
= (obj
->ptr
);
6246 addReply(c
,shared
.wrongtypeerr
);
6251 /* default all weights to 1 */
6252 src
[i
].weight
= 1.0;
6255 /* parse optional extra arguments */
6257 int remaining
= c
->argc
- j
;
6260 if (remaining
>= (setnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
6262 for (i
= 0; i
< setnum
; i
++, j
++, remaining
--) {
6263 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
6266 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
6268 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
6269 aggregate
= REDIS_AGGR_SUM
;
6270 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
6271 aggregate
= REDIS_AGGR_MIN
;
6272 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
6273 aggregate
= REDIS_AGGR_MAX
;
6276 addReply(c
,shared
.syntaxerr
);
6282 addReply(c
,shared
.syntaxerr
);
6288 /* sort sets from the smallest to largest, this will improve our
6289 * algorithm's performance */
6290 qsort(src
,setnum
,sizeof(zsetopsrc
),qsortCompareZsetopsrcByCardinality
);
6292 dstobj
= createZsetObject();
6293 dstzset
= dstobj
->ptr
;
6295 if (op
== REDIS_OP_INTER
) {
6296 /* skip going over all entries if the smallest zset is NULL or empty */
6297 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
6298 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6299 * from small to large, all src[i > 0].dict are non-empty too */
6300 di
= dictGetIterator(src
[0].dict
);
6301 while((de
= dictNext(di
)) != NULL
) {
6302 double *score
= zmalloc(sizeof(double)), value
;
6303 *score
= src
[0].weight
* zunionInterDictValue(de
);
6305 for (j
= 1; j
< setnum
; j
++) {
6306 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6308 value
= src
[j
].weight
* zunionInterDictValue(other
);
6309 zunionInterAggregate(score
, value
, aggregate
);
6315 /* skip entry when not present in every source dict */
6319 robj
*o
= dictGetEntryKey(de
);
6320 dictAdd(dstzset
->dict
,o
,score
);
6321 incrRefCount(o
); /* added to dictionary */
6322 zslInsert(dstzset
->zsl
,*score
,o
);
6323 incrRefCount(o
); /* added to skiplist */
6326 dictReleaseIterator(di
);
6328 } else if (op
== REDIS_OP_UNION
) {
6329 for (i
= 0; i
< setnum
; i
++) {
6330 if (!src
[i
].dict
) continue;
6332 di
= dictGetIterator(src
[i
].dict
);
6333 while((de
= dictNext(di
)) != NULL
) {
6334 /* skip key when already processed */
6335 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6337 double *score
= zmalloc(sizeof(double)), value
;
6338 *score
= src
[i
].weight
* zunionInterDictValue(de
);
6340 /* because the zsets are sorted by size, its only possible
6341 * for sets at larger indices to hold this entry */
6342 for (j
= (i
+1); j
< setnum
; j
++) {
6343 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6345 value
= src
[j
].weight
* zunionInterDictValue(other
);
6346 zunionInterAggregate(score
, value
, aggregate
);
6350 robj
*o
= dictGetEntryKey(de
);
6351 dictAdd(dstzset
->dict
,o
,score
);
6352 incrRefCount(o
); /* added to dictionary */
6353 zslInsert(dstzset
->zsl
,*score
,o
);
6354 incrRefCount(o
); /* added to skiplist */
6356 dictReleaseIterator(di
);
6359 /* unknown operator */
6360 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6363 deleteKey(c
->db
,dstkey
);
6364 if (dstzset
->zsl
->length
) {
6365 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6366 incrRefCount(dstkey
);
6367 addReplyLongLong(c
, dstzset
->zsl
->length
);
6370 decrRefCount(dstobj
);
6371 addReply(c
, shared
.czero
);
6376 static void zunionstoreCommand(redisClient
*c
) {
6377 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6380 static void zinterstoreCommand(redisClient
*c
) {
6381 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6384 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6396 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6397 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6399 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6401 } else if (c
->argc
>= 5) {
6402 addReply(c
,shared
.syntaxerr
);
6406 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6407 || checkType(c
,o
,REDIS_ZSET
)) return;
6412 /* convert negative indexes */
6413 if (start
< 0) start
= llen
+start
;
6414 if (end
< 0) end
= llen
+end
;
6415 if (start
< 0) start
= 0;
6416 if (end
< 0) end
= 0;
6418 /* indexes sanity checks */
6419 if (start
> end
|| start
>= llen
) {
6420 /* Out of range start or start > end result in empty list */
6421 addReply(c
,shared
.emptymultibulk
);
6424 if (end
>= llen
) end
= llen
-1;
6425 rangelen
= (end
-start
)+1;
6427 /* check if starting point is trivial, before searching
6428 * the element in log(N) time */
6430 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6433 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6436 /* Return the result in form of a multi-bulk reply */
6437 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6438 withscores
? (rangelen
*2) : rangelen
));
6439 for (j
= 0; j
< rangelen
; j
++) {
6441 addReplyBulk(c
,ele
);
6443 addReplyDouble(c
,ln
->score
);
6444 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6448 static void zrangeCommand(redisClient
*c
) {
6449 zrangeGenericCommand(c
,0);
6452 static void zrevrangeCommand(redisClient
*c
) {
6453 zrangeGenericCommand(c
,1);
6456 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6457 * If justcount is non-zero, just the count is returned. */
6458 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6461 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6462 int offset
= 0, limit
= -1;
6466 /* Parse the min-max interval. If one of the values is prefixed
6467 * by the "(" character, it's considered "open". For instance
6468 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6469 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6470 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6471 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6474 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6476 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6477 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6480 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6483 /* Parse "WITHSCORES": note that if the command was called with
6484 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6485 * enter the following paths to parse WITHSCORES and LIMIT. */
6486 if (c
->argc
== 5 || c
->argc
== 8) {
6487 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6492 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6496 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6501 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6502 addReply(c
,shared
.syntaxerr
);
6504 } else if (c
->argc
== (7 + withscores
)) {
6505 offset
= atoi(c
->argv
[5]->ptr
);
6506 limit
= atoi(c
->argv
[6]->ptr
);
6507 if (offset
< 0) offset
= 0;
6510 /* Ok, lookup the key and get the range */
6511 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6513 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6515 if (o
->type
!= REDIS_ZSET
) {
6516 addReply(c
,shared
.wrongtypeerr
);
6518 zset
*zsetobj
= o
->ptr
;
6519 zskiplist
*zsl
= zsetobj
->zsl
;
6521 robj
*ele
, *lenobj
= NULL
;
6522 unsigned long rangelen
= 0;
6524 /* Get the first node with the score >= min, or with
6525 * score > min if 'minex' is true. */
6526 ln
= zslFirstWithScore(zsl
,min
);
6527 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6530 /* No element matching the speciifed interval */
6531 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6535 /* We don't know in advance how many matching elements there
6536 * are in the list, so we push this object that will represent
6537 * the multi-bulk length in the output buffer, and will "fix"
6540 lenobj
= createObject(REDIS_STRING
,NULL
);
6542 decrRefCount(lenobj
);
6545 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6548 ln
= ln
->forward
[0];
6551 if (limit
== 0) break;
6554 addReplyBulk(c
,ele
);
6556 addReplyDouble(c
,ln
->score
);
6558 ln
= ln
->forward
[0];
6560 if (limit
> 0) limit
--;
6563 addReplyLongLong(c
,(long)rangelen
);
6565 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6566 withscores
? (rangelen
*2) : rangelen
);
6572 static void zrangebyscoreCommand(redisClient
*c
) {
6573 genericZrangebyscoreCommand(c
,0);
6576 static void zcountCommand(redisClient
*c
) {
6577 genericZrangebyscoreCommand(c
,1);
6580 static void zcardCommand(redisClient
*c
) {
6584 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6585 checkType(c
,o
,REDIS_ZSET
)) return;
6588 addReplyUlong(c
,zs
->zsl
->length
);
6591 static void zscoreCommand(redisClient
*c
) {
6596 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6597 checkType(c
,o
,REDIS_ZSET
)) return;
6600 de
= dictFind(zs
->dict
,c
->argv
[2]);
6602 addReply(c
,shared
.nullbulk
);
6604 double *score
= dictGetEntryVal(de
);
6606 addReplyDouble(c
,*score
);
6610 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6618 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6619 checkType(c
,o
,REDIS_ZSET
)) return;
6623 de
= dictFind(zs
->dict
,c
->argv
[2]);
6625 addReply(c
,shared
.nullbulk
);
6629 score
= dictGetEntryVal(de
);
6630 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6633 addReplyLongLong(c
, zsl
->length
- rank
);
6635 addReplyLongLong(c
, rank
-1);
6638 addReply(c
,shared
.nullbulk
);
6642 static void zrankCommand(redisClient
*c
) {
6643 zrankGenericCommand(c
, 0);
6646 static void zrevrankCommand(redisClient
*c
) {
6647 zrankGenericCommand(c
, 1);
6650 /* ========================= Hashes utility functions ======================= */
6651 #define REDIS_HASH_KEY 1
6652 #define REDIS_HASH_VALUE 2
6654 /* Check the length of a number of objects to see if we need to convert a
6655 * zipmap to a real hash. Note that we only check string encoded objects
6656 * as their string length can be queried in constant time. */
6657 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6659 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6661 for (i
= start
; i
<= end
; i
++) {
6662 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6663 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6665 convertToRealHash(subject
);
6671 /* Encode given objects in-place when the hash uses a dict. */
6672 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6673 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6674 if (o1
) *o1
= tryObjectEncoding(*o1
);
6675 if (o2
) *o2
= tryObjectEncoding(*o2
);
6679 /* Get the value from a hash identified by key. Returns either a string
6680 * object or NULL if the value cannot be found. The refcount of the object
6681 * is always increased by 1 when the value was found. */
6682 static robj
*hashGet(robj
*o
, robj
*key
) {
6684 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6687 key
= getDecodedObject(key
);
6688 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6689 value
= createStringObject((char*)v
,vlen
);
6693 dictEntry
*de
= dictFind(o
->ptr
,key
);
6695 value
= dictGetEntryVal(de
);
6696 incrRefCount(value
);
6702 /* Test if the key exists in the given hash. Returns 1 if the key
6703 * exists and 0 when it doesn't. */
6704 static int hashExists(robj
*o
, robj
*key
) {
6705 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6706 key
= getDecodedObject(key
);
6707 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6713 if (dictFind(o
->ptr
,key
) != NULL
) {
6720 /* Add an element, discard the old if the key already exists.
6721 * Return 0 on insert and 1 on update. */
6722 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6724 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6725 key
= getDecodedObject(key
);
6726 value
= getDecodedObject(value
);
6727 o
->ptr
= zipmapSet(o
->ptr
,
6728 key
->ptr
,sdslen(key
->ptr
),
6729 value
->ptr
,sdslen(value
->ptr
), &update
);
6731 decrRefCount(value
);
6733 /* Check if the zipmap needs to be upgraded to a real hash table */
6734 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6735 convertToRealHash(o
);
6737 if (dictReplace(o
->ptr
,key
,value
)) {
6744 incrRefCount(value
);
6749 /* Delete an element from a hash.
6750 * Return 1 on deleted and 0 on not found. */
6751 static int hashDelete(robj
*o
, robj
*key
) {
6753 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6754 key
= getDecodedObject(key
);
6755 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6758 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6759 /* Always check if the dictionary needs a resize after a delete. */
6760 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6765 /* Return the number of elements in a hash. */
6766 static unsigned long hashLength(robj
*o
) {
6767 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6768 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6771 /* Structure to hold hash iteration abstration. Note that iteration over
6772 * hashes involves both fields and values. Because it is possible that
6773 * not both are required, store pointers in the iterator to avoid
6774 * unnecessary memory allocation for fields/values. */
6778 unsigned char *zk
, *zv
;
6779 unsigned int zklen
, zvlen
;
6785 static hashIterator
*hashInitIterator(robj
*subject
) {
6786 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6787 hi
->encoding
= subject
->encoding
;
6788 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6789 hi
->zi
= zipmapRewind(subject
->ptr
);
6790 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6791 hi
->di
= dictGetIterator(subject
->ptr
);
6798 static void hashReleaseIterator(hashIterator
*hi
) {
6799 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6800 dictReleaseIterator(hi
->di
);
6805 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6806 * could be found and REDIS_ERR when the iterator reaches the end. */
6807 static int hashNext(hashIterator
*hi
) {
6808 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6809 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6810 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6812 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6817 /* Get key or value object at current iteration position.
6818 * This increases the refcount of the field object by 1. */
6819 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6821 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6822 if (what
& REDIS_HASH_KEY
) {
6823 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6825 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6828 if (what
& REDIS_HASH_KEY
) {
6829 o
= dictGetEntryKey(hi
->de
);
6831 o
= dictGetEntryVal(hi
->de
);
6838 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6839 robj
*o
= lookupKeyWrite(c
->db
,key
);
6841 o
= createHashObject();
6842 dictAdd(c
->db
->dict
,key
,o
);
6845 if (o
->type
!= REDIS_HASH
) {
6846 addReply(c
,shared
.wrongtypeerr
);
6853 /* ============================= Hash commands ============================== */
6854 static void hsetCommand(redisClient
*c
) {
6858 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6859 hashTryConversion(o
,c
->argv
,2,3);
6860 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6861 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6862 addReply(c
, update
? shared
.czero
: shared
.cone
);
6866 static void hsetnxCommand(redisClient
*c
) {
6868 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6869 hashTryConversion(o
,c
->argv
,2,3);
6871 if (hashExists(o
, c
->argv
[2])) {
6872 addReply(c
, shared
.czero
);
6874 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6875 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6876 addReply(c
, shared
.cone
);
6881 static void hmsetCommand(redisClient
*c
) {
6885 if ((c
->argc
% 2) == 1) {
6886 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6890 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6891 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6892 for (i
= 2; i
< c
->argc
; i
+= 2) {
6893 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6894 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6896 addReply(c
, shared
.ok
);
6900 static void hincrbyCommand(redisClient
*c
) {
6901 long long value
, incr
;
6902 robj
*o
, *current
, *new;
6904 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6905 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6906 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6907 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6908 "hash value is not an integer") != REDIS_OK
) {
6909 decrRefCount(current
);
6912 decrRefCount(current
);
6918 new = createStringObjectFromLongLong(value
);
6919 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6920 hashSet(o
,c
->argv
[2],new);
6922 addReplyLongLong(c
,value
);
6926 static void hgetCommand(redisClient
*c
) {
6928 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6929 checkType(c
,o
,REDIS_HASH
)) return;
6931 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6932 addReplyBulk(c
,value
);
6933 decrRefCount(value
);
6935 addReply(c
,shared
.nullbulk
);
6939 static void hmgetCommand(redisClient
*c
) {
6942 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6943 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6944 addReply(c
,shared
.wrongtypeerr
);
6947 /* Note the check for o != NULL happens inside the loop. This is
6948 * done because objects that cannot be found are considered to be
6949 * an empty hash. The reply should then be a series of NULLs. */
6950 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6951 for (i
= 2; i
< c
->argc
; i
++) {
6952 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6953 addReplyBulk(c
,value
);
6954 decrRefCount(value
);
6956 addReply(c
,shared
.nullbulk
);
6961 static void hdelCommand(redisClient
*c
) {
6963 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6964 checkType(c
,o
,REDIS_HASH
)) return;
6966 if (hashDelete(o
,c
->argv
[2])) {
6967 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6968 addReply(c
,shared
.cone
);
6971 addReply(c
,shared
.czero
);
6975 static void hlenCommand(redisClient
*c
) {
6977 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6978 checkType(c
,o
,REDIS_HASH
)) return;
6980 addReplyUlong(c
,hashLength(o
));
6983 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6984 robj
*o
, *lenobj
, *obj
;
6985 unsigned long count
= 0;
6988 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6989 || checkType(c
,o
,REDIS_HASH
)) return;
6991 lenobj
= createObject(REDIS_STRING
,NULL
);
6993 decrRefCount(lenobj
);
6995 hi
= hashInitIterator(o
);
6996 while (hashNext(hi
) != REDIS_ERR
) {
6997 if (flags
& REDIS_HASH_KEY
) {
6998 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6999 addReplyBulk(c
,obj
);
7003 if (flags
& REDIS_HASH_VALUE
) {
7004 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
7005 addReplyBulk(c
,obj
);
7010 hashReleaseIterator(hi
);
7012 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
7015 static void hkeysCommand(redisClient
*c
) {
7016 genericHgetallCommand(c
,REDIS_HASH_KEY
);
7019 static void hvalsCommand(redisClient
*c
) {
7020 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
7023 static void hgetallCommand(redisClient
*c
) {
7024 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
7027 static void hexistsCommand(redisClient
*c
) {
7029 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7030 checkType(c
,o
,REDIS_HASH
)) return;
7032 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
7035 static void convertToRealHash(robj
*o
) {
7036 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
7037 unsigned int klen
, vlen
;
7038 dict
*dict
= dictCreate(&hashDictType
,NULL
);
7040 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
7041 p
= zipmapRewind(zm
);
7042 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
7043 robj
*keyobj
, *valobj
;
7045 keyobj
= createStringObject((char*)key
,klen
);
7046 valobj
= createStringObject((char*)val
,vlen
);
7047 keyobj
= tryObjectEncoding(keyobj
);
7048 valobj
= tryObjectEncoding(valobj
);
7049 dictAdd(dict
,keyobj
,valobj
);
7051 o
->encoding
= REDIS_ENCODING_HT
;
7056 /* ========================= Non type-specific commands ==================== */
7058 static void flushdbCommand(redisClient
*c
) {
7059 server
.dirty
+= dictSize(c
->db
->dict
);
7060 touchWatchedKeysOnFlush(c
->db
->id
);
7061 dictEmpty(c
->db
->dict
);
7062 dictEmpty(c
->db
->expires
);
7063 addReply(c
,shared
.ok
);
7066 static void flushallCommand(redisClient
*c
) {
7067 touchWatchedKeysOnFlush(-1);
7068 server
.dirty
+= emptyDb();
7069 addReply(c
,shared
.ok
);
7070 if (server
.bgsavechildpid
!= -1) {
7071 kill(server
.bgsavechildpid
,SIGKILL
);
7072 rdbRemoveTempFile(server
.bgsavechildpid
);
7074 rdbSave(server
.dbfilename
);
7078 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
7079 redisSortOperation
*so
= zmalloc(sizeof(*so
));
7081 so
->pattern
= pattern
;
7085 /* Return the value associated to the key with a name obtained
7086 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7087 * The returned object will always have its refcount increased by 1
7088 * when it is non-NULL. */
7089 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
7092 robj keyobj
, fieldobj
, *o
;
7093 int prefixlen
, sublen
, postfixlen
, fieldlen
;
7094 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7098 char buf
[REDIS_SORTKEY_MAX
+1];
7099 } keyname
, fieldname
;
7101 /* If the pattern is "#" return the substitution object itself in order
7102 * to implement the "SORT ... GET #" feature. */
7103 spat
= pattern
->ptr
;
7104 if (spat
[0] == '#' && spat
[1] == '\0') {
7105 incrRefCount(subst
);
7109 /* The substitution object may be specially encoded. If so we create
7110 * a decoded object on the fly. Otherwise getDecodedObject will just
7111 * increment the ref count, that we'll decrement later. */
7112 subst
= getDecodedObject(subst
);
7115 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
7116 p
= strchr(spat
,'*');
7118 decrRefCount(subst
);
7122 /* Find out if we're dealing with a hash dereference. */
7123 if ((f
= strstr(p
+1, "->")) != NULL
) {
7124 fieldlen
= sdslen(spat
)-(f
-spat
);
7125 /* this also copies \0 character */
7126 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
7127 fieldname
.len
= fieldlen
-2;
7133 sublen
= sdslen(ssub
);
7134 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
7135 memcpy(keyname
.buf
,spat
,prefixlen
);
7136 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
7137 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
7138 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
7139 keyname
.len
= prefixlen
+sublen
+postfixlen
;
7140 decrRefCount(subst
);
7142 /* Lookup substituted key */
7143 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
7144 o
= lookupKeyRead(db
,&keyobj
);
7145 if (o
== NULL
) return NULL
;
7148 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
7150 /* Retrieve value from hash by the field name. This operation
7151 * already increases the refcount of the returned object. */
7152 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
7153 o
= hashGet(o
, &fieldobj
);
7155 if (o
->type
!= REDIS_STRING
) return NULL
;
7157 /* Every object that this function returns needs to have its refcount
7158 * increased. sortCommand decreases it again. */
7165 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7166 * the additional parameter is not standard but a BSD-specific we have to
7167 * pass sorting parameters via the global 'server' structure */
7168 static int sortCompare(const void *s1
, const void *s2
) {
7169 const redisSortObject
*so1
= s1
, *so2
= s2
;
7172 if (!server
.sort_alpha
) {
7173 /* Numeric sorting. Here it's trivial as we precomputed scores */
7174 if (so1
->u
.score
> so2
->u
.score
) {
7176 } else if (so1
->u
.score
< so2
->u
.score
) {
7182 /* Alphanumeric sorting */
7183 if (server
.sort_bypattern
) {
7184 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
7185 /* At least one compare object is NULL */
7186 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
7188 else if (so1
->u
.cmpobj
== NULL
)
7193 /* We have both the objects, use strcoll */
7194 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
7197 /* Compare elements directly. */
7198 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
7201 return server
.sort_desc
? -cmp
: cmp
;
7204 /* The SORT command is the most complex command in Redis. Warning: this code
7205 * is optimized for speed and a bit less for readability */
7206 static void sortCommand(redisClient
*c
) {
7209 int desc
= 0, alpha
= 0;
7210 int limit_start
= 0, limit_count
= -1, start
, end
;
7211 int j
, dontsort
= 0, vectorlen
;
7212 int getop
= 0; /* GET operation counter */
7213 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
7214 redisSortObject
*vector
; /* Resulting vector to sort */
7216 /* Lookup the key to sort. It must be of the right types */
7217 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
7218 if (sortval
== NULL
) {
7219 addReply(c
,shared
.emptymultibulk
);
7222 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
7223 sortval
->type
!= REDIS_ZSET
)
7225 addReply(c
,shared
.wrongtypeerr
);
7229 /* Create a list of operations to perform for every sorted element.
7230 * Operations can be GET/DEL/INCR/DECR */
7231 operations
= listCreate();
7232 listSetFreeMethod(operations
,zfree
);
7235 /* Now we need to protect sortval incrementing its count, in the future
7236 * SORT may have options able to overwrite/delete keys during the sorting
7237 * and the sorted key itself may get destroied */
7238 incrRefCount(sortval
);
7240 /* The SORT command has an SQL-alike syntax, parse it */
7241 while(j
< c
->argc
) {
7242 int leftargs
= c
->argc
-j
-1;
7243 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
7245 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
7247 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
7249 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
7250 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
7251 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
7253 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
7254 storekey
= c
->argv
[j
+1];
7256 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
7257 sortby
= c
->argv
[j
+1];
7258 /* If the BY pattern does not contain '*', i.e. it is constant,
7259 * we don't need to sort nor to lookup the weight keys. */
7260 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
7262 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
7263 listAddNodeTail(operations
,createSortOperation(
7264 REDIS_SORT_GET
,c
->argv
[j
+1]));
7268 decrRefCount(sortval
);
7269 listRelease(operations
);
7270 addReply(c
,shared
.syntaxerr
);
7276 /* Load the sorting vector with all the objects to sort */
7277 switch(sortval
->type
) {
7278 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
7279 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
7280 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
7281 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7283 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
7286 if (sortval
->type
== REDIS_LIST
) {
7287 list
*list
= sortval
->ptr
;
7291 listRewind(list
,&li
);
7292 while((ln
= listNext(&li
))) {
7293 robj
*ele
= ln
->value
;
7294 vector
[j
].obj
= ele
;
7295 vector
[j
].u
.score
= 0;
7296 vector
[j
].u
.cmpobj
= NULL
;
7304 if (sortval
->type
== REDIS_SET
) {
7307 zset
*zs
= sortval
->ptr
;
7311 di
= dictGetIterator(set
);
7312 while((setele
= dictNext(di
)) != NULL
) {
7313 vector
[j
].obj
= dictGetEntryKey(setele
);
7314 vector
[j
].u
.score
= 0;
7315 vector
[j
].u
.cmpobj
= NULL
;
7318 dictReleaseIterator(di
);
7320 redisAssert(j
== vectorlen
);
7322 /* Now it's time to load the right scores in the sorting vector */
7323 if (dontsort
== 0) {
7324 for (j
= 0; j
< vectorlen
; j
++) {
7327 /* lookup value to sort by */
7328 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7329 if (!byval
) continue;
7331 /* use object itself to sort by */
7332 byval
= vector
[j
].obj
;
7336 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7338 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7339 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7340 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7341 /* Don't need to decode the object if it's
7342 * integer-encoded (the only encoding supported) so
7343 * far. We can just cast it */
7344 vector
[j
].u
.score
= (long)byval
->ptr
;
7346 redisAssert(1 != 1);
7350 /* when the object was retrieved using lookupKeyByPattern,
7351 * its refcount needs to be decreased. */
7353 decrRefCount(byval
);
7358 /* We are ready to sort the vector... perform a bit of sanity check
7359 * on the LIMIT option too. We'll use a partial version of quicksort. */
7360 start
= (limit_start
< 0) ? 0 : limit_start
;
7361 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7362 if (start
>= vectorlen
) {
7363 start
= vectorlen
-1;
7366 if (end
>= vectorlen
) end
= vectorlen
-1;
7368 if (dontsort
== 0) {
7369 server
.sort_desc
= desc
;
7370 server
.sort_alpha
= alpha
;
7371 server
.sort_bypattern
= sortby
? 1 : 0;
7372 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7373 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7375 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7378 /* Send command output to the output buffer, performing the specified
7379 * GET/DEL/INCR/DECR operations if any. */
7380 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7381 if (storekey
== NULL
) {
7382 /* STORE option not specified, sent the sorting result to client */
7383 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7384 for (j
= start
; j
<= end
; j
++) {
7388 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7389 listRewind(operations
,&li
);
7390 while((ln
= listNext(&li
))) {
7391 redisSortOperation
*sop
= ln
->value
;
7392 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7395 if (sop
->type
== REDIS_SORT_GET
) {
7397 addReply(c
,shared
.nullbulk
);
7399 addReplyBulk(c
,val
);
7403 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7408 robj
*listObject
= createListObject();
7409 list
*listPtr
= (list
*) listObject
->ptr
;
7411 /* STORE option specified, set the sorting result as a List object */
7412 for (j
= start
; j
<= end
; j
++) {
7417 listAddNodeTail(listPtr
,vector
[j
].obj
);
7418 incrRefCount(vector
[j
].obj
);
7420 listRewind(operations
,&li
);
7421 while((ln
= listNext(&li
))) {
7422 redisSortOperation
*sop
= ln
->value
;
7423 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7426 if (sop
->type
== REDIS_SORT_GET
) {
7428 listAddNodeTail(listPtr
,createStringObject("",0));
7430 /* We should do a incrRefCount on val because it is
7431 * added to the list, but also a decrRefCount because
7432 * it is returned by lookupKeyByPattern. This results
7433 * in doing nothing at all. */
7434 listAddNodeTail(listPtr
,val
);
7437 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7441 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7442 incrRefCount(storekey
);
7444 /* Note: we add 1 because the DB is dirty anyway since even if the
7445 * SORT result is empty a new key is set and maybe the old content
7447 server
.dirty
+= 1+outputlen
;
7448 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7452 decrRefCount(sortval
);
7453 listRelease(operations
);
7454 for (j
= 0; j
< vectorlen
; j
++) {
7455 if (alpha
&& vector
[j
].u
.cmpobj
)
7456 decrRefCount(vector
[j
].u
.cmpobj
);
7461 /* Convert an amount of bytes into a human readable string in the form
7462 * of 100B, 2G, 100M, 4K, and so forth. */
7463 static void bytesToHuman(char *s
, unsigned long long n
) {
7468 sprintf(s
,"%lluB",n
);
7470 } else if (n
< (1024*1024)) {
7471 d
= (double)n
/(1024);
7472 sprintf(s
,"%.2fK",d
);
7473 } else if (n
< (1024LL*1024*1024)) {
7474 d
= (double)n
/(1024*1024);
7475 sprintf(s
,"%.2fM",d
);
7476 } else if (n
< (1024LL*1024*1024*1024)) {
7477 d
= (double)n
/(1024LL*1024*1024);
7478 sprintf(s
,"%.2fG",d
);
7482 /* Create the string returned by the INFO command. This is decoupled
7483 * by the INFO command itself as we need to report the same information
7484 * on memory corruption problems. */
7485 static sds
genRedisInfoString(void) {
7487 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7491 bytesToHuman(hmem
,zmalloc_used_memory());
7492 info
= sdscatprintf(sdsempty(),
7493 "redis_version:%s\r\n"
7494 "redis_git_sha1:%s\r\n"
7495 "redis_git_dirty:%d\r\n"
7497 "multiplexing_api:%s\r\n"
7498 "process_id:%ld\r\n"
7499 "uptime_in_seconds:%ld\r\n"
7500 "uptime_in_days:%ld\r\n"
7501 "connected_clients:%d\r\n"
7502 "connected_slaves:%d\r\n"
7503 "blocked_clients:%d\r\n"
7504 "used_memory:%zu\r\n"
7505 "used_memory_human:%s\r\n"
7506 "changes_since_last_save:%lld\r\n"
7507 "bgsave_in_progress:%d\r\n"
7508 "last_save_time:%ld\r\n"
7509 "bgrewriteaof_in_progress:%d\r\n"
7510 "total_connections_received:%lld\r\n"
7511 "total_commands_processed:%lld\r\n"
7512 "expired_keys:%lld\r\n"
7513 "hash_max_zipmap_entries:%zu\r\n"
7514 "hash_max_zipmap_value:%zu\r\n"
7515 "pubsub_channels:%ld\r\n"
7516 "pubsub_patterns:%u\r\n"
7521 strtol(REDIS_GIT_DIRTY
,NULL
,10) > 0,
7522 (sizeof(long) == 8) ? "64" : "32",
7527 listLength(server
.clients
)-listLength(server
.slaves
),
7528 listLength(server
.slaves
),
7529 server
.blpop_blocked_clients
,
7530 zmalloc_used_memory(),
7533 server
.bgsavechildpid
!= -1,
7535 server
.bgrewritechildpid
!= -1,
7536 server
.stat_numconnections
,
7537 server
.stat_numcommands
,
7538 server
.stat_expiredkeys
,
7539 server
.hash_max_zipmap_entries
,
7540 server
.hash_max_zipmap_value
,
7541 dictSize(server
.pubsub_channels
),
7542 listLength(server
.pubsub_patterns
),
7543 server
.vm_enabled
!= 0,
7544 server
.masterhost
== NULL
? "master" : "slave"
7546 if (server
.masterhost
) {
7547 info
= sdscatprintf(info
,
7548 "master_host:%s\r\n"
7549 "master_port:%d\r\n"
7550 "master_link_status:%s\r\n"
7551 "master_last_io_seconds_ago:%d\r\n"
7554 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7556 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7559 if (server
.vm_enabled
) {
7561 info
= sdscatprintf(info
,
7562 "vm_conf_max_memory:%llu\r\n"
7563 "vm_conf_page_size:%llu\r\n"
7564 "vm_conf_pages:%llu\r\n"
7565 "vm_stats_used_pages:%llu\r\n"
7566 "vm_stats_swapped_objects:%llu\r\n"
7567 "vm_stats_swappin_count:%llu\r\n"
7568 "vm_stats_swappout_count:%llu\r\n"
7569 "vm_stats_io_newjobs_len:%lu\r\n"
7570 "vm_stats_io_processing_len:%lu\r\n"
7571 "vm_stats_io_processed_len:%lu\r\n"
7572 "vm_stats_io_active_threads:%lu\r\n"
7573 "vm_stats_blocked_clients:%lu\r\n"
7574 ,(unsigned long long) server
.vm_max_memory
,
7575 (unsigned long long) server
.vm_page_size
,
7576 (unsigned long long) server
.vm_pages
,
7577 (unsigned long long) server
.vm_stats_used_pages
,
7578 (unsigned long long) server
.vm_stats_swapped_objects
,
7579 (unsigned long long) server
.vm_stats_swapins
,
7580 (unsigned long long) server
.vm_stats_swapouts
,
7581 (unsigned long) listLength(server
.io_newjobs
),
7582 (unsigned long) listLength(server
.io_processing
),
7583 (unsigned long) listLength(server
.io_processed
),
7584 (unsigned long) server
.io_active_threads
,
7585 (unsigned long) server
.vm_blocked_clients
7589 for (j
= 0; j
< server
.dbnum
; j
++) {
7590 long long keys
, vkeys
;
7592 keys
= dictSize(server
.db
[j
].dict
);
7593 vkeys
= dictSize(server
.db
[j
].expires
);
7594 if (keys
|| vkeys
) {
7595 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7602 static void infoCommand(redisClient
*c
) {
7603 sds info
= genRedisInfoString();
7604 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7605 (unsigned long)sdslen(info
)));
7606 addReplySds(c
,info
);
7607 addReply(c
,shared
.crlf
);
7610 static void monitorCommand(redisClient
*c
) {
7611 /* ignore MONITOR if aleady slave or in monitor mode */
7612 if (c
->flags
& REDIS_SLAVE
) return;
7614 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7616 listAddNodeTail(server
.monitors
,c
);
7617 addReply(c
,shared
.ok
);
7620 /* ================================= Expire ================================= */
7621 static int removeExpire(redisDb
*db
, robj
*key
) {
7622 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7629 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7630 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7638 /* Return the expire time of the specified key, or -1 if no expire
7639 * is associated with this key (i.e. the key is non volatile) */
7640 static time_t getExpire(redisDb
*db
, robj
*key
) {
7643 /* No expire? return ASAP */
7644 if (dictSize(db
->expires
) == 0 ||
7645 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7647 return (time_t) dictGetEntryVal(de
);
7650 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7654 /* No expire? return ASAP */
7655 if (dictSize(db
->expires
) == 0 ||
7656 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7658 /* Lookup the expire */
7659 when
= (time_t) dictGetEntryVal(de
);
7660 if (time(NULL
) <= when
) return 0;
7662 /* Delete the key */
7663 dictDelete(db
->expires
,key
);
7664 server
.stat_expiredkeys
++;
7665 return dictDelete(db
->dict
,key
) == DICT_OK
;
7668 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7671 /* No expire? return ASAP */
7672 if (dictSize(db
->expires
) == 0 ||
7673 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7675 /* Delete the key */
7677 server
.stat_expiredkeys
++;
7678 dictDelete(db
->expires
,key
);
7679 return dictDelete(db
->dict
,key
) == DICT_OK
;
7682 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7686 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7690 de
= dictFind(c
->db
->dict
,key
);
7692 addReply(c
,shared
.czero
);
7696 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7697 addReply(c
, shared
.cone
);
7700 time_t when
= time(NULL
)+seconds
;
7701 if (setExpire(c
->db
,key
,when
)) {
7702 addReply(c
,shared
.cone
);
7705 addReply(c
,shared
.czero
);
7711 static void expireCommand(redisClient
*c
) {
7712 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7715 static void expireatCommand(redisClient
*c
) {
7716 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7719 static void ttlCommand(redisClient
*c
) {
7723 expire
= getExpire(c
->db
,c
->argv
[1]);
7725 ttl
= (int) (expire
-time(NULL
));
7726 if (ttl
< 0) ttl
= -1;
7728 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7731 /* ================================ MULTI/EXEC ============================== */
7733 /* Client state initialization for MULTI/EXEC */
7734 static void initClientMultiState(redisClient
*c
) {
7735 c
->mstate
.commands
= NULL
;
7736 c
->mstate
.count
= 0;
7739 /* Release all the resources associated with MULTI/EXEC state */
7740 static void freeClientMultiState(redisClient
*c
) {
7743 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7745 multiCmd
*mc
= c
->mstate
.commands
+j
;
7747 for (i
= 0; i
< mc
->argc
; i
++)
7748 decrRefCount(mc
->argv
[i
]);
7751 zfree(c
->mstate
.commands
);
7754 /* Add a new command into the MULTI commands queue */
7755 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7759 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7760 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7761 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7764 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7765 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7766 for (j
= 0; j
< c
->argc
; j
++)
7767 incrRefCount(mc
->argv
[j
]);
7771 static void multiCommand(redisClient
*c
) {
7772 if (c
->flags
& REDIS_MULTI
) {
7773 addReplySds(c
,sdsnew("-ERR MULTI calls can not be nested\r\n"));
7776 c
->flags
|= REDIS_MULTI
;
7777 addReply(c
,shared
.ok
);
7780 static void discardCommand(redisClient
*c
) {
7781 if (!(c
->flags
& REDIS_MULTI
)) {
7782 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7786 freeClientMultiState(c
);
7787 initClientMultiState(c
);
7788 c
->flags
&= (~REDIS_MULTI
);
7789 addReply(c
,shared
.ok
);
7792 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7793 * implememntation for more information. */
7794 static void execCommandReplicateMulti(redisClient
*c
) {
7795 struct redisCommand
*cmd
;
7796 robj
*multistring
= createStringObject("MULTI",5);
7798 cmd
= lookupCommand("multi");
7799 if (server
.appendonly
)
7800 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7801 if (listLength(server
.slaves
))
7802 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7803 decrRefCount(multistring
);
7806 static void execCommand(redisClient
*c
) {
7811 if (!(c
->flags
& REDIS_MULTI
)) {
7812 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7816 /* Check if we need to abort the EXEC if some WATCHed key was touched.
7817 * A failed EXEC will return a multi bulk nil object. */
7818 if (c
->flags
& REDIS_DIRTY_CAS
) {
7819 freeClientMultiState(c
);
7820 initClientMultiState(c
);
7821 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7823 addReply(c
,shared
.nullmultibulk
);
7827 /* Replicate a MULTI request now that we are sure the block is executed.
7828 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7829 * both the AOF and the replication link will have the same consistency
7830 * and atomicity guarantees. */
7831 execCommandReplicateMulti(c
);
7833 /* Exec all the queued commands */
7834 unwatchAllKeys(c
); /* Unwatch ASAP otherwise we'll waste CPU cycles */
7835 orig_argv
= c
->argv
;
7836 orig_argc
= c
->argc
;
7837 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7838 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7839 c
->argc
= c
->mstate
.commands
[j
].argc
;
7840 c
->argv
= c
->mstate
.commands
[j
].argv
;
7841 call(c
,c
->mstate
.commands
[j
].cmd
);
7843 c
->argv
= orig_argv
;
7844 c
->argc
= orig_argc
;
7845 freeClientMultiState(c
);
7846 initClientMultiState(c
);
7847 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7848 /* Make sure the EXEC command is always replicated / AOF, since we
7849 * always send the MULTI command (we can't know beforehand if the
7850 * next operations will contain at least a modification to the DB). */
7854 /* =========================== Blocking Operations ========================= */
7856 /* Currently Redis blocking operations support is limited to list POP ops,
7857 * so the current implementation is not fully generic, but it is also not
7858 * completely specific so it will not require a rewrite to support new
7859 * kind of blocking operations in the future.
7861 * Still it's important to note that list blocking operations can be already
7862 * used as a notification mechanism in order to implement other blocking
7863 * operations at application level, so there must be a very strong evidence
7864 * of usefulness and generality before new blocking operations are implemented.
7866 * This is how the current blocking POP works, we use BLPOP as example:
7867 * - If the user calls BLPOP and the key exists and contains a non empty list
7868 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7869 * if there is not to block.
7870 * - If instead BLPOP is called and the key does not exists or the list is
7871 * empty we need to block. In order to do so we remove the notification for
7872 * new data to read in the client socket (so that we'll not serve new
7873 * requests if the blocking request is not served). Also we put the client
7874 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
7875 * blocking for this keys.
7876 * - If a PUSH operation against a key with blocked clients waiting is
7877 * performed, we serve the first in the list: basically instead to push
7878 * the new element inside the list we return it to the (first / oldest)
7879 * blocking client, unblock the client, and remove it form the list.
7881 * The above comment and the source code should be enough in order to understand
7882 * the implementation and modify / fix it later.
7885 /* Set a client in blocking mode for the specified key, with the specified
7887 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7892 c
->blocking_keys
= zmalloc(sizeof(robj
*)*numkeys
);
7893 c
->blocking_keys_num
= numkeys
;
7894 c
->blockingto
= timeout
;
7895 for (j
= 0; j
< numkeys
; j
++) {
7896 /* Add the key in the client structure, to map clients -> keys */
7897 c
->blocking_keys
[j
] = keys
[j
];
7898 incrRefCount(keys
[j
]);
7900 /* And in the other "side", to map keys -> clients */
7901 de
= dictFind(c
->db
->blocking_keys
,keys
[j
]);
7905 /* For every key we take a list of clients blocked for it */
7907 retval
= dictAdd(c
->db
->blocking_keys
,keys
[j
],l
);
7908 incrRefCount(keys
[j
]);
7909 assert(retval
== DICT_OK
);
7911 l
= dictGetEntryVal(de
);
7913 listAddNodeTail(l
,c
);
7915 /* Mark the client as a blocked client */
7916 c
->flags
|= REDIS_BLOCKED
;
7917 server
.blpop_blocked_clients
++;
7920 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7921 static void unblockClientWaitingData(redisClient
*c
) {
7926 assert(c
->blocking_keys
!= NULL
);
7927 /* The client may wait for multiple keys, so unblock it for every key. */
7928 for (j
= 0; j
< c
->blocking_keys_num
; j
++) {
7929 /* Remove this client from the list of clients waiting for this key. */
7930 de
= dictFind(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7932 l
= dictGetEntryVal(de
);
7933 listDelNode(l
,listSearchKey(l
,c
));
7934 /* If the list is empty we need to remove it to avoid wasting memory */
7935 if (listLength(l
) == 0)
7936 dictDelete(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7937 decrRefCount(c
->blocking_keys
[j
]);
7939 /* Cleanup the client structure */
7940 zfree(c
->blocking_keys
);
7941 c
->blocking_keys
= NULL
;
7942 c
->flags
&= (~REDIS_BLOCKED
);
7943 server
.blpop_blocked_clients
--;
7944 /* We want to process data if there is some command waiting
7945 * in the input buffer. Note that this is safe even if
7946 * unblockClientWaitingData() gets called from freeClient() because
7947 * freeClient() will be smart enough to call this function
7948 * *after* c->querybuf was set to NULL. */
7949 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7952 /* This should be called from any function PUSHing into lists.
7953 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7954 * 'ele' is the element pushed.
7956 * If the function returns 0 there was no client waiting for a list push
7959 * If the function returns 1 there was a client waiting for a list push
7960 * against this key, the element was passed to this client thus it's not
7961 * needed to actually add it to the list and the caller should return asap. */
7962 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7963 struct dictEntry
*de
;
7964 redisClient
*receiver
;
7968 de
= dictFind(c
->db
->blocking_keys
,key
);
7969 if (de
== NULL
) return 0;
7970 l
= dictGetEntryVal(de
);
7973 receiver
= ln
->value
;
7975 addReplySds(receiver
,sdsnew("*2\r\n"));
7976 addReplyBulk(receiver
,key
);
7977 addReplyBulk(receiver
,ele
);
7978 unblockClientWaitingData(receiver
);
7982 /* Blocking RPOP/LPOP */
7983 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7988 for (j
= 1; j
< c
->argc
-1; j
++) {
7989 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7991 if (o
->type
!= REDIS_LIST
) {
7992 addReply(c
,shared
.wrongtypeerr
);
7995 list
*list
= o
->ptr
;
7996 if (listLength(list
) != 0) {
7997 /* If the list contains elements fall back to the usual
7998 * non-blocking POP operation */
7999 robj
*argv
[2], **orig_argv
;
8002 /* We need to alter the command arguments before to call
8003 * popGenericCommand() as the command takes a single key. */
8004 orig_argv
= c
->argv
;
8005 orig_argc
= c
->argc
;
8006 argv
[1] = c
->argv
[j
];
8010 /* Also the return value is different, we need to output
8011 * the multi bulk reply header and the key name. The
8012 * "real" command will add the last element (the value)
8013 * for us. If this souds like an hack to you it's just
8014 * because it is... */
8015 addReplySds(c
,sdsnew("*2\r\n"));
8016 addReplyBulk(c
,argv
[1]);
8017 popGenericCommand(c
,where
);
8019 /* Fix the client structure with the original stuff */
8020 c
->argv
= orig_argv
;
8021 c
->argc
= orig_argc
;
8027 /* If the list is empty or the key does not exists we must block */
8028 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
8029 if (timeout
> 0) timeout
+= time(NULL
);
8030 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
8033 static void blpopCommand(redisClient
*c
) {
8034 blockingPopGenericCommand(c
,REDIS_HEAD
);
8037 static void brpopCommand(redisClient
*c
) {
8038 blockingPopGenericCommand(c
,REDIS_TAIL
);
8041 /* =============================== Replication ============================= */
8043 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8044 ssize_t nwritten
, ret
= size
;
8045 time_t start
= time(NULL
);
8049 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
8050 nwritten
= write(fd
,ptr
,size
);
8051 if (nwritten
== -1) return -1;
8055 if ((time(NULL
)-start
) > timeout
) {
8063 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8064 ssize_t nread
, totread
= 0;
8065 time_t start
= time(NULL
);
8069 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
8070 nread
= read(fd
,ptr
,size
);
8071 if (nread
== -1) return -1;
8076 if ((time(NULL
)-start
) > timeout
) {
8084 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8091 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
8094 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
8105 static void syncCommand(redisClient
*c
) {
8106 /* ignore SYNC if aleady slave or in monitor mode */
8107 if (c
->flags
& REDIS_SLAVE
) return;
8109 /* SYNC can't be issued when the server has pending data to send to
8110 * the client about already issued commands. We need a fresh reply
8111 * buffer registering the differences between the BGSAVE and the current
8112 * dataset, so that we can copy to other slaves if needed. */
8113 if (listLength(c
->reply
) != 0) {
8114 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8118 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
8119 /* Here we need to check if there is a background saving operation
8120 * in progress, or if it is required to start one */
8121 if (server
.bgsavechildpid
!= -1) {
8122 /* Ok a background save is in progress. Let's check if it is a good
8123 * one for replication, i.e. if there is another slave that is
8124 * registering differences since the server forked to save */
8129 listRewind(server
.slaves
,&li
);
8130 while((ln
= listNext(&li
))) {
8132 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
8135 /* Perfect, the server is already registering differences for
8136 * another slave. Set the right state, and copy the buffer. */
8137 listRelease(c
->reply
);
8138 c
->reply
= listDup(slave
->reply
);
8139 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8140 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
8142 /* No way, we need to wait for the next BGSAVE in order to
8143 * register differences */
8144 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8145 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
8148 /* Ok we don't have a BGSAVE in progress, let's start one */
8149 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
8150 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8151 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
8152 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
8155 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8158 c
->flags
|= REDIS_SLAVE
;
8160 listAddNodeTail(server
.slaves
,c
);
8164 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
8165 redisClient
*slave
= privdata
;
8167 REDIS_NOTUSED(mask
);
8168 char buf
[REDIS_IOBUF_LEN
];
8169 ssize_t nwritten
, buflen
;
8171 if (slave
->repldboff
== 0) {
8172 /* Write the bulk write count before to transfer the DB. In theory here
8173 * we don't know how much room there is in the output buffer of the
8174 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8175 * operations) will never be smaller than the few bytes we need. */
8178 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8180 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
8188 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
8189 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
8191 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
8192 (buflen
== 0) ? "premature EOF" : strerror(errno
));
8196 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
8197 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
8202 slave
->repldboff
+= nwritten
;
8203 if (slave
->repldboff
== slave
->repldbsize
) {
8204 close(slave
->repldbfd
);
8205 slave
->repldbfd
= -1;
8206 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8207 slave
->replstate
= REDIS_REPL_ONLINE
;
8208 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
8209 sendReplyToClient
, slave
) == AE_ERR
) {
8213 addReplySds(slave
,sdsempty());
8214 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
8218 /* This function is called at the end of every backgrond saving.
8219 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8220 * otherwise REDIS_ERR is passed to the function.
8222 * The goal of this function is to handle slaves waiting for a successful
8223 * background saving in order to perform non-blocking synchronization. */
8224 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
8226 int startbgsave
= 0;
8229 listRewind(server
.slaves
,&li
);
8230 while((ln
= listNext(&li
))) {
8231 redisClient
*slave
= ln
->value
;
8233 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
8235 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8236 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
8237 struct redis_stat buf
;
8239 if (bgsaveerr
!= REDIS_OK
) {
8241 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
8244 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
8245 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
8247 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
8250 slave
->repldboff
= 0;
8251 slave
->repldbsize
= buf
.st_size
;
8252 slave
->replstate
= REDIS_REPL_SEND_BULK
;
8253 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8254 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
8261 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8264 listRewind(server
.slaves
,&li
);
8265 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
8266 while((ln
= listNext(&li
))) {
8267 redisClient
*slave
= ln
->value
;
8269 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
8276 static int syncWithMaster(void) {
8277 char buf
[1024], tmpfile
[256], authcmd
[1024];
8279 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
8280 int dfd
, maxtries
= 5;
8283 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
8288 /* AUTH with the master if required. */
8289 if(server
.masterauth
) {
8290 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
8291 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
8293 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
8297 /* Read the AUTH result. */
8298 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8300 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
8304 if (buf
[0] != '+') {
8306 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
8311 /* Issue the SYNC command */
8312 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
8314 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
8318 /* Read the bulk write count */
8319 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8321 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
8325 if (buf
[0] != '$') {
8327 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8330 dumpsize
= strtol(buf
+1,NULL
,10);
8331 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8332 /* Read the bulk write data on a temp file */
8334 snprintf(tmpfile
,256,
8335 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8336 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8337 if (dfd
!= -1) break;
8342 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8346 int nread
, nwritten
;
8348 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8350 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8356 nwritten
= write(dfd
,buf
,nread
);
8357 if (nwritten
== -1) {
8358 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8366 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8367 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8373 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8374 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8378 server
.master
= createClient(fd
);
8379 server
.master
->flags
|= REDIS_MASTER
;
8380 server
.master
->authenticated
= 1;
8381 server
.replstate
= REDIS_REPL_CONNECTED
;
8385 static void slaveofCommand(redisClient
*c
) {
8386 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8387 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8388 if (server
.masterhost
) {
8389 sdsfree(server
.masterhost
);
8390 server
.masterhost
= NULL
;
8391 if (server
.master
) freeClient(server
.master
);
8392 server
.replstate
= REDIS_REPL_NONE
;
8393 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8396 sdsfree(server
.masterhost
);
8397 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8398 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8399 if (server
.master
) freeClient(server
.master
);
8400 server
.replstate
= REDIS_REPL_CONNECT
;
8401 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8402 server
.masterhost
, server
.masterport
);
8404 addReply(c
,shared
.ok
);
8407 /* ============================ Maxmemory directive ======================== */
8409 /* Try to free one object form the pre-allocated objects free list.
8410 * This is useful under low mem conditions as by default we take 1 million
8411 * free objects allocated. On success REDIS_OK is returned, otherwise
8413 static int tryFreeOneObjectFromFreelist(void) {
8416 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8417 if (listLength(server
.objfreelist
)) {
8418 listNode
*head
= listFirst(server
.objfreelist
);
8419 o
= listNodeValue(head
);
8420 listDelNode(server
.objfreelist
,head
);
8421 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8425 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8430 /* This function gets called when 'maxmemory' is set on the config file to limit
8431 * the max memory used by the server, and we are out of memory.
8432 * This function will try to, in order:
8434 * - Free objects from the free list
8435 * - Try to remove keys with an EXPIRE set
8437 * It is not possible to free enough memory to reach used-memory < maxmemory
8438 * the server will start refusing commands that will enlarge even more the
8441 static void freeMemoryIfNeeded(void) {
8442 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8443 int j
, k
, freed
= 0;
8445 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8446 for (j
= 0; j
< server
.dbnum
; j
++) {
8448 robj
*minkey
= NULL
;
8449 struct dictEntry
*de
;
8451 if (dictSize(server
.db
[j
].expires
)) {
8453 /* From a sample of three keys drop the one nearest to
8454 * the natural expire */
8455 for (k
= 0; k
< 3; k
++) {
8458 de
= dictGetRandomKey(server
.db
[j
].expires
);
8459 t
= (time_t) dictGetEntryVal(de
);
8460 if (minttl
== -1 || t
< minttl
) {
8461 minkey
= dictGetEntryKey(de
);
8465 deleteKey(server
.db
+j
,minkey
);
8468 if (!freed
) return; /* nothing to free... */
8472 /* ============================== Append Only file ========================== */
8474 /* Write the append only file buffer on disk.
8476 * Since we are required to write the AOF before replying to the client,
8477 * and the only way the client socket can get a write is entering when the
8478 * the event loop, we accumulate all the AOF writes in a memory
8479 * buffer and write it on disk using this function just before entering
8480 * the event loop again. */
8481 static void flushAppendOnlyFile(void) {
8485 if (sdslen(server
.aofbuf
) == 0) return;
8487 /* We want to perform a single write. This should be guaranteed atomic
8488 * at least if the filesystem we are writing is a real physical one.
8489 * While this will save us against the server being killed I don't think
8490 * there is much to do about the whole server stopping for power problems
8492 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8493 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8494 /* Ooops, we are in troubles. The best thing to do for now is
8495 * aborting instead of giving the illusion that everything is
8496 * working as expected. */
8497 if (nwritten
== -1) {
8498 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8500 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8504 sdsfree(server
.aofbuf
);
8505 server
.aofbuf
= sdsempty();
8507 /* Fsync if needed */
8509 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8510 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8511 now
-server
.lastfsync
> 1))
8513 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8514 * flushing metadata. */
8515 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8516 server
.lastfsync
= now
;
8520 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8522 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8523 for (j
= 0; j
< argc
; j
++) {
8524 robj
*o
= getDecodedObject(argv
[j
]);
8525 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8526 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8527 buf
= sdscatlen(buf
,"\r\n",2);
8533 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8538 /* Make sure we can use strtol */
8539 seconds
= getDecodedObject(seconds
);
8540 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8541 decrRefCount(seconds
);
8543 argv
[0] = createStringObject("EXPIREAT",8);
8545 argv
[2] = createObject(REDIS_STRING
,
8546 sdscatprintf(sdsempty(),"%ld",when
));
8547 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8548 decrRefCount(argv
[0]);
8549 decrRefCount(argv
[2]);
8553 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8554 sds buf
= sdsempty();
8557 /* The DB this command was targetting is not the same as the last command
8558 * we appendend. To issue a SELECT command is needed. */
8559 if (dictid
!= server
.appendseldb
) {
8562 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8563 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8564 (unsigned long)strlen(seldb
),seldb
);
8565 server
.appendseldb
= dictid
;
8568 if (cmd
->proc
== expireCommand
) {
8569 /* Translate EXPIRE into EXPIREAT */
8570 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8571 } else if (cmd
->proc
== setexCommand
) {
8572 /* Translate SETEX to SET and EXPIREAT */
8573 tmpargv
[0] = createStringObject("SET",3);
8574 tmpargv
[1] = argv
[1];
8575 tmpargv
[2] = argv
[3];
8576 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8577 decrRefCount(tmpargv
[0]);
8578 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8580 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8583 /* Append to the AOF buffer. This will be flushed on disk just before
8584 * of re-entering the event loop, so before the client will get a
8585 * positive reply about the operation performed. */
8586 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8588 /* If a background append only file rewriting is in progress we want to
8589 * accumulate the differences between the child DB and the current one
8590 * in a buffer, so that when the child process will do its work we
8591 * can append the differences to the new append only file. */
8592 if (server
.bgrewritechildpid
!= -1)
8593 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8598 /* In Redis commands are always executed in the context of a client, so in
8599 * order to load the append only file we need to create a fake client. */
8600 static struct redisClient
*createFakeClient(void) {
8601 struct redisClient
*c
= zmalloc(sizeof(*c
));
8605 c
->querybuf
= sdsempty();
8609 /* We set the fake client as a slave waiting for the synchronization
8610 * so that Redis will not try to send replies to this client. */
8611 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8612 c
->reply
= listCreate();
8613 listSetFreeMethod(c
->reply
,decrRefCount
);
8614 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8615 initClientMultiState(c
);
8619 static void freeFakeClient(struct redisClient
*c
) {
8620 sdsfree(c
->querybuf
);
8621 listRelease(c
->reply
);
8622 freeClientMultiState(c
);
8626 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8627 * error (the append only file is zero-length) REDIS_ERR is returned. On
8628 * fatal error an error message is logged and the program exists. */
8629 int loadAppendOnlyFile(char *filename
) {
8630 struct redisClient
*fakeClient
;
8631 FILE *fp
= fopen(filename
,"r");
8632 struct redis_stat sb
;
8633 unsigned long long loadedkeys
= 0;
8634 int appendonly
= server
.appendonly
;
8636 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8640 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8644 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8645 * to the same file we're about to read. */
8646 server
.appendonly
= 0;
8648 fakeClient
= createFakeClient();
8655 struct redisCommand
*cmd
;
8657 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8663 if (buf
[0] != '*') goto fmterr
;
8665 argv
= zmalloc(sizeof(robj
*)*argc
);
8666 for (j
= 0; j
< argc
; j
++) {
8667 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8668 if (buf
[0] != '$') goto fmterr
;
8669 len
= strtol(buf
+1,NULL
,10);
8670 argsds
= sdsnewlen(NULL
,len
);
8671 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8672 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8673 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8676 /* Command lookup */
8677 cmd
= lookupCommand(argv
[0]->ptr
);
8679 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8682 /* Try object encoding */
8683 if (cmd
->flags
& REDIS_CMD_BULK
)
8684 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8685 /* Run the command in the context of a fake client */
8686 fakeClient
->argc
= argc
;
8687 fakeClient
->argv
= argv
;
8688 cmd
->proc(fakeClient
);
8689 /* Discard the reply objects list from the fake client */
8690 while(listLength(fakeClient
->reply
))
8691 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8692 /* Clean up, ready for the next command */
8693 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8695 /* Handle swapping while loading big datasets when VM is on */
8697 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8698 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8699 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8704 /* This point can only be reached when EOF is reached without errors.
8705 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8706 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8709 freeFakeClient(fakeClient
);
8710 server
.appendonly
= appendonly
;
8715 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8717 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8721 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8725 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8726 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8730 /* Avoid the incr/decr ref count business if possible to help
8731 * copy-on-write (we are often in a child process when this function
8733 * Also makes sure that key objects don't get incrRefCount-ed when VM
8735 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8736 obj
= getDecodedObject(obj
);
8739 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8740 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8741 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8743 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8744 if (decrrc
) decrRefCount(obj
);
8747 if (decrrc
) decrRefCount(obj
);
8751 /* Write binary-safe string into a file in the bulkformat
8752 * $<count>\r\n<payload>\r\n */
8753 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8756 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8757 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8758 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8759 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8763 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8764 static int fwriteBulkDouble(FILE *fp
, double d
) {
8765 char buf
[128], dbuf
[128];
8767 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8768 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8769 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8770 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8774 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8775 static int fwriteBulkLong(FILE *fp
, long l
) {
8776 char buf
[128], lbuf
[128];
8778 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8779 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8780 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8781 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8785 /* Write a sequence of commands able to fully rebuild the dataset into
8786 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8787 static int rewriteAppendOnlyFile(char *filename
) {
8788 dictIterator
*di
= NULL
;
8793 time_t now
= time(NULL
);
8795 /* Note that we have to use a different temp name here compared to the
8796 * one used by rewriteAppendOnlyFileBackground() function. */
8797 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8798 fp
= fopen(tmpfile
,"w");
8800 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8803 for (j
= 0; j
< server
.dbnum
; j
++) {
8804 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8805 redisDb
*db
= server
.db
+j
;
8807 if (dictSize(d
) == 0) continue;
8808 di
= dictGetIterator(d
);
8814 /* SELECT the new DB */
8815 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8816 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8818 /* Iterate this DB writing every entry */
8819 while((de
= dictNext(di
)) != NULL
) {
8824 key
= dictGetEntryKey(de
);
8825 /* If the value for this key is swapped, load a preview in memory.
8826 * We use a "swapped" flag to remember if we need to free the
8827 * value object instead to just increment the ref count anyway
8828 * in order to avoid copy-on-write of pages if we are forked() */
8829 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8830 key
->storage
== REDIS_VM_SWAPPING
) {
8831 o
= dictGetEntryVal(de
);
8834 o
= vmPreviewObject(key
);
8837 expiretime
= getExpire(db
,key
);
8839 /* Save the key and associated value */
8840 if (o
->type
== REDIS_STRING
) {
8841 /* Emit a SET command */
8842 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8843 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8845 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8846 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8847 } else if (o
->type
== REDIS_LIST
) {
8848 /* Emit the RPUSHes needed to rebuild the list */
8849 list
*list
= o
->ptr
;
8853 listRewind(list
,&li
);
8854 while((ln
= listNext(&li
))) {
8855 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8856 robj
*eleobj
= listNodeValue(ln
);
8858 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8859 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8860 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8862 } else if (o
->type
== REDIS_SET
) {
8863 /* Emit the SADDs needed to rebuild the set */
8865 dictIterator
*di
= dictGetIterator(set
);
8868 while((de
= dictNext(di
)) != NULL
) {
8869 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8870 robj
*eleobj
= dictGetEntryKey(de
);
8872 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8873 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8874 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8876 dictReleaseIterator(di
);
8877 } else if (o
->type
== REDIS_ZSET
) {
8878 /* Emit the ZADDs needed to rebuild the sorted set */
8880 dictIterator
*di
= dictGetIterator(zs
->dict
);
8883 while((de
= dictNext(di
)) != NULL
) {
8884 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8885 robj
*eleobj
= dictGetEntryKey(de
);
8886 double *score
= dictGetEntryVal(de
);
8888 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8889 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8890 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8891 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8893 dictReleaseIterator(di
);
8894 } else if (o
->type
== REDIS_HASH
) {
8895 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8897 /* Emit the HSETs needed to rebuild the hash */
8898 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8899 unsigned char *p
= zipmapRewind(o
->ptr
);
8900 unsigned char *field
, *val
;
8901 unsigned int flen
, vlen
;
8903 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8904 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8905 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8906 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8908 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8912 dictIterator
*di
= dictGetIterator(o
->ptr
);
8915 while((de
= dictNext(di
)) != NULL
) {
8916 robj
*field
= dictGetEntryKey(de
);
8917 robj
*val
= dictGetEntryVal(de
);
8919 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8920 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8921 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8922 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8924 dictReleaseIterator(di
);
8927 redisPanic("Unknown object type");
8929 /* Save the expire time */
8930 if (expiretime
!= -1) {
8931 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8932 /* If this key is already expired skip it */
8933 if (expiretime
< now
) continue;
8934 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8935 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8936 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8938 if (swapped
) decrRefCount(o
);
8940 dictReleaseIterator(di
);
8943 /* Make sure data will not remain on the OS's output buffers */
8948 /* Use RENAME to make sure the DB file is changed atomically only
8949 * if the generate DB file is ok. */
8950 if (rename(tmpfile
,filename
) == -1) {
8951 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8955 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8961 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8962 if (di
) dictReleaseIterator(di
);
8966 /* This is how rewriting of the append only file in background works:
8968 * 1) The user calls BGREWRITEAOF
8969 * 2) Redis calls this function, that forks():
8970 * 2a) the child rewrite the append only file in a temp file.
8971 * 2b) the parent accumulates differences in server.bgrewritebuf.
8972 * 3) When the child finished '2a' exists.
8973 * 4) The parent will trap the exit code, if it's OK, will append the
8974 * data accumulated into server.bgrewritebuf into the temp file, and
8975 * finally will rename(2) the temp file in the actual file name.
8976 * The the new file is reopened as the new append only file. Profit!
8978 static int rewriteAppendOnlyFileBackground(void) {
8981 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8982 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8983 if ((childpid
= fork()) == 0) {
8987 if (server
.vm_enabled
) vmReopenSwapFile();
8989 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8990 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8997 if (childpid
== -1) {
8998 redisLog(REDIS_WARNING
,
8999 "Can't rewrite append only file in background: fork: %s",
9003 redisLog(REDIS_NOTICE
,
9004 "Background append only file rewriting started by pid %d",childpid
);
9005 server
.bgrewritechildpid
= childpid
;
9006 updateDictResizePolicy();
9007 /* We set appendseldb to -1 in order to force the next call to the
9008 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9009 * accumulated by the parent into server.bgrewritebuf will start
9010 * with a SELECT statement and it will be safe to merge. */
9011 server
.appendseldb
= -1;
9014 return REDIS_OK
; /* unreached */
9017 static void bgrewriteaofCommand(redisClient
*c
) {
9018 if (server
.bgrewritechildpid
!= -1) {
9019 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9022 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
9023 char *status
= "+Background append only file rewriting started\r\n";
9024 addReplySds(c
,sdsnew(status
));
9026 addReply(c
,shared
.err
);
9030 static void aofRemoveTempFile(pid_t childpid
) {
9033 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
9037 /* Virtual Memory is composed mainly of two subsystems:
9038 * - Blocking Virutal Memory
9039 * - Threaded Virtual Memory I/O
9040 * The two parts are not fully decoupled, but functions are split among two
9041 * different sections of the source code (delimited by comments) in order to
9042 * make more clear what functionality is about the blocking VM and what about
9043 * the threaded (not blocking) VM.
9047 * Redis VM is a blocking VM (one that blocks reading swapped values from
9048 * disk into memory when a value swapped out is needed in memory) that is made
9049 * unblocking by trying to examine the command argument vector in order to
9050 * load in background values that will likely be needed in order to exec
9051 * the command. The command is executed only once all the relevant keys
9052 * are loaded into memory.
9054 * This basically is almost as simple of a blocking VM, but almost as parallel
9055 * as a fully non-blocking VM.
9058 /* Called when the user switches from "appendonly yes" to "appendonly no"
9059 * at runtime using the CONFIG command. */
9060 static void stopAppendOnly(void) {
9061 flushAppendOnlyFile();
9062 fsync(server
.appendfd
);
9063 close(server
.appendfd
);
9065 server
.appendfd
= -1;
9066 server
.appendseldb
= -1;
9067 server
.appendonly
= 0;
9068 /* rewrite operation in progress? kill it, wait child exit */
9069 if (server
.bgsavechildpid
!= -1) {
9072 if (kill(server
.bgsavechildpid
,SIGKILL
) != -1)
9073 wait3(&statloc
,0,NULL
);
9074 /* reset the buffer accumulating changes while the child saves */
9075 sdsfree(server
.bgrewritebuf
);
9076 server
.bgrewritebuf
= sdsempty();
9077 server
.bgsavechildpid
= -1;
9081 /* Called when the user switches from "appendonly no" to "appendonly yes"
9082 * at runtime using the CONFIG command. */
9083 static int startAppendOnly(void) {
9084 server
.appendonly
= 1;
9085 server
.lastfsync
= time(NULL
);
9086 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
9087 if (server
.appendfd
== -1) {
9088 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno
));
9091 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
9092 server
.appendonly
= 0;
9093 close(server
.appendfd
);
9094 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno
));
9100 /* =================== Virtual Memory - Blocking Side ====================== */
9102 static void vmInit(void) {
9108 if (server
.vm_max_threads
!= 0)
9109 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9111 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
9112 /* Try to open the old swap file, otherwise create it */
9113 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
9114 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
9116 if (server
.vm_fp
== NULL
) {
9117 redisLog(REDIS_WARNING
,
9118 "Can't open the swap file: %s. Exiting.",
9122 server
.vm_fd
= fileno(server
.vm_fp
);
9123 /* Lock the swap file for writing, this is useful in order to avoid
9124 * another instance to use the same swap file for a config error. */
9125 fl
.l_type
= F_WRLCK
;
9126 fl
.l_whence
= SEEK_SET
;
9127 fl
.l_start
= fl
.l_len
= 0;
9128 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
9129 redisLog(REDIS_WARNING
,
9130 "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
));
9134 server
.vm_next_page
= 0;
9135 server
.vm_near_pages
= 0;
9136 server
.vm_stats_used_pages
= 0;
9137 server
.vm_stats_swapped_objects
= 0;
9138 server
.vm_stats_swapouts
= 0;
9139 server
.vm_stats_swapins
= 0;
9140 totsize
= server
.vm_pages
*server
.vm_page_size
;
9141 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
9142 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
9143 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
9147 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
9149 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
9150 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
9151 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
9152 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
9154 /* Initialize threaded I/O (used by Virtual Memory) */
9155 server
.io_newjobs
= listCreate();
9156 server
.io_processing
= listCreate();
9157 server
.io_processed
= listCreate();
9158 server
.io_ready_clients
= listCreate();
9159 pthread_mutex_init(&server
.io_mutex
,NULL
);
9160 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
9161 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
9162 server
.io_active_threads
= 0;
9163 if (pipe(pipefds
) == -1) {
9164 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
9168 server
.io_ready_pipe_read
= pipefds
[0];
9169 server
.io_ready_pipe_write
= pipefds
[1];
9170 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
9171 /* LZF requires a lot of stack */
9172 pthread_attr_init(&server
.io_threads_attr
);
9173 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
9174 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
9175 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
9176 /* Listen for events in the threaded I/O pipe */
9177 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
9178 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
9179 oom("creating file event");
9182 /* Mark the page as used */
9183 static void vmMarkPageUsed(off_t page
) {
9184 off_t byte
= page
/8;
9186 redisAssert(vmFreePage(page
) == 1);
9187 server
.vm_bitmap
[byte
] |= 1<<bit
;
9190 /* Mark N contiguous pages as used, with 'page' being the first. */
9191 static void vmMarkPagesUsed(off_t page
, off_t count
) {
9194 for (j
= 0; j
< count
; j
++)
9195 vmMarkPageUsed(page
+j
);
9196 server
.vm_stats_used_pages
+= count
;
9197 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
9198 (long long)count
, (long long)page
);
9201 /* Mark the page as free */
9202 static void vmMarkPageFree(off_t page
) {
9203 off_t byte
= page
/8;
9205 redisAssert(vmFreePage(page
) == 0);
9206 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
9209 /* Mark N contiguous pages as free, with 'page' being the first. */
9210 static void vmMarkPagesFree(off_t page
, off_t count
) {
9213 for (j
= 0; j
< count
; j
++)
9214 vmMarkPageFree(page
+j
);
9215 server
.vm_stats_used_pages
-= count
;
9216 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
9217 (long long)count
, (long long)page
);
9220 /* Test if the page is free */
9221 static int vmFreePage(off_t page
) {
9222 off_t byte
= page
/8;
9224 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
9227 /* Find N contiguous free pages storing the first page of the cluster in *first.
9228 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9229 * REDIS_ERR is returned.
9231 * This function uses a simple algorithm: we try to allocate
9232 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9233 * again from the start of the swap file searching for free spaces.
9235 * If it looks pretty clear that there are no free pages near our offset
9236 * we try to find less populated places doing a forward jump of
9237 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9238 * without hurry, and then we jump again and so forth...
9240 * This function can be improved using a free list to avoid to guess
9241 * too much, since we could collect data about freed pages.
9243 * note: I implemented this function just after watching an episode of
9244 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9246 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
9247 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
9249 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
9250 server
.vm_near_pages
= 0;
9251 server
.vm_next_page
= 0;
9253 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
9254 base
= server
.vm_next_page
;
9256 while(offset
< server
.vm_pages
) {
9257 off_t
this = base
+offset
;
9259 /* If we overflow, restart from page zero */
9260 if (this >= server
.vm_pages
) {
9261 this -= server
.vm_pages
;
9263 /* Just overflowed, what we found on tail is no longer
9264 * interesting, as it's no longer contiguous. */
9268 if (vmFreePage(this)) {
9269 /* This is a free page */
9271 /* Already got N free pages? Return to the caller, with success */
9273 *first
= this-(n
-1);
9274 server
.vm_next_page
= this+1;
9275 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
9279 /* The current one is not a free page */
9283 /* Fast-forward if the current page is not free and we already
9284 * searched enough near this place. */
9286 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
9287 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
9289 /* Note that even if we rewind after the jump, we are don't need
9290 * to make sure numfree is set to zero as we only jump *if* it
9291 * is set to zero. */
9293 /* Otherwise just check the next page */
9300 /* Write the specified object at the specified page of the swap file */
9301 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
9302 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9303 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9304 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9305 redisLog(REDIS_WARNING
,
9306 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9310 rdbSaveObject(server
.vm_fp
,o
);
9311 fflush(server
.vm_fp
);
9312 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9316 /* Swap the 'val' object relative to 'key' into disk. Store all the information
9317 * needed to later retrieve the object into the key object.
9318 * If we can't find enough contiguous empty pages to swap the object on disk
9319 * REDIS_ERR is returned. */
9320 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
9321 off_t pages
= rdbSavedObjectPages(val
,NULL
);
9324 assert(key
->storage
== REDIS_VM_MEMORY
);
9325 assert(key
->refcount
== 1);
9326 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
9327 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
9328 key
->vm
.page
= page
;
9329 key
->vm
.usedpages
= pages
;
9330 key
->storage
= REDIS_VM_SWAPPED
;
9331 key
->vtype
= val
->type
;
9332 decrRefCount(val
); /* Deallocate the object from memory. */
9333 vmMarkPagesUsed(page
,pages
);
9334 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
9335 (unsigned char*) key
->ptr
,
9336 (unsigned long long) page
, (unsigned long long) pages
);
9337 server
.vm_stats_swapped_objects
++;
9338 server
.vm_stats_swapouts
++;
9342 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
9345 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9346 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9347 redisLog(REDIS_WARNING
,
9348 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9352 o
= rdbLoadObject(type
,server
.vm_fp
);
9354 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
9357 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9361 /* Load the value object relative to the 'key' object from swap to memory.
9362 * The newly allocated object is returned.
9364 * If preview is true the unserialized object is returned to the caller but
9365 * no changes are made to the key object, nor the pages are marked as freed */
9366 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
9369 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
9370 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
9372 key
->storage
= REDIS_VM_MEMORY
;
9373 key
->vm
.atime
= server
.unixtime
;
9374 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9375 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
9376 (unsigned char*) key
->ptr
);
9377 server
.vm_stats_swapped_objects
--;
9379 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
9380 (unsigned char*) key
->ptr
);
9382 server
.vm_stats_swapins
++;
9386 /* Plain object loading, from swap to memory */
9387 static robj
*vmLoadObject(robj
*key
) {
9388 /* If we are loading the object in background, stop it, we
9389 * need to load this object synchronously ASAP. */
9390 if (key
->storage
== REDIS_VM_LOADING
)
9391 vmCancelThreadedIOJob(key
);
9392 return vmGenericLoadObject(key
,0);
9395 /* Just load the value on disk, without to modify the key.
9396 * This is useful when we want to perform some operation on the value
9397 * without to really bring it from swap to memory, like while saving the
9398 * dataset or rewriting the append only log. */
9399 static robj
*vmPreviewObject(robj
*key
) {
9400 return vmGenericLoadObject(key
,1);
9403 /* How a good candidate is this object for swapping?
9404 * The better candidate it is, the greater the returned value.
9406 * Currently we try to perform a fast estimation of the object size in
9407 * memory, and combine it with aging informations.
9409 * Basically swappability = idle-time * log(estimated size)
9411 * Bigger objects are preferred over smaller objects, but not
9412 * proportionally, this is why we use the logarithm. This algorithm is
9413 * just a first try and will probably be tuned later. */
9414 static double computeObjectSwappability(robj
*o
) {
9415 time_t age
= server
.unixtime
- o
->vm
.atime
;
9419 struct dictEntry
*de
;
9422 if (age
<= 0) return 0;
9425 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9428 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9433 listNode
*ln
= listFirst(l
);
9435 asize
= sizeof(list
);
9437 robj
*ele
= ln
->value
;
9440 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9441 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9443 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9448 z
= (o
->type
== REDIS_ZSET
);
9449 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9451 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9452 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9457 de
= dictGetRandomKey(d
);
9458 ele
= dictGetEntryKey(de
);
9459 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9460 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9462 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9463 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9467 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9468 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9469 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9470 unsigned int klen
, vlen
;
9471 unsigned char *key
, *val
;
9473 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9477 asize
= len
*(klen
+vlen
+3);
9478 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9480 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9485 de
= dictGetRandomKey(d
);
9486 ele
= dictGetEntryKey(de
);
9487 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9488 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9490 ele
= dictGetEntryVal(de
);
9491 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9492 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9494 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9499 return (double)age
*log(1+asize
);
9502 /* Try to swap an object that's a good candidate for swapping.
9503 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9504 * to swap any object at all.
9506 * If 'usethreaded' is true, Redis will try to swap the object in background
9507 * using I/O threads. */
9508 static int vmSwapOneObject(int usethreads
) {
9510 struct dictEntry
*best
= NULL
;
9511 double best_swappability
= 0;
9512 redisDb
*best_db
= NULL
;
9515 for (j
= 0; j
< server
.dbnum
; j
++) {
9516 redisDb
*db
= server
.db
+j
;
9517 /* Why maxtries is set to 100?
9518 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9519 * are swappable objects */
9522 if (dictSize(db
->dict
) == 0) continue;
9523 for (i
= 0; i
< 5; i
++) {
9525 double swappability
;
9527 if (maxtries
) maxtries
--;
9528 de
= dictGetRandomKey(db
->dict
);
9529 key
= dictGetEntryKey(de
);
9530 val
= dictGetEntryVal(de
);
9531 /* Only swap objects that are currently in memory.
9533 * Also don't swap shared objects if threaded VM is on, as we
9534 * try to ensure that the main thread does not touch the
9535 * object while the I/O thread is using it, but we can't
9536 * control other keys without adding additional mutex. */
9537 if (key
->storage
!= REDIS_VM_MEMORY
||
9538 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9539 if (maxtries
) i
--; /* don't count this try */
9542 swappability
= computeObjectSwappability(val
);
9543 if (!best
|| swappability
> best_swappability
) {
9545 best_swappability
= swappability
;
9550 if (best
== NULL
) return REDIS_ERR
;
9551 key
= dictGetEntryKey(best
);
9552 val
= dictGetEntryVal(best
);
9554 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9555 key
->ptr
, best_swappability
);
9557 /* Unshare the key if needed */
9558 if (key
->refcount
> 1) {
9559 robj
*newkey
= dupStringObject(key
);
9561 key
= dictGetEntryKey(best
) = newkey
;
9565 vmSwapObjectThreaded(key
,val
,best_db
);
9568 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9569 dictGetEntryVal(best
) = NULL
;
9577 static int vmSwapOneObjectBlocking() {
9578 return vmSwapOneObject(0);
9581 static int vmSwapOneObjectThreaded() {
9582 return vmSwapOneObject(1);
9585 /* Return true if it's safe to swap out objects in a given moment.
9586 * Basically we don't want to swap objects out while there is a BGSAVE
9587 * or a BGAEOREWRITE running in backgroud. */
9588 static int vmCanSwapOut(void) {
9589 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9592 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9593 * and was deleted. Otherwise 0 is returned. */
9594 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9598 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9599 foundkey
= dictGetEntryKey(de
);
9600 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9605 /* =================== Virtual Memory - Threaded I/O ======================= */
9607 static void freeIOJob(iojob
*j
) {
9608 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9609 j
->type
== REDIS_IOJOB_DO_SWAP
||
9610 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9611 decrRefCount(j
->val
);
9612 /* We don't decrRefCount the j->key field as we did't incremented
9613 * the count creating IO Jobs. This is because the key field here is
9614 * just used as an indentifier and if a key is removed the Job should
9615 * never be touched again. */
9619 /* Every time a thread finished a Job, it writes a byte into the write side
9620 * of an unix pipe in order to "awake" the main thread, and this function
9622 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9626 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9628 REDIS_NOTUSED(mask
);
9629 REDIS_NOTUSED(privdata
);
9631 /* For every byte we read in the read side of the pipe, there is one
9632 * I/O job completed to process. */
9633 while((retval
= read(fd
,buf
,1)) == 1) {
9637 struct dictEntry
*de
;
9639 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9641 /* Get the processed element (the oldest one) */
9643 assert(listLength(server
.io_processed
) != 0);
9644 if (toprocess
== -1) {
9645 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9646 if (toprocess
<= 0) toprocess
= 1;
9648 ln
= listFirst(server
.io_processed
);
9650 listDelNode(server
.io_processed
,ln
);
9652 /* If this job is marked as canceled, just ignore it */
9657 /* Post process it in the main thread, as there are things we
9658 * can do just here to avoid race conditions and/or invasive locks */
9659 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
);
9660 de
= dictFind(j
->db
->dict
,j
->key
);
9662 key
= dictGetEntryKey(de
);
9663 if (j
->type
== REDIS_IOJOB_LOAD
) {
9666 /* Key loaded, bring it at home */
9667 key
->storage
= REDIS_VM_MEMORY
;
9668 key
->vm
.atime
= server
.unixtime
;
9669 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9670 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9671 (unsigned char*) key
->ptr
);
9672 server
.vm_stats_swapped_objects
--;
9673 server
.vm_stats_swapins
++;
9674 dictGetEntryVal(de
) = j
->val
;
9675 incrRefCount(j
->val
);
9678 /* Handle clients waiting for this key to be loaded. */
9679 handleClientsBlockedOnSwappedKey(db
,key
);
9680 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9681 /* Now we know the amount of pages required to swap this object.
9682 * Let's find some space for it, and queue this task again
9683 * rebranded as REDIS_IOJOB_DO_SWAP. */
9684 if (!vmCanSwapOut() ||
9685 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9687 /* Ooops... no space or we can't swap as there is
9688 * a fork()ed Redis trying to save stuff on disk. */
9690 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9692 /* Note that we need to mark this pages as used now,
9693 * if the job will be canceled, we'll mark them as freed
9695 vmMarkPagesUsed(j
->page
,j
->pages
);
9696 j
->type
= REDIS_IOJOB_DO_SWAP
;
9701 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9704 /* Key swapped. We can finally free some memory. */
9705 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9706 printf("key->storage: %d\n",key
->storage
);
9707 printf("key->name: %s\n",(char*)key
->ptr
);
9708 printf("key->refcount: %d\n",key
->refcount
);
9709 printf("val: %p\n",(void*)j
->val
);
9710 printf("val->type: %d\n",j
->val
->type
);
9711 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9713 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9714 val
= dictGetEntryVal(de
);
9715 key
->vm
.page
= j
->page
;
9716 key
->vm
.usedpages
= j
->pages
;
9717 key
->storage
= REDIS_VM_SWAPPED
;
9718 key
->vtype
= j
->val
->type
;
9719 decrRefCount(val
); /* Deallocate the object from memory. */
9720 dictGetEntryVal(de
) = NULL
;
9721 redisLog(REDIS_DEBUG
,
9722 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9723 (unsigned char*) key
->ptr
,
9724 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9725 server
.vm_stats_swapped_objects
++;
9726 server
.vm_stats_swapouts
++;
9728 /* Put a few more swap requests in queue if we are still
9730 if (trytoswap
&& vmCanSwapOut() &&
9731 zmalloc_used_memory() > server
.vm_max_memory
)
9736 more
= listLength(server
.io_newjobs
) <
9737 (unsigned) server
.vm_max_threads
;
9739 /* Don't waste CPU time if swappable objects are rare. */
9740 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9748 if (processed
== toprocess
) return;
9750 if (retval
< 0 && errno
!= EAGAIN
) {
9751 redisLog(REDIS_WARNING
,
9752 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9757 static void lockThreadedIO(void) {
9758 pthread_mutex_lock(&server
.io_mutex
);
9761 static void unlockThreadedIO(void) {
9762 pthread_mutex_unlock(&server
.io_mutex
);
9765 /* Remove the specified object from the threaded I/O queue if still not
9766 * processed, otherwise make sure to flag it as canceled. */
9767 static void vmCancelThreadedIOJob(robj
*o
) {
9769 server
.io_newjobs
, /* 0 */
9770 server
.io_processing
, /* 1 */
9771 server
.io_processed
/* 2 */
9775 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9778 /* Search for a matching key in one of the queues */
9779 for (i
= 0; i
< 3; i
++) {
9783 listRewind(lists
[i
],&li
);
9784 while ((ln
= listNext(&li
)) != NULL
) {
9785 iojob
*job
= ln
->value
;
9787 if (job
->canceled
) continue; /* Skip this, already canceled. */
9788 if (job
->key
== o
) {
9789 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9790 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9791 /* Mark the pages as free since the swap didn't happened
9792 * or happened but is now discarded. */
9793 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9794 vmMarkPagesFree(job
->page
,job
->pages
);
9795 /* Cancel the job. It depends on the list the job is
9798 case 0: /* io_newjobs */
9799 /* If the job was yet not processed the best thing to do
9800 * is to remove it from the queue at all */
9802 listDelNode(lists
[i
],ln
);
9804 case 1: /* io_processing */
9805 /* Oh Shi- the thread is messing with the Job:
9807 * Probably it's accessing the object if this is a
9808 * PREPARE_SWAP or DO_SWAP job.
9809 * If it's a LOAD job it may be reading from disk and
9810 * if we don't wait for the job to terminate before to
9811 * cancel it, maybe in a few microseconds data can be
9812 * corrupted in this pages. So the short story is:
9814 * Better to wait for the job to move into the
9815 * next queue (processed)... */
9817 /* We try again and again until the job is completed. */
9819 /* But let's wait some time for the I/O thread
9820 * to finish with this job. After all this condition
9821 * should be very rare. */
9824 case 2: /* io_processed */
9825 /* The job was already processed, that's easy...
9826 * just mark it as canceled so that we'll ignore it
9827 * when processing completed jobs. */
9831 /* Finally we have to adjust the storage type of the object
9832 * in order to "UNDO" the operaiton. */
9833 if (o
->storage
== REDIS_VM_LOADING
)
9834 o
->storage
= REDIS_VM_SWAPPED
;
9835 else if (o
->storage
== REDIS_VM_SWAPPING
)
9836 o
->storage
= REDIS_VM_MEMORY
;
9843 assert(1 != 1); /* We should never reach this */
9846 static void *IOThreadEntryPoint(void *arg
) {
9851 pthread_detach(pthread_self());
9853 /* Get a new job to process */
9855 if (listLength(server
.io_newjobs
) == 0) {
9856 /* No new jobs in queue, exit. */
9857 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9858 (long) pthread_self());
9859 server
.io_active_threads
--;
9863 ln
= listFirst(server
.io_newjobs
);
9865 listDelNode(server
.io_newjobs
,ln
);
9866 /* Add the job in the processing queue */
9867 j
->thread
= pthread_self();
9868 listAddNodeTail(server
.io_processing
,j
);
9869 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9871 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9872 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9874 /* Process the Job */
9875 if (j
->type
== REDIS_IOJOB_LOAD
) {
9876 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9877 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9878 FILE *fp
= fopen("/dev/null","w+");
9879 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9881 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9882 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9886 /* Done: insert the job into the processed queue */
9887 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9888 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9890 listDelNode(server
.io_processing
,ln
);
9891 listAddNodeTail(server
.io_processed
,j
);
9894 /* Signal the main thread there is new stuff to process */
9895 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9897 return NULL
; /* never reached */
9900 static void spawnIOThread(void) {
9902 sigset_t mask
, omask
;
9906 sigaddset(&mask
,SIGCHLD
);
9907 sigaddset(&mask
,SIGHUP
);
9908 sigaddset(&mask
,SIGPIPE
);
9909 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9910 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9911 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9915 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9916 server
.io_active_threads
++;
9919 /* We need to wait for the last thread to exit before we are able to
9920 * fork() in order to BGSAVE or BGREWRITEAOF. */
9921 static void waitEmptyIOJobsQueue(void) {
9923 int io_processed_len
;
9926 if (listLength(server
.io_newjobs
) == 0 &&
9927 listLength(server
.io_processing
) == 0 &&
9928 server
.io_active_threads
== 0)
9933 /* While waiting for empty jobs queue condition we post-process some
9934 * finshed job, as I/O threads may be hanging trying to write against
9935 * the io_ready_pipe_write FD but there are so much pending jobs that
9937 io_processed_len
= listLength(server
.io_processed
);
9939 if (io_processed_len
) {
9940 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9941 usleep(1000); /* 1 millisecond */
9943 usleep(10000); /* 10 milliseconds */
9948 static void vmReopenSwapFile(void) {
9949 /* Note: we don't close the old one as we are in the child process
9950 * and don't want to mess at all with the original file object. */
9951 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9952 if (server
.vm_fp
== NULL
) {
9953 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9954 server
.vm_swap_file
);
9957 server
.vm_fd
= fileno(server
.vm_fp
);
9960 /* This function must be called while with threaded IO locked */
9961 static void queueIOJob(iojob
*j
) {
9962 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9963 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9964 listAddNodeTail(server
.io_newjobs
,j
);
9965 if (server
.io_active_threads
< server
.vm_max_threads
)
9969 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9972 assert(key
->storage
== REDIS_VM_MEMORY
);
9973 assert(key
->refcount
== 1);
9975 j
= zmalloc(sizeof(*j
));
9976 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9982 j
->thread
= (pthread_t
) -1;
9983 key
->storage
= REDIS_VM_SWAPPING
;
9991 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9993 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9994 * If there is not already a job loading the key, it is craeted.
9995 * The key is added to the io_keys list in the client structure, and also
9996 * in the hash table mapping swapped keys to waiting clients, that is,
9997 * server.io_waited_keys. */
9998 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9999 struct dictEntry
*de
;
10003 /* If the key does not exist or is already in RAM we don't need to
10004 * block the client at all. */
10005 de
= dictFind(c
->db
->dict
,key
);
10006 if (de
== NULL
) return 0;
10007 o
= dictGetEntryKey(de
);
10008 if (o
->storage
== REDIS_VM_MEMORY
) {
10010 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
10011 /* We were swapping the key, undo it! */
10012 vmCancelThreadedIOJob(o
);
10016 /* OK: the key is either swapped, or being loaded just now. */
10018 /* Add the key to the list of keys this client is waiting for.
10019 * This maps clients to keys they are waiting for. */
10020 listAddNodeTail(c
->io_keys
,key
);
10023 /* Add the client to the swapped keys => clients waiting map. */
10024 de
= dictFind(c
->db
->io_keys
,key
);
10028 /* For every key we take a list of clients blocked for it */
10030 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
10032 assert(retval
== DICT_OK
);
10034 l
= dictGetEntryVal(de
);
10036 listAddNodeTail(l
,c
);
10038 /* Are we already loading the key from disk? If not create a job */
10039 if (o
->storage
== REDIS_VM_SWAPPED
) {
10042 o
->storage
= REDIS_VM_LOADING
;
10043 j
= zmalloc(sizeof(*j
));
10044 j
->type
= REDIS_IOJOB_LOAD
;
10047 j
->key
->vtype
= o
->vtype
;
10048 j
->page
= o
->vm
.page
;
10051 j
->thread
= (pthread_t
) -1;
10054 unlockThreadedIO();
10059 /* Preload keys for any command with first, last and step values for
10060 * the command keys prototype, as defined in the command table. */
10061 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10063 if (cmd
->vm_firstkey
== 0) return;
10064 last
= cmd
->vm_lastkey
;
10065 if (last
< 0) last
= argc
+last
;
10066 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
10067 redisAssert(j
< argc
);
10068 waitForSwappedKey(c
,argv
[j
]);
10072 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10073 * Note that the number of keys to preload is user-defined, so we need to
10074 * apply a sanity check against argc. */
10075 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10077 REDIS_NOTUSED(cmd
);
10079 num
= atoi(argv
[2]->ptr
);
10080 if (num
> (argc
-3)) return;
10081 for (i
= 0; i
< num
; i
++) {
10082 waitForSwappedKey(c
,argv
[3+i
]);
10086 /* Preload keys needed to execute the entire MULTI/EXEC block.
10088 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10089 * and will block the client when any command requires a swapped out value. */
10090 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10092 struct redisCommand
*mcmd
;
10094 REDIS_NOTUSED(cmd
);
10095 REDIS_NOTUSED(argc
);
10096 REDIS_NOTUSED(argv
);
10098 if (!(c
->flags
& REDIS_MULTI
)) return;
10099 for (i
= 0; i
< c
->mstate
.count
; i
++) {
10100 mcmd
= c
->mstate
.commands
[i
].cmd
;
10101 margc
= c
->mstate
.commands
[i
].argc
;
10102 margv
= c
->mstate
.commands
[i
].argv
;
10104 if (mcmd
->vm_preload_proc
!= NULL
) {
10105 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
10107 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
10112 /* Is this client attempting to run a command against swapped keys?
10113 * If so, block it ASAP, load the keys in background, then resume it.
10115 * The important idea about this function is that it can fail! If keys will
10116 * still be swapped when the client is resumed, this key lookups will
10117 * just block loading keys from disk. In practical terms this should only
10118 * happen with SORT BY command or if there is a bug in this function.
10120 * Return 1 if the client is marked as blocked, 0 if the client can
10121 * continue as the keys it is going to access appear to be in memory. */
10122 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
10123 if (cmd
->vm_preload_proc
!= NULL
) {
10124 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
10126 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
10129 /* If the client was blocked for at least one key, mark it as blocked. */
10130 if (listLength(c
->io_keys
)) {
10131 c
->flags
|= REDIS_IO_WAIT
;
10132 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
10133 server
.vm_blocked_clients
++;
10140 /* Remove the 'key' from the list of blocked keys for a given client.
10142 * The function returns 1 when there are no longer blocking keys after
10143 * the current one was removed (and the client can be unblocked). */
10144 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
10148 struct dictEntry
*de
;
10150 /* Remove the key from the list of keys this client is waiting for. */
10151 listRewind(c
->io_keys
,&li
);
10152 while ((ln
= listNext(&li
)) != NULL
) {
10153 if (equalStringObjects(ln
->value
,key
)) {
10154 listDelNode(c
->io_keys
,ln
);
10158 assert(ln
!= NULL
);
10160 /* Remove the client form the key => waiting clients map. */
10161 de
= dictFind(c
->db
->io_keys
,key
);
10162 assert(de
!= NULL
);
10163 l
= dictGetEntryVal(de
);
10164 ln
= listSearchKey(l
,c
);
10165 assert(ln
!= NULL
);
10167 if (listLength(l
) == 0)
10168 dictDelete(c
->db
->io_keys
,key
);
10170 return listLength(c
->io_keys
) == 0;
10173 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
10174 struct dictEntry
*de
;
10179 de
= dictFind(db
->io_keys
,key
);
10182 l
= dictGetEntryVal(de
);
10183 len
= listLength(l
);
10184 /* Note: we can't use something like while(listLength(l)) as the list
10185 * can be freed by the calling function when we remove the last element. */
10188 redisClient
*c
= ln
->value
;
10190 if (dontWaitForSwappedKey(c
,key
)) {
10191 /* Put the client in the list of clients ready to go as we
10192 * loaded all the keys about it. */
10193 listAddNodeTail(server
.io_ready_clients
,c
);
10198 /* =========================== Remote Configuration ========================= */
10200 static void configSetCommand(redisClient
*c
) {
10201 robj
*o
= getDecodedObject(c
->argv
[3]);
10204 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
10205 zfree(server
.dbfilename
);
10206 server
.dbfilename
= zstrdup(o
->ptr
);
10207 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
10208 zfree(server
.requirepass
);
10209 server
.requirepass
= zstrdup(o
->ptr
);
10210 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
10211 zfree(server
.masterauth
);
10212 server
.masterauth
= zstrdup(o
->ptr
);
10213 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
10214 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10215 ll
< 0) goto badfmt
;
10216 server
.maxmemory
= ll
;
10217 } else if (!strcasecmp(c
->argv
[2]->ptr
,"timeout")) {
10218 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10219 ll
< 0 || ll
> LONG_MAX
) goto badfmt
;
10220 server
.maxidletime
= ll
;
10221 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
10222 if (!strcasecmp(o
->ptr
,"no")) {
10223 server
.appendfsync
= APPENDFSYNC_NO
;
10224 } else if (!strcasecmp(o
->ptr
,"everysec")) {
10225 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
10226 } else if (!strcasecmp(o
->ptr
,"always")) {
10227 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
10231 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendonly")) {
10232 int old
= server
.appendonly
;
10233 int new = yesnotoi(o
->ptr
);
10235 if (new == -1) goto badfmt
;
10240 if (startAppendOnly() == REDIS_ERR
) {
10241 addReplySds(c
,sdscatprintf(sdsempty(),
10242 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10248 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
10250 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
10252 /* Perform sanity check before setting the new config:
10253 * - Even number of args
10254 * - Seconds >= 1, changes >= 0 */
10256 sdsfreesplitres(v
,vlen
);
10259 for (j
= 0; j
< vlen
; j
++) {
10263 val
= strtoll(v
[j
], &eptr
, 10);
10264 if (eptr
[0] != '\0' ||
10265 ((j
& 1) == 0 && val
< 1) ||
10266 ((j
& 1) == 1 && val
< 0)) {
10267 sdsfreesplitres(v
,vlen
);
10271 /* Finally set the new config */
10272 resetServerSaveParams();
10273 for (j
= 0; j
< vlen
; j
+= 2) {
10277 seconds
= strtoll(v
[j
],NULL
,10);
10278 changes
= strtoll(v
[j
+1],NULL
,10);
10279 appendServerSaveParams(seconds
, changes
);
10281 sdsfreesplitres(v
,vlen
);
10283 addReplySds(c
,sdscatprintf(sdsempty(),
10284 "-ERR not supported CONFIG parameter %s\r\n",
10285 (char*)c
->argv
[2]->ptr
));
10290 addReply(c
,shared
.ok
);
10293 badfmt
: /* Bad format errors */
10294 addReplySds(c
,sdscatprintf(sdsempty(),
10295 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10297 (char*)c
->argv
[2]->ptr
));
10301 static void configGetCommand(redisClient
*c
) {
10302 robj
*o
= getDecodedObject(c
->argv
[2]);
10303 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
10304 char *pattern
= o
->ptr
;
10307 addReply(c
,lenobj
);
10308 decrRefCount(lenobj
);
10310 if (stringmatch(pattern
,"dbfilename",0)) {
10311 addReplyBulkCString(c
,"dbfilename");
10312 addReplyBulkCString(c
,server
.dbfilename
);
10315 if (stringmatch(pattern
,"requirepass",0)) {
10316 addReplyBulkCString(c
,"requirepass");
10317 addReplyBulkCString(c
,server
.requirepass
);
10320 if (stringmatch(pattern
,"masterauth",0)) {
10321 addReplyBulkCString(c
,"masterauth");
10322 addReplyBulkCString(c
,server
.masterauth
);
10325 if (stringmatch(pattern
,"maxmemory",0)) {
10328 ll2string(buf
,128,server
.maxmemory
);
10329 addReplyBulkCString(c
,"maxmemory");
10330 addReplyBulkCString(c
,buf
);
10333 if (stringmatch(pattern
,"timeout",0)) {
10336 ll2string(buf
,128,server
.maxidletime
);
10337 addReplyBulkCString(c
,"timeout");
10338 addReplyBulkCString(c
,buf
);
10341 if (stringmatch(pattern
,"appendonly",0)) {
10342 addReplyBulkCString(c
,"appendonly");
10343 addReplyBulkCString(c
,server
.appendonly
? "yes" : "no");
10346 if (stringmatch(pattern
,"appendfsync",0)) {
10349 switch(server
.appendfsync
) {
10350 case APPENDFSYNC_NO
: policy
= "no"; break;
10351 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
10352 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
10353 default: policy
= "unknown"; break; /* too harmless to panic */
10355 addReplyBulkCString(c
,"appendfsync");
10356 addReplyBulkCString(c
,policy
);
10359 if (stringmatch(pattern
,"save",0)) {
10360 sds buf
= sdsempty();
10363 for (j
= 0; j
< server
.saveparamslen
; j
++) {
10364 buf
= sdscatprintf(buf
,"%ld %d",
10365 server
.saveparams
[j
].seconds
,
10366 server
.saveparams
[j
].changes
);
10367 if (j
!= server
.saveparamslen
-1)
10368 buf
= sdscatlen(buf
," ",1);
10370 addReplyBulkCString(c
,"save");
10371 addReplyBulkCString(c
,buf
);
10376 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
10379 static void configCommand(redisClient
*c
) {
10380 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
10381 if (c
->argc
!= 4) goto badarity
;
10382 configSetCommand(c
);
10383 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
10384 if (c
->argc
!= 3) goto badarity
;
10385 configGetCommand(c
);
10386 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
10387 if (c
->argc
!= 2) goto badarity
;
10388 server
.stat_numcommands
= 0;
10389 server
.stat_numconnections
= 0;
10390 server
.stat_expiredkeys
= 0;
10391 server
.stat_starttime
= time(NULL
);
10392 addReply(c
,shared
.ok
);
10394 addReplySds(c
,sdscatprintf(sdsempty(),
10395 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10400 addReplySds(c
,sdscatprintf(sdsempty(),
10401 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10402 (char*) c
->argv
[1]->ptr
));
10405 /* =========================== Pubsub implementation ======================== */
10407 static void freePubsubPattern(void *p
) {
10408 pubsubPattern
*pat
= p
;
10410 decrRefCount(pat
->pattern
);
10414 static int listMatchPubsubPattern(void *a
, void *b
) {
10415 pubsubPattern
*pa
= a
, *pb
= b
;
10417 return (pa
->client
== pb
->client
) &&
10418 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10421 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10422 * 0 if the client was already subscribed to that channel. */
10423 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10424 struct dictEntry
*de
;
10425 list
*clients
= NULL
;
10428 /* Add the channel to the client -> channels hash table */
10429 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10431 incrRefCount(channel
);
10432 /* Add the client to the channel -> list of clients hash table */
10433 de
= dictFind(server
.pubsub_channels
,channel
);
10435 clients
= listCreate();
10436 dictAdd(server
.pubsub_channels
,channel
,clients
);
10437 incrRefCount(channel
);
10439 clients
= dictGetEntryVal(de
);
10441 listAddNodeTail(clients
,c
);
10443 /* Notify the client */
10444 addReply(c
,shared
.mbulk3
);
10445 addReply(c
,shared
.subscribebulk
);
10446 addReplyBulk(c
,channel
);
10447 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10451 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10452 * 0 if the client was not subscribed to the specified channel. */
10453 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10454 struct dictEntry
*de
;
10459 /* Remove the channel from the client -> channels hash table */
10460 incrRefCount(channel
); /* channel may be just a pointer to the same object
10461 we have in the hash tables. Protect it... */
10462 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10464 /* Remove the client from the channel -> clients list hash table */
10465 de
= dictFind(server
.pubsub_channels
,channel
);
10466 assert(de
!= NULL
);
10467 clients
= dictGetEntryVal(de
);
10468 ln
= listSearchKey(clients
,c
);
10469 assert(ln
!= NULL
);
10470 listDelNode(clients
,ln
);
10471 if (listLength(clients
) == 0) {
10472 /* Free the list and associated hash entry at all if this was
10473 * the latest client, so that it will be possible to abuse
10474 * Redis PUBSUB creating millions of channels. */
10475 dictDelete(server
.pubsub_channels
,channel
);
10478 /* Notify the client */
10480 addReply(c
,shared
.mbulk3
);
10481 addReply(c
,shared
.unsubscribebulk
);
10482 addReplyBulk(c
,channel
);
10483 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10484 listLength(c
->pubsub_patterns
));
10487 decrRefCount(channel
); /* it is finally safe to release it */
10491 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10492 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10495 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10497 pubsubPattern
*pat
;
10498 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10499 incrRefCount(pattern
);
10500 pat
= zmalloc(sizeof(*pat
));
10501 pat
->pattern
= getDecodedObject(pattern
);
10503 listAddNodeTail(server
.pubsub_patterns
,pat
);
10505 /* Notify the client */
10506 addReply(c
,shared
.mbulk3
);
10507 addReply(c
,shared
.psubscribebulk
);
10508 addReplyBulk(c
,pattern
);
10509 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10513 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10514 * 0 if the client was not subscribed to the specified channel. */
10515 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10520 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10521 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10523 listDelNode(c
->pubsub_patterns
,ln
);
10525 pat
.pattern
= pattern
;
10526 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10527 listDelNode(server
.pubsub_patterns
,ln
);
10529 /* Notify the client */
10531 addReply(c
,shared
.mbulk3
);
10532 addReply(c
,shared
.punsubscribebulk
);
10533 addReplyBulk(c
,pattern
);
10534 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10535 listLength(c
->pubsub_patterns
));
10537 decrRefCount(pattern
);
10541 /* Unsubscribe from all the channels. Return the number of channels the
10542 * client was subscribed from. */
10543 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10544 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10548 while((de
= dictNext(di
)) != NULL
) {
10549 robj
*channel
= dictGetEntryKey(de
);
10551 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10553 dictReleaseIterator(di
);
10557 /* Unsubscribe from all the patterns. Return the number of patterns the
10558 * client was subscribed from. */
10559 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10564 listRewind(c
->pubsub_patterns
,&li
);
10565 while ((ln
= listNext(&li
)) != NULL
) {
10566 robj
*pattern
= ln
->value
;
10568 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10573 /* Publish a message */
10574 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10576 struct dictEntry
*de
;
10580 /* Send to clients listening for that channel */
10581 de
= dictFind(server
.pubsub_channels
,channel
);
10583 list
*list
= dictGetEntryVal(de
);
10587 listRewind(list
,&li
);
10588 while ((ln
= listNext(&li
)) != NULL
) {
10589 redisClient
*c
= ln
->value
;
10591 addReply(c
,shared
.mbulk3
);
10592 addReply(c
,shared
.messagebulk
);
10593 addReplyBulk(c
,channel
);
10594 addReplyBulk(c
,message
);
10598 /* Send to clients listening to matching channels */
10599 if (listLength(server
.pubsub_patterns
)) {
10600 listRewind(server
.pubsub_patterns
,&li
);
10601 channel
= getDecodedObject(channel
);
10602 while ((ln
= listNext(&li
)) != NULL
) {
10603 pubsubPattern
*pat
= ln
->value
;
10605 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10606 sdslen(pat
->pattern
->ptr
),
10607 (char*)channel
->ptr
,
10608 sdslen(channel
->ptr
),0)) {
10609 addReply(pat
->client
,shared
.mbulk4
);
10610 addReply(pat
->client
,shared
.pmessagebulk
);
10611 addReplyBulk(pat
->client
,pat
->pattern
);
10612 addReplyBulk(pat
->client
,channel
);
10613 addReplyBulk(pat
->client
,message
);
10617 decrRefCount(channel
);
10622 static void subscribeCommand(redisClient
*c
) {
10625 for (j
= 1; j
< c
->argc
; j
++)
10626 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10629 static void unsubscribeCommand(redisClient
*c
) {
10630 if (c
->argc
== 1) {
10631 pubsubUnsubscribeAllChannels(c
,1);
10636 for (j
= 1; j
< c
->argc
; j
++)
10637 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10641 static void psubscribeCommand(redisClient
*c
) {
10644 for (j
= 1; j
< c
->argc
; j
++)
10645 pubsubSubscribePattern(c
,c
->argv
[j
]);
10648 static void punsubscribeCommand(redisClient
*c
) {
10649 if (c
->argc
== 1) {
10650 pubsubUnsubscribeAllPatterns(c
,1);
10655 for (j
= 1; j
< c
->argc
; j
++)
10656 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10660 static void publishCommand(redisClient
*c
) {
10661 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10662 addReplyLongLong(c
,receivers
);
10665 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10667 * The implementation uses a per-DB hash table mapping keys to list of clients
10668 * WATCHing those keys, so that given a key that is going to be modified
10669 * we can mark all the associated clients as dirty.
10671 * Also every client contains a list of WATCHed keys so that's possible to
10672 * un-watch such keys when the client is freed or when UNWATCH is called. */
10674 /* In the client->watched_keys list we need to use watchedKey structures
10675 * as in order to identify a key in Redis we need both the key name and the
10677 typedef struct watchedKey
{
10682 /* Watch for the specified key */
10683 static void watchForKey(redisClient
*c
, robj
*key
) {
10684 list
*clients
= NULL
;
10689 /* Check if we are already watching for this key */
10690 listRewind(c
->watched_keys
,&li
);
10691 while((ln
= listNext(&li
))) {
10692 wk
= listNodeValue(ln
);
10693 if (wk
->db
== c
->db
&& equalStringObjects(key
,wk
->key
))
10694 return; /* Key already watched */
10696 /* This key is not already watched in this DB. Let's add it */
10697 clients
= dictFetchValue(c
->db
->watched_keys
,key
);
10699 clients
= listCreate();
10700 dictAdd(c
->db
->watched_keys
,key
,clients
);
10703 listAddNodeTail(clients
,c
);
10704 /* Add the new key to the lits of keys watched by this client */
10705 wk
= zmalloc(sizeof(*wk
));
10709 listAddNodeTail(c
->watched_keys
,wk
);
10712 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10713 * flag is up to the caller. */
10714 static void unwatchAllKeys(redisClient
*c
) {
10718 if (listLength(c
->watched_keys
) == 0) return;
10719 listRewind(c
->watched_keys
,&li
);
10720 while((ln
= listNext(&li
))) {
10724 /* Lookup the watched key -> clients list and remove the client
10726 wk
= listNodeValue(ln
);
10727 clients
= dictFetchValue(wk
->db
->watched_keys
, wk
->key
);
10728 assert(clients
!= NULL
);
10729 listDelNode(clients
,listSearchKey(clients
,c
));
10730 /* Kill the entry at all if this was the only client */
10731 if (listLength(clients
) == 0)
10732 dictDelete(wk
->db
->watched_keys
, wk
->key
);
10733 /* Remove this watched key from the client->watched list */
10734 listDelNode(c
->watched_keys
,ln
);
10735 decrRefCount(wk
->key
);
10740 /* "Touch" a key, so that if this key is being WATCHed by some client the
10741 * next EXEC will fail. */
10742 static void touchWatchedKey(redisDb
*db
, robj
*key
) {
10747 if (dictSize(db
->watched_keys
) == 0) return;
10748 clients
= dictFetchValue(db
->watched_keys
, key
);
10749 if (!clients
) return;
10751 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
10752 /* Check if we are already watching for this key */
10753 listRewind(clients
,&li
);
10754 while((ln
= listNext(&li
))) {
10755 redisClient
*c
= listNodeValue(ln
);
10757 c
->flags
|= REDIS_DIRTY_CAS
;
10761 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
10762 * flush but will be deleted as effect of the flushing operation should
10763 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
10764 * a FLUSHALL operation (all the DBs flushed). */
10765 static void touchWatchedKeysOnFlush(int dbid
) {
10769 /* For every client, check all the waited keys */
10770 listRewind(server
.clients
,&li1
);
10771 while((ln
= listNext(&li1
))) {
10772 redisClient
*c
= listNodeValue(ln
);
10773 listRewind(c
->watched_keys
,&li2
);
10774 while((ln
= listNext(&li2
))) {
10775 watchedKey
*wk
= listNodeValue(ln
);
10777 /* For every watched key matching the specified DB, if the
10778 * key exists, mark the client as dirty, as the key will be
10780 if (dbid
== -1 || wk
->db
->id
== dbid
) {
10781 if (dictFind(wk
->db
->dict
, wk
->key
) != NULL
)
10782 c
->flags
|= REDIS_DIRTY_CAS
;
10788 static void watchCommand(redisClient
*c
) {
10791 if (c
->flags
& REDIS_MULTI
) {
10792 addReplySds(c
,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
10795 for (j
= 1; j
< c
->argc
; j
++)
10796 watchForKey(c
,c
->argv
[j
]);
10797 addReply(c
,shared
.ok
);
10800 static void unwatchCommand(redisClient
*c
) {
10802 c
->flags
&= (~REDIS_DIRTY_CAS
);
10803 addReply(c
,shared
.ok
);
10806 /* ================================= Debugging ============================== */
10808 /* Compute the sha1 of string at 's' with 'len' bytes long.
10809 * The SHA1 is then xored againt the string pointed by digest.
10810 * Since xor is commutative, this operation is used in order to
10811 * "add" digests relative to unordered elements.
10813 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
10814 static void xorDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10816 unsigned char hash
[20], *s
= ptr
;
10820 SHA1Update(&ctx
,s
,len
);
10821 SHA1Final(hash
,&ctx
);
10823 for (j
= 0; j
< 20; j
++)
10824 digest
[j
] ^= hash
[j
];
10827 static void xorObjectDigest(unsigned char *digest
, robj
*o
) {
10828 o
= getDecodedObject(o
);
10829 xorDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10833 /* This function instead of just computing the SHA1 and xoring it
10834 * against diget, also perform the digest of "digest" itself and
10835 * replace the old value with the new one.
10837 * So the final digest will be:
10839 * digest = SHA1(digest xor SHA1(data))
10841 * This function is used every time we want to preserve the order so
10842 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
10844 * Also note that mixdigest("foo") followed by mixdigest("bar")
10845 * will lead to a different digest compared to "fo", "obar".
10847 static void mixDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10851 xorDigest(digest
,s
,len
);
10853 SHA1Update(&ctx
,digest
,20);
10854 SHA1Final(digest
,&ctx
);
10857 static void mixObjectDigest(unsigned char *digest
, robj
*o
) {
10858 o
= getDecodedObject(o
);
10859 mixDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10863 /* Compute the dataset digest. Since keys, sets elements, hashes elements
10864 * are not ordered, we use a trick: every aggregate digest is the xor
10865 * of the digests of their elements. This way the order will not change
10866 * the result. For list instead we use a feedback entering the output digest
10867 * as input in order to ensure that a different ordered list will result in
10868 * a different digest. */
10869 static void computeDatasetDigest(unsigned char *final
) {
10870 unsigned char digest
[20];
10872 dictIterator
*di
= NULL
;
10877 memset(final
,0,20); /* Start with a clean result */
10879 for (j
= 0; j
< server
.dbnum
; j
++) {
10880 redisDb
*db
= server
.db
+j
;
10882 if (dictSize(db
->dict
) == 0) continue;
10883 di
= dictGetIterator(db
->dict
);
10885 /* hash the DB id, so the same dataset moved in a different
10886 * DB will lead to a different digest */
10888 mixDigest(final
,&aux
,sizeof(aux
));
10890 /* Iterate this DB writing every entry */
10891 while((de
= dictNext(di
)) != NULL
) {
10892 robj
*key
, *o
, *kcopy
;
10895 memset(digest
,0,20); /* This key-val digest */
10896 key
= dictGetEntryKey(de
);
10898 if (!server
.vm_enabled
) {
10899 mixObjectDigest(digest
,key
);
10900 o
= dictGetEntryVal(de
);
10902 /* Don't work with the key directly as when VM is active
10903 * this is unsafe: TODO: fix decrRefCount to check if the
10904 * count really reached 0 to avoid this mess */
10905 kcopy
= dupStringObject(key
);
10906 mixObjectDigest(digest
,kcopy
);
10907 o
= lookupKeyRead(db
,kcopy
);
10908 decrRefCount(kcopy
);
10910 aux
= htonl(o
->type
);
10911 mixDigest(digest
,&aux
,sizeof(aux
));
10912 expiretime
= getExpire(db
,key
);
10914 /* Save the key and associated value */
10915 if (o
->type
== REDIS_STRING
) {
10916 mixObjectDigest(digest
,o
);
10917 } else if (o
->type
== REDIS_LIST
) {
10918 list
*list
= o
->ptr
;
10922 listRewind(list
,&li
);
10923 while((ln
= listNext(&li
))) {
10924 robj
*eleobj
= listNodeValue(ln
);
10926 mixObjectDigest(digest
,eleobj
);
10928 } else if (o
->type
== REDIS_SET
) {
10929 dict
*set
= o
->ptr
;
10930 dictIterator
*di
= dictGetIterator(set
);
10933 while((de
= dictNext(di
)) != NULL
) {
10934 robj
*eleobj
= dictGetEntryKey(de
);
10936 xorObjectDigest(digest
,eleobj
);
10938 dictReleaseIterator(di
);
10939 } else if (o
->type
== REDIS_ZSET
) {
10941 dictIterator
*di
= dictGetIterator(zs
->dict
);
10944 while((de
= dictNext(di
)) != NULL
) {
10945 robj
*eleobj
= dictGetEntryKey(de
);
10946 double *score
= dictGetEntryVal(de
);
10947 unsigned char eledigest
[20];
10949 snprintf(buf
,sizeof(buf
),"%.17g",*score
);
10950 memset(eledigest
,0,20);
10951 mixObjectDigest(eledigest
,eleobj
);
10952 mixDigest(eledigest
,buf
,strlen(buf
));
10953 xorDigest(digest
,eledigest
,20);
10955 dictReleaseIterator(di
);
10956 } else if (o
->type
== REDIS_HASH
) {
10960 hi
= hashInitIterator(o
);
10961 while (hashNext(hi
) != REDIS_ERR
) {
10962 unsigned char eledigest
[20];
10964 memset(eledigest
,0,20);
10965 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
10966 mixObjectDigest(eledigest
,obj
);
10968 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
10969 mixObjectDigest(eledigest
,obj
);
10971 xorDigest(digest
,eledigest
,20);
10973 hashReleaseIterator(hi
);
10975 redisPanic("Unknown object type");
10977 /* If the key has an expire, add it to the mix */
10978 if (expiretime
!= -1) xorDigest(digest
,"!!expire!!",10);
10979 /* We can finally xor the key-val digest to the final digest */
10980 xorDigest(final
,digest
,20);
10982 dictReleaseIterator(di
);
10986 static void debugCommand(redisClient
*c
) {
10987 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10988 *((char*)-1) = 'x';
10989 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10990 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10991 addReply(c
,shared
.err
);
10995 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10996 addReply(c
,shared
.err
);
10999 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
11000 addReply(c
,shared
.ok
);
11001 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
11003 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
11004 addReply(c
,shared
.err
);
11007 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
11008 addReply(c
,shared
.ok
);
11009 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
11010 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
11014 addReply(c
,shared
.nokeyerr
);
11017 key
= dictGetEntryKey(de
);
11018 val
= dictGetEntryVal(de
);
11019 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
11020 key
->storage
== REDIS_VM_SWAPPING
)) {
11024 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
11025 strenc
= strencoding
[val
->encoding
];
11027 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
11030 addReplySds(c
,sdscatprintf(sdsempty(),
11031 "+Key at:%p refcount:%d, value at:%p refcount:%d "
11032 "encoding:%s serializedlength:%lld\r\n",
11033 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
11034 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
11036 addReplySds(c
,sdscatprintf(sdsempty(),
11037 "+Key at:%p refcount:%d, value swapped at: page %llu "
11038 "using %llu pages\r\n",
11039 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
11040 (unsigned long long) key
->vm
.usedpages
));
11042 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
11043 lookupKeyRead(c
->db
,c
->argv
[2]);
11044 addReply(c
,shared
.ok
);
11045 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
11046 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
11049 if (!server
.vm_enabled
) {
11050 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11054 addReply(c
,shared
.nokeyerr
);
11057 key
= dictGetEntryKey(de
);
11058 val
= dictGetEntryVal(de
);
11059 /* If the key is shared we want to create a copy */
11060 if (key
->refcount
> 1) {
11061 robj
*newkey
= dupStringObject(key
);
11063 key
= dictGetEntryKey(de
) = newkey
;
11066 if (key
->storage
!= REDIS_VM_MEMORY
) {
11067 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
11068 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
11069 dictGetEntryVal(de
) = NULL
;
11070 addReply(c
,shared
.ok
);
11072 addReply(c
,shared
.err
);
11074 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
11079 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
11081 for (j
= 0; j
< keys
; j
++) {
11082 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
11083 key
= createStringObject(buf
,strlen(buf
));
11084 if (lookupKeyRead(c
->db
,key
) != NULL
) {
11088 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
11089 val
= createStringObject(buf
,strlen(buf
));
11090 dictAdd(c
->db
->dict
,key
,val
);
11092 addReply(c
,shared
.ok
);
11093 } else if (!strcasecmp(c
->argv
[1]->ptr
,"digest") && c
->argc
== 2) {
11094 unsigned char digest
[20];
11095 sds d
= sdsnew("+");
11098 computeDatasetDigest(digest
);
11099 for (j
= 0; j
< 20; j
++)
11100 d
= sdscatprintf(d
, "%02x",digest
[j
]);
11102 d
= sdscatlen(d
,"\r\n",2);
11105 addReplySds(c
,sdsnew(
11106 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11110 static void _redisAssert(char *estr
, char *file
, int line
) {
11111 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
11112 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true",file
,line
,estr
);
11113 #ifdef HAVE_BACKTRACE
11114 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11115 *((char*)-1) = 'x';
11119 static void _redisPanic(char *msg
, char *file
, int line
) {
11120 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
11121 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
11122 #ifdef HAVE_BACKTRACE
11123 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11124 *((char*)-1) = 'x';
11128 /* =================================== Main! ================================ */
11131 int linuxOvercommitMemoryValue(void) {
11132 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
11135 if (!fp
) return -1;
11136 if (fgets(buf
,64,fp
) == NULL
) {
11145 void linuxOvercommitMemoryWarning(void) {
11146 if (linuxOvercommitMemoryValue() == 0) {
11147 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.");
11150 #endif /* __linux__ */
11152 static void daemonize(void) {
11156 if (fork() != 0) exit(0); /* parent exits */
11157 setsid(); /* create a new session */
11159 /* Every output goes to /dev/null. If Redis is daemonized but
11160 * the 'logfile' is set to 'stdout' in the configuration file
11161 * it will not log at all. */
11162 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
11163 dup2(fd
, STDIN_FILENO
);
11164 dup2(fd
, STDOUT_FILENO
);
11165 dup2(fd
, STDERR_FILENO
);
11166 if (fd
> STDERR_FILENO
) close(fd
);
11168 /* Try to write the pid file */
11169 fp
= fopen(server
.pidfile
,"w");
11171 fprintf(fp
,"%d\n",getpid());
11176 static void version() {
11177 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
11178 REDIS_GIT_SHA1
, atoi(REDIS_GIT_DIRTY
) > 0);
11182 static void usage() {
11183 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
11184 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
11188 int main(int argc
, char **argv
) {
11191 initServerConfig();
11192 sortCommandTable();
11194 if (strcmp(argv
[1], "-v") == 0 ||
11195 strcmp(argv
[1], "--version") == 0) version();
11196 if (strcmp(argv
[1], "--help") == 0) usage();
11197 resetServerSaveParams();
11198 loadServerConfig(argv
[1]);
11199 } else if ((argc
> 2)) {
11202 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'");
11204 if (server
.daemonize
) daemonize();
11206 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
11208 linuxOvercommitMemoryWarning();
11210 start
= time(NULL
);
11211 if (server
.appendonly
) {
11212 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
11213 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
11215 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
11216 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
11218 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
11219 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
11221 aeDeleteEventLoop(server
.el
);
11225 /* ============================= Backtrace support ========================= */
11227 #ifdef HAVE_BACKTRACE
11228 static char *findFuncName(void *pointer
, unsigned long *offset
);
11230 static void *getMcontextEip(ucontext_t
*uc
) {
11231 #if defined(__FreeBSD__)
11232 return (void*) uc
->uc_mcontext
.mc_eip
;
11233 #elif defined(__dietlibc__)
11234 return (void*) uc
->uc_mcontext
.eip
;
11235 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11237 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11239 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11241 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11242 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11243 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11245 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11247 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11248 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
11249 #elif defined(__ia64__) /* Linux IA64 */
11250 return (void*) uc
->uc_mcontext
.sc_ip
;
11256 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
11258 char **messages
= NULL
;
11259 int i
, trace_size
= 0;
11260 unsigned long offset
=0;
11261 ucontext_t
*uc
= (ucontext_t
*) secret
;
11263 REDIS_NOTUSED(info
);
11265 redisLog(REDIS_WARNING
,
11266 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
11267 infostring
= genRedisInfoString();
11268 redisLog(REDIS_WARNING
, "%s",infostring
);
11269 /* It's not safe to sdsfree() the returned string under memory
11270 * corruption conditions. Let it leak as we are going to abort */
11272 trace_size
= backtrace(trace
, 100);
11273 /* overwrite sigaction with caller's address */
11274 if (getMcontextEip(uc
) != NULL
) {
11275 trace
[1] = getMcontextEip(uc
);
11277 messages
= backtrace_symbols(trace
, trace_size
);
11279 for (i
=1; i
<trace_size
; ++i
) {
11280 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
11282 p
= strchr(messages
[i
],'+');
11283 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
11284 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
11286 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
11289 /* free(messages); Don't call free() with possibly corrupted memory. */
11293 static void sigtermHandler(int sig
) {
11294 REDIS_NOTUSED(sig
);
11296 redisLog(REDIS_WARNING
,"SIGTERM received, scheduling shutting down...");
11297 server
.shutdown_asap
= 1;
11300 static void setupSigSegvAction(void) {
11301 struct sigaction act
;
11303 sigemptyset (&act
.sa_mask
);
11304 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11305 * is used. Otherwise, sa_handler is used */
11306 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
11307 act
.sa_sigaction
= segvHandler
;
11308 sigaction (SIGSEGV
, &act
, NULL
);
11309 sigaction (SIGBUS
, &act
, NULL
);
11310 sigaction (SIGFPE
, &act
, NULL
);
11311 sigaction (SIGILL
, &act
, NULL
);
11312 sigaction (SIGBUS
, &act
, NULL
);
11314 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
11315 act
.sa_handler
= sigtermHandler
;
11316 sigaction (SIGTERM
, &act
, NULL
);
11320 #include "staticsymbols.h"
11321 /* This function try to convert a pointer into a function name. It's used in
11322 * oreder to provide a backtrace under segmentation fault that's able to
11323 * display functions declared as static (otherwise the backtrace is useless). */
11324 static char *findFuncName(void *pointer
, unsigned long *offset
){
11326 unsigned long off
, minoff
= 0;
11328 /* Try to match against the Symbol with the smallest offset */
11329 for (i
=0; symsTable
[i
].pointer
; i
++) {
11330 unsigned long lp
= (unsigned long) pointer
;
11332 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
11333 off
=lp
-symsTable
[i
].pointer
;
11334 if (ret
< 0 || off
< minoff
) {
11340 if (ret
== -1) return NULL
;
11342 return symsTable
[ret
].name
;
11344 #else /* HAVE_BACKTRACE */
11345 static void setupSigSegvAction(void) {
11347 #endif /* HAVE_BACKTRACE */