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();
2987 robj
*o
= createObject(REDIS_LIST
,l
);
2988 listSetFreeMethod(l
,decrRefCount
);
2989 o
->encoding
= REDIS_ENCODING_LIST
;
2993 static robj
*createZiplistObject(void) {
2994 unsigned char *zl
= ziplistNew();
2995 robj
*o
= createObject(REDIS_LIST
,zl
);
2996 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
3000 static robj
*createSetObject(void) {
3001 dict
*d
= dictCreate(&setDictType
,NULL
);
3002 return createObject(REDIS_SET
,d
);
3005 static robj
*createHashObject(void) {
3006 /* All the Hashes start as zipmaps. Will be automatically converted
3007 * into hash tables if there are enough elements or big elements
3009 unsigned char *zm
= zipmapNew();
3010 robj
*o
= createObject(REDIS_HASH
,zm
);
3011 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
3015 static robj
*createZsetObject(void) {
3016 zset
*zs
= zmalloc(sizeof(*zs
));
3018 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
3019 zs
->zsl
= zslCreate();
3020 return createObject(REDIS_ZSET
,zs
);
3023 static void freeStringObject(robj
*o
) {
3024 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3029 static void freeListObject(robj
*o
) {
3030 switch (o
->encoding
) {
3031 case REDIS_ENCODING_LIST
:
3032 listRelease((list
*) o
->ptr
);
3034 case REDIS_ENCODING_ZIPLIST
:
3038 redisPanic("Unknown list encoding type");
3042 static void freeSetObject(robj
*o
) {
3043 dictRelease((dict
*) o
->ptr
);
3046 static void freeZsetObject(robj
*o
) {
3049 dictRelease(zs
->dict
);
3054 static void freeHashObject(robj
*o
) {
3055 switch (o
->encoding
) {
3056 case REDIS_ENCODING_HT
:
3057 dictRelease((dict
*) o
->ptr
);
3059 case REDIS_ENCODING_ZIPMAP
:
3063 redisPanic("Unknown hash encoding type");
3068 static void incrRefCount(robj
*o
) {
3072 static void decrRefCount(void *obj
) {
3075 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3076 /* Object is a key of a swapped out value, or in the process of being
3078 if (server
.vm_enabled
&&
3079 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3081 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3082 redisAssert(o
->type
== REDIS_STRING
);
3083 freeStringObject(o
);
3084 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3085 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3086 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3087 !listAddNodeHead(server
.objfreelist
,o
))
3089 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3090 server
.vm_stats_swapped_objects
--;
3093 /* Object is in memory, or in the process of being swapped out. */
3094 if (--(o
->refcount
) == 0) {
3095 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3096 vmCancelThreadedIOJob(obj
);
3098 case REDIS_STRING
: freeStringObject(o
); break;
3099 case REDIS_LIST
: freeListObject(o
); break;
3100 case REDIS_SET
: freeSetObject(o
); break;
3101 case REDIS_ZSET
: freeZsetObject(o
); break;
3102 case REDIS_HASH
: freeHashObject(o
); break;
3103 default: redisPanic("Unknown object type"); break;
3105 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3106 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3107 !listAddNodeHead(server
.objfreelist
,o
))
3109 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3113 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3114 dictEntry
*de
= dictFind(db
->dict
,key
);
3116 robj
*key
= dictGetEntryKey(de
);
3117 robj
*val
= dictGetEntryVal(de
);
3119 if (server
.vm_enabled
) {
3120 if (key
->storage
== REDIS_VM_MEMORY
||
3121 key
->storage
== REDIS_VM_SWAPPING
)
3123 /* If we were swapping the object out, stop it, this key
3125 if (key
->storage
== REDIS_VM_SWAPPING
)
3126 vmCancelThreadedIOJob(key
);
3127 /* Update the access time of the key for the aging algorithm. */
3128 key
->vm
.atime
= server
.unixtime
;
3130 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3132 /* Our value was swapped on disk. Bring it at home. */
3133 redisAssert(val
== NULL
);
3134 val
= vmLoadObject(key
);
3135 dictGetEntryVal(de
) = val
;
3137 /* Clients blocked by the VM subsystem may be waiting for
3139 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3148 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3149 expireIfNeeded(db
,key
);
3150 return lookupKey(db
,key
);
3153 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3154 deleteIfVolatile(db
,key
);
3155 touchWatchedKey(db
,key
);
3156 return lookupKey(db
,key
);
3159 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3160 robj
*o
= lookupKeyRead(c
->db
, key
);
3161 if (!o
) addReply(c
,reply
);
3165 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3166 robj
*o
= lookupKeyWrite(c
->db
, key
);
3167 if (!o
) addReply(c
,reply
);
3171 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3172 if (o
->type
!= type
) {
3173 addReply(c
,shared
.wrongtypeerr
);
3179 static int deleteKey(redisDb
*db
, robj
*key
) {
3182 /* We need to protect key from destruction: after the first dictDelete()
3183 * it may happen that 'key' is no longer valid if we don't increment
3184 * it's count. This may happen when we get the object reference directly
3185 * from the hash table with dictRandomKey() or dict iterators */
3187 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3188 retval
= dictDelete(db
->dict
,key
);
3191 return retval
== DICT_OK
;
3194 /* Check if the nul-terminated string 's' can be represented by a long
3195 * (that is, is a number that fits into long without any other space or
3196 * character before or after the digits).
3198 * If so, the function returns REDIS_OK and *longval is set to the value
3199 * of the number. Otherwise REDIS_ERR is returned */
3200 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3201 char buf
[32], *endptr
;
3205 value
= strtol(s
, &endptr
, 10);
3206 if (endptr
[0] != '\0') return REDIS_ERR
;
3207 slen
= ll2string(buf
,32,value
);
3209 /* If the number converted back into a string is not identical
3210 * then it's not possible to encode the string as integer */
3211 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3212 if (longval
) *longval
= value
;
3216 /* Try to encode a string object in order to save space */
3217 static robj
*tryObjectEncoding(robj
*o
) {
3221 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3222 return o
; /* Already encoded */
3224 /* It's not safe to encode shared objects: shared objects can be shared
3225 * everywhere in the "object space" of Redis. Encoded objects can only
3226 * appear as "values" (and not, for instance, as keys) */
3227 if (o
->refcount
> 1) return o
;
3229 /* Currently we try to encode only strings */
3230 redisAssert(o
->type
== REDIS_STRING
);
3232 /* Check if we can represent this string as a long integer */
3233 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3235 /* Ok, this object can be encoded */
3236 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3238 incrRefCount(shared
.integers
[value
]);
3239 return shared
.integers
[value
];
3241 o
->encoding
= REDIS_ENCODING_INT
;
3243 o
->ptr
= (void*) value
;
3248 /* Get a decoded version of an encoded object (returned as a new object).
3249 * If the object is already raw-encoded just increment the ref count. */
3250 static robj
*getDecodedObject(robj
*o
) {
3253 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3257 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3260 ll2string(buf
,32,(long)o
->ptr
);
3261 dec
= createStringObject(buf
,strlen(buf
));
3264 redisPanic("Unknown encoding type");
3268 /* Compare two string objects via strcmp() or alike.
3269 * Note that the objects may be integer-encoded. In such a case we
3270 * use ll2string() to get a string representation of the numbers on the stack
3271 * and compare the strings, it's much faster than calling getDecodedObject().
3273 * Important note: if objects are not integer encoded, but binary-safe strings,
3274 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3276 static int compareStringObjects(robj
*a
, robj
*b
) {
3277 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3278 char bufa
[128], bufb
[128], *astr
, *bstr
;
3281 if (a
== b
) return 0;
3282 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3283 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3289 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3290 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3296 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3299 /* Equal string objects return 1 if the two objects are the same from the
3300 * point of view of a string comparison, otherwise 0 is returned. Note that
3301 * this function is faster then checking for (compareStringObject(a,b) == 0)
3302 * because it can perform some more optimization. */
3303 static int equalStringObjects(robj
*a
, robj
*b
) {
3304 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3305 return a
->ptr
== b
->ptr
;
3307 return compareStringObjects(a
,b
) == 0;
3311 static size_t stringObjectLen(robj
*o
) {
3312 redisAssert(o
->type
== REDIS_STRING
);
3313 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3314 return sdslen(o
->ptr
);
3318 return ll2string(buf
,32,(long)o
->ptr
);
3322 static int getDoubleFromObject(robj
*o
, double *target
) {
3329 redisAssert(o
->type
== REDIS_STRING
);
3330 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3331 value
= strtod(o
->ptr
, &eptr
);
3332 if (eptr
[0] != '\0') return REDIS_ERR
;
3333 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3334 value
= (long)o
->ptr
;
3336 redisPanic("Unknown string encoding");
3344 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3346 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3348 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3350 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3359 static int getLongLongFromObject(robj
*o
, long long *target
) {
3366 redisAssert(o
->type
== REDIS_STRING
);
3367 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3368 value
= strtoll(o
->ptr
, &eptr
, 10);
3369 if (eptr
[0] != '\0') return REDIS_ERR
;
3370 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3371 value
= (long)o
->ptr
;
3373 redisPanic("Unknown string encoding");
3381 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3383 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3385 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3387 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3396 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3399 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3400 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3402 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3404 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3413 /*============================ RDB saving/loading =========================== */
3415 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3416 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3420 static int rdbSaveTime(FILE *fp
, time_t t
) {
3421 int32_t t32
= (int32_t) t
;
3422 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3426 /* check rdbLoadLen() comments for more info */
3427 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3428 unsigned char buf
[2];
3431 /* Save a 6 bit len */
3432 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3433 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3434 } else if (len
< (1<<14)) {
3435 /* Save a 14 bit len */
3436 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3438 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3440 /* Save a 32 bit len */
3441 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3442 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3444 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3449 /* Encode 'value' as an integer if possible (if integer will fit the
3450 * supported range). If the function sucessful encoded the integer
3451 * then the (up to 5 bytes) encoded representation is written in the
3452 * string pointed by 'enc' and the length is returned. Otherwise
3454 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3455 /* Finally check if it fits in our ranges */
3456 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3457 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3458 enc
[1] = value
&0xFF;
3460 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3461 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3462 enc
[1] = value
&0xFF;
3463 enc
[2] = (value
>>8)&0xFF;
3465 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3466 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3467 enc
[1] = value
&0xFF;
3468 enc
[2] = (value
>>8)&0xFF;
3469 enc
[3] = (value
>>16)&0xFF;
3470 enc
[4] = (value
>>24)&0xFF;
3477 /* String objects in the form "2391" "-100" without any space and with a
3478 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3479 * encoded as integers to save space */
3480 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3482 char *endptr
, buf
[32];
3484 /* Check if it's possible to encode this value as a number */
3485 value
= strtoll(s
, &endptr
, 10);
3486 if (endptr
[0] != '\0') return 0;
3487 ll2string(buf
,32,value
);
3489 /* If the number converted back into a string is not identical
3490 * then it's not possible to encode the string as integer */
3491 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3493 return rdbEncodeInteger(value
,enc
);
3496 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3497 size_t comprlen
, outlen
;
3501 /* We require at least four bytes compression for this to be worth it */
3502 if (len
<= 4) return 0;
3504 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3505 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3506 if (comprlen
== 0) {
3510 /* Data compressed! Let's save it on disk */
3511 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3512 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3513 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3514 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3515 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3524 /* Save a string objet as [len][data] on disk. If the object is a string
3525 * representation of an integer value we try to safe it in a special form */
3526 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3529 /* Try integer encoding */
3531 unsigned char buf
[5];
3532 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3533 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3538 /* Try LZF compression - under 20 bytes it's unable to compress even
3539 * aaaaaaaaaaaaaaaaaa so skip it */
3540 if (server
.rdbcompression
&& len
> 20) {
3543 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3544 if (retval
== -1) return -1;
3545 if (retval
> 0) return 0;
3546 /* retval == 0 means data can't be compressed, save the old way */
3549 /* Store verbatim */
3550 if (rdbSaveLen(fp
,len
) == -1) return -1;
3551 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3555 /* Save a long long value as either an encoded string or a string. */
3556 static int rdbSaveLongLongAsStringObject(FILE *fp
, long long value
) {
3557 unsigned char buf
[32];
3558 int enclen
= rdbEncodeInteger(value
,buf
);
3560 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3562 /* Encode as string */
3563 enclen
= ll2string((char*)buf
,32,value
);
3564 redisAssert(enclen
< 32);
3565 if (rdbSaveLen(fp
,enclen
) == -1) return -1;
3566 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3571 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3572 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3573 /* Avoid to decode the object, then encode it again, if the
3574 * object is alrady integer encoded. */
3575 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3576 return rdbSaveLongLongAsStringObject(fp
,(long)obj
->ptr
);
3578 redisAssert(obj
->encoding
== REDIS_ENCODING_RAW
);
3579 return rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3583 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3584 * 8 bit integer specifing the length of the representation.
3585 * This 8 bit integer has special values in order to specify the following
3591 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3592 unsigned char buf
[128];
3598 } else if (!isfinite(val
)) {
3600 buf
[0] = (val
< 0) ? 255 : 254;
3602 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3603 /* Check if the float is in a safe range to be casted into a
3604 * long long. We are assuming that long long is 64 bit here.
3605 * Also we are assuming that there are no implementations around where
3606 * double has precision < 52 bit.
3608 * Under this assumptions we test if a double is inside an interval
3609 * where casting to long long is safe. Then using two castings we
3610 * make sure the decimal part is zero. If all this is true we use
3611 * integer printing function that is much faster. */
3612 double min
= -4503599627370495; /* (2^52)-1 */
3613 double max
= 4503599627370496; /* -(2^52) */
3614 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3615 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3618 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3619 buf
[0] = strlen((char*)buf
+1);
3622 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3626 /* Save a Redis object. */
3627 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3628 if (o
->type
== REDIS_STRING
) {
3629 /* Save a string value */
3630 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3631 } else if (o
->type
== REDIS_LIST
) {
3632 /* Save a list value */
3633 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
3635 unsigned char *vstr
;
3639 if (rdbSaveLen(fp
,ziplistLen(o
->ptr
)) == -1) return -1;
3640 p
= ziplistIndex(o
->ptr
,0);
3641 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
3643 if (rdbSaveRawString(fp
,vstr
,vlen
) == -1)
3646 if (rdbSaveLongLongAsStringObject(fp
,vlong
) == -1)
3649 p
= ziplistNext(o
->ptr
,p
);
3651 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
3652 list
*list
= o
->ptr
;
3656 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3657 listRewind(list
,&li
);
3658 while((ln
= listNext(&li
))) {
3659 robj
*eleobj
= listNodeValue(ln
);
3660 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3663 redisPanic("Unknown list encoding");
3665 } else if (o
->type
== REDIS_SET
) {
3666 /* Save a set value */
3668 dictIterator
*di
= dictGetIterator(set
);
3671 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3672 while((de
= dictNext(di
)) != NULL
) {
3673 robj
*eleobj
= dictGetEntryKey(de
);
3675 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3677 dictReleaseIterator(di
);
3678 } else if (o
->type
== REDIS_ZSET
) {
3679 /* Save a set value */
3681 dictIterator
*di
= dictGetIterator(zs
->dict
);
3684 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3685 while((de
= dictNext(di
)) != NULL
) {
3686 robj
*eleobj
= dictGetEntryKey(de
);
3687 double *score
= dictGetEntryVal(de
);
3689 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3690 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3692 dictReleaseIterator(di
);
3693 } else if (o
->type
== REDIS_HASH
) {
3694 /* Save a hash value */
3695 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3696 unsigned char *p
= zipmapRewind(o
->ptr
);
3697 unsigned int count
= zipmapLen(o
->ptr
);
3698 unsigned char *key
, *val
;
3699 unsigned int klen
, vlen
;
3701 if (rdbSaveLen(fp
,count
) == -1) return -1;
3702 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3703 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3704 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3707 dictIterator
*di
= dictGetIterator(o
->ptr
);
3710 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3711 while((de
= dictNext(di
)) != NULL
) {
3712 robj
*key
= dictGetEntryKey(de
);
3713 robj
*val
= dictGetEntryVal(de
);
3715 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3716 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3718 dictReleaseIterator(di
);
3721 redisPanic("Unknown object type");
3726 /* Return the length the object will have on disk if saved with
3727 * the rdbSaveObject() function. Currently we use a trick to get
3728 * this length with very little changes to the code. In the future
3729 * we could switch to a faster solution. */
3730 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3731 if (fp
== NULL
) fp
= server
.devnull
;
3733 assert(rdbSaveObject(fp
,o
) != 1);
3737 /* Return the number of pages required to save this object in the swap file */
3738 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3739 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3741 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3744 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3745 static int rdbSave(char *filename
) {
3746 dictIterator
*di
= NULL
;
3751 time_t now
= time(NULL
);
3753 /* Wait for I/O therads to terminate, just in case this is a
3754 * foreground-saving, to avoid seeking the swap file descriptor at the
3756 if (server
.vm_enabled
)
3757 waitEmptyIOJobsQueue();
3759 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3760 fp
= fopen(tmpfile
,"w");
3762 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3765 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3766 for (j
= 0; j
< server
.dbnum
; j
++) {
3767 redisDb
*db
= server
.db
+j
;
3769 if (dictSize(d
) == 0) continue;
3770 di
= dictGetIterator(d
);
3776 /* Write the SELECT DB opcode */
3777 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3778 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3780 /* Iterate this DB writing every entry */
3781 while((de
= dictNext(di
)) != NULL
) {
3782 robj
*key
= dictGetEntryKey(de
);
3783 robj
*o
= dictGetEntryVal(de
);
3784 time_t expiretime
= getExpire(db
,key
);
3786 /* Save the expire time */
3787 if (expiretime
!= -1) {
3788 /* If this key is already expired skip it */
3789 if (expiretime
< now
) continue;
3790 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3791 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3793 /* Save the key and associated value. This requires special
3794 * handling if the value is swapped out. */
3795 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3796 key
->storage
== REDIS_VM_SWAPPING
) {
3797 /* Save type, key, value */
3798 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3799 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3800 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3802 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3804 /* Get a preview of the object in memory */
3805 po
= vmPreviewObject(key
);
3806 /* Save type, key, value */
3807 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3808 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3809 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3810 /* Remove the loaded object from memory */
3814 dictReleaseIterator(di
);
3817 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3819 /* Make sure data will not remain on the OS's output buffers */
3824 /* Use RENAME to make sure the DB file is changed atomically only
3825 * if the generate DB file is ok. */
3826 if (rename(tmpfile
,filename
) == -1) {
3827 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3831 redisLog(REDIS_NOTICE
,"DB saved on disk");
3833 server
.lastsave
= time(NULL
);
3839 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3840 if (di
) dictReleaseIterator(di
);
3844 static int rdbSaveBackground(char *filename
) {
3847 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3848 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3849 if ((childpid
= fork()) == 0) {
3851 if (server
.vm_enabled
) vmReopenSwapFile();
3853 if (rdbSave(filename
) == REDIS_OK
) {
3860 if (childpid
== -1) {
3861 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3865 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3866 server
.bgsavechildpid
= childpid
;
3867 updateDictResizePolicy();
3870 return REDIS_OK
; /* unreached */
3873 static void rdbRemoveTempFile(pid_t childpid
) {
3876 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3880 static int rdbLoadType(FILE *fp
) {
3882 if (fread(&type
,1,1,fp
) == 0) return -1;
3886 static time_t rdbLoadTime(FILE *fp
) {
3888 if (fread(&t32
,4,1,fp
) == 0) return -1;
3889 return (time_t) t32
;
3892 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3893 * of this file for a description of how this are stored on disk.
3895 * isencoded is set to 1 if the readed length is not actually a length but
3896 * an "encoding type", check the above comments for more info */
3897 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3898 unsigned char buf
[2];
3902 if (isencoded
) *isencoded
= 0;
3903 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3904 type
= (buf
[0]&0xC0)>>6;
3905 if (type
== REDIS_RDB_6BITLEN
) {
3906 /* Read a 6 bit len */
3908 } else if (type
== REDIS_RDB_ENCVAL
) {
3909 /* Read a 6 bit len encoding type */
3910 if (isencoded
) *isencoded
= 1;
3912 } else if (type
== REDIS_RDB_14BITLEN
) {
3913 /* Read a 14 bit len */
3914 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3915 return ((buf
[0]&0x3F)<<8)|buf
[1];
3917 /* Read a 32 bit len */
3918 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3923 /* Load an integer-encoded object from file 'fp', with the specified
3924 * encoding type 'enctype'. If encode is true the function may return
3925 * an integer-encoded object as reply, otherwise the returned object
3926 * will always be encoded as a raw string. */
3927 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3928 unsigned char enc
[4];
3931 if (enctype
== REDIS_RDB_ENC_INT8
) {
3932 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3933 val
= (signed char)enc
[0];
3934 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3936 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3937 v
= enc
[0]|(enc
[1]<<8);
3939 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3941 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3942 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3945 val
= 0; /* anti-warning */
3946 redisPanic("Unknown RDB integer encoding type");
3949 return createStringObjectFromLongLong(val
);
3951 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3954 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3955 unsigned int len
, clen
;
3956 unsigned char *c
= NULL
;
3959 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3960 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3961 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3962 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3963 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3964 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3966 return createObject(REDIS_STRING
,val
);
3973 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3978 len
= rdbLoadLen(fp
,&isencoded
);
3981 case REDIS_RDB_ENC_INT8
:
3982 case REDIS_RDB_ENC_INT16
:
3983 case REDIS_RDB_ENC_INT32
:
3984 return rdbLoadIntegerObject(fp
,len
,encode
);
3985 case REDIS_RDB_ENC_LZF
:
3986 return rdbLoadLzfStringObject(fp
);
3988 redisPanic("Unknown RDB encoding type");
3992 if (len
== REDIS_RDB_LENERR
) return NULL
;
3993 val
= sdsnewlen(NULL
,len
);
3994 if (len
&& fread(val
,len
,1,fp
) == 0) {
3998 return createObject(REDIS_STRING
,val
);
4001 static robj
*rdbLoadStringObject(FILE *fp
) {
4002 return rdbGenericLoadStringObject(fp
,0);
4005 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
4006 return rdbGenericLoadStringObject(fp
,1);
4009 /* For information about double serialization check rdbSaveDoubleValue() */
4010 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
4014 if (fread(&len
,1,1,fp
) == 0) return -1;
4016 case 255: *val
= R_NegInf
; return 0;
4017 case 254: *val
= R_PosInf
; return 0;
4018 case 253: *val
= R_Nan
; return 0;
4020 if (fread(buf
,len
,1,fp
) == 0) return -1;
4022 sscanf(buf
, "%lg", val
);
4027 /* Load a Redis object of the specified type from the specified file.
4028 * On success a newly allocated object is returned, otherwise NULL. */
4029 static robj
*rdbLoadObject(int type
, FILE *fp
) {
4030 robj
*o
, *ele
, *dec
;
4033 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
4034 if (type
== REDIS_STRING
) {
4035 /* Read string value */
4036 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4037 o
= tryObjectEncoding(o
);
4038 } else if (type
== REDIS_LIST
) {
4039 /* Read list value */
4040 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4042 o
= createZiplistObject();
4044 /* Load every single element of the list */
4046 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4048 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4049 dec
= getDecodedObject(ele
);
4050 o
->ptr
= ziplistPush(o
->ptr
,dec
->ptr
,sdslen(dec
->ptr
),REDIS_TAIL
);
4054 ele
= tryObjectEncoding(ele
);
4055 listAddNodeTail(o
->ptr
,ele
);
4059 } else if (type
== REDIS_SET
) {
4060 /* Read list/set value */
4061 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4062 o
= createSetObject();
4063 /* It's faster to expand the dict to the right size asap in order
4064 * to avoid rehashing */
4065 if (len
> DICT_HT_INITIAL_SIZE
)
4066 dictExpand(o
->ptr
,len
);
4067 /* Load every single element of the list/set */
4069 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4070 ele
= tryObjectEncoding(ele
);
4071 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
4073 } else if (type
== REDIS_ZSET
) {
4074 /* Read list/set value */
4078 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4079 o
= createZsetObject();
4081 /* Load every single element of the list/set */
4084 double *score
= zmalloc(sizeof(double));
4086 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4087 ele
= tryObjectEncoding(ele
);
4088 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
4089 dictAdd(zs
->dict
,ele
,score
);
4090 zslInsert(zs
->zsl
,*score
,ele
);
4091 incrRefCount(ele
); /* added to skiplist */
4093 } else if (type
== REDIS_HASH
) {
4096 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4097 o
= createHashObject();
4098 /* Too many entries? Use an hash table. */
4099 if (hashlen
> server
.hash_max_zipmap_entries
)
4100 convertToRealHash(o
);
4101 /* Load every key/value, then set it into the zipmap or hash
4102 * table, as needed. */
4106 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4107 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4108 /* If we are using a zipmap and there are too big values
4109 * the object is converted to real hash table encoding. */
4110 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4111 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
4112 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
4114 convertToRealHash(o
);
4117 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
4118 unsigned char *zm
= o
->ptr
;
4120 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4121 val
->ptr
,sdslen(val
->ptr
),NULL
);
4126 key
= tryObjectEncoding(key
);
4127 val
= tryObjectEncoding(val
);
4128 dictAdd((dict
*)o
->ptr
,key
,val
);
4132 redisPanic("Unknown object type");
4137 static int rdbLoad(char *filename
) {
4140 int type
, retval
, rdbver
;
4141 int swap_all_values
= 0;
4142 dict
*d
= server
.db
[0].dict
;
4143 redisDb
*db
= server
.db
+0;
4145 time_t expiretime
, now
= time(NULL
);
4146 long long loadedkeys
= 0;
4148 fp
= fopen(filename
,"r");
4149 if (!fp
) return REDIS_ERR
;
4150 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4152 if (memcmp(buf
,"REDIS",5) != 0) {
4154 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4157 rdbver
= atoi(buf
+5);
4160 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4168 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4169 if (type
== REDIS_EXPIRETIME
) {
4170 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4171 /* We read the time so we need to read the object type again */
4172 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4174 if (type
== REDIS_EOF
) break;
4175 /* Handle SELECT DB opcode as a special case */
4176 if (type
== REDIS_SELECTDB
) {
4177 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4179 if (dbid
>= (unsigned)server
.dbnum
) {
4180 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4183 db
= server
.db
+dbid
;
4188 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4190 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4191 /* Check if the key already expired */
4192 if (expiretime
!= -1 && expiretime
< now
) {
4197 /* Add the new object in the hash table */
4198 retval
= dictAdd(d
,key
,val
);
4199 if (retval
== DICT_ERR
) {
4200 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4204 /* Set the expire time if needed */
4205 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4207 /* Handle swapping while loading big datasets when VM is on */
4209 /* If we detecter we are hopeless about fitting something in memory
4210 * we just swap every new key on disk. Directly...
4211 * Note that's important to check for this condition before resorting
4212 * to random sampling, otherwise we may try to swap already
4214 if (swap_all_values
) {
4215 dictEntry
*de
= dictFind(d
,key
);
4217 /* de may be NULL since the key already expired */
4219 key
= dictGetEntryKey(de
);
4220 val
= dictGetEntryVal(de
);
4222 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4223 dictGetEntryVal(de
) = NULL
;
4229 /* If we have still some hope of having some value fitting memory
4230 * then we try random sampling. */
4231 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4232 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4233 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4235 if (zmalloc_used_memory() > server
.vm_max_memory
)
4236 swap_all_values
= 1; /* We are already using too much mem */
4242 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4243 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4245 return REDIS_ERR
; /* Just to avoid warning */
4248 /*================================== Shutdown =============================== */
4249 static int prepareForShutdown() {
4250 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4251 /* Kill the saving child if there is a background saving in progress.
4252 We want to avoid race conditions, for instance our saving child may
4253 overwrite the synchronous saving did by SHUTDOWN. */
4254 if (server
.bgsavechildpid
!= -1) {
4255 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4256 kill(server
.bgsavechildpid
,SIGKILL
);
4257 rdbRemoveTempFile(server
.bgsavechildpid
);
4259 if (server
.appendonly
) {
4260 /* Append only file: fsync() the AOF and exit */
4261 fsync(server
.appendfd
);
4262 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4264 /* Snapshotting. Perform a SYNC SAVE and exit */
4265 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4266 if (server
.daemonize
)
4267 unlink(server
.pidfile
);
4268 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4270 /* Ooops.. error saving! The best we can do is to continue
4271 * operating. Note that if there was a background saving process,
4272 * in the next cron() Redis will be notified that the background
4273 * saving aborted, handling special stuff like slaves pending for
4274 * synchronization... */
4275 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4279 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4283 /*================================== Commands =============================== */
4285 static void authCommand(redisClient
*c
) {
4286 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4287 c
->authenticated
= 1;
4288 addReply(c
,shared
.ok
);
4290 c
->authenticated
= 0;
4291 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4295 static void pingCommand(redisClient
*c
) {
4296 addReply(c
,shared
.pong
);
4299 static void echoCommand(redisClient
*c
) {
4300 addReplyBulk(c
,c
->argv
[1]);
4303 /*=================================== Strings =============================== */
4305 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4307 long seconds
= 0; /* initialized to avoid an harmness warning */
4310 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4313 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4318 touchWatchedKey(c
->db
,key
);
4319 if (nx
) deleteIfVolatile(c
->db
,key
);
4320 retval
= dictAdd(c
->db
->dict
,key
,val
);
4321 if (retval
== DICT_ERR
) {
4323 /* If the key is about a swapped value, we want a new key object
4324 * to overwrite the old. So we delete the old key in the database.
4325 * This will also make sure that swap pages about the old object
4326 * will be marked as free. */
4327 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4329 dictReplace(c
->db
->dict
,key
,val
);
4332 addReply(c
,shared
.czero
);
4340 removeExpire(c
->db
,key
);
4341 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4342 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4345 static void setCommand(redisClient
*c
) {
4346 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4349 static void setnxCommand(redisClient
*c
) {
4350 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4353 static void setexCommand(redisClient
*c
) {
4354 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4357 static int getGenericCommand(redisClient
*c
) {
4360 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4363 if (o
->type
!= REDIS_STRING
) {
4364 addReply(c
,shared
.wrongtypeerr
);
4372 static void getCommand(redisClient
*c
) {
4373 getGenericCommand(c
);
4376 static void getsetCommand(redisClient
*c
) {
4377 if (getGenericCommand(c
) == REDIS_ERR
) return;
4378 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4379 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4381 incrRefCount(c
->argv
[1]);
4383 incrRefCount(c
->argv
[2]);
4385 removeExpire(c
->db
,c
->argv
[1]);
4388 static void mgetCommand(redisClient
*c
) {
4391 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4392 for (j
= 1; j
< c
->argc
; j
++) {
4393 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4395 addReply(c
,shared
.nullbulk
);
4397 if (o
->type
!= REDIS_STRING
) {
4398 addReply(c
,shared
.nullbulk
);
4406 static void msetGenericCommand(redisClient
*c
, int nx
) {
4407 int j
, busykeys
= 0;
4409 if ((c
->argc
% 2) == 0) {
4410 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4413 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4414 * set nothing at all if at least one already key exists. */
4416 for (j
= 1; j
< c
->argc
; j
+= 2) {
4417 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4423 addReply(c
, shared
.czero
);
4427 for (j
= 1; j
< c
->argc
; j
+= 2) {
4430 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4431 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4432 if (retval
== DICT_ERR
) {
4433 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4434 incrRefCount(c
->argv
[j
+1]);
4436 incrRefCount(c
->argv
[j
]);
4437 incrRefCount(c
->argv
[j
+1]);
4439 removeExpire(c
->db
,c
->argv
[j
]);
4441 server
.dirty
+= (c
->argc
-1)/2;
4442 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4445 static void msetCommand(redisClient
*c
) {
4446 msetGenericCommand(c
,0);
4449 static void msetnxCommand(redisClient
*c
) {
4450 msetGenericCommand(c
,1);
4453 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4458 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4459 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4460 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4463 o
= createStringObjectFromLongLong(value
);
4464 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4465 if (retval
== DICT_ERR
) {
4466 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4467 removeExpire(c
->db
,c
->argv
[1]);
4469 incrRefCount(c
->argv
[1]);
4472 addReply(c
,shared
.colon
);
4474 addReply(c
,shared
.crlf
);
4477 static void incrCommand(redisClient
*c
) {
4478 incrDecrCommand(c
,1);
4481 static void decrCommand(redisClient
*c
) {
4482 incrDecrCommand(c
,-1);
4485 static void incrbyCommand(redisClient
*c
) {
4488 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4489 incrDecrCommand(c
,incr
);
4492 static void decrbyCommand(redisClient
*c
) {
4495 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4496 incrDecrCommand(c
,-incr
);
4499 static void appendCommand(redisClient
*c
) {
4504 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4506 /* Create the key */
4507 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4508 incrRefCount(c
->argv
[1]);
4509 incrRefCount(c
->argv
[2]);
4510 totlen
= stringObjectLen(c
->argv
[2]);
4514 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4517 o
= dictGetEntryVal(de
);
4518 if (o
->type
!= REDIS_STRING
) {
4519 addReply(c
,shared
.wrongtypeerr
);
4522 /* If the object is specially encoded or shared we have to make
4524 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4525 robj
*decoded
= getDecodedObject(o
);
4527 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4528 decrRefCount(decoded
);
4529 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4532 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4533 o
->ptr
= sdscatlen(o
->ptr
,
4534 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4536 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4537 (unsigned long) c
->argv
[2]->ptr
);
4539 totlen
= sdslen(o
->ptr
);
4542 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4545 static void substrCommand(redisClient
*c
) {
4547 long start
= atoi(c
->argv
[2]->ptr
);
4548 long end
= atoi(c
->argv
[3]->ptr
);
4549 size_t rangelen
, strlen
;
4552 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4553 checkType(c
,o
,REDIS_STRING
)) return;
4555 o
= getDecodedObject(o
);
4556 strlen
= sdslen(o
->ptr
);
4558 /* convert negative indexes */
4559 if (start
< 0) start
= strlen
+start
;
4560 if (end
< 0) end
= strlen
+end
;
4561 if (start
< 0) start
= 0;
4562 if (end
< 0) end
= 0;
4564 /* indexes sanity checks */
4565 if (start
> end
|| (size_t)start
>= strlen
) {
4566 /* Out of range start or start > end result in null reply */
4567 addReply(c
,shared
.nullbulk
);
4571 if ((size_t)end
>= strlen
) end
= strlen
-1;
4572 rangelen
= (end
-start
)+1;
4574 /* Return the result */
4575 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4576 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4577 addReplySds(c
,range
);
4578 addReply(c
,shared
.crlf
);
4582 /* ========================= Type agnostic commands ========================= */
4584 static void delCommand(redisClient
*c
) {
4587 for (j
= 1; j
< c
->argc
; j
++) {
4588 if (deleteKey(c
->db
,c
->argv
[j
])) {
4589 touchWatchedKey(c
->db
,c
->argv
[j
]);
4594 addReplyLongLong(c
,deleted
);
4597 static void existsCommand(redisClient
*c
) {
4598 expireIfNeeded(c
->db
,c
->argv
[1]);
4599 if (dictFind(c
->db
->dict
,c
->argv
[1])) {
4600 addReply(c
, shared
.cone
);
4602 addReply(c
, shared
.czero
);
4606 static void selectCommand(redisClient
*c
) {
4607 int id
= atoi(c
->argv
[1]->ptr
);
4609 if (selectDb(c
,id
) == REDIS_ERR
) {
4610 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4612 addReply(c
,shared
.ok
);
4616 static void randomkeyCommand(redisClient
*c
) {
4621 de
= dictGetRandomKey(c
->db
->dict
);
4622 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4626 addReply(c
,shared
.nullbulk
);
4630 key
= dictGetEntryKey(de
);
4631 if (server
.vm_enabled
) {
4632 key
= dupStringObject(key
);
4633 addReplyBulk(c
,key
);
4636 addReplyBulk(c
,key
);
4640 static void keysCommand(redisClient
*c
) {
4643 sds pattern
= c
->argv
[1]->ptr
;
4644 int plen
= sdslen(pattern
);
4645 unsigned long numkeys
= 0;
4646 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4648 di
= dictGetIterator(c
->db
->dict
);
4650 decrRefCount(lenobj
);
4651 while((de
= dictNext(di
)) != NULL
) {
4652 robj
*keyobj
= dictGetEntryKey(de
);
4654 sds key
= keyobj
->ptr
;
4655 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4656 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4657 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4658 addReplyBulk(c
,keyobj
);
4663 dictReleaseIterator(di
);
4664 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4667 static void dbsizeCommand(redisClient
*c
) {
4669 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4672 static void lastsaveCommand(redisClient
*c
) {
4674 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4677 static void typeCommand(redisClient
*c
) {
4681 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4686 case REDIS_STRING
: type
= "+string"; break;
4687 case REDIS_LIST
: type
= "+list"; break;
4688 case REDIS_SET
: type
= "+set"; break;
4689 case REDIS_ZSET
: type
= "+zset"; break;
4690 case REDIS_HASH
: type
= "+hash"; break;
4691 default: type
= "+unknown"; break;
4694 addReplySds(c
,sdsnew(type
));
4695 addReply(c
,shared
.crlf
);
4698 static void saveCommand(redisClient
*c
) {
4699 if (server
.bgsavechildpid
!= -1) {
4700 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4703 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4704 addReply(c
,shared
.ok
);
4706 addReply(c
,shared
.err
);
4710 static void bgsaveCommand(redisClient
*c
) {
4711 if (server
.bgsavechildpid
!= -1) {
4712 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4715 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4716 char *status
= "+Background saving started\r\n";
4717 addReplySds(c
,sdsnew(status
));
4719 addReply(c
,shared
.err
);
4723 static void shutdownCommand(redisClient
*c
) {
4724 if (prepareForShutdown() == REDIS_OK
)
4726 addReplySds(c
, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4729 static void renameGenericCommand(redisClient
*c
, int nx
) {
4732 /* To use the same key as src and dst is probably an error */
4733 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4734 addReply(c
,shared
.sameobjecterr
);
4738 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4742 deleteIfVolatile(c
->db
,c
->argv
[2]);
4743 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4746 addReply(c
,shared
.czero
);
4749 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4751 incrRefCount(c
->argv
[2]);
4753 deleteKey(c
->db
,c
->argv
[1]);
4754 touchWatchedKey(c
->db
,c
->argv
[2]);
4756 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4759 static void renameCommand(redisClient
*c
) {
4760 renameGenericCommand(c
,0);
4763 static void renamenxCommand(redisClient
*c
) {
4764 renameGenericCommand(c
,1);
4767 static void moveCommand(redisClient
*c
) {
4772 /* Obtain source and target DB pointers */
4775 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4776 addReply(c
,shared
.outofrangeerr
);
4780 selectDb(c
,srcid
); /* Back to the source DB */
4782 /* If the user is moving using as target the same
4783 * DB as the source DB it is probably an error. */
4785 addReply(c
,shared
.sameobjecterr
);
4789 /* Check if the element exists and get a reference */
4790 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4792 addReply(c
,shared
.czero
);
4796 /* Try to add the element to the target DB */
4797 deleteIfVolatile(dst
,c
->argv
[1]);
4798 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4799 addReply(c
,shared
.czero
);
4802 incrRefCount(c
->argv
[1]);
4805 /* OK! key moved, free the entry in the source DB */
4806 deleteKey(src
,c
->argv
[1]);
4808 addReply(c
,shared
.cone
);
4811 /* =================================== Lists ================================ */
4812 static void lPush(robj
*subject
, robj
*value
, int where
) {
4813 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4814 int pos
= (where
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4815 value
= getDecodedObject(value
);
4816 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),pos
);
4817 decrRefCount(value
);
4818 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4819 if (where
== REDIS_HEAD
) {
4820 listAddNodeHead(subject
->ptr
,value
);
4822 listAddNodeTail(subject
->ptr
,value
);
4824 incrRefCount(value
);
4826 redisPanic("Unknown list encoding");
4830 static robj
*lPop(robj
*subject
, int where
) {
4832 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4834 unsigned char *vstr
;
4837 int pos
= (where
== REDIS_HEAD
) ? 0 : -1;
4838 p
= ziplistIndex(subject
->ptr
,pos
);
4839 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
4841 value
= createStringObject((char*)vstr
,vlen
);
4843 value
= createStringObjectFromLongLong(vlong
);
4845 /* We only need to delete an element when it exists */
4846 subject
->ptr
= ziplistDelete(subject
->ptr
,&p
);
4848 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4849 list
*list
= subject
->ptr
;
4851 if (where
== REDIS_HEAD
) {
4852 ln
= listFirst(list
);
4854 ln
= listLast(list
);
4857 value
= listNodeValue(ln
);
4858 incrRefCount(value
);
4859 listDelNode(list
,ln
);
4862 redisPanic("Unknown list encoding");
4867 static unsigned long lLength(robj
*subject
) {
4868 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4869 return ziplistLen(subject
->ptr
);
4870 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4871 return listLength((list
*)subject
->ptr
);
4873 redisPanic("Unknown list encoding");
4877 /* Structure to hold set iteration abstraction. */
4880 unsigned char encoding
;
4881 unsigned char direction
; /* Iteration direction */
4886 /* Structure for an entry while iterating over a list. */
4889 unsigned char *zi
; /* Entry in ziplist */
4890 listNode
*ln
; /* Entry in linked list */
4893 /* Initialize an iterator at the specified index. */
4894 static lIterator
*lInitIterator(robj
*subject
, int index
, unsigned char direction
) {
4895 lIterator
*li
= zmalloc(sizeof(lIterator
));
4896 li
->subject
= subject
;
4897 li
->encoding
= subject
->encoding
;
4898 li
->direction
= direction
;
4899 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4900 li
->zi
= ziplistIndex(subject
->ptr
,index
);
4901 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4902 li
->ln
= listIndex(subject
->ptr
,index
);
4904 redisPanic("Unknown list encoding");
4909 /* Clean up the iterator. */
4910 static void lReleaseIterator(lIterator
*li
) {
4914 /* Stores pointer to current the entry in the provided entry structure
4915 * and advances the position of the iterator. Returns 1 when the current
4916 * entry is in fact an entry, 0 otherwise. */
4917 static int lNext(lIterator
*li
, lEntry
*entry
) {
4919 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4921 if (entry
->zi
!= NULL
) {
4922 if (li
->direction
== REDIS_TAIL
)
4923 li
->zi
= ziplistNext(li
->subject
->ptr
,li
->zi
);
4925 li
->zi
= ziplistPrev(li
->subject
->ptr
,li
->zi
);
4928 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4930 if (entry
->ln
!= NULL
) {
4931 if (li
->direction
== REDIS_TAIL
)
4932 li
->ln
= li
->ln
->next
;
4934 li
->ln
= li
->ln
->prev
;
4938 redisPanic("Unknown list encoding");
4943 /* Return entry or NULL at the current position of the iterator. */
4944 static robj
*lGet(lEntry
*entry
) {
4945 lIterator
*li
= entry
->li
;
4947 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4948 unsigned char *vstr
;
4951 redisAssert(entry
->zi
!= NULL
);
4952 if (ziplistGet(entry
->zi
,&vstr
,&vlen
,&vlong
)) {
4954 value
= createStringObject((char*)vstr
,vlen
);
4956 value
= createStringObjectFromLongLong(vlong
);
4959 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4960 redisAssert(entry
->ln
!= NULL
);
4961 value
= listNodeValue(entry
->ln
);
4962 incrRefCount(value
);
4964 redisPanic("Unknown list encoding");
4969 /* Compare the given object with the entry at the current position. */
4970 static int lEqual(lEntry
*entry
, robj
*o
) {
4971 lIterator
*li
= entry
->li
;
4972 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4973 redisAssert(o
->encoding
== REDIS_ENCODING_RAW
);
4974 return ziplistCompare(entry
->zi
,o
->ptr
,sdslen(o
->ptr
));
4975 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4976 return equalStringObjects(o
,listNodeValue(entry
->ln
));
4978 redisPanic("Unknown list encoding");
4982 /* Delete the element pointed to. */
4983 static void lDelete(lEntry
*entry
) {
4984 lIterator
*li
= entry
->li
;
4985 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4986 unsigned char *p
= entry
->zi
;
4987 li
->subject
->ptr
= ziplistDelete(li
->subject
->ptr
,&p
);
4989 /* Update position of the iterator depending on the direction */
4990 if (li
->direction
== REDIS_TAIL
)
4993 li
->zi
= ziplistPrev(li
->subject
->ptr
,p
);
4994 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
4996 if (li
->direction
== REDIS_TAIL
)
4997 next
= entry
->ln
->next
;
4999 next
= entry
->ln
->prev
;
5000 listDelNode(li
->subject
->ptr
,entry
->ln
);
5003 redisPanic("Unknown list encoding");
5007 static void pushGenericCommand(redisClient
*c
, int where
) {
5008 robj
*lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5010 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5011 addReply(c
,shared
.cone
);
5014 lobj
= createZiplistObject();
5015 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
5016 incrRefCount(c
->argv
[1]);
5018 if (lobj
->type
!= REDIS_LIST
) {
5019 addReply(c
,shared
.wrongtypeerr
);
5022 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5023 addReply(c
,shared
.cone
);
5027 lPush(lobj
,c
->argv
[2],where
);
5028 addReplyLongLong(c
,lLength(lobj
));
5032 static void lpushCommand(redisClient
*c
) {
5033 pushGenericCommand(c
,REDIS_HEAD
);
5036 static void rpushCommand(redisClient
*c
) {
5037 pushGenericCommand(c
,REDIS_TAIL
);
5040 static void llenCommand(redisClient
*c
) {
5041 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
);
5042 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5043 addReplyUlong(c
,lLength(o
));
5046 static void lindexCommand(redisClient
*c
) {
5047 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5048 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5049 int index
= atoi(c
->argv
[2]->ptr
);
5052 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5054 unsigned char *vstr
;
5057 p
= ziplistIndex(o
->ptr
,index
);
5058 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
5060 value
= createStringObject((char*)vstr
,vlen
);
5062 value
= createStringObjectFromLongLong(vlong
);
5064 addReplyBulk(c
,value
);
5065 decrRefCount(value
);
5067 addReply(c
,shared
.nullbulk
);
5069 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5070 listNode
*ln
= listIndex(o
->ptr
,index
);
5072 value
= listNodeValue(ln
);
5073 addReplyBulk(c
,value
);
5075 addReply(c
,shared
.nullbulk
);
5078 redisPanic("Unknown list encoding");
5082 static void lsetCommand(redisClient
*c
) {
5083 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
);
5084 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5085 int index
= atoi(c
->argv
[2]->ptr
);
5086 robj
*value
= c
->argv
[3];
5088 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5089 unsigned char *p
, *zl
= o
->ptr
;
5090 p
= ziplistIndex(zl
,index
);
5092 addReply(c
,shared
.outofrangeerr
);
5094 o
->ptr
= ziplistDelete(o
->ptr
,&p
);
5095 value
= getDecodedObject(value
);
5096 o
->ptr
= ziplistInsert(o
->ptr
,p
,value
->ptr
,sdslen(value
->ptr
));
5097 decrRefCount(value
);
5098 addReply(c
,shared
.ok
);
5101 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5102 listNode
*ln
= listIndex(o
->ptr
,index
);
5104 addReply(c
,shared
.outofrangeerr
);
5106 decrRefCount((robj
*)listNodeValue(ln
));
5107 listNodeValue(ln
) = value
;
5108 incrRefCount(value
);
5109 addReply(c
,shared
.ok
);
5113 redisPanic("Unknown list encoding");
5117 static void popGenericCommand(redisClient
*c
, int where
) {
5118 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5119 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5121 robj
*value
= lPop(o
,where
);
5122 if (value
== NULL
) {
5123 addReply(c
,shared
.nullbulk
);
5125 addReplyBulk(c
,value
);
5126 decrRefCount(value
);
5127 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5132 static void lpopCommand(redisClient
*c
) {
5133 popGenericCommand(c
,REDIS_HEAD
);
5136 static void rpopCommand(redisClient
*c
) {
5137 popGenericCommand(c
,REDIS_TAIL
);
5140 static void lrangeCommand(redisClient
*c
) {
5142 int start
= atoi(c
->argv
[2]->ptr
);
5143 int end
= atoi(c
->argv
[3]->ptr
);
5148 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5149 || checkType(c
,o
,REDIS_LIST
)) return;
5152 /* convert negative indexes */
5153 if (start
< 0) start
= llen
+start
;
5154 if (end
< 0) end
= llen
+end
;
5155 if (start
< 0) start
= 0;
5156 if (end
< 0) end
= 0;
5158 /* indexes sanity checks */
5159 if (start
> end
|| start
>= llen
) {
5160 /* Out of range start or start > end result in empty list */
5161 addReply(c
,shared
.emptymultibulk
);
5164 if (end
>= llen
) end
= llen
-1;
5165 rangelen
= (end
-start
)+1;
5167 /* Return the result in form of a multi-bulk reply */
5168 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
5169 lIterator
*li
= lInitIterator(o
,start
,REDIS_TAIL
);
5170 for (j
= 0; j
< rangelen
; j
++) {
5171 redisAssert(lNext(li
,&entry
));
5172 value
= lGet(&entry
);
5173 addReplyBulk(c
,value
);
5174 decrRefCount(value
);
5176 lReleaseIterator(li
);
5179 static void ltrimCommand(redisClient
*c
) {
5181 int start
= atoi(c
->argv
[2]->ptr
);
5182 int end
= atoi(c
->argv
[3]->ptr
);
5184 int j
, ltrim
, rtrim
;
5188 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
5189 checkType(c
,o
,REDIS_LIST
)) return;
5192 /* convert negative indexes */
5193 if (start
< 0) start
= llen
+start
;
5194 if (end
< 0) end
= llen
+end
;
5195 if (start
< 0) start
= 0;
5196 if (end
< 0) end
= 0;
5198 /* indexes sanity checks */
5199 if (start
> end
|| start
>= llen
) {
5200 /* Out of range start or start > end result in empty list */
5204 if (end
>= llen
) end
= llen
-1;
5209 /* Remove list elements to perform the trim */
5210 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5211 o
->ptr
= ziplistDeleteRange(o
->ptr
,0,ltrim
);
5212 o
->ptr
= ziplistDeleteRange(o
->ptr
,-rtrim
,rtrim
);
5213 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5215 for (j
= 0; j
< ltrim
; j
++) {
5216 ln
= listFirst(list
);
5217 listDelNode(list
,ln
);
5219 for (j
= 0; j
< rtrim
; j
++) {
5220 ln
= listLast(list
);
5221 listDelNode(list
,ln
);
5224 redisPanic("Unknown list encoding");
5226 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5228 addReply(c
,shared
.ok
);
5231 static void lremCommand(redisClient
*c
) {
5232 robj
*subject
, *obj
= c
->argv
[3];
5233 int toremove
= atoi(c
->argv
[2]->ptr
);
5237 subject
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
);
5238 if (subject
== NULL
|| checkType(c
,subject
,REDIS_LIST
)) return;
5240 /* Make sure obj is raw when we're dealing with a ziplist */
5241 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5242 obj
= getDecodedObject(obj
);
5246 toremove
= -toremove
;
5247 li
= lInitIterator(subject
,-1,REDIS_HEAD
);
5249 li
= lInitIterator(subject
,0,REDIS_TAIL
);
5252 while (lNext(li
,&entry
)) {
5253 if (lEqual(&entry
,obj
)) {
5257 if (toremove
&& removed
== toremove
) break;
5260 lReleaseIterator(li
);
5262 /* Clean up raw encoded object */
5263 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5266 if (lLength(subject
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5267 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
5270 /* This is the semantic of this command:
5271 * RPOPLPUSH srclist dstlist:
5272 * IF LLEN(srclist) > 0
5273 * element = RPOP srclist
5274 * LPUSH dstlist element
5281 * The idea is to be able to get an element from a list in a reliable way
5282 * since the element is not just returned but pushed against another list
5283 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5285 static void rpoplpushcommand(redisClient
*c
) {
5287 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5288 checkType(c
,sobj
,REDIS_LIST
)) return;
5290 if (lLength(sobj
) == 0) {
5291 addReply(c
,shared
.nullbulk
);
5293 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5294 if (dobj
&& checkType(c
,dobj
,REDIS_LIST
)) return;
5295 value
= lPop(sobj
,REDIS_TAIL
);
5297 /* Add the element to the target list (unless it's directly
5298 * passed to some BLPOP-ing client */
5299 if (!handleClientsWaitingListPush(c
,c
->argv
[2],value
)) {
5300 /* Create the list if the key does not exist */
5302 dobj
= createZiplistObject();
5303 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
5304 incrRefCount(c
->argv
[2]);
5306 lPush(dobj
,value
,REDIS_HEAD
);
5309 /* Send the element to the client as reply as well */
5310 addReplyBulk(c
,value
);
5312 /* lPop returns an object with its refcount incremented */
5313 decrRefCount(value
);
5315 /* Delete the source list when it is empty */
5316 if (lLength(sobj
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5321 /* ==================================== Sets ================================ */
5323 static void saddCommand(redisClient
*c
) {
5326 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5328 set
= createSetObject();
5329 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5330 incrRefCount(c
->argv
[1]);
5332 if (set
->type
!= REDIS_SET
) {
5333 addReply(c
,shared
.wrongtypeerr
);
5337 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5338 incrRefCount(c
->argv
[2]);
5340 addReply(c
,shared
.cone
);
5342 addReply(c
,shared
.czero
);
5346 static void sremCommand(redisClient
*c
) {
5349 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5350 checkType(c
,set
,REDIS_SET
)) return;
5352 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5354 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5355 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5356 addReply(c
,shared
.cone
);
5358 addReply(c
,shared
.czero
);
5362 static void smoveCommand(redisClient
*c
) {
5363 robj
*srcset
, *dstset
;
5365 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5366 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5368 /* If the source key does not exist return 0, if it's of the wrong type
5370 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5371 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5374 /* Error if the destination key is not a set as well */
5375 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5376 addReply(c
,shared
.wrongtypeerr
);
5379 /* Remove the element from the source set */
5380 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5381 /* Key not found in the src set! return zero */
5382 addReply(c
,shared
.czero
);
5385 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5386 deleteKey(c
->db
,c
->argv
[1]);
5388 /* Add the element to the destination set */
5390 dstset
= createSetObject();
5391 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5392 incrRefCount(c
->argv
[2]);
5394 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5395 incrRefCount(c
->argv
[3]);
5396 addReply(c
,shared
.cone
);
5399 static void sismemberCommand(redisClient
*c
) {
5402 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5403 checkType(c
,set
,REDIS_SET
)) return;
5405 if (dictFind(set
->ptr
,c
->argv
[2]))
5406 addReply(c
,shared
.cone
);
5408 addReply(c
,shared
.czero
);
5411 static void scardCommand(redisClient
*c
) {
5415 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5416 checkType(c
,o
,REDIS_SET
)) return;
5419 addReplyUlong(c
,dictSize(s
));
5422 static void spopCommand(redisClient
*c
) {
5426 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5427 checkType(c
,set
,REDIS_SET
)) return;
5429 de
= dictGetRandomKey(set
->ptr
);
5431 addReply(c
,shared
.nullbulk
);
5433 robj
*ele
= dictGetEntryKey(de
);
5435 addReplyBulk(c
,ele
);
5436 dictDelete(set
->ptr
,ele
);
5437 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5438 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5443 static void srandmemberCommand(redisClient
*c
) {
5447 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5448 checkType(c
,set
,REDIS_SET
)) return;
5450 de
= dictGetRandomKey(set
->ptr
);
5452 addReply(c
,shared
.nullbulk
);
5454 robj
*ele
= dictGetEntryKey(de
);
5456 addReplyBulk(c
,ele
);
5460 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5461 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5463 return dictSize(*d1
)-dictSize(*d2
);
5466 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5467 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5470 robj
*lenobj
= NULL
, *dstset
= NULL
;
5471 unsigned long j
, cardinality
= 0;
5473 for (j
= 0; j
< setsnum
; j
++) {
5477 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5478 lookupKeyRead(c
->db
,setskeys
[j
]);
5482 if (deleteKey(c
->db
,dstkey
))
5484 addReply(c
,shared
.czero
);
5486 addReply(c
,shared
.emptymultibulk
);
5490 if (setobj
->type
!= REDIS_SET
) {
5492 addReply(c
,shared
.wrongtypeerr
);
5495 dv
[j
] = setobj
->ptr
;
5497 /* Sort sets from the smallest to largest, this will improve our
5498 * algorithm's performace */
5499 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5501 /* The first thing we should output is the total number of elements...
5502 * since this is a multi-bulk write, but at this stage we don't know
5503 * the intersection set size, so we use a trick, append an empty object
5504 * to the output list and save the pointer to later modify it with the
5507 lenobj
= createObject(REDIS_STRING
,NULL
);
5509 decrRefCount(lenobj
);
5511 /* If we have a target key where to store the resulting set
5512 * create this key with an empty set inside */
5513 dstset
= createSetObject();
5516 /* Iterate all the elements of the first (smallest) set, and test
5517 * the element against all the other sets, if at least one set does
5518 * not include the element it is discarded */
5519 di
= dictGetIterator(dv
[0]);
5521 while((de
= dictNext(di
)) != NULL
) {
5524 for (j
= 1; j
< setsnum
; j
++)
5525 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5527 continue; /* at least one set does not contain the member */
5528 ele
= dictGetEntryKey(de
);
5530 addReplyBulk(c
,ele
);
5533 dictAdd(dstset
->ptr
,ele
,NULL
);
5537 dictReleaseIterator(di
);
5540 /* Store the resulting set into the target, if the intersection
5541 * is not an empty set. */
5542 deleteKey(c
->db
,dstkey
);
5543 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5544 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5545 incrRefCount(dstkey
);
5546 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5548 decrRefCount(dstset
);
5549 addReply(c
,shared
.czero
);
5553 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5558 static void sinterCommand(redisClient
*c
) {
5559 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5562 static void sinterstoreCommand(redisClient
*c
) {
5563 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5566 #define REDIS_OP_UNION 0
5567 #define REDIS_OP_DIFF 1
5568 #define REDIS_OP_INTER 2
5570 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5571 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5574 robj
*dstset
= NULL
;
5575 int j
, cardinality
= 0;
5577 for (j
= 0; j
< setsnum
; j
++) {
5581 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5582 lookupKeyRead(c
->db
,setskeys
[j
]);
5587 if (setobj
->type
!= REDIS_SET
) {
5589 addReply(c
,shared
.wrongtypeerr
);
5592 dv
[j
] = setobj
->ptr
;
5595 /* We need a temp set object to store our union. If the dstkey
5596 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5597 * this set object will be the resulting object to set into the target key*/
5598 dstset
= createSetObject();
5600 /* Iterate all the elements of all the sets, add every element a single
5601 * time to the result set */
5602 for (j
= 0; j
< setsnum
; j
++) {
5603 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5604 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5606 di
= dictGetIterator(dv
[j
]);
5608 while((de
= dictNext(di
)) != NULL
) {
5611 /* dictAdd will not add the same element multiple times */
5612 ele
= dictGetEntryKey(de
);
5613 if (op
== REDIS_OP_UNION
|| j
== 0) {
5614 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5618 } else if (op
== REDIS_OP_DIFF
) {
5619 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5624 dictReleaseIterator(di
);
5626 /* result set is empty? Exit asap. */
5627 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5630 /* Output the content of the resulting set, if not in STORE mode */
5632 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5633 di
= dictGetIterator(dstset
->ptr
);
5634 while((de
= dictNext(di
)) != NULL
) {
5637 ele
= dictGetEntryKey(de
);
5638 addReplyBulk(c
,ele
);
5640 dictReleaseIterator(di
);
5641 decrRefCount(dstset
);
5643 /* If we have a target key where to store the resulting set
5644 * create this key with the result set inside */
5645 deleteKey(c
->db
,dstkey
);
5646 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5647 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5648 incrRefCount(dstkey
);
5649 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5651 decrRefCount(dstset
);
5652 addReply(c
,shared
.czero
);
5659 static void sunionCommand(redisClient
*c
) {
5660 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5663 static void sunionstoreCommand(redisClient
*c
) {
5664 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5667 static void sdiffCommand(redisClient
*c
) {
5668 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5671 static void sdiffstoreCommand(redisClient
*c
) {
5672 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5675 /* ==================================== ZSets =============================== */
5677 /* ZSETs are ordered sets using two data structures to hold the same elements
5678 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5681 * The elements are added to an hash table mapping Redis objects to scores.
5682 * At the same time the elements are added to a skip list mapping scores
5683 * to Redis objects (so objects are sorted by scores in this "view"). */
5685 /* This skiplist implementation is almost a C translation of the original
5686 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5687 * Alternative to Balanced Trees", modified in three ways:
5688 * a) this implementation allows for repeated values.
5689 * b) the comparison is not just by key (our 'score') but by satellite data.
5690 * c) there is a back pointer, so it's a doubly linked list with the back
5691 * pointers being only at "level 1". This allows to traverse the list
5692 * from tail to head, useful for ZREVRANGE. */
5694 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5695 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5697 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5699 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5707 static zskiplist
*zslCreate(void) {
5711 zsl
= zmalloc(sizeof(*zsl
));
5714 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5715 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5716 zsl
->header
->forward
[j
] = NULL
;
5718 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5719 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5720 zsl
->header
->span
[j
] = 0;
5722 zsl
->header
->backward
= NULL
;
5727 static void zslFreeNode(zskiplistNode
*node
) {
5728 decrRefCount(node
->obj
);
5729 zfree(node
->forward
);
5734 static void zslFree(zskiplist
*zsl
) {
5735 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5737 zfree(zsl
->header
->forward
);
5738 zfree(zsl
->header
->span
);
5741 next
= node
->forward
[0];
5748 static int zslRandomLevel(void) {
5750 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5752 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5755 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5756 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5757 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5761 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5762 /* store rank that is crossed to reach the insert position */
5763 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5765 while (x
->forward
[i
] &&
5766 (x
->forward
[i
]->score
< score
||
5767 (x
->forward
[i
]->score
== score
&&
5768 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5769 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5774 /* we assume the key is not already inside, since we allow duplicated
5775 * scores, and the re-insertion of score and redis object should never
5776 * happpen since the caller of zslInsert() should test in the hash table
5777 * if the element is already inside or not. */
5778 level
= zslRandomLevel();
5779 if (level
> zsl
->level
) {
5780 for (i
= zsl
->level
; i
< level
; i
++) {
5782 update
[i
] = zsl
->header
;
5783 update
[i
]->span
[i
-1] = zsl
->length
;
5787 x
= zslCreateNode(level
,score
,obj
);
5788 for (i
= 0; i
< level
; i
++) {
5789 x
->forward
[i
] = update
[i
]->forward
[i
];
5790 update
[i
]->forward
[i
] = x
;
5792 /* update span covered by update[i] as x is inserted here */
5794 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5795 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5799 /* increment span for untouched levels */
5800 for (i
= level
; i
< zsl
->level
; i
++) {
5801 update
[i
]->span
[i
-1]++;
5804 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5806 x
->forward
[0]->backward
= x
;
5812 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5813 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5815 for (i
= 0; i
< zsl
->level
; i
++) {
5816 if (update
[i
]->forward
[i
] == x
) {
5818 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5820 update
[i
]->forward
[i
] = x
->forward
[i
];
5822 /* invariant: i > 0, because update[0]->forward[0]
5823 * is always equal to x */
5824 update
[i
]->span
[i
-1] -= 1;
5827 if (x
->forward
[0]) {
5828 x
->forward
[0]->backward
= x
->backward
;
5830 zsl
->tail
= x
->backward
;
5832 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5837 /* Delete an element with matching score/object from the skiplist. */
5838 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5839 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5843 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5844 while (x
->forward
[i
] &&
5845 (x
->forward
[i
]->score
< score
||
5846 (x
->forward
[i
]->score
== score
&&
5847 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5851 /* We may have multiple elements with the same score, what we need
5852 * is to find the element with both the right score and object. */
5854 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5855 zslDeleteNode(zsl
, x
, update
);
5859 return 0; /* not found */
5861 return 0; /* not found */
5864 /* Delete all the elements with score between min and max from the skiplist.
5865 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5866 * Note that this function takes the reference to the hash table view of the
5867 * sorted set, in order to remove the elements from the hash table too. */
5868 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5869 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5870 unsigned long removed
= 0;
5874 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5875 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5879 /* We may have multiple elements with the same score, what we need
5880 * is to find the element with both the right score and object. */
5882 while (x
&& x
->score
<= max
) {
5883 zskiplistNode
*next
= x
->forward
[0];
5884 zslDeleteNode(zsl
, x
, update
);
5885 dictDelete(dict
,x
->obj
);
5890 return removed
; /* not found */
5893 /* Delete all the elements with rank between start and end from the skiplist.
5894 * Start and end are inclusive. Note that start and end need to be 1-based */
5895 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5896 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5897 unsigned long traversed
= 0, removed
= 0;
5901 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5902 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5903 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5911 while (x
&& traversed
<= end
) {
5912 zskiplistNode
*next
= x
->forward
[0];
5913 zslDeleteNode(zsl
, x
, update
);
5914 dictDelete(dict
,x
->obj
);
5923 /* Find the first node having a score equal or greater than the specified one.
5924 * Returns NULL if there is no match. */
5925 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5930 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5931 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5934 /* We may have multiple elements with the same score, what we need
5935 * is to find the element with both the right score and object. */
5936 return x
->forward
[0];
5939 /* Find the rank for an element by both score and key.
5940 * Returns 0 when the element cannot be found, rank otherwise.
5941 * Note that the rank is 1-based due to the span of zsl->header to the
5943 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5945 unsigned long rank
= 0;
5949 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5950 while (x
->forward
[i
] &&
5951 (x
->forward
[i
]->score
< score
||
5952 (x
->forward
[i
]->score
== score
&&
5953 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5954 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5958 /* x might be equal to zsl->header, so test if obj is non-NULL */
5959 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5966 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5967 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5969 unsigned long traversed
= 0;
5973 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5974 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5976 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5979 if (traversed
== rank
) {
5986 /* The actual Z-commands implementations */
5988 /* This generic command implements both ZADD and ZINCRBY.
5989 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5990 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5991 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5996 if (isnan(scoreval
)) {
5997 addReplySds(c
,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
6001 zsetobj
= lookupKeyWrite(c
->db
,key
);
6002 if (zsetobj
== NULL
) {
6003 zsetobj
= createZsetObject();
6004 dictAdd(c
->db
->dict
,key
,zsetobj
);
6007 if (zsetobj
->type
!= REDIS_ZSET
) {
6008 addReply(c
,shared
.wrongtypeerr
);
6014 /* Ok now since we implement both ZADD and ZINCRBY here the code
6015 * needs to handle the two different conditions. It's all about setting
6016 * '*score', that is, the new score to set, to the right value. */
6017 score
= zmalloc(sizeof(double));
6021 /* Read the old score. If the element was not present starts from 0 */
6022 de
= dictFind(zs
->dict
,ele
);
6024 double *oldscore
= dictGetEntryVal(de
);
6025 *score
= *oldscore
+ scoreval
;
6029 if (isnan(*score
)) {
6031 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6033 /* Note that we don't need to check if the zset may be empty and
6034 * should be removed here, as we can only obtain Nan as score if
6035 * there was already an element in the sorted set. */
6042 /* What follows is a simple remove and re-insert operation that is common
6043 * to both ZADD and ZINCRBY... */
6044 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
6045 /* case 1: New element */
6046 incrRefCount(ele
); /* added to hash */
6047 zslInsert(zs
->zsl
,*score
,ele
);
6048 incrRefCount(ele
); /* added to skiplist */
6051 addReplyDouble(c
,*score
);
6053 addReply(c
,shared
.cone
);
6058 /* case 2: Score update operation */
6059 de
= dictFind(zs
->dict
,ele
);
6060 redisAssert(de
!= NULL
);
6061 oldscore
= dictGetEntryVal(de
);
6062 if (*score
!= *oldscore
) {
6065 /* Remove and insert the element in the skip list with new score */
6066 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
6067 redisAssert(deleted
!= 0);
6068 zslInsert(zs
->zsl
,*score
,ele
);
6070 /* Update the score in the hash table */
6071 dictReplace(zs
->dict
,ele
,score
);
6077 addReplyDouble(c
,*score
);
6079 addReply(c
,shared
.czero
);
6083 static void zaddCommand(redisClient
*c
) {
6086 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6087 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
6090 static void zincrbyCommand(redisClient
*c
) {
6093 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6094 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
6097 static void zremCommand(redisClient
*c
) {
6104 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6105 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6108 de
= dictFind(zs
->dict
,c
->argv
[2]);
6110 addReply(c
,shared
.czero
);
6113 /* Delete from the skiplist */
6114 oldscore
= dictGetEntryVal(de
);
6115 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
6116 redisAssert(deleted
!= 0);
6118 /* Delete from the hash table */
6119 dictDelete(zs
->dict
,c
->argv
[2]);
6120 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6121 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6123 addReply(c
,shared
.cone
);
6126 static void zremrangebyscoreCommand(redisClient
*c
) {
6133 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
6134 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
6136 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6137 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6140 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
6141 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6142 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6143 server
.dirty
+= deleted
;
6144 addReplyLongLong(c
,deleted
);
6147 static void zremrangebyrankCommand(redisClient
*c
) {
6155 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6156 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6158 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6159 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6161 llen
= zs
->zsl
->length
;
6163 /* convert negative indexes */
6164 if (start
< 0) start
= llen
+start
;
6165 if (end
< 0) end
= llen
+end
;
6166 if (start
< 0) start
= 0;
6167 if (end
< 0) end
= 0;
6169 /* indexes sanity checks */
6170 if (start
> end
|| start
>= llen
) {
6171 addReply(c
,shared
.czero
);
6174 if (end
>= llen
) end
= llen
-1;
6176 /* increment start and end because zsl*Rank functions
6177 * use 1-based rank */
6178 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
6179 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6180 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6181 server
.dirty
+= deleted
;
6182 addReplyLongLong(c
, deleted
);
6190 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
6191 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
6192 unsigned long size1
, size2
;
6193 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
6194 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
6195 return size1
- size2
;
6198 #define REDIS_AGGR_SUM 1
6199 #define REDIS_AGGR_MIN 2
6200 #define REDIS_AGGR_MAX 3
6201 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6203 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
6204 if (aggregate
== REDIS_AGGR_SUM
) {
6205 *target
= *target
+ val
;
6206 } else if (aggregate
== REDIS_AGGR_MIN
) {
6207 *target
= val
< *target
? val
: *target
;
6208 } else if (aggregate
== REDIS_AGGR_MAX
) {
6209 *target
= val
> *target
? val
: *target
;
6212 redisPanic("Unknown ZUNION/INTER aggregate type");
6216 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
6218 int aggregate
= REDIS_AGGR_SUM
;
6225 /* expect setnum input keys to be given */
6226 setnum
= atoi(c
->argv
[2]->ptr
);
6228 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6232 /* test if the expected number of keys would overflow */
6233 if (3+setnum
> c
->argc
) {
6234 addReply(c
,shared
.syntaxerr
);
6238 /* read keys to be used for input */
6239 src
= zmalloc(sizeof(zsetopsrc
) * setnum
);
6240 for (i
= 0, j
= 3; i
< setnum
; i
++, j
++) {
6241 robj
*obj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6245 if (obj
->type
== REDIS_ZSET
) {
6246 src
[i
].dict
= ((zset
*)obj
->ptr
)->dict
;
6247 } else if (obj
->type
== REDIS_SET
) {
6248 src
[i
].dict
= (obj
->ptr
);
6251 addReply(c
,shared
.wrongtypeerr
);
6256 /* default all weights to 1 */
6257 src
[i
].weight
= 1.0;
6260 /* parse optional extra arguments */
6262 int remaining
= c
->argc
- j
;
6265 if (remaining
>= (setnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
6267 for (i
= 0; i
< setnum
; i
++, j
++, remaining
--) {
6268 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
6271 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
6273 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
6274 aggregate
= REDIS_AGGR_SUM
;
6275 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
6276 aggregate
= REDIS_AGGR_MIN
;
6277 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
6278 aggregate
= REDIS_AGGR_MAX
;
6281 addReply(c
,shared
.syntaxerr
);
6287 addReply(c
,shared
.syntaxerr
);
6293 /* sort sets from the smallest to largest, this will improve our
6294 * algorithm's performance */
6295 qsort(src
,setnum
,sizeof(zsetopsrc
),qsortCompareZsetopsrcByCardinality
);
6297 dstobj
= createZsetObject();
6298 dstzset
= dstobj
->ptr
;
6300 if (op
== REDIS_OP_INTER
) {
6301 /* skip going over all entries if the smallest zset is NULL or empty */
6302 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
6303 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6304 * from small to large, all src[i > 0].dict are non-empty too */
6305 di
= dictGetIterator(src
[0].dict
);
6306 while((de
= dictNext(di
)) != NULL
) {
6307 double *score
= zmalloc(sizeof(double)), value
;
6308 *score
= src
[0].weight
* zunionInterDictValue(de
);
6310 for (j
= 1; j
< setnum
; j
++) {
6311 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6313 value
= src
[j
].weight
* zunionInterDictValue(other
);
6314 zunionInterAggregate(score
, value
, aggregate
);
6320 /* skip entry when not present in every source dict */
6324 robj
*o
= dictGetEntryKey(de
);
6325 dictAdd(dstzset
->dict
,o
,score
);
6326 incrRefCount(o
); /* added to dictionary */
6327 zslInsert(dstzset
->zsl
,*score
,o
);
6328 incrRefCount(o
); /* added to skiplist */
6331 dictReleaseIterator(di
);
6333 } else if (op
== REDIS_OP_UNION
) {
6334 for (i
= 0; i
< setnum
; i
++) {
6335 if (!src
[i
].dict
) continue;
6337 di
= dictGetIterator(src
[i
].dict
);
6338 while((de
= dictNext(di
)) != NULL
) {
6339 /* skip key when already processed */
6340 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6342 double *score
= zmalloc(sizeof(double)), value
;
6343 *score
= src
[i
].weight
* zunionInterDictValue(de
);
6345 /* because the zsets are sorted by size, its only possible
6346 * for sets at larger indices to hold this entry */
6347 for (j
= (i
+1); j
< setnum
; j
++) {
6348 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6350 value
= src
[j
].weight
* zunionInterDictValue(other
);
6351 zunionInterAggregate(score
, value
, aggregate
);
6355 robj
*o
= dictGetEntryKey(de
);
6356 dictAdd(dstzset
->dict
,o
,score
);
6357 incrRefCount(o
); /* added to dictionary */
6358 zslInsert(dstzset
->zsl
,*score
,o
);
6359 incrRefCount(o
); /* added to skiplist */
6361 dictReleaseIterator(di
);
6364 /* unknown operator */
6365 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6368 deleteKey(c
->db
,dstkey
);
6369 if (dstzset
->zsl
->length
) {
6370 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6371 incrRefCount(dstkey
);
6372 addReplyLongLong(c
, dstzset
->zsl
->length
);
6375 decrRefCount(dstobj
);
6376 addReply(c
, shared
.czero
);
6381 static void zunionstoreCommand(redisClient
*c
) {
6382 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6385 static void zinterstoreCommand(redisClient
*c
) {
6386 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6389 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6401 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6402 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6404 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6406 } else if (c
->argc
>= 5) {
6407 addReply(c
,shared
.syntaxerr
);
6411 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6412 || checkType(c
,o
,REDIS_ZSET
)) return;
6417 /* convert negative indexes */
6418 if (start
< 0) start
= llen
+start
;
6419 if (end
< 0) end
= llen
+end
;
6420 if (start
< 0) start
= 0;
6421 if (end
< 0) end
= 0;
6423 /* indexes sanity checks */
6424 if (start
> end
|| start
>= llen
) {
6425 /* Out of range start or start > end result in empty list */
6426 addReply(c
,shared
.emptymultibulk
);
6429 if (end
>= llen
) end
= llen
-1;
6430 rangelen
= (end
-start
)+1;
6432 /* check if starting point is trivial, before searching
6433 * the element in log(N) time */
6435 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6438 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6441 /* Return the result in form of a multi-bulk reply */
6442 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6443 withscores
? (rangelen
*2) : rangelen
));
6444 for (j
= 0; j
< rangelen
; j
++) {
6446 addReplyBulk(c
,ele
);
6448 addReplyDouble(c
,ln
->score
);
6449 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6453 static void zrangeCommand(redisClient
*c
) {
6454 zrangeGenericCommand(c
,0);
6457 static void zrevrangeCommand(redisClient
*c
) {
6458 zrangeGenericCommand(c
,1);
6461 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6462 * If justcount is non-zero, just the count is returned. */
6463 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6466 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6467 int offset
= 0, limit
= -1;
6471 /* Parse the min-max interval. If one of the values is prefixed
6472 * by the "(" character, it's considered "open". For instance
6473 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6474 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6475 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6476 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6479 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6481 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6482 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6485 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6488 /* Parse "WITHSCORES": note that if the command was called with
6489 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6490 * enter the following paths to parse WITHSCORES and LIMIT. */
6491 if (c
->argc
== 5 || c
->argc
== 8) {
6492 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6497 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6501 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6506 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6507 addReply(c
,shared
.syntaxerr
);
6509 } else if (c
->argc
== (7 + withscores
)) {
6510 offset
= atoi(c
->argv
[5]->ptr
);
6511 limit
= atoi(c
->argv
[6]->ptr
);
6512 if (offset
< 0) offset
= 0;
6515 /* Ok, lookup the key and get the range */
6516 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6518 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6520 if (o
->type
!= REDIS_ZSET
) {
6521 addReply(c
,shared
.wrongtypeerr
);
6523 zset
*zsetobj
= o
->ptr
;
6524 zskiplist
*zsl
= zsetobj
->zsl
;
6526 robj
*ele
, *lenobj
= NULL
;
6527 unsigned long rangelen
= 0;
6529 /* Get the first node with the score >= min, or with
6530 * score > min if 'minex' is true. */
6531 ln
= zslFirstWithScore(zsl
,min
);
6532 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6535 /* No element matching the speciifed interval */
6536 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6540 /* We don't know in advance how many matching elements there
6541 * are in the list, so we push this object that will represent
6542 * the multi-bulk length in the output buffer, and will "fix"
6545 lenobj
= createObject(REDIS_STRING
,NULL
);
6547 decrRefCount(lenobj
);
6550 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6553 ln
= ln
->forward
[0];
6556 if (limit
== 0) break;
6559 addReplyBulk(c
,ele
);
6561 addReplyDouble(c
,ln
->score
);
6563 ln
= ln
->forward
[0];
6565 if (limit
> 0) limit
--;
6568 addReplyLongLong(c
,(long)rangelen
);
6570 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6571 withscores
? (rangelen
*2) : rangelen
);
6577 static void zrangebyscoreCommand(redisClient
*c
) {
6578 genericZrangebyscoreCommand(c
,0);
6581 static void zcountCommand(redisClient
*c
) {
6582 genericZrangebyscoreCommand(c
,1);
6585 static void zcardCommand(redisClient
*c
) {
6589 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6590 checkType(c
,o
,REDIS_ZSET
)) return;
6593 addReplyUlong(c
,zs
->zsl
->length
);
6596 static void zscoreCommand(redisClient
*c
) {
6601 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6602 checkType(c
,o
,REDIS_ZSET
)) return;
6605 de
= dictFind(zs
->dict
,c
->argv
[2]);
6607 addReply(c
,shared
.nullbulk
);
6609 double *score
= dictGetEntryVal(de
);
6611 addReplyDouble(c
,*score
);
6615 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6623 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6624 checkType(c
,o
,REDIS_ZSET
)) return;
6628 de
= dictFind(zs
->dict
,c
->argv
[2]);
6630 addReply(c
,shared
.nullbulk
);
6634 score
= dictGetEntryVal(de
);
6635 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6638 addReplyLongLong(c
, zsl
->length
- rank
);
6640 addReplyLongLong(c
, rank
-1);
6643 addReply(c
,shared
.nullbulk
);
6647 static void zrankCommand(redisClient
*c
) {
6648 zrankGenericCommand(c
, 0);
6651 static void zrevrankCommand(redisClient
*c
) {
6652 zrankGenericCommand(c
, 1);
6655 /* ========================= Hashes utility functions ======================= */
6656 #define REDIS_HASH_KEY 1
6657 #define REDIS_HASH_VALUE 2
6659 /* Check the length of a number of objects to see if we need to convert a
6660 * zipmap to a real hash. Note that we only check string encoded objects
6661 * as their string length can be queried in constant time. */
6662 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6664 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6666 for (i
= start
; i
<= end
; i
++) {
6667 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6668 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6670 convertToRealHash(subject
);
6676 /* Encode given objects in-place when the hash uses a dict. */
6677 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6678 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6679 if (o1
) *o1
= tryObjectEncoding(*o1
);
6680 if (o2
) *o2
= tryObjectEncoding(*o2
);
6684 /* Get the value from a hash identified by key. Returns either a string
6685 * object or NULL if the value cannot be found. The refcount of the object
6686 * is always increased by 1 when the value was found. */
6687 static robj
*hashGet(robj
*o
, robj
*key
) {
6689 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6692 key
= getDecodedObject(key
);
6693 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6694 value
= createStringObject((char*)v
,vlen
);
6698 dictEntry
*de
= dictFind(o
->ptr
,key
);
6700 value
= dictGetEntryVal(de
);
6701 incrRefCount(value
);
6707 /* Test if the key exists in the given hash. Returns 1 if the key
6708 * exists and 0 when it doesn't. */
6709 static int hashExists(robj
*o
, robj
*key
) {
6710 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6711 key
= getDecodedObject(key
);
6712 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6718 if (dictFind(o
->ptr
,key
) != NULL
) {
6725 /* Add an element, discard the old if the key already exists.
6726 * Return 0 on insert and 1 on update. */
6727 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6729 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6730 key
= getDecodedObject(key
);
6731 value
= getDecodedObject(value
);
6732 o
->ptr
= zipmapSet(o
->ptr
,
6733 key
->ptr
,sdslen(key
->ptr
),
6734 value
->ptr
,sdslen(value
->ptr
), &update
);
6736 decrRefCount(value
);
6738 /* Check if the zipmap needs to be upgraded to a real hash table */
6739 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6740 convertToRealHash(o
);
6742 if (dictReplace(o
->ptr
,key
,value
)) {
6749 incrRefCount(value
);
6754 /* Delete an element from a hash.
6755 * Return 1 on deleted and 0 on not found. */
6756 static int hashDelete(robj
*o
, robj
*key
) {
6758 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6759 key
= getDecodedObject(key
);
6760 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6763 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6764 /* Always check if the dictionary needs a resize after a delete. */
6765 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6770 /* Return the number of elements in a hash. */
6771 static unsigned long hashLength(robj
*o
) {
6772 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6773 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6776 /* Structure to hold hash iteration abstration. Note that iteration over
6777 * hashes involves both fields and values. Because it is possible that
6778 * not both are required, store pointers in the iterator to avoid
6779 * unnecessary memory allocation for fields/values. */
6783 unsigned char *zk
, *zv
;
6784 unsigned int zklen
, zvlen
;
6790 static hashIterator
*hashInitIterator(robj
*subject
) {
6791 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6792 hi
->encoding
= subject
->encoding
;
6793 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6794 hi
->zi
= zipmapRewind(subject
->ptr
);
6795 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6796 hi
->di
= dictGetIterator(subject
->ptr
);
6803 static void hashReleaseIterator(hashIterator
*hi
) {
6804 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6805 dictReleaseIterator(hi
->di
);
6810 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6811 * could be found and REDIS_ERR when the iterator reaches the end. */
6812 static int hashNext(hashIterator
*hi
) {
6813 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6814 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6815 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6817 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6822 /* Get key or value object at current iteration position.
6823 * This increases the refcount of the field object by 1. */
6824 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6826 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6827 if (what
& REDIS_HASH_KEY
) {
6828 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6830 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6833 if (what
& REDIS_HASH_KEY
) {
6834 o
= dictGetEntryKey(hi
->de
);
6836 o
= dictGetEntryVal(hi
->de
);
6843 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6844 robj
*o
= lookupKeyWrite(c
->db
,key
);
6846 o
= createHashObject();
6847 dictAdd(c
->db
->dict
,key
,o
);
6850 if (o
->type
!= REDIS_HASH
) {
6851 addReply(c
,shared
.wrongtypeerr
);
6858 /* ============================= Hash commands ============================== */
6859 static void hsetCommand(redisClient
*c
) {
6863 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6864 hashTryConversion(o
,c
->argv
,2,3);
6865 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6866 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6867 addReply(c
, update
? shared
.czero
: shared
.cone
);
6871 static void hsetnxCommand(redisClient
*c
) {
6873 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6874 hashTryConversion(o
,c
->argv
,2,3);
6876 if (hashExists(o
, c
->argv
[2])) {
6877 addReply(c
, shared
.czero
);
6879 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6880 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6881 addReply(c
, shared
.cone
);
6886 static void hmsetCommand(redisClient
*c
) {
6890 if ((c
->argc
% 2) == 1) {
6891 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6895 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6896 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6897 for (i
= 2; i
< c
->argc
; i
+= 2) {
6898 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6899 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6901 addReply(c
, shared
.ok
);
6905 static void hincrbyCommand(redisClient
*c
) {
6906 long long value
, incr
;
6907 robj
*o
, *current
, *new;
6909 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6910 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6911 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6912 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6913 "hash value is not an integer") != REDIS_OK
) {
6914 decrRefCount(current
);
6917 decrRefCount(current
);
6923 new = createStringObjectFromLongLong(value
);
6924 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6925 hashSet(o
,c
->argv
[2],new);
6927 addReplyLongLong(c
,value
);
6931 static void hgetCommand(redisClient
*c
) {
6933 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6934 checkType(c
,o
,REDIS_HASH
)) return;
6936 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6937 addReplyBulk(c
,value
);
6938 decrRefCount(value
);
6940 addReply(c
,shared
.nullbulk
);
6944 static void hmgetCommand(redisClient
*c
) {
6947 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6948 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6949 addReply(c
,shared
.wrongtypeerr
);
6952 /* Note the check for o != NULL happens inside the loop. This is
6953 * done because objects that cannot be found are considered to be
6954 * an empty hash. The reply should then be a series of NULLs. */
6955 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6956 for (i
= 2; i
< c
->argc
; i
++) {
6957 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6958 addReplyBulk(c
,value
);
6959 decrRefCount(value
);
6961 addReply(c
,shared
.nullbulk
);
6966 static void hdelCommand(redisClient
*c
) {
6968 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6969 checkType(c
,o
,REDIS_HASH
)) return;
6971 if (hashDelete(o
,c
->argv
[2])) {
6972 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6973 addReply(c
,shared
.cone
);
6976 addReply(c
,shared
.czero
);
6980 static void hlenCommand(redisClient
*c
) {
6982 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6983 checkType(c
,o
,REDIS_HASH
)) return;
6985 addReplyUlong(c
,hashLength(o
));
6988 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6989 robj
*o
, *lenobj
, *obj
;
6990 unsigned long count
= 0;
6993 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6994 || checkType(c
,o
,REDIS_HASH
)) return;
6996 lenobj
= createObject(REDIS_STRING
,NULL
);
6998 decrRefCount(lenobj
);
7000 hi
= hashInitIterator(o
);
7001 while (hashNext(hi
) != REDIS_ERR
) {
7002 if (flags
& REDIS_HASH_KEY
) {
7003 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
7004 addReplyBulk(c
,obj
);
7008 if (flags
& REDIS_HASH_VALUE
) {
7009 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
7010 addReplyBulk(c
,obj
);
7015 hashReleaseIterator(hi
);
7017 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
7020 static void hkeysCommand(redisClient
*c
) {
7021 genericHgetallCommand(c
,REDIS_HASH_KEY
);
7024 static void hvalsCommand(redisClient
*c
) {
7025 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
7028 static void hgetallCommand(redisClient
*c
) {
7029 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
7032 static void hexistsCommand(redisClient
*c
) {
7034 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7035 checkType(c
,o
,REDIS_HASH
)) return;
7037 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
7040 static void convertToRealHash(robj
*o
) {
7041 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
7042 unsigned int klen
, vlen
;
7043 dict
*dict
= dictCreate(&hashDictType
,NULL
);
7045 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
7046 p
= zipmapRewind(zm
);
7047 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
7048 robj
*keyobj
, *valobj
;
7050 keyobj
= createStringObject((char*)key
,klen
);
7051 valobj
= createStringObject((char*)val
,vlen
);
7052 keyobj
= tryObjectEncoding(keyobj
);
7053 valobj
= tryObjectEncoding(valobj
);
7054 dictAdd(dict
,keyobj
,valobj
);
7056 o
->encoding
= REDIS_ENCODING_HT
;
7061 /* ========================= Non type-specific commands ==================== */
7063 static void flushdbCommand(redisClient
*c
) {
7064 server
.dirty
+= dictSize(c
->db
->dict
);
7065 touchWatchedKeysOnFlush(c
->db
->id
);
7066 dictEmpty(c
->db
->dict
);
7067 dictEmpty(c
->db
->expires
);
7068 addReply(c
,shared
.ok
);
7071 static void flushallCommand(redisClient
*c
) {
7072 touchWatchedKeysOnFlush(-1);
7073 server
.dirty
+= emptyDb();
7074 addReply(c
,shared
.ok
);
7075 if (server
.bgsavechildpid
!= -1) {
7076 kill(server
.bgsavechildpid
,SIGKILL
);
7077 rdbRemoveTempFile(server
.bgsavechildpid
);
7079 rdbSave(server
.dbfilename
);
7083 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
7084 redisSortOperation
*so
= zmalloc(sizeof(*so
));
7086 so
->pattern
= pattern
;
7090 /* Return the value associated to the key with a name obtained
7091 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7092 * The returned object will always have its refcount increased by 1
7093 * when it is non-NULL. */
7094 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
7097 robj keyobj
, fieldobj
, *o
;
7098 int prefixlen
, sublen
, postfixlen
, fieldlen
;
7099 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7103 char buf
[REDIS_SORTKEY_MAX
+1];
7104 } keyname
, fieldname
;
7106 /* If the pattern is "#" return the substitution object itself in order
7107 * to implement the "SORT ... GET #" feature. */
7108 spat
= pattern
->ptr
;
7109 if (spat
[0] == '#' && spat
[1] == '\0') {
7110 incrRefCount(subst
);
7114 /* The substitution object may be specially encoded. If so we create
7115 * a decoded object on the fly. Otherwise getDecodedObject will just
7116 * increment the ref count, that we'll decrement later. */
7117 subst
= getDecodedObject(subst
);
7120 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
7121 p
= strchr(spat
,'*');
7123 decrRefCount(subst
);
7127 /* Find out if we're dealing with a hash dereference. */
7128 if ((f
= strstr(p
+1, "->")) != NULL
) {
7129 fieldlen
= sdslen(spat
)-(f
-spat
);
7130 /* this also copies \0 character */
7131 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
7132 fieldname
.len
= fieldlen
-2;
7138 sublen
= sdslen(ssub
);
7139 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
7140 memcpy(keyname
.buf
,spat
,prefixlen
);
7141 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
7142 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
7143 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
7144 keyname
.len
= prefixlen
+sublen
+postfixlen
;
7145 decrRefCount(subst
);
7147 /* Lookup substituted key */
7148 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
7149 o
= lookupKeyRead(db
,&keyobj
);
7150 if (o
== NULL
) return NULL
;
7153 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
7155 /* Retrieve value from hash by the field name. This operation
7156 * already increases the refcount of the returned object. */
7157 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
7158 o
= hashGet(o
, &fieldobj
);
7160 if (o
->type
!= REDIS_STRING
) return NULL
;
7162 /* Every object that this function returns needs to have its refcount
7163 * increased. sortCommand decreases it again. */
7170 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7171 * the additional parameter is not standard but a BSD-specific we have to
7172 * pass sorting parameters via the global 'server' structure */
7173 static int sortCompare(const void *s1
, const void *s2
) {
7174 const redisSortObject
*so1
= s1
, *so2
= s2
;
7177 if (!server
.sort_alpha
) {
7178 /* Numeric sorting. Here it's trivial as we precomputed scores */
7179 if (so1
->u
.score
> so2
->u
.score
) {
7181 } else if (so1
->u
.score
< so2
->u
.score
) {
7187 /* Alphanumeric sorting */
7188 if (server
.sort_bypattern
) {
7189 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
7190 /* At least one compare object is NULL */
7191 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
7193 else if (so1
->u
.cmpobj
== NULL
)
7198 /* We have both the objects, use strcoll */
7199 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
7202 /* Compare elements directly. */
7203 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
7206 return server
.sort_desc
? -cmp
: cmp
;
7209 /* The SORT command is the most complex command in Redis. Warning: this code
7210 * is optimized for speed and a bit less for readability */
7211 static void sortCommand(redisClient
*c
) {
7214 int desc
= 0, alpha
= 0;
7215 int limit_start
= 0, limit_count
= -1, start
, end
;
7216 int j
, dontsort
= 0, vectorlen
;
7217 int getop
= 0; /* GET operation counter */
7218 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
7219 redisSortObject
*vector
; /* Resulting vector to sort */
7221 /* Lookup the key to sort. It must be of the right types */
7222 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
7223 if (sortval
== NULL
) {
7224 addReply(c
,shared
.emptymultibulk
);
7227 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
7228 sortval
->type
!= REDIS_ZSET
)
7230 addReply(c
,shared
.wrongtypeerr
);
7234 /* Create a list of operations to perform for every sorted element.
7235 * Operations can be GET/DEL/INCR/DECR */
7236 operations
= listCreate();
7237 listSetFreeMethod(operations
,zfree
);
7240 /* Now we need to protect sortval incrementing its count, in the future
7241 * SORT may have options able to overwrite/delete keys during the sorting
7242 * and the sorted key itself may get destroied */
7243 incrRefCount(sortval
);
7245 /* The SORT command has an SQL-alike syntax, parse it */
7246 while(j
< c
->argc
) {
7247 int leftargs
= c
->argc
-j
-1;
7248 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
7250 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
7252 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
7254 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
7255 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
7256 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
7258 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
7259 storekey
= c
->argv
[j
+1];
7261 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
7262 sortby
= c
->argv
[j
+1];
7263 /* If the BY pattern does not contain '*', i.e. it is constant,
7264 * we don't need to sort nor to lookup the weight keys. */
7265 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
7267 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
7268 listAddNodeTail(operations
,createSortOperation(
7269 REDIS_SORT_GET
,c
->argv
[j
+1]));
7273 decrRefCount(sortval
);
7274 listRelease(operations
);
7275 addReply(c
,shared
.syntaxerr
);
7281 /* Load the sorting vector with all the objects to sort */
7282 switch(sortval
->type
) {
7283 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
7284 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
7285 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
7286 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7288 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
7291 if (sortval
->type
== REDIS_LIST
) {
7292 list
*list
= sortval
->ptr
;
7296 listRewind(list
,&li
);
7297 while((ln
= listNext(&li
))) {
7298 robj
*ele
= ln
->value
;
7299 vector
[j
].obj
= ele
;
7300 vector
[j
].u
.score
= 0;
7301 vector
[j
].u
.cmpobj
= NULL
;
7309 if (sortval
->type
== REDIS_SET
) {
7312 zset
*zs
= sortval
->ptr
;
7316 di
= dictGetIterator(set
);
7317 while((setele
= dictNext(di
)) != NULL
) {
7318 vector
[j
].obj
= dictGetEntryKey(setele
);
7319 vector
[j
].u
.score
= 0;
7320 vector
[j
].u
.cmpobj
= NULL
;
7323 dictReleaseIterator(di
);
7325 redisAssert(j
== vectorlen
);
7327 /* Now it's time to load the right scores in the sorting vector */
7328 if (dontsort
== 0) {
7329 for (j
= 0; j
< vectorlen
; j
++) {
7332 /* lookup value to sort by */
7333 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7334 if (!byval
) continue;
7336 /* use object itself to sort by */
7337 byval
= vector
[j
].obj
;
7341 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7343 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7344 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7345 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7346 /* Don't need to decode the object if it's
7347 * integer-encoded (the only encoding supported) so
7348 * far. We can just cast it */
7349 vector
[j
].u
.score
= (long)byval
->ptr
;
7351 redisAssert(1 != 1);
7355 /* when the object was retrieved using lookupKeyByPattern,
7356 * its refcount needs to be decreased. */
7358 decrRefCount(byval
);
7363 /* We are ready to sort the vector... perform a bit of sanity check
7364 * on the LIMIT option too. We'll use a partial version of quicksort. */
7365 start
= (limit_start
< 0) ? 0 : limit_start
;
7366 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7367 if (start
>= vectorlen
) {
7368 start
= vectorlen
-1;
7371 if (end
>= vectorlen
) end
= vectorlen
-1;
7373 if (dontsort
== 0) {
7374 server
.sort_desc
= desc
;
7375 server
.sort_alpha
= alpha
;
7376 server
.sort_bypattern
= sortby
? 1 : 0;
7377 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7378 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7380 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7383 /* Send command output to the output buffer, performing the specified
7384 * GET/DEL/INCR/DECR operations if any. */
7385 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7386 if (storekey
== NULL
) {
7387 /* STORE option not specified, sent the sorting result to client */
7388 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7389 for (j
= start
; j
<= end
; j
++) {
7393 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7394 listRewind(operations
,&li
);
7395 while((ln
= listNext(&li
))) {
7396 redisSortOperation
*sop
= ln
->value
;
7397 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7400 if (sop
->type
== REDIS_SORT_GET
) {
7402 addReply(c
,shared
.nullbulk
);
7404 addReplyBulk(c
,val
);
7408 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7413 robj
*listObject
= createListObject();
7414 list
*listPtr
= (list
*) listObject
->ptr
;
7416 /* STORE option specified, set the sorting result as a List object */
7417 for (j
= start
; j
<= end
; j
++) {
7422 listAddNodeTail(listPtr
,vector
[j
].obj
);
7423 incrRefCount(vector
[j
].obj
);
7425 listRewind(operations
,&li
);
7426 while((ln
= listNext(&li
))) {
7427 redisSortOperation
*sop
= ln
->value
;
7428 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7431 if (sop
->type
== REDIS_SORT_GET
) {
7433 listAddNodeTail(listPtr
,createStringObject("",0));
7435 /* We should do a incrRefCount on val because it is
7436 * added to the list, but also a decrRefCount because
7437 * it is returned by lookupKeyByPattern. This results
7438 * in doing nothing at all. */
7439 listAddNodeTail(listPtr
,val
);
7442 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7446 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7447 incrRefCount(storekey
);
7449 /* Note: we add 1 because the DB is dirty anyway since even if the
7450 * SORT result is empty a new key is set and maybe the old content
7452 server
.dirty
+= 1+outputlen
;
7453 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7457 decrRefCount(sortval
);
7458 listRelease(operations
);
7459 for (j
= 0; j
< vectorlen
; j
++) {
7460 if (alpha
&& vector
[j
].u
.cmpobj
)
7461 decrRefCount(vector
[j
].u
.cmpobj
);
7466 /* Convert an amount of bytes into a human readable string in the form
7467 * of 100B, 2G, 100M, 4K, and so forth. */
7468 static void bytesToHuman(char *s
, unsigned long long n
) {
7473 sprintf(s
,"%lluB",n
);
7475 } else if (n
< (1024*1024)) {
7476 d
= (double)n
/(1024);
7477 sprintf(s
,"%.2fK",d
);
7478 } else if (n
< (1024LL*1024*1024)) {
7479 d
= (double)n
/(1024*1024);
7480 sprintf(s
,"%.2fM",d
);
7481 } else if (n
< (1024LL*1024*1024*1024)) {
7482 d
= (double)n
/(1024LL*1024*1024);
7483 sprintf(s
,"%.2fG",d
);
7487 /* Create the string returned by the INFO command. This is decoupled
7488 * by the INFO command itself as we need to report the same information
7489 * on memory corruption problems. */
7490 static sds
genRedisInfoString(void) {
7492 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7496 bytesToHuman(hmem
,zmalloc_used_memory());
7497 info
= sdscatprintf(sdsempty(),
7498 "redis_version:%s\r\n"
7499 "redis_git_sha1:%s\r\n"
7500 "redis_git_dirty:%d\r\n"
7502 "multiplexing_api:%s\r\n"
7503 "process_id:%ld\r\n"
7504 "uptime_in_seconds:%ld\r\n"
7505 "uptime_in_days:%ld\r\n"
7506 "connected_clients:%d\r\n"
7507 "connected_slaves:%d\r\n"
7508 "blocked_clients:%d\r\n"
7509 "used_memory:%zu\r\n"
7510 "used_memory_human:%s\r\n"
7511 "changes_since_last_save:%lld\r\n"
7512 "bgsave_in_progress:%d\r\n"
7513 "last_save_time:%ld\r\n"
7514 "bgrewriteaof_in_progress:%d\r\n"
7515 "total_connections_received:%lld\r\n"
7516 "total_commands_processed:%lld\r\n"
7517 "expired_keys:%lld\r\n"
7518 "hash_max_zipmap_entries:%zu\r\n"
7519 "hash_max_zipmap_value:%zu\r\n"
7520 "pubsub_channels:%ld\r\n"
7521 "pubsub_patterns:%u\r\n"
7526 strtol(REDIS_GIT_DIRTY
,NULL
,10) > 0,
7527 (sizeof(long) == 8) ? "64" : "32",
7532 listLength(server
.clients
)-listLength(server
.slaves
),
7533 listLength(server
.slaves
),
7534 server
.blpop_blocked_clients
,
7535 zmalloc_used_memory(),
7538 server
.bgsavechildpid
!= -1,
7540 server
.bgrewritechildpid
!= -1,
7541 server
.stat_numconnections
,
7542 server
.stat_numcommands
,
7543 server
.stat_expiredkeys
,
7544 server
.hash_max_zipmap_entries
,
7545 server
.hash_max_zipmap_value
,
7546 dictSize(server
.pubsub_channels
),
7547 listLength(server
.pubsub_patterns
),
7548 server
.vm_enabled
!= 0,
7549 server
.masterhost
== NULL
? "master" : "slave"
7551 if (server
.masterhost
) {
7552 info
= sdscatprintf(info
,
7553 "master_host:%s\r\n"
7554 "master_port:%d\r\n"
7555 "master_link_status:%s\r\n"
7556 "master_last_io_seconds_ago:%d\r\n"
7559 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7561 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7564 if (server
.vm_enabled
) {
7566 info
= sdscatprintf(info
,
7567 "vm_conf_max_memory:%llu\r\n"
7568 "vm_conf_page_size:%llu\r\n"
7569 "vm_conf_pages:%llu\r\n"
7570 "vm_stats_used_pages:%llu\r\n"
7571 "vm_stats_swapped_objects:%llu\r\n"
7572 "vm_stats_swappin_count:%llu\r\n"
7573 "vm_stats_swappout_count:%llu\r\n"
7574 "vm_stats_io_newjobs_len:%lu\r\n"
7575 "vm_stats_io_processing_len:%lu\r\n"
7576 "vm_stats_io_processed_len:%lu\r\n"
7577 "vm_stats_io_active_threads:%lu\r\n"
7578 "vm_stats_blocked_clients:%lu\r\n"
7579 ,(unsigned long long) server
.vm_max_memory
,
7580 (unsigned long long) server
.vm_page_size
,
7581 (unsigned long long) server
.vm_pages
,
7582 (unsigned long long) server
.vm_stats_used_pages
,
7583 (unsigned long long) server
.vm_stats_swapped_objects
,
7584 (unsigned long long) server
.vm_stats_swapins
,
7585 (unsigned long long) server
.vm_stats_swapouts
,
7586 (unsigned long) listLength(server
.io_newjobs
),
7587 (unsigned long) listLength(server
.io_processing
),
7588 (unsigned long) listLength(server
.io_processed
),
7589 (unsigned long) server
.io_active_threads
,
7590 (unsigned long) server
.vm_blocked_clients
7594 for (j
= 0; j
< server
.dbnum
; j
++) {
7595 long long keys
, vkeys
;
7597 keys
= dictSize(server
.db
[j
].dict
);
7598 vkeys
= dictSize(server
.db
[j
].expires
);
7599 if (keys
|| vkeys
) {
7600 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7607 static void infoCommand(redisClient
*c
) {
7608 sds info
= genRedisInfoString();
7609 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7610 (unsigned long)sdslen(info
)));
7611 addReplySds(c
,info
);
7612 addReply(c
,shared
.crlf
);
7615 static void monitorCommand(redisClient
*c
) {
7616 /* ignore MONITOR if aleady slave or in monitor mode */
7617 if (c
->flags
& REDIS_SLAVE
) return;
7619 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7621 listAddNodeTail(server
.monitors
,c
);
7622 addReply(c
,shared
.ok
);
7625 /* ================================= Expire ================================= */
7626 static int removeExpire(redisDb
*db
, robj
*key
) {
7627 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7634 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7635 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7643 /* Return the expire time of the specified key, or -1 if no expire
7644 * is associated with this key (i.e. the key is non volatile) */
7645 static time_t getExpire(redisDb
*db
, robj
*key
) {
7648 /* No expire? return ASAP */
7649 if (dictSize(db
->expires
) == 0 ||
7650 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7652 return (time_t) dictGetEntryVal(de
);
7655 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7659 /* No expire? return ASAP */
7660 if (dictSize(db
->expires
) == 0 ||
7661 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7663 /* Lookup the expire */
7664 when
= (time_t) dictGetEntryVal(de
);
7665 if (time(NULL
) <= when
) return 0;
7667 /* Delete the key */
7668 dictDelete(db
->expires
,key
);
7669 server
.stat_expiredkeys
++;
7670 return dictDelete(db
->dict
,key
) == DICT_OK
;
7673 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7676 /* No expire? return ASAP */
7677 if (dictSize(db
->expires
) == 0 ||
7678 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7680 /* Delete the key */
7682 server
.stat_expiredkeys
++;
7683 dictDelete(db
->expires
,key
);
7684 return dictDelete(db
->dict
,key
) == DICT_OK
;
7687 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7691 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7695 de
= dictFind(c
->db
->dict
,key
);
7697 addReply(c
,shared
.czero
);
7701 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7702 addReply(c
, shared
.cone
);
7705 time_t when
= time(NULL
)+seconds
;
7706 if (setExpire(c
->db
,key
,when
)) {
7707 addReply(c
,shared
.cone
);
7710 addReply(c
,shared
.czero
);
7716 static void expireCommand(redisClient
*c
) {
7717 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7720 static void expireatCommand(redisClient
*c
) {
7721 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7724 static void ttlCommand(redisClient
*c
) {
7728 expire
= getExpire(c
->db
,c
->argv
[1]);
7730 ttl
= (int) (expire
-time(NULL
));
7731 if (ttl
< 0) ttl
= -1;
7733 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7736 /* ================================ MULTI/EXEC ============================== */
7738 /* Client state initialization for MULTI/EXEC */
7739 static void initClientMultiState(redisClient
*c
) {
7740 c
->mstate
.commands
= NULL
;
7741 c
->mstate
.count
= 0;
7744 /* Release all the resources associated with MULTI/EXEC state */
7745 static void freeClientMultiState(redisClient
*c
) {
7748 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7750 multiCmd
*mc
= c
->mstate
.commands
+j
;
7752 for (i
= 0; i
< mc
->argc
; i
++)
7753 decrRefCount(mc
->argv
[i
]);
7756 zfree(c
->mstate
.commands
);
7759 /* Add a new command into the MULTI commands queue */
7760 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7764 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7765 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7766 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7769 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7770 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7771 for (j
= 0; j
< c
->argc
; j
++)
7772 incrRefCount(mc
->argv
[j
]);
7776 static void multiCommand(redisClient
*c
) {
7777 if (c
->flags
& REDIS_MULTI
) {
7778 addReplySds(c
,sdsnew("-ERR MULTI calls can not be nested\r\n"));
7781 c
->flags
|= REDIS_MULTI
;
7782 addReply(c
,shared
.ok
);
7785 static void discardCommand(redisClient
*c
) {
7786 if (!(c
->flags
& REDIS_MULTI
)) {
7787 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7791 freeClientMultiState(c
);
7792 initClientMultiState(c
);
7793 c
->flags
&= (~REDIS_MULTI
);
7794 addReply(c
,shared
.ok
);
7797 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7798 * implememntation for more information. */
7799 static void execCommandReplicateMulti(redisClient
*c
) {
7800 struct redisCommand
*cmd
;
7801 robj
*multistring
= createStringObject("MULTI",5);
7803 cmd
= lookupCommand("multi");
7804 if (server
.appendonly
)
7805 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7806 if (listLength(server
.slaves
))
7807 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7808 decrRefCount(multistring
);
7811 static void execCommand(redisClient
*c
) {
7816 if (!(c
->flags
& REDIS_MULTI
)) {
7817 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7821 /* Check if we need to abort the EXEC if some WATCHed key was touched.
7822 * A failed EXEC will return a multi bulk nil object. */
7823 if (c
->flags
& REDIS_DIRTY_CAS
) {
7824 freeClientMultiState(c
);
7825 initClientMultiState(c
);
7826 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7828 addReply(c
,shared
.nullmultibulk
);
7832 /* Replicate a MULTI request now that we are sure the block is executed.
7833 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7834 * both the AOF and the replication link will have the same consistency
7835 * and atomicity guarantees. */
7836 execCommandReplicateMulti(c
);
7838 /* Exec all the queued commands */
7839 unwatchAllKeys(c
); /* Unwatch ASAP otherwise we'll waste CPU cycles */
7840 orig_argv
= c
->argv
;
7841 orig_argc
= c
->argc
;
7842 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7843 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7844 c
->argc
= c
->mstate
.commands
[j
].argc
;
7845 c
->argv
= c
->mstate
.commands
[j
].argv
;
7846 call(c
,c
->mstate
.commands
[j
].cmd
);
7848 c
->argv
= orig_argv
;
7849 c
->argc
= orig_argc
;
7850 freeClientMultiState(c
);
7851 initClientMultiState(c
);
7852 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7853 /* Make sure the EXEC command is always replicated / AOF, since we
7854 * always send the MULTI command (we can't know beforehand if the
7855 * next operations will contain at least a modification to the DB). */
7859 /* =========================== Blocking Operations ========================= */
7861 /* Currently Redis blocking operations support is limited to list POP ops,
7862 * so the current implementation is not fully generic, but it is also not
7863 * completely specific so it will not require a rewrite to support new
7864 * kind of blocking operations in the future.
7866 * Still it's important to note that list blocking operations can be already
7867 * used as a notification mechanism in order to implement other blocking
7868 * operations at application level, so there must be a very strong evidence
7869 * of usefulness and generality before new blocking operations are implemented.
7871 * This is how the current blocking POP works, we use BLPOP as example:
7872 * - If the user calls BLPOP and the key exists and contains a non empty list
7873 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7874 * if there is not to block.
7875 * - If instead BLPOP is called and the key does not exists or the list is
7876 * empty we need to block. In order to do so we remove the notification for
7877 * new data to read in the client socket (so that we'll not serve new
7878 * requests if the blocking request is not served). Also we put the client
7879 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
7880 * blocking for this keys.
7881 * - If a PUSH operation against a key with blocked clients waiting is
7882 * performed, we serve the first in the list: basically instead to push
7883 * the new element inside the list we return it to the (first / oldest)
7884 * blocking client, unblock the client, and remove it form the list.
7886 * The above comment and the source code should be enough in order to understand
7887 * the implementation and modify / fix it later.
7890 /* Set a client in blocking mode for the specified key, with the specified
7892 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7897 c
->blocking_keys
= zmalloc(sizeof(robj
*)*numkeys
);
7898 c
->blocking_keys_num
= numkeys
;
7899 c
->blockingto
= timeout
;
7900 for (j
= 0; j
< numkeys
; j
++) {
7901 /* Add the key in the client structure, to map clients -> keys */
7902 c
->blocking_keys
[j
] = keys
[j
];
7903 incrRefCount(keys
[j
]);
7905 /* And in the other "side", to map keys -> clients */
7906 de
= dictFind(c
->db
->blocking_keys
,keys
[j
]);
7910 /* For every key we take a list of clients blocked for it */
7912 retval
= dictAdd(c
->db
->blocking_keys
,keys
[j
],l
);
7913 incrRefCount(keys
[j
]);
7914 assert(retval
== DICT_OK
);
7916 l
= dictGetEntryVal(de
);
7918 listAddNodeTail(l
,c
);
7920 /* Mark the client as a blocked client */
7921 c
->flags
|= REDIS_BLOCKED
;
7922 server
.blpop_blocked_clients
++;
7925 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7926 static void unblockClientWaitingData(redisClient
*c
) {
7931 assert(c
->blocking_keys
!= NULL
);
7932 /* The client may wait for multiple keys, so unblock it for every key. */
7933 for (j
= 0; j
< c
->blocking_keys_num
; j
++) {
7934 /* Remove this client from the list of clients waiting for this key. */
7935 de
= dictFind(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7937 l
= dictGetEntryVal(de
);
7938 listDelNode(l
,listSearchKey(l
,c
));
7939 /* If the list is empty we need to remove it to avoid wasting memory */
7940 if (listLength(l
) == 0)
7941 dictDelete(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7942 decrRefCount(c
->blocking_keys
[j
]);
7944 /* Cleanup the client structure */
7945 zfree(c
->blocking_keys
);
7946 c
->blocking_keys
= NULL
;
7947 c
->flags
&= (~REDIS_BLOCKED
);
7948 server
.blpop_blocked_clients
--;
7949 /* We want to process data if there is some command waiting
7950 * in the input buffer. Note that this is safe even if
7951 * unblockClientWaitingData() gets called from freeClient() because
7952 * freeClient() will be smart enough to call this function
7953 * *after* c->querybuf was set to NULL. */
7954 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7957 /* This should be called from any function PUSHing into lists.
7958 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7959 * 'ele' is the element pushed.
7961 * If the function returns 0 there was no client waiting for a list push
7964 * If the function returns 1 there was a client waiting for a list push
7965 * against this key, the element was passed to this client thus it's not
7966 * needed to actually add it to the list and the caller should return asap. */
7967 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7968 struct dictEntry
*de
;
7969 redisClient
*receiver
;
7973 de
= dictFind(c
->db
->blocking_keys
,key
);
7974 if (de
== NULL
) return 0;
7975 l
= dictGetEntryVal(de
);
7978 receiver
= ln
->value
;
7980 addReplySds(receiver
,sdsnew("*2\r\n"));
7981 addReplyBulk(receiver
,key
);
7982 addReplyBulk(receiver
,ele
);
7983 unblockClientWaitingData(receiver
);
7987 /* Blocking RPOP/LPOP */
7988 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7993 for (j
= 1; j
< c
->argc
-1; j
++) {
7994 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7996 if (o
->type
!= REDIS_LIST
) {
7997 addReply(c
,shared
.wrongtypeerr
);
8000 list
*list
= o
->ptr
;
8001 if (listLength(list
) != 0) {
8002 /* If the list contains elements fall back to the usual
8003 * non-blocking POP operation */
8004 robj
*argv
[2], **orig_argv
;
8007 /* We need to alter the command arguments before to call
8008 * popGenericCommand() as the command takes a single key. */
8009 orig_argv
= c
->argv
;
8010 orig_argc
= c
->argc
;
8011 argv
[1] = c
->argv
[j
];
8015 /* Also the return value is different, we need to output
8016 * the multi bulk reply header and the key name. The
8017 * "real" command will add the last element (the value)
8018 * for us. If this souds like an hack to you it's just
8019 * because it is... */
8020 addReplySds(c
,sdsnew("*2\r\n"));
8021 addReplyBulk(c
,argv
[1]);
8022 popGenericCommand(c
,where
);
8024 /* Fix the client structure with the original stuff */
8025 c
->argv
= orig_argv
;
8026 c
->argc
= orig_argc
;
8032 /* If the list is empty or the key does not exists we must block */
8033 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
8034 if (timeout
> 0) timeout
+= time(NULL
);
8035 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
8038 static void blpopCommand(redisClient
*c
) {
8039 blockingPopGenericCommand(c
,REDIS_HEAD
);
8042 static void brpopCommand(redisClient
*c
) {
8043 blockingPopGenericCommand(c
,REDIS_TAIL
);
8046 /* =============================== Replication ============================= */
8048 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8049 ssize_t nwritten
, ret
= size
;
8050 time_t start
= time(NULL
);
8054 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
8055 nwritten
= write(fd
,ptr
,size
);
8056 if (nwritten
== -1) return -1;
8060 if ((time(NULL
)-start
) > timeout
) {
8068 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8069 ssize_t nread
, totread
= 0;
8070 time_t start
= time(NULL
);
8074 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
8075 nread
= read(fd
,ptr
,size
);
8076 if (nread
== -1) return -1;
8081 if ((time(NULL
)-start
) > timeout
) {
8089 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8096 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
8099 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
8110 static void syncCommand(redisClient
*c
) {
8111 /* ignore SYNC if aleady slave or in monitor mode */
8112 if (c
->flags
& REDIS_SLAVE
) return;
8114 /* SYNC can't be issued when the server has pending data to send to
8115 * the client about already issued commands. We need a fresh reply
8116 * buffer registering the differences between the BGSAVE and the current
8117 * dataset, so that we can copy to other slaves if needed. */
8118 if (listLength(c
->reply
) != 0) {
8119 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8123 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
8124 /* Here we need to check if there is a background saving operation
8125 * in progress, or if it is required to start one */
8126 if (server
.bgsavechildpid
!= -1) {
8127 /* Ok a background save is in progress. Let's check if it is a good
8128 * one for replication, i.e. if there is another slave that is
8129 * registering differences since the server forked to save */
8134 listRewind(server
.slaves
,&li
);
8135 while((ln
= listNext(&li
))) {
8137 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
8140 /* Perfect, the server is already registering differences for
8141 * another slave. Set the right state, and copy the buffer. */
8142 listRelease(c
->reply
);
8143 c
->reply
= listDup(slave
->reply
);
8144 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8145 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
8147 /* No way, we need to wait for the next BGSAVE in order to
8148 * register differences */
8149 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8150 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
8153 /* Ok we don't have a BGSAVE in progress, let's start one */
8154 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
8155 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8156 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
8157 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
8160 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8163 c
->flags
|= REDIS_SLAVE
;
8165 listAddNodeTail(server
.slaves
,c
);
8169 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
8170 redisClient
*slave
= privdata
;
8172 REDIS_NOTUSED(mask
);
8173 char buf
[REDIS_IOBUF_LEN
];
8174 ssize_t nwritten
, buflen
;
8176 if (slave
->repldboff
== 0) {
8177 /* Write the bulk write count before to transfer the DB. In theory here
8178 * we don't know how much room there is in the output buffer of the
8179 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8180 * operations) will never be smaller than the few bytes we need. */
8183 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8185 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
8193 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
8194 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
8196 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
8197 (buflen
== 0) ? "premature EOF" : strerror(errno
));
8201 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
8202 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
8207 slave
->repldboff
+= nwritten
;
8208 if (slave
->repldboff
== slave
->repldbsize
) {
8209 close(slave
->repldbfd
);
8210 slave
->repldbfd
= -1;
8211 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8212 slave
->replstate
= REDIS_REPL_ONLINE
;
8213 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
8214 sendReplyToClient
, slave
) == AE_ERR
) {
8218 addReplySds(slave
,sdsempty());
8219 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
8223 /* This function is called at the end of every backgrond saving.
8224 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8225 * otherwise REDIS_ERR is passed to the function.
8227 * The goal of this function is to handle slaves waiting for a successful
8228 * background saving in order to perform non-blocking synchronization. */
8229 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
8231 int startbgsave
= 0;
8234 listRewind(server
.slaves
,&li
);
8235 while((ln
= listNext(&li
))) {
8236 redisClient
*slave
= ln
->value
;
8238 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
8240 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8241 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
8242 struct redis_stat buf
;
8244 if (bgsaveerr
!= REDIS_OK
) {
8246 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
8249 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
8250 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
8252 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
8255 slave
->repldboff
= 0;
8256 slave
->repldbsize
= buf
.st_size
;
8257 slave
->replstate
= REDIS_REPL_SEND_BULK
;
8258 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8259 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
8266 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8269 listRewind(server
.slaves
,&li
);
8270 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
8271 while((ln
= listNext(&li
))) {
8272 redisClient
*slave
= ln
->value
;
8274 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
8281 static int syncWithMaster(void) {
8282 char buf
[1024], tmpfile
[256], authcmd
[1024];
8284 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
8285 int dfd
, maxtries
= 5;
8288 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
8293 /* AUTH with the master if required. */
8294 if(server
.masterauth
) {
8295 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
8296 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
8298 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
8302 /* Read the AUTH result. */
8303 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8305 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
8309 if (buf
[0] != '+') {
8311 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
8316 /* Issue the SYNC command */
8317 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
8319 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
8323 /* Read the bulk write count */
8324 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8326 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
8330 if (buf
[0] != '$') {
8332 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8335 dumpsize
= strtol(buf
+1,NULL
,10);
8336 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8337 /* Read the bulk write data on a temp file */
8339 snprintf(tmpfile
,256,
8340 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8341 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8342 if (dfd
!= -1) break;
8347 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8351 int nread
, nwritten
;
8353 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8355 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8361 nwritten
= write(dfd
,buf
,nread
);
8362 if (nwritten
== -1) {
8363 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8371 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8372 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8378 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8379 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8383 server
.master
= createClient(fd
);
8384 server
.master
->flags
|= REDIS_MASTER
;
8385 server
.master
->authenticated
= 1;
8386 server
.replstate
= REDIS_REPL_CONNECTED
;
8390 static void slaveofCommand(redisClient
*c
) {
8391 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8392 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8393 if (server
.masterhost
) {
8394 sdsfree(server
.masterhost
);
8395 server
.masterhost
= NULL
;
8396 if (server
.master
) freeClient(server
.master
);
8397 server
.replstate
= REDIS_REPL_NONE
;
8398 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8401 sdsfree(server
.masterhost
);
8402 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8403 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8404 if (server
.master
) freeClient(server
.master
);
8405 server
.replstate
= REDIS_REPL_CONNECT
;
8406 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8407 server
.masterhost
, server
.masterport
);
8409 addReply(c
,shared
.ok
);
8412 /* ============================ Maxmemory directive ======================== */
8414 /* Try to free one object form the pre-allocated objects free list.
8415 * This is useful under low mem conditions as by default we take 1 million
8416 * free objects allocated. On success REDIS_OK is returned, otherwise
8418 static int tryFreeOneObjectFromFreelist(void) {
8421 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8422 if (listLength(server
.objfreelist
)) {
8423 listNode
*head
= listFirst(server
.objfreelist
);
8424 o
= listNodeValue(head
);
8425 listDelNode(server
.objfreelist
,head
);
8426 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8430 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8435 /* This function gets called when 'maxmemory' is set on the config file to limit
8436 * the max memory used by the server, and we are out of memory.
8437 * This function will try to, in order:
8439 * - Free objects from the free list
8440 * - Try to remove keys with an EXPIRE set
8442 * It is not possible to free enough memory to reach used-memory < maxmemory
8443 * the server will start refusing commands that will enlarge even more the
8446 static void freeMemoryIfNeeded(void) {
8447 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8448 int j
, k
, freed
= 0;
8450 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8451 for (j
= 0; j
< server
.dbnum
; j
++) {
8453 robj
*minkey
= NULL
;
8454 struct dictEntry
*de
;
8456 if (dictSize(server
.db
[j
].expires
)) {
8458 /* From a sample of three keys drop the one nearest to
8459 * the natural expire */
8460 for (k
= 0; k
< 3; k
++) {
8463 de
= dictGetRandomKey(server
.db
[j
].expires
);
8464 t
= (time_t) dictGetEntryVal(de
);
8465 if (minttl
== -1 || t
< minttl
) {
8466 minkey
= dictGetEntryKey(de
);
8470 deleteKey(server
.db
+j
,minkey
);
8473 if (!freed
) return; /* nothing to free... */
8477 /* ============================== Append Only file ========================== */
8479 /* Write the append only file buffer on disk.
8481 * Since we are required to write the AOF before replying to the client,
8482 * and the only way the client socket can get a write is entering when the
8483 * the event loop, we accumulate all the AOF writes in a memory
8484 * buffer and write it on disk using this function just before entering
8485 * the event loop again. */
8486 static void flushAppendOnlyFile(void) {
8490 if (sdslen(server
.aofbuf
) == 0) return;
8492 /* We want to perform a single write. This should be guaranteed atomic
8493 * at least if the filesystem we are writing is a real physical one.
8494 * While this will save us against the server being killed I don't think
8495 * there is much to do about the whole server stopping for power problems
8497 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8498 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8499 /* Ooops, we are in troubles. The best thing to do for now is
8500 * aborting instead of giving the illusion that everything is
8501 * working as expected. */
8502 if (nwritten
== -1) {
8503 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8505 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8509 sdsfree(server
.aofbuf
);
8510 server
.aofbuf
= sdsempty();
8512 /* Fsync if needed */
8514 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8515 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8516 now
-server
.lastfsync
> 1))
8518 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8519 * flushing metadata. */
8520 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8521 server
.lastfsync
= now
;
8525 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8527 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8528 for (j
= 0; j
< argc
; j
++) {
8529 robj
*o
= getDecodedObject(argv
[j
]);
8530 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8531 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8532 buf
= sdscatlen(buf
,"\r\n",2);
8538 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8543 /* Make sure we can use strtol */
8544 seconds
= getDecodedObject(seconds
);
8545 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8546 decrRefCount(seconds
);
8548 argv
[0] = createStringObject("EXPIREAT",8);
8550 argv
[2] = createObject(REDIS_STRING
,
8551 sdscatprintf(sdsempty(),"%ld",when
));
8552 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8553 decrRefCount(argv
[0]);
8554 decrRefCount(argv
[2]);
8558 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8559 sds buf
= sdsempty();
8562 /* The DB this command was targetting is not the same as the last command
8563 * we appendend. To issue a SELECT command is needed. */
8564 if (dictid
!= server
.appendseldb
) {
8567 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8568 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8569 (unsigned long)strlen(seldb
),seldb
);
8570 server
.appendseldb
= dictid
;
8573 if (cmd
->proc
== expireCommand
) {
8574 /* Translate EXPIRE into EXPIREAT */
8575 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8576 } else if (cmd
->proc
== setexCommand
) {
8577 /* Translate SETEX to SET and EXPIREAT */
8578 tmpargv
[0] = createStringObject("SET",3);
8579 tmpargv
[1] = argv
[1];
8580 tmpargv
[2] = argv
[3];
8581 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8582 decrRefCount(tmpargv
[0]);
8583 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8585 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8588 /* Append to the AOF buffer. This will be flushed on disk just before
8589 * of re-entering the event loop, so before the client will get a
8590 * positive reply about the operation performed. */
8591 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8593 /* If a background append only file rewriting is in progress we want to
8594 * accumulate the differences between the child DB and the current one
8595 * in a buffer, so that when the child process will do its work we
8596 * can append the differences to the new append only file. */
8597 if (server
.bgrewritechildpid
!= -1)
8598 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8603 /* In Redis commands are always executed in the context of a client, so in
8604 * order to load the append only file we need to create a fake client. */
8605 static struct redisClient
*createFakeClient(void) {
8606 struct redisClient
*c
= zmalloc(sizeof(*c
));
8610 c
->querybuf
= sdsempty();
8614 /* We set the fake client as a slave waiting for the synchronization
8615 * so that Redis will not try to send replies to this client. */
8616 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8617 c
->reply
= listCreate();
8618 listSetFreeMethod(c
->reply
,decrRefCount
);
8619 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8620 initClientMultiState(c
);
8624 static void freeFakeClient(struct redisClient
*c
) {
8625 sdsfree(c
->querybuf
);
8626 listRelease(c
->reply
);
8627 freeClientMultiState(c
);
8631 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8632 * error (the append only file is zero-length) REDIS_ERR is returned. On
8633 * fatal error an error message is logged and the program exists. */
8634 int loadAppendOnlyFile(char *filename
) {
8635 struct redisClient
*fakeClient
;
8636 FILE *fp
= fopen(filename
,"r");
8637 struct redis_stat sb
;
8638 unsigned long long loadedkeys
= 0;
8639 int appendonly
= server
.appendonly
;
8641 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8645 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8649 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8650 * to the same file we're about to read. */
8651 server
.appendonly
= 0;
8653 fakeClient
= createFakeClient();
8660 struct redisCommand
*cmd
;
8662 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8668 if (buf
[0] != '*') goto fmterr
;
8670 argv
= zmalloc(sizeof(robj
*)*argc
);
8671 for (j
= 0; j
< argc
; j
++) {
8672 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8673 if (buf
[0] != '$') goto fmterr
;
8674 len
= strtol(buf
+1,NULL
,10);
8675 argsds
= sdsnewlen(NULL
,len
);
8676 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8677 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8678 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8681 /* Command lookup */
8682 cmd
= lookupCommand(argv
[0]->ptr
);
8684 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8687 /* Try object encoding */
8688 if (cmd
->flags
& REDIS_CMD_BULK
)
8689 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8690 /* Run the command in the context of a fake client */
8691 fakeClient
->argc
= argc
;
8692 fakeClient
->argv
= argv
;
8693 cmd
->proc(fakeClient
);
8694 /* Discard the reply objects list from the fake client */
8695 while(listLength(fakeClient
->reply
))
8696 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8697 /* Clean up, ready for the next command */
8698 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8700 /* Handle swapping while loading big datasets when VM is on */
8702 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8703 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8704 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8709 /* This point can only be reached when EOF is reached without errors.
8710 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8711 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8714 freeFakeClient(fakeClient
);
8715 server
.appendonly
= appendonly
;
8720 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8722 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8726 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8730 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8731 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8735 /* Avoid the incr/decr ref count business if possible to help
8736 * copy-on-write (we are often in a child process when this function
8738 * Also makes sure that key objects don't get incrRefCount-ed when VM
8740 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8741 obj
= getDecodedObject(obj
);
8744 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8745 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8746 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8748 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8749 if (decrrc
) decrRefCount(obj
);
8752 if (decrrc
) decrRefCount(obj
);
8756 /* Write binary-safe string into a file in the bulkformat
8757 * $<count>\r\n<payload>\r\n */
8758 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8761 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8762 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8763 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8764 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8768 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8769 static int fwriteBulkDouble(FILE *fp
, double d
) {
8770 char buf
[128], dbuf
[128];
8772 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8773 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8774 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8775 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8779 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8780 static int fwriteBulkLong(FILE *fp
, long l
) {
8781 char buf
[128], lbuf
[128];
8783 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8784 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8785 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8786 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8790 /* Write a sequence of commands able to fully rebuild the dataset into
8791 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8792 static int rewriteAppendOnlyFile(char *filename
) {
8793 dictIterator
*di
= NULL
;
8798 time_t now
= time(NULL
);
8800 /* Note that we have to use a different temp name here compared to the
8801 * one used by rewriteAppendOnlyFileBackground() function. */
8802 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8803 fp
= fopen(tmpfile
,"w");
8805 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8808 for (j
= 0; j
< server
.dbnum
; j
++) {
8809 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8810 redisDb
*db
= server
.db
+j
;
8812 if (dictSize(d
) == 0) continue;
8813 di
= dictGetIterator(d
);
8819 /* SELECT the new DB */
8820 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8821 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8823 /* Iterate this DB writing every entry */
8824 while((de
= dictNext(di
)) != NULL
) {
8829 key
= dictGetEntryKey(de
);
8830 /* If the value for this key is swapped, load a preview in memory.
8831 * We use a "swapped" flag to remember if we need to free the
8832 * value object instead to just increment the ref count anyway
8833 * in order to avoid copy-on-write of pages if we are forked() */
8834 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8835 key
->storage
== REDIS_VM_SWAPPING
) {
8836 o
= dictGetEntryVal(de
);
8839 o
= vmPreviewObject(key
);
8842 expiretime
= getExpire(db
,key
);
8844 /* Save the key and associated value */
8845 if (o
->type
== REDIS_STRING
) {
8846 /* Emit a SET command */
8847 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8848 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8850 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8851 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8852 } else if (o
->type
== REDIS_LIST
) {
8853 /* Emit the RPUSHes needed to rebuild the list */
8854 list
*list
= o
->ptr
;
8858 listRewind(list
,&li
);
8859 while((ln
= listNext(&li
))) {
8860 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8861 robj
*eleobj
= listNodeValue(ln
);
8863 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8864 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8865 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8867 } else if (o
->type
== REDIS_SET
) {
8868 /* Emit the SADDs needed to rebuild the set */
8870 dictIterator
*di
= dictGetIterator(set
);
8873 while((de
= dictNext(di
)) != NULL
) {
8874 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8875 robj
*eleobj
= dictGetEntryKey(de
);
8877 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8878 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8879 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8881 dictReleaseIterator(di
);
8882 } else if (o
->type
== REDIS_ZSET
) {
8883 /* Emit the ZADDs needed to rebuild the sorted set */
8885 dictIterator
*di
= dictGetIterator(zs
->dict
);
8888 while((de
= dictNext(di
)) != NULL
) {
8889 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8890 robj
*eleobj
= dictGetEntryKey(de
);
8891 double *score
= dictGetEntryVal(de
);
8893 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8894 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8895 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8896 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8898 dictReleaseIterator(di
);
8899 } else if (o
->type
== REDIS_HASH
) {
8900 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8902 /* Emit the HSETs needed to rebuild the hash */
8903 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8904 unsigned char *p
= zipmapRewind(o
->ptr
);
8905 unsigned char *field
, *val
;
8906 unsigned int flen
, vlen
;
8908 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8909 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8910 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8911 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8913 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8917 dictIterator
*di
= dictGetIterator(o
->ptr
);
8920 while((de
= dictNext(di
)) != NULL
) {
8921 robj
*field
= dictGetEntryKey(de
);
8922 robj
*val
= dictGetEntryVal(de
);
8924 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8925 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8926 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8927 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8929 dictReleaseIterator(di
);
8932 redisPanic("Unknown object type");
8934 /* Save the expire time */
8935 if (expiretime
!= -1) {
8936 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8937 /* If this key is already expired skip it */
8938 if (expiretime
< now
) continue;
8939 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8940 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8941 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8943 if (swapped
) decrRefCount(o
);
8945 dictReleaseIterator(di
);
8948 /* Make sure data will not remain on the OS's output buffers */
8953 /* Use RENAME to make sure the DB file is changed atomically only
8954 * if the generate DB file is ok. */
8955 if (rename(tmpfile
,filename
) == -1) {
8956 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8960 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8966 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8967 if (di
) dictReleaseIterator(di
);
8971 /* This is how rewriting of the append only file in background works:
8973 * 1) The user calls BGREWRITEAOF
8974 * 2) Redis calls this function, that forks():
8975 * 2a) the child rewrite the append only file in a temp file.
8976 * 2b) the parent accumulates differences in server.bgrewritebuf.
8977 * 3) When the child finished '2a' exists.
8978 * 4) The parent will trap the exit code, if it's OK, will append the
8979 * data accumulated into server.bgrewritebuf into the temp file, and
8980 * finally will rename(2) the temp file in the actual file name.
8981 * The the new file is reopened as the new append only file. Profit!
8983 static int rewriteAppendOnlyFileBackground(void) {
8986 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8987 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8988 if ((childpid
= fork()) == 0) {
8992 if (server
.vm_enabled
) vmReopenSwapFile();
8994 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8995 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
9002 if (childpid
== -1) {
9003 redisLog(REDIS_WARNING
,
9004 "Can't rewrite append only file in background: fork: %s",
9008 redisLog(REDIS_NOTICE
,
9009 "Background append only file rewriting started by pid %d",childpid
);
9010 server
.bgrewritechildpid
= childpid
;
9011 updateDictResizePolicy();
9012 /* We set appendseldb to -1 in order to force the next call to the
9013 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9014 * accumulated by the parent into server.bgrewritebuf will start
9015 * with a SELECT statement and it will be safe to merge. */
9016 server
.appendseldb
= -1;
9019 return REDIS_OK
; /* unreached */
9022 static void bgrewriteaofCommand(redisClient
*c
) {
9023 if (server
.bgrewritechildpid
!= -1) {
9024 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9027 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
9028 char *status
= "+Background append only file rewriting started\r\n";
9029 addReplySds(c
,sdsnew(status
));
9031 addReply(c
,shared
.err
);
9035 static void aofRemoveTempFile(pid_t childpid
) {
9038 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
9042 /* Virtual Memory is composed mainly of two subsystems:
9043 * - Blocking Virutal Memory
9044 * - Threaded Virtual Memory I/O
9045 * The two parts are not fully decoupled, but functions are split among two
9046 * different sections of the source code (delimited by comments) in order to
9047 * make more clear what functionality is about the blocking VM and what about
9048 * the threaded (not blocking) VM.
9052 * Redis VM is a blocking VM (one that blocks reading swapped values from
9053 * disk into memory when a value swapped out is needed in memory) that is made
9054 * unblocking by trying to examine the command argument vector in order to
9055 * load in background values that will likely be needed in order to exec
9056 * the command. The command is executed only once all the relevant keys
9057 * are loaded into memory.
9059 * This basically is almost as simple of a blocking VM, but almost as parallel
9060 * as a fully non-blocking VM.
9063 /* Called when the user switches from "appendonly yes" to "appendonly no"
9064 * at runtime using the CONFIG command. */
9065 static void stopAppendOnly(void) {
9066 flushAppendOnlyFile();
9067 fsync(server
.appendfd
);
9068 close(server
.appendfd
);
9070 server
.appendfd
= -1;
9071 server
.appendseldb
= -1;
9072 server
.appendonly
= 0;
9073 /* rewrite operation in progress? kill it, wait child exit */
9074 if (server
.bgsavechildpid
!= -1) {
9077 if (kill(server
.bgsavechildpid
,SIGKILL
) != -1)
9078 wait3(&statloc
,0,NULL
);
9079 /* reset the buffer accumulating changes while the child saves */
9080 sdsfree(server
.bgrewritebuf
);
9081 server
.bgrewritebuf
= sdsempty();
9082 server
.bgsavechildpid
= -1;
9086 /* Called when the user switches from "appendonly no" to "appendonly yes"
9087 * at runtime using the CONFIG command. */
9088 static int startAppendOnly(void) {
9089 server
.appendonly
= 1;
9090 server
.lastfsync
= time(NULL
);
9091 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
9092 if (server
.appendfd
== -1) {
9093 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno
));
9096 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
9097 server
.appendonly
= 0;
9098 close(server
.appendfd
);
9099 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
));
9105 /* =================== Virtual Memory - Blocking Side ====================== */
9107 static void vmInit(void) {
9113 if (server
.vm_max_threads
!= 0)
9114 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9116 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
9117 /* Try to open the old swap file, otherwise create it */
9118 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
9119 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
9121 if (server
.vm_fp
== NULL
) {
9122 redisLog(REDIS_WARNING
,
9123 "Can't open the swap file: %s. Exiting.",
9127 server
.vm_fd
= fileno(server
.vm_fp
);
9128 /* Lock the swap file for writing, this is useful in order to avoid
9129 * another instance to use the same swap file for a config error. */
9130 fl
.l_type
= F_WRLCK
;
9131 fl
.l_whence
= SEEK_SET
;
9132 fl
.l_start
= fl
.l_len
= 0;
9133 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
9134 redisLog(REDIS_WARNING
,
9135 "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
));
9139 server
.vm_next_page
= 0;
9140 server
.vm_near_pages
= 0;
9141 server
.vm_stats_used_pages
= 0;
9142 server
.vm_stats_swapped_objects
= 0;
9143 server
.vm_stats_swapouts
= 0;
9144 server
.vm_stats_swapins
= 0;
9145 totsize
= server
.vm_pages
*server
.vm_page_size
;
9146 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
9147 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
9148 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
9152 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
9154 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
9155 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
9156 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
9157 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
9159 /* Initialize threaded I/O (used by Virtual Memory) */
9160 server
.io_newjobs
= listCreate();
9161 server
.io_processing
= listCreate();
9162 server
.io_processed
= listCreate();
9163 server
.io_ready_clients
= listCreate();
9164 pthread_mutex_init(&server
.io_mutex
,NULL
);
9165 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
9166 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
9167 server
.io_active_threads
= 0;
9168 if (pipe(pipefds
) == -1) {
9169 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
9173 server
.io_ready_pipe_read
= pipefds
[0];
9174 server
.io_ready_pipe_write
= pipefds
[1];
9175 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
9176 /* LZF requires a lot of stack */
9177 pthread_attr_init(&server
.io_threads_attr
);
9178 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
9179 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
9180 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
9181 /* Listen for events in the threaded I/O pipe */
9182 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
9183 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
9184 oom("creating file event");
9187 /* Mark the page as used */
9188 static void vmMarkPageUsed(off_t page
) {
9189 off_t byte
= page
/8;
9191 redisAssert(vmFreePage(page
) == 1);
9192 server
.vm_bitmap
[byte
] |= 1<<bit
;
9195 /* Mark N contiguous pages as used, with 'page' being the first. */
9196 static void vmMarkPagesUsed(off_t page
, off_t count
) {
9199 for (j
= 0; j
< count
; j
++)
9200 vmMarkPageUsed(page
+j
);
9201 server
.vm_stats_used_pages
+= count
;
9202 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
9203 (long long)count
, (long long)page
);
9206 /* Mark the page as free */
9207 static void vmMarkPageFree(off_t page
) {
9208 off_t byte
= page
/8;
9210 redisAssert(vmFreePage(page
) == 0);
9211 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
9214 /* Mark N contiguous pages as free, with 'page' being the first. */
9215 static void vmMarkPagesFree(off_t page
, off_t count
) {
9218 for (j
= 0; j
< count
; j
++)
9219 vmMarkPageFree(page
+j
);
9220 server
.vm_stats_used_pages
-= count
;
9221 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
9222 (long long)count
, (long long)page
);
9225 /* Test if the page is free */
9226 static int vmFreePage(off_t page
) {
9227 off_t byte
= page
/8;
9229 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
9232 /* Find N contiguous free pages storing the first page of the cluster in *first.
9233 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9234 * REDIS_ERR is returned.
9236 * This function uses a simple algorithm: we try to allocate
9237 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9238 * again from the start of the swap file searching for free spaces.
9240 * If it looks pretty clear that there are no free pages near our offset
9241 * we try to find less populated places doing a forward jump of
9242 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9243 * without hurry, and then we jump again and so forth...
9245 * This function can be improved using a free list to avoid to guess
9246 * too much, since we could collect data about freed pages.
9248 * note: I implemented this function just after watching an episode of
9249 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9251 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
9252 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
9254 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
9255 server
.vm_near_pages
= 0;
9256 server
.vm_next_page
= 0;
9258 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
9259 base
= server
.vm_next_page
;
9261 while(offset
< server
.vm_pages
) {
9262 off_t
this = base
+offset
;
9264 /* If we overflow, restart from page zero */
9265 if (this >= server
.vm_pages
) {
9266 this -= server
.vm_pages
;
9268 /* Just overflowed, what we found on tail is no longer
9269 * interesting, as it's no longer contiguous. */
9273 if (vmFreePage(this)) {
9274 /* This is a free page */
9276 /* Already got N free pages? Return to the caller, with success */
9278 *first
= this-(n
-1);
9279 server
.vm_next_page
= this+1;
9280 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
9284 /* The current one is not a free page */
9288 /* Fast-forward if the current page is not free and we already
9289 * searched enough near this place. */
9291 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
9292 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
9294 /* Note that even if we rewind after the jump, we are don't need
9295 * to make sure numfree is set to zero as we only jump *if* it
9296 * is set to zero. */
9298 /* Otherwise just check the next page */
9305 /* Write the specified object at the specified page of the swap file */
9306 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
9307 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9308 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9309 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9310 redisLog(REDIS_WARNING
,
9311 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9315 rdbSaveObject(server
.vm_fp
,o
);
9316 fflush(server
.vm_fp
);
9317 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9321 /* Swap the 'val' object relative to 'key' into disk. Store all the information
9322 * needed to later retrieve the object into the key object.
9323 * If we can't find enough contiguous empty pages to swap the object on disk
9324 * REDIS_ERR is returned. */
9325 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
9326 off_t pages
= rdbSavedObjectPages(val
,NULL
);
9329 assert(key
->storage
== REDIS_VM_MEMORY
);
9330 assert(key
->refcount
== 1);
9331 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
9332 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
9333 key
->vm
.page
= page
;
9334 key
->vm
.usedpages
= pages
;
9335 key
->storage
= REDIS_VM_SWAPPED
;
9336 key
->vtype
= val
->type
;
9337 decrRefCount(val
); /* Deallocate the object from memory. */
9338 vmMarkPagesUsed(page
,pages
);
9339 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
9340 (unsigned char*) key
->ptr
,
9341 (unsigned long long) page
, (unsigned long long) pages
);
9342 server
.vm_stats_swapped_objects
++;
9343 server
.vm_stats_swapouts
++;
9347 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
9350 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9351 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9352 redisLog(REDIS_WARNING
,
9353 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9357 o
= rdbLoadObject(type
,server
.vm_fp
);
9359 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
9362 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9366 /* Load the value object relative to the 'key' object from swap to memory.
9367 * The newly allocated object is returned.
9369 * If preview is true the unserialized object is returned to the caller but
9370 * no changes are made to the key object, nor the pages are marked as freed */
9371 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
9374 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
9375 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
9377 key
->storage
= REDIS_VM_MEMORY
;
9378 key
->vm
.atime
= server
.unixtime
;
9379 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9380 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
9381 (unsigned char*) key
->ptr
);
9382 server
.vm_stats_swapped_objects
--;
9384 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
9385 (unsigned char*) key
->ptr
);
9387 server
.vm_stats_swapins
++;
9391 /* Plain object loading, from swap to memory */
9392 static robj
*vmLoadObject(robj
*key
) {
9393 /* If we are loading the object in background, stop it, we
9394 * need to load this object synchronously ASAP. */
9395 if (key
->storage
== REDIS_VM_LOADING
)
9396 vmCancelThreadedIOJob(key
);
9397 return vmGenericLoadObject(key
,0);
9400 /* Just load the value on disk, without to modify the key.
9401 * This is useful when we want to perform some operation on the value
9402 * without to really bring it from swap to memory, like while saving the
9403 * dataset or rewriting the append only log. */
9404 static robj
*vmPreviewObject(robj
*key
) {
9405 return vmGenericLoadObject(key
,1);
9408 /* How a good candidate is this object for swapping?
9409 * The better candidate it is, the greater the returned value.
9411 * Currently we try to perform a fast estimation of the object size in
9412 * memory, and combine it with aging informations.
9414 * Basically swappability = idle-time * log(estimated size)
9416 * Bigger objects are preferred over smaller objects, but not
9417 * proportionally, this is why we use the logarithm. This algorithm is
9418 * just a first try and will probably be tuned later. */
9419 static double computeObjectSwappability(robj
*o
) {
9420 time_t age
= server
.unixtime
- o
->vm
.atime
;
9424 struct dictEntry
*de
;
9427 if (age
<= 0) return 0;
9430 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9433 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9438 listNode
*ln
= listFirst(l
);
9440 asize
= sizeof(list
);
9442 robj
*ele
= ln
->value
;
9445 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9446 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9448 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9453 z
= (o
->type
== REDIS_ZSET
);
9454 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9456 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9457 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9462 de
= dictGetRandomKey(d
);
9463 ele
= dictGetEntryKey(de
);
9464 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9465 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9467 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9468 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9472 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9473 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9474 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9475 unsigned int klen
, vlen
;
9476 unsigned char *key
, *val
;
9478 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9482 asize
= len
*(klen
+vlen
+3);
9483 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9485 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9490 de
= dictGetRandomKey(d
);
9491 ele
= dictGetEntryKey(de
);
9492 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9493 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9495 ele
= dictGetEntryVal(de
);
9496 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9497 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9499 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9504 return (double)age
*log(1+asize
);
9507 /* Try to swap an object that's a good candidate for swapping.
9508 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9509 * to swap any object at all.
9511 * If 'usethreaded' is true, Redis will try to swap the object in background
9512 * using I/O threads. */
9513 static int vmSwapOneObject(int usethreads
) {
9515 struct dictEntry
*best
= NULL
;
9516 double best_swappability
= 0;
9517 redisDb
*best_db
= NULL
;
9520 for (j
= 0; j
< server
.dbnum
; j
++) {
9521 redisDb
*db
= server
.db
+j
;
9522 /* Why maxtries is set to 100?
9523 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9524 * are swappable objects */
9527 if (dictSize(db
->dict
) == 0) continue;
9528 for (i
= 0; i
< 5; i
++) {
9530 double swappability
;
9532 if (maxtries
) maxtries
--;
9533 de
= dictGetRandomKey(db
->dict
);
9534 key
= dictGetEntryKey(de
);
9535 val
= dictGetEntryVal(de
);
9536 /* Only swap objects that are currently in memory.
9538 * Also don't swap shared objects if threaded VM is on, as we
9539 * try to ensure that the main thread does not touch the
9540 * object while the I/O thread is using it, but we can't
9541 * control other keys without adding additional mutex. */
9542 if (key
->storage
!= REDIS_VM_MEMORY
||
9543 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9544 if (maxtries
) i
--; /* don't count this try */
9547 swappability
= computeObjectSwappability(val
);
9548 if (!best
|| swappability
> best_swappability
) {
9550 best_swappability
= swappability
;
9555 if (best
== NULL
) return REDIS_ERR
;
9556 key
= dictGetEntryKey(best
);
9557 val
= dictGetEntryVal(best
);
9559 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9560 key
->ptr
, best_swappability
);
9562 /* Unshare the key if needed */
9563 if (key
->refcount
> 1) {
9564 robj
*newkey
= dupStringObject(key
);
9566 key
= dictGetEntryKey(best
) = newkey
;
9570 vmSwapObjectThreaded(key
,val
,best_db
);
9573 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9574 dictGetEntryVal(best
) = NULL
;
9582 static int vmSwapOneObjectBlocking() {
9583 return vmSwapOneObject(0);
9586 static int vmSwapOneObjectThreaded() {
9587 return vmSwapOneObject(1);
9590 /* Return true if it's safe to swap out objects in a given moment.
9591 * Basically we don't want to swap objects out while there is a BGSAVE
9592 * or a BGAEOREWRITE running in backgroud. */
9593 static int vmCanSwapOut(void) {
9594 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9597 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9598 * and was deleted. Otherwise 0 is returned. */
9599 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9603 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9604 foundkey
= dictGetEntryKey(de
);
9605 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9610 /* =================== Virtual Memory - Threaded I/O ======================= */
9612 static void freeIOJob(iojob
*j
) {
9613 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9614 j
->type
== REDIS_IOJOB_DO_SWAP
||
9615 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9616 decrRefCount(j
->val
);
9617 /* We don't decrRefCount the j->key field as we did't incremented
9618 * the count creating IO Jobs. This is because the key field here is
9619 * just used as an indentifier and if a key is removed the Job should
9620 * never be touched again. */
9624 /* Every time a thread finished a Job, it writes a byte into the write side
9625 * of an unix pipe in order to "awake" the main thread, and this function
9627 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9631 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9633 REDIS_NOTUSED(mask
);
9634 REDIS_NOTUSED(privdata
);
9636 /* For every byte we read in the read side of the pipe, there is one
9637 * I/O job completed to process. */
9638 while((retval
= read(fd
,buf
,1)) == 1) {
9642 struct dictEntry
*de
;
9644 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9646 /* Get the processed element (the oldest one) */
9648 assert(listLength(server
.io_processed
) != 0);
9649 if (toprocess
== -1) {
9650 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9651 if (toprocess
<= 0) toprocess
= 1;
9653 ln
= listFirst(server
.io_processed
);
9655 listDelNode(server
.io_processed
,ln
);
9657 /* If this job is marked as canceled, just ignore it */
9662 /* Post process it in the main thread, as there are things we
9663 * can do just here to avoid race conditions and/or invasive locks */
9664 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
);
9665 de
= dictFind(j
->db
->dict
,j
->key
);
9667 key
= dictGetEntryKey(de
);
9668 if (j
->type
== REDIS_IOJOB_LOAD
) {
9671 /* Key loaded, bring it at home */
9672 key
->storage
= REDIS_VM_MEMORY
;
9673 key
->vm
.atime
= server
.unixtime
;
9674 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9675 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9676 (unsigned char*) key
->ptr
);
9677 server
.vm_stats_swapped_objects
--;
9678 server
.vm_stats_swapins
++;
9679 dictGetEntryVal(de
) = j
->val
;
9680 incrRefCount(j
->val
);
9683 /* Handle clients waiting for this key to be loaded. */
9684 handleClientsBlockedOnSwappedKey(db
,key
);
9685 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9686 /* Now we know the amount of pages required to swap this object.
9687 * Let's find some space for it, and queue this task again
9688 * rebranded as REDIS_IOJOB_DO_SWAP. */
9689 if (!vmCanSwapOut() ||
9690 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9692 /* Ooops... no space or we can't swap as there is
9693 * a fork()ed Redis trying to save stuff on disk. */
9695 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9697 /* Note that we need to mark this pages as used now,
9698 * if the job will be canceled, we'll mark them as freed
9700 vmMarkPagesUsed(j
->page
,j
->pages
);
9701 j
->type
= REDIS_IOJOB_DO_SWAP
;
9706 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9709 /* Key swapped. We can finally free some memory. */
9710 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9711 printf("key->storage: %d\n",key
->storage
);
9712 printf("key->name: %s\n",(char*)key
->ptr
);
9713 printf("key->refcount: %d\n",key
->refcount
);
9714 printf("val: %p\n",(void*)j
->val
);
9715 printf("val->type: %d\n",j
->val
->type
);
9716 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9718 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9719 val
= dictGetEntryVal(de
);
9720 key
->vm
.page
= j
->page
;
9721 key
->vm
.usedpages
= j
->pages
;
9722 key
->storage
= REDIS_VM_SWAPPED
;
9723 key
->vtype
= j
->val
->type
;
9724 decrRefCount(val
); /* Deallocate the object from memory. */
9725 dictGetEntryVal(de
) = NULL
;
9726 redisLog(REDIS_DEBUG
,
9727 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9728 (unsigned char*) key
->ptr
,
9729 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9730 server
.vm_stats_swapped_objects
++;
9731 server
.vm_stats_swapouts
++;
9733 /* Put a few more swap requests in queue if we are still
9735 if (trytoswap
&& vmCanSwapOut() &&
9736 zmalloc_used_memory() > server
.vm_max_memory
)
9741 more
= listLength(server
.io_newjobs
) <
9742 (unsigned) server
.vm_max_threads
;
9744 /* Don't waste CPU time if swappable objects are rare. */
9745 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9753 if (processed
== toprocess
) return;
9755 if (retval
< 0 && errno
!= EAGAIN
) {
9756 redisLog(REDIS_WARNING
,
9757 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9762 static void lockThreadedIO(void) {
9763 pthread_mutex_lock(&server
.io_mutex
);
9766 static void unlockThreadedIO(void) {
9767 pthread_mutex_unlock(&server
.io_mutex
);
9770 /* Remove the specified object from the threaded I/O queue if still not
9771 * processed, otherwise make sure to flag it as canceled. */
9772 static void vmCancelThreadedIOJob(robj
*o
) {
9774 server
.io_newjobs
, /* 0 */
9775 server
.io_processing
, /* 1 */
9776 server
.io_processed
/* 2 */
9780 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9783 /* Search for a matching key in one of the queues */
9784 for (i
= 0; i
< 3; i
++) {
9788 listRewind(lists
[i
],&li
);
9789 while ((ln
= listNext(&li
)) != NULL
) {
9790 iojob
*job
= ln
->value
;
9792 if (job
->canceled
) continue; /* Skip this, already canceled. */
9793 if (job
->key
== o
) {
9794 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9795 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9796 /* Mark the pages as free since the swap didn't happened
9797 * or happened but is now discarded. */
9798 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9799 vmMarkPagesFree(job
->page
,job
->pages
);
9800 /* Cancel the job. It depends on the list the job is
9803 case 0: /* io_newjobs */
9804 /* If the job was yet not processed the best thing to do
9805 * is to remove it from the queue at all */
9807 listDelNode(lists
[i
],ln
);
9809 case 1: /* io_processing */
9810 /* Oh Shi- the thread is messing with the Job:
9812 * Probably it's accessing the object if this is a
9813 * PREPARE_SWAP or DO_SWAP job.
9814 * If it's a LOAD job it may be reading from disk and
9815 * if we don't wait for the job to terminate before to
9816 * cancel it, maybe in a few microseconds data can be
9817 * corrupted in this pages. So the short story is:
9819 * Better to wait for the job to move into the
9820 * next queue (processed)... */
9822 /* We try again and again until the job is completed. */
9824 /* But let's wait some time for the I/O thread
9825 * to finish with this job. After all this condition
9826 * should be very rare. */
9829 case 2: /* io_processed */
9830 /* The job was already processed, that's easy...
9831 * just mark it as canceled so that we'll ignore it
9832 * when processing completed jobs. */
9836 /* Finally we have to adjust the storage type of the object
9837 * in order to "UNDO" the operaiton. */
9838 if (o
->storage
== REDIS_VM_LOADING
)
9839 o
->storage
= REDIS_VM_SWAPPED
;
9840 else if (o
->storage
== REDIS_VM_SWAPPING
)
9841 o
->storage
= REDIS_VM_MEMORY
;
9848 assert(1 != 1); /* We should never reach this */
9851 static void *IOThreadEntryPoint(void *arg
) {
9856 pthread_detach(pthread_self());
9858 /* Get a new job to process */
9860 if (listLength(server
.io_newjobs
) == 0) {
9861 /* No new jobs in queue, exit. */
9862 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9863 (long) pthread_self());
9864 server
.io_active_threads
--;
9868 ln
= listFirst(server
.io_newjobs
);
9870 listDelNode(server
.io_newjobs
,ln
);
9871 /* Add the job in the processing queue */
9872 j
->thread
= pthread_self();
9873 listAddNodeTail(server
.io_processing
,j
);
9874 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9876 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9877 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9879 /* Process the Job */
9880 if (j
->type
== REDIS_IOJOB_LOAD
) {
9881 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9882 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9883 FILE *fp
= fopen("/dev/null","w+");
9884 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9886 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9887 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9891 /* Done: insert the job into the processed queue */
9892 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9893 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9895 listDelNode(server
.io_processing
,ln
);
9896 listAddNodeTail(server
.io_processed
,j
);
9899 /* Signal the main thread there is new stuff to process */
9900 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9902 return NULL
; /* never reached */
9905 static void spawnIOThread(void) {
9907 sigset_t mask
, omask
;
9911 sigaddset(&mask
,SIGCHLD
);
9912 sigaddset(&mask
,SIGHUP
);
9913 sigaddset(&mask
,SIGPIPE
);
9914 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9915 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9916 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9920 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9921 server
.io_active_threads
++;
9924 /* We need to wait for the last thread to exit before we are able to
9925 * fork() in order to BGSAVE or BGREWRITEAOF. */
9926 static void waitEmptyIOJobsQueue(void) {
9928 int io_processed_len
;
9931 if (listLength(server
.io_newjobs
) == 0 &&
9932 listLength(server
.io_processing
) == 0 &&
9933 server
.io_active_threads
== 0)
9938 /* While waiting for empty jobs queue condition we post-process some
9939 * finshed job, as I/O threads may be hanging trying to write against
9940 * the io_ready_pipe_write FD but there are so much pending jobs that
9942 io_processed_len
= listLength(server
.io_processed
);
9944 if (io_processed_len
) {
9945 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9946 usleep(1000); /* 1 millisecond */
9948 usleep(10000); /* 10 milliseconds */
9953 static void vmReopenSwapFile(void) {
9954 /* Note: we don't close the old one as we are in the child process
9955 * and don't want to mess at all with the original file object. */
9956 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9957 if (server
.vm_fp
== NULL
) {
9958 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9959 server
.vm_swap_file
);
9962 server
.vm_fd
= fileno(server
.vm_fp
);
9965 /* This function must be called while with threaded IO locked */
9966 static void queueIOJob(iojob
*j
) {
9967 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9968 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9969 listAddNodeTail(server
.io_newjobs
,j
);
9970 if (server
.io_active_threads
< server
.vm_max_threads
)
9974 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9977 assert(key
->storage
== REDIS_VM_MEMORY
);
9978 assert(key
->refcount
== 1);
9980 j
= zmalloc(sizeof(*j
));
9981 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9987 j
->thread
= (pthread_t
) -1;
9988 key
->storage
= REDIS_VM_SWAPPING
;
9996 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9998 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9999 * If there is not already a job loading the key, it is craeted.
10000 * The key is added to the io_keys list in the client structure, and also
10001 * in the hash table mapping swapped keys to waiting clients, that is,
10002 * server.io_waited_keys. */
10003 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
10004 struct dictEntry
*de
;
10008 /* If the key does not exist or is already in RAM we don't need to
10009 * block the client at all. */
10010 de
= dictFind(c
->db
->dict
,key
);
10011 if (de
== NULL
) return 0;
10012 o
= dictGetEntryKey(de
);
10013 if (o
->storage
== REDIS_VM_MEMORY
) {
10015 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
10016 /* We were swapping the key, undo it! */
10017 vmCancelThreadedIOJob(o
);
10021 /* OK: the key is either swapped, or being loaded just now. */
10023 /* Add the key to the list of keys this client is waiting for.
10024 * This maps clients to keys they are waiting for. */
10025 listAddNodeTail(c
->io_keys
,key
);
10028 /* Add the client to the swapped keys => clients waiting map. */
10029 de
= dictFind(c
->db
->io_keys
,key
);
10033 /* For every key we take a list of clients blocked for it */
10035 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
10037 assert(retval
== DICT_OK
);
10039 l
= dictGetEntryVal(de
);
10041 listAddNodeTail(l
,c
);
10043 /* Are we already loading the key from disk? If not create a job */
10044 if (o
->storage
== REDIS_VM_SWAPPED
) {
10047 o
->storage
= REDIS_VM_LOADING
;
10048 j
= zmalloc(sizeof(*j
));
10049 j
->type
= REDIS_IOJOB_LOAD
;
10052 j
->key
->vtype
= o
->vtype
;
10053 j
->page
= o
->vm
.page
;
10056 j
->thread
= (pthread_t
) -1;
10059 unlockThreadedIO();
10064 /* Preload keys for any command with first, last and step values for
10065 * the command keys prototype, as defined in the command table. */
10066 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10068 if (cmd
->vm_firstkey
== 0) return;
10069 last
= cmd
->vm_lastkey
;
10070 if (last
< 0) last
= argc
+last
;
10071 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
10072 redisAssert(j
< argc
);
10073 waitForSwappedKey(c
,argv
[j
]);
10077 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10078 * Note that the number of keys to preload is user-defined, so we need to
10079 * apply a sanity check against argc. */
10080 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10082 REDIS_NOTUSED(cmd
);
10084 num
= atoi(argv
[2]->ptr
);
10085 if (num
> (argc
-3)) return;
10086 for (i
= 0; i
< num
; i
++) {
10087 waitForSwappedKey(c
,argv
[3+i
]);
10091 /* Preload keys needed to execute the entire MULTI/EXEC block.
10093 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10094 * and will block the client when any command requires a swapped out value. */
10095 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10097 struct redisCommand
*mcmd
;
10099 REDIS_NOTUSED(cmd
);
10100 REDIS_NOTUSED(argc
);
10101 REDIS_NOTUSED(argv
);
10103 if (!(c
->flags
& REDIS_MULTI
)) return;
10104 for (i
= 0; i
< c
->mstate
.count
; i
++) {
10105 mcmd
= c
->mstate
.commands
[i
].cmd
;
10106 margc
= c
->mstate
.commands
[i
].argc
;
10107 margv
= c
->mstate
.commands
[i
].argv
;
10109 if (mcmd
->vm_preload_proc
!= NULL
) {
10110 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
10112 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
10117 /* Is this client attempting to run a command against swapped keys?
10118 * If so, block it ASAP, load the keys in background, then resume it.
10120 * The important idea about this function is that it can fail! If keys will
10121 * still be swapped when the client is resumed, this key lookups will
10122 * just block loading keys from disk. In practical terms this should only
10123 * happen with SORT BY command or if there is a bug in this function.
10125 * Return 1 if the client is marked as blocked, 0 if the client can
10126 * continue as the keys it is going to access appear to be in memory. */
10127 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
10128 if (cmd
->vm_preload_proc
!= NULL
) {
10129 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
10131 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
10134 /* If the client was blocked for at least one key, mark it as blocked. */
10135 if (listLength(c
->io_keys
)) {
10136 c
->flags
|= REDIS_IO_WAIT
;
10137 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
10138 server
.vm_blocked_clients
++;
10145 /* Remove the 'key' from the list of blocked keys for a given client.
10147 * The function returns 1 when there are no longer blocking keys after
10148 * the current one was removed (and the client can be unblocked). */
10149 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
10153 struct dictEntry
*de
;
10155 /* Remove the key from the list of keys this client is waiting for. */
10156 listRewind(c
->io_keys
,&li
);
10157 while ((ln
= listNext(&li
)) != NULL
) {
10158 if (equalStringObjects(ln
->value
,key
)) {
10159 listDelNode(c
->io_keys
,ln
);
10163 assert(ln
!= NULL
);
10165 /* Remove the client form the key => waiting clients map. */
10166 de
= dictFind(c
->db
->io_keys
,key
);
10167 assert(de
!= NULL
);
10168 l
= dictGetEntryVal(de
);
10169 ln
= listSearchKey(l
,c
);
10170 assert(ln
!= NULL
);
10172 if (listLength(l
) == 0)
10173 dictDelete(c
->db
->io_keys
,key
);
10175 return listLength(c
->io_keys
) == 0;
10178 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
10179 struct dictEntry
*de
;
10184 de
= dictFind(db
->io_keys
,key
);
10187 l
= dictGetEntryVal(de
);
10188 len
= listLength(l
);
10189 /* Note: we can't use something like while(listLength(l)) as the list
10190 * can be freed by the calling function when we remove the last element. */
10193 redisClient
*c
= ln
->value
;
10195 if (dontWaitForSwappedKey(c
,key
)) {
10196 /* Put the client in the list of clients ready to go as we
10197 * loaded all the keys about it. */
10198 listAddNodeTail(server
.io_ready_clients
,c
);
10203 /* =========================== Remote Configuration ========================= */
10205 static void configSetCommand(redisClient
*c
) {
10206 robj
*o
= getDecodedObject(c
->argv
[3]);
10209 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
10210 zfree(server
.dbfilename
);
10211 server
.dbfilename
= zstrdup(o
->ptr
);
10212 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
10213 zfree(server
.requirepass
);
10214 server
.requirepass
= zstrdup(o
->ptr
);
10215 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
10216 zfree(server
.masterauth
);
10217 server
.masterauth
= zstrdup(o
->ptr
);
10218 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
10219 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10220 ll
< 0) goto badfmt
;
10221 server
.maxmemory
= ll
;
10222 } else if (!strcasecmp(c
->argv
[2]->ptr
,"timeout")) {
10223 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10224 ll
< 0 || ll
> LONG_MAX
) goto badfmt
;
10225 server
.maxidletime
= ll
;
10226 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
10227 if (!strcasecmp(o
->ptr
,"no")) {
10228 server
.appendfsync
= APPENDFSYNC_NO
;
10229 } else if (!strcasecmp(o
->ptr
,"everysec")) {
10230 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
10231 } else if (!strcasecmp(o
->ptr
,"always")) {
10232 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
10236 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendonly")) {
10237 int old
= server
.appendonly
;
10238 int new = yesnotoi(o
->ptr
);
10240 if (new == -1) goto badfmt
;
10245 if (startAppendOnly() == REDIS_ERR
) {
10246 addReplySds(c
,sdscatprintf(sdsempty(),
10247 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10253 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
10255 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
10257 /* Perform sanity check before setting the new config:
10258 * - Even number of args
10259 * - Seconds >= 1, changes >= 0 */
10261 sdsfreesplitres(v
,vlen
);
10264 for (j
= 0; j
< vlen
; j
++) {
10268 val
= strtoll(v
[j
], &eptr
, 10);
10269 if (eptr
[0] != '\0' ||
10270 ((j
& 1) == 0 && val
< 1) ||
10271 ((j
& 1) == 1 && val
< 0)) {
10272 sdsfreesplitres(v
,vlen
);
10276 /* Finally set the new config */
10277 resetServerSaveParams();
10278 for (j
= 0; j
< vlen
; j
+= 2) {
10282 seconds
= strtoll(v
[j
],NULL
,10);
10283 changes
= strtoll(v
[j
+1],NULL
,10);
10284 appendServerSaveParams(seconds
, changes
);
10286 sdsfreesplitres(v
,vlen
);
10288 addReplySds(c
,sdscatprintf(sdsempty(),
10289 "-ERR not supported CONFIG parameter %s\r\n",
10290 (char*)c
->argv
[2]->ptr
));
10295 addReply(c
,shared
.ok
);
10298 badfmt
: /* Bad format errors */
10299 addReplySds(c
,sdscatprintf(sdsempty(),
10300 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10302 (char*)c
->argv
[2]->ptr
));
10306 static void configGetCommand(redisClient
*c
) {
10307 robj
*o
= getDecodedObject(c
->argv
[2]);
10308 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
10309 char *pattern
= o
->ptr
;
10312 addReply(c
,lenobj
);
10313 decrRefCount(lenobj
);
10315 if (stringmatch(pattern
,"dbfilename",0)) {
10316 addReplyBulkCString(c
,"dbfilename");
10317 addReplyBulkCString(c
,server
.dbfilename
);
10320 if (stringmatch(pattern
,"requirepass",0)) {
10321 addReplyBulkCString(c
,"requirepass");
10322 addReplyBulkCString(c
,server
.requirepass
);
10325 if (stringmatch(pattern
,"masterauth",0)) {
10326 addReplyBulkCString(c
,"masterauth");
10327 addReplyBulkCString(c
,server
.masterauth
);
10330 if (stringmatch(pattern
,"maxmemory",0)) {
10333 ll2string(buf
,128,server
.maxmemory
);
10334 addReplyBulkCString(c
,"maxmemory");
10335 addReplyBulkCString(c
,buf
);
10338 if (stringmatch(pattern
,"timeout",0)) {
10341 ll2string(buf
,128,server
.maxidletime
);
10342 addReplyBulkCString(c
,"timeout");
10343 addReplyBulkCString(c
,buf
);
10346 if (stringmatch(pattern
,"appendonly",0)) {
10347 addReplyBulkCString(c
,"appendonly");
10348 addReplyBulkCString(c
,server
.appendonly
? "yes" : "no");
10351 if (stringmatch(pattern
,"appendfsync",0)) {
10354 switch(server
.appendfsync
) {
10355 case APPENDFSYNC_NO
: policy
= "no"; break;
10356 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
10357 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
10358 default: policy
= "unknown"; break; /* too harmless to panic */
10360 addReplyBulkCString(c
,"appendfsync");
10361 addReplyBulkCString(c
,policy
);
10364 if (stringmatch(pattern
,"save",0)) {
10365 sds buf
= sdsempty();
10368 for (j
= 0; j
< server
.saveparamslen
; j
++) {
10369 buf
= sdscatprintf(buf
,"%ld %d",
10370 server
.saveparams
[j
].seconds
,
10371 server
.saveparams
[j
].changes
);
10372 if (j
!= server
.saveparamslen
-1)
10373 buf
= sdscatlen(buf
," ",1);
10375 addReplyBulkCString(c
,"save");
10376 addReplyBulkCString(c
,buf
);
10381 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
10384 static void configCommand(redisClient
*c
) {
10385 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
10386 if (c
->argc
!= 4) goto badarity
;
10387 configSetCommand(c
);
10388 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
10389 if (c
->argc
!= 3) goto badarity
;
10390 configGetCommand(c
);
10391 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
10392 if (c
->argc
!= 2) goto badarity
;
10393 server
.stat_numcommands
= 0;
10394 server
.stat_numconnections
= 0;
10395 server
.stat_expiredkeys
= 0;
10396 server
.stat_starttime
= time(NULL
);
10397 addReply(c
,shared
.ok
);
10399 addReplySds(c
,sdscatprintf(sdsempty(),
10400 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10405 addReplySds(c
,sdscatprintf(sdsempty(),
10406 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10407 (char*) c
->argv
[1]->ptr
));
10410 /* =========================== Pubsub implementation ======================== */
10412 static void freePubsubPattern(void *p
) {
10413 pubsubPattern
*pat
= p
;
10415 decrRefCount(pat
->pattern
);
10419 static int listMatchPubsubPattern(void *a
, void *b
) {
10420 pubsubPattern
*pa
= a
, *pb
= b
;
10422 return (pa
->client
== pb
->client
) &&
10423 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10426 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10427 * 0 if the client was already subscribed to that channel. */
10428 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10429 struct dictEntry
*de
;
10430 list
*clients
= NULL
;
10433 /* Add the channel to the client -> channels hash table */
10434 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10436 incrRefCount(channel
);
10437 /* Add the client to the channel -> list of clients hash table */
10438 de
= dictFind(server
.pubsub_channels
,channel
);
10440 clients
= listCreate();
10441 dictAdd(server
.pubsub_channels
,channel
,clients
);
10442 incrRefCount(channel
);
10444 clients
= dictGetEntryVal(de
);
10446 listAddNodeTail(clients
,c
);
10448 /* Notify the client */
10449 addReply(c
,shared
.mbulk3
);
10450 addReply(c
,shared
.subscribebulk
);
10451 addReplyBulk(c
,channel
);
10452 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10456 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10457 * 0 if the client was not subscribed to the specified channel. */
10458 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10459 struct dictEntry
*de
;
10464 /* Remove the channel from the client -> channels hash table */
10465 incrRefCount(channel
); /* channel may be just a pointer to the same object
10466 we have in the hash tables. Protect it... */
10467 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10469 /* Remove the client from the channel -> clients list hash table */
10470 de
= dictFind(server
.pubsub_channels
,channel
);
10471 assert(de
!= NULL
);
10472 clients
= dictGetEntryVal(de
);
10473 ln
= listSearchKey(clients
,c
);
10474 assert(ln
!= NULL
);
10475 listDelNode(clients
,ln
);
10476 if (listLength(clients
) == 0) {
10477 /* Free the list and associated hash entry at all if this was
10478 * the latest client, so that it will be possible to abuse
10479 * Redis PUBSUB creating millions of channels. */
10480 dictDelete(server
.pubsub_channels
,channel
);
10483 /* Notify the client */
10485 addReply(c
,shared
.mbulk3
);
10486 addReply(c
,shared
.unsubscribebulk
);
10487 addReplyBulk(c
,channel
);
10488 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10489 listLength(c
->pubsub_patterns
));
10492 decrRefCount(channel
); /* it is finally safe to release it */
10496 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10497 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10500 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10502 pubsubPattern
*pat
;
10503 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10504 incrRefCount(pattern
);
10505 pat
= zmalloc(sizeof(*pat
));
10506 pat
->pattern
= getDecodedObject(pattern
);
10508 listAddNodeTail(server
.pubsub_patterns
,pat
);
10510 /* Notify the client */
10511 addReply(c
,shared
.mbulk3
);
10512 addReply(c
,shared
.psubscribebulk
);
10513 addReplyBulk(c
,pattern
);
10514 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10518 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10519 * 0 if the client was not subscribed to the specified channel. */
10520 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10525 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10526 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10528 listDelNode(c
->pubsub_patterns
,ln
);
10530 pat
.pattern
= pattern
;
10531 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10532 listDelNode(server
.pubsub_patterns
,ln
);
10534 /* Notify the client */
10536 addReply(c
,shared
.mbulk3
);
10537 addReply(c
,shared
.punsubscribebulk
);
10538 addReplyBulk(c
,pattern
);
10539 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10540 listLength(c
->pubsub_patterns
));
10542 decrRefCount(pattern
);
10546 /* Unsubscribe from all the channels. Return the number of channels the
10547 * client was subscribed from. */
10548 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10549 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10553 while((de
= dictNext(di
)) != NULL
) {
10554 robj
*channel
= dictGetEntryKey(de
);
10556 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10558 dictReleaseIterator(di
);
10562 /* Unsubscribe from all the patterns. Return the number of patterns the
10563 * client was subscribed from. */
10564 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10569 listRewind(c
->pubsub_patterns
,&li
);
10570 while ((ln
= listNext(&li
)) != NULL
) {
10571 robj
*pattern
= ln
->value
;
10573 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10578 /* Publish a message */
10579 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10581 struct dictEntry
*de
;
10585 /* Send to clients listening for that channel */
10586 de
= dictFind(server
.pubsub_channels
,channel
);
10588 list
*list
= dictGetEntryVal(de
);
10592 listRewind(list
,&li
);
10593 while ((ln
= listNext(&li
)) != NULL
) {
10594 redisClient
*c
= ln
->value
;
10596 addReply(c
,shared
.mbulk3
);
10597 addReply(c
,shared
.messagebulk
);
10598 addReplyBulk(c
,channel
);
10599 addReplyBulk(c
,message
);
10603 /* Send to clients listening to matching channels */
10604 if (listLength(server
.pubsub_patterns
)) {
10605 listRewind(server
.pubsub_patterns
,&li
);
10606 channel
= getDecodedObject(channel
);
10607 while ((ln
= listNext(&li
)) != NULL
) {
10608 pubsubPattern
*pat
= ln
->value
;
10610 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10611 sdslen(pat
->pattern
->ptr
),
10612 (char*)channel
->ptr
,
10613 sdslen(channel
->ptr
),0)) {
10614 addReply(pat
->client
,shared
.mbulk4
);
10615 addReply(pat
->client
,shared
.pmessagebulk
);
10616 addReplyBulk(pat
->client
,pat
->pattern
);
10617 addReplyBulk(pat
->client
,channel
);
10618 addReplyBulk(pat
->client
,message
);
10622 decrRefCount(channel
);
10627 static void subscribeCommand(redisClient
*c
) {
10630 for (j
= 1; j
< c
->argc
; j
++)
10631 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10634 static void unsubscribeCommand(redisClient
*c
) {
10635 if (c
->argc
== 1) {
10636 pubsubUnsubscribeAllChannels(c
,1);
10641 for (j
= 1; j
< c
->argc
; j
++)
10642 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10646 static void psubscribeCommand(redisClient
*c
) {
10649 for (j
= 1; j
< c
->argc
; j
++)
10650 pubsubSubscribePattern(c
,c
->argv
[j
]);
10653 static void punsubscribeCommand(redisClient
*c
) {
10654 if (c
->argc
== 1) {
10655 pubsubUnsubscribeAllPatterns(c
,1);
10660 for (j
= 1; j
< c
->argc
; j
++)
10661 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10665 static void publishCommand(redisClient
*c
) {
10666 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10667 addReplyLongLong(c
,receivers
);
10670 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10672 * The implementation uses a per-DB hash table mapping keys to list of clients
10673 * WATCHing those keys, so that given a key that is going to be modified
10674 * we can mark all the associated clients as dirty.
10676 * Also every client contains a list of WATCHed keys so that's possible to
10677 * un-watch such keys when the client is freed or when UNWATCH is called. */
10679 /* In the client->watched_keys list we need to use watchedKey structures
10680 * as in order to identify a key in Redis we need both the key name and the
10682 typedef struct watchedKey
{
10687 /* Watch for the specified key */
10688 static void watchForKey(redisClient
*c
, robj
*key
) {
10689 list
*clients
= NULL
;
10694 /* Check if we are already watching for this key */
10695 listRewind(c
->watched_keys
,&li
);
10696 while((ln
= listNext(&li
))) {
10697 wk
= listNodeValue(ln
);
10698 if (wk
->db
== c
->db
&& equalStringObjects(key
,wk
->key
))
10699 return; /* Key already watched */
10701 /* This key is not already watched in this DB. Let's add it */
10702 clients
= dictFetchValue(c
->db
->watched_keys
,key
);
10704 clients
= listCreate();
10705 dictAdd(c
->db
->watched_keys
,key
,clients
);
10708 listAddNodeTail(clients
,c
);
10709 /* Add the new key to the lits of keys watched by this client */
10710 wk
= zmalloc(sizeof(*wk
));
10714 listAddNodeTail(c
->watched_keys
,wk
);
10717 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10718 * flag is up to the caller. */
10719 static void unwatchAllKeys(redisClient
*c
) {
10723 if (listLength(c
->watched_keys
) == 0) return;
10724 listRewind(c
->watched_keys
,&li
);
10725 while((ln
= listNext(&li
))) {
10729 /* Lookup the watched key -> clients list and remove the client
10731 wk
= listNodeValue(ln
);
10732 clients
= dictFetchValue(wk
->db
->watched_keys
, wk
->key
);
10733 assert(clients
!= NULL
);
10734 listDelNode(clients
,listSearchKey(clients
,c
));
10735 /* Kill the entry at all if this was the only client */
10736 if (listLength(clients
) == 0)
10737 dictDelete(wk
->db
->watched_keys
, wk
->key
);
10738 /* Remove this watched key from the client->watched list */
10739 listDelNode(c
->watched_keys
,ln
);
10740 decrRefCount(wk
->key
);
10745 /* "Touch" a key, so that if this key is being WATCHed by some client the
10746 * next EXEC will fail. */
10747 static void touchWatchedKey(redisDb
*db
, robj
*key
) {
10752 if (dictSize(db
->watched_keys
) == 0) return;
10753 clients
= dictFetchValue(db
->watched_keys
, key
);
10754 if (!clients
) return;
10756 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
10757 /* Check if we are already watching for this key */
10758 listRewind(clients
,&li
);
10759 while((ln
= listNext(&li
))) {
10760 redisClient
*c
= listNodeValue(ln
);
10762 c
->flags
|= REDIS_DIRTY_CAS
;
10766 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
10767 * flush but will be deleted as effect of the flushing operation should
10768 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
10769 * a FLUSHALL operation (all the DBs flushed). */
10770 static void touchWatchedKeysOnFlush(int dbid
) {
10774 /* For every client, check all the waited keys */
10775 listRewind(server
.clients
,&li1
);
10776 while((ln
= listNext(&li1
))) {
10777 redisClient
*c
= listNodeValue(ln
);
10778 listRewind(c
->watched_keys
,&li2
);
10779 while((ln
= listNext(&li2
))) {
10780 watchedKey
*wk
= listNodeValue(ln
);
10782 /* For every watched key matching the specified DB, if the
10783 * key exists, mark the client as dirty, as the key will be
10785 if (dbid
== -1 || wk
->db
->id
== dbid
) {
10786 if (dictFind(wk
->db
->dict
, wk
->key
) != NULL
)
10787 c
->flags
|= REDIS_DIRTY_CAS
;
10793 static void watchCommand(redisClient
*c
) {
10796 if (c
->flags
& REDIS_MULTI
) {
10797 addReplySds(c
,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
10800 for (j
= 1; j
< c
->argc
; j
++)
10801 watchForKey(c
,c
->argv
[j
]);
10802 addReply(c
,shared
.ok
);
10805 static void unwatchCommand(redisClient
*c
) {
10807 c
->flags
&= (~REDIS_DIRTY_CAS
);
10808 addReply(c
,shared
.ok
);
10811 /* ================================= Debugging ============================== */
10813 /* Compute the sha1 of string at 's' with 'len' bytes long.
10814 * The SHA1 is then xored againt the string pointed by digest.
10815 * Since xor is commutative, this operation is used in order to
10816 * "add" digests relative to unordered elements.
10818 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
10819 static void xorDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10821 unsigned char hash
[20], *s
= ptr
;
10825 SHA1Update(&ctx
,s
,len
);
10826 SHA1Final(hash
,&ctx
);
10828 for (j
= 0; j
< 20; j
++)
10829 digest
[j
] ^= hash
[j
];
10832 static void xorObjectDigest(unsigned char *digest
, robj
*o
) {
10833 o
= getDecodedObject(o
);
10834 xorDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10838 /* This function instead of just computing the SHA1 and xoring it
10839 * against diget, also perform the digest of "digest" itself and
10840 * replace the old value with the new one.
10842 * So the final digest will be:
10844 * digest = SHA1(digest xor SHA1(data))
10846 * This function is used every time we want to preserve the order so
10847 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
10849 * Also note that mixdigest("foo") followed by mixdigest("bar")
10850 * will lead to a different digest compared to "fo", "obar".
10852 static void mixDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10856 xorDigest(digest
,s
,len
);
10858 SHA1Update(&ctx
,digest
,20);
10859 SHA1Final(digest
,&ctx
);
10862 static void mixObjectDigest(unsigned char *digest
, robj
*o
) {
10863 o
= getDecodedObject(o
);
10864 mixDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10868 /* Compute the dataset digest. Since keys, sets elements, hashes elements
10869 * are not ordered, we use a trick: every aggregate digest is the xor
10870 * of the digests of their elements. This way the order will not change
10871 * the result. For list instead we use a feedback entering the output digest
10872 * as input in order to ensure that a different ordered list will result in
10873 * a different digest. */
10874 static void computeDatasetDigest(unsigned char *final
) {
10875 unsigned char digest
[20];
10877 dictIterator
*di
= NULL
;
10882 memset(final
,0,20); /* Start with a clean result */
10884 for (j
= 0; j
< server
.dbnum
; j
++) {
10885 redisDb
*db
= server
.db
+j
;
10887 if (dictSize(db
->dict
) == 0) continue;
10888 di
= dictGetIterator(db
->dict
);
10890 /* hash the DB id, so the same dataset moved in a different
10891 * DB will lead to a different digest */
10893 mixDigest(final
,&aux
,sizeof(aux
));
10895 /* Iterate this DB writing every entry */
10896 while((de
= dictNext(di
)) != NULL
) {
10897 robj
*key
, *o
, *kcopy
;
10900 memset(digest
,0,20); /* This key-val digest */
10901 key
= dictGetEntryKey(de
);
10903 if (!server
.vm_enabled
) {
10904 mixObjectDigest(digest
,key
);
10905 o
= dictGetEntryVal(de
);
10907 /* Don't work with the key directly as when VM is active
10908 * this is unsafe: TODO: fix decrRefCount to check if the
10909 * count really reached 0 to avoid this mess */
10910 kcopy
= dupStringObject(key
);
10911 mixObjectDigest(digest
,kcopy
);
10912 o
= lookupKeyRead(db
,kcopy
);
10913 decrRefCount(kcopy
);
10915 aux
= htonl(o
->type
);
10916 mixDigest(digest
,&aux
,sizeof(aux
));
10917 expiretime
= getExpire(db
,key
);
10919 /* Save the key and associated value */
10920 if (o
->type
== REDIS_STRING
) {
10921 mixObjectDigest(digest
,o
);
10922 } else if (o
->type
== REDIS_LIST
) {
10923 list
*list
= o
->ptr
;
10927 listRewind(list
,&li
);
10928 while((ln
= listNext(&li
))) {
10929 robj
*eleobj
= listNodeValue(ln
);
10931 mixObjectDigest(digest
,eleobj
);
10933 } else if (o
->type
== REDIS_SET
) {
10934 dict
*set
= o
->ptr
;
10935 dictIterator
*di
= dictGetIterator(set
);
10938 while((de
= dictNext(di
)) != NULL
) {
10939 robj
*eleobj
= dictGetEntryKey(de
);
10941 xorObjectDigest(digest
,eleobj
);
10943 dictReleaseIterator(di
);
10944 } else if (o
->type
== REDIS_ZSET
) {
10946 dictIterator
*di
= dictGetIterator(zs
->dict
);
10949 while((de
= dictNext(di
)) != NULL
) {
10950 robj
*eleobj
= dictGetEntryKey(de
);
10951 double *score
= dictGetEntryVal(de
);
10952 unsigned char eledigest
[20];
10954 snprintf(buf
,sizeof(buf
),"%.17g",*score
);
10955 memset(eledigest
,0,20);
10956 mixObjectDigest(eledigest
,eleobj
);
10957 mixDigest(eledigest
,buf
,strlen(buf
));
10958 xorDigest(digest
,eledigest
,20);
10960 dictReleaseIterator(di
);
10961 } else if (o
->type
== REDIS_HASH
) {
10965 hi
= hashInitIterator(o
);
10966 while (hashNext(hi
) != REDIS_ERR
) {
10967 unsigned char eledigest
[20];
10969 memset(eledigest
,0,20);
10970 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
10971 mixObjectDigest(eledigest
,obj
);
10973 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
10974 mixObjectDigest(eledigest
,obj
);
10976 xorDigest(digest
,eledigest
,20);
10978 hashReleaseIterator(hi
);
10980 redisPanic("Unknown object type");
10982 /* If the key has an expire, add it to the mix */
10983 if (expiretime
!= -1) xorDigest(digest
,"!!expire!!",10);
10984 /* We can finally xor the key-val digest to the final digest */
10985 xorDigest(final
,digest
,20);
10987 dictReleaseIterator(di
);
10991 static void debugCommand(redisClient
*c
) {
10992 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10993 *((char*)-1) = 'x';
10994 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10995 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10996 addReply(c
,shared
.err
);
11000 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
11001 addReply(c
,shared
.err
);
11004 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
11005 addReply(c
,shared
.ok
);
11006 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
11008 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
11009 addReply(c
,shared
.err
);
11012 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
11013 addReply(c
,shared
.ok
);
11014 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
11015 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
11019 addReply(c
,shared
.nokeyerr
);
11022 key
= dictGetEntryKey(de
);
11023 val
= dictGetEntryVal(de
);
11024 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
11025 key
->storage
== REDIS_VM_SWAPPING
)) {
11029 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
11030 strenc
= strencoding
[val
->encoding
];
11032 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
11035 addReplySds(c
,sdscatprintf(sdsempty(),
11036 "+Key at:%p refcount:%d, value at:%p refcount:%d "
11037 "encoding:%s serializedlength:%lld\r\n",
11038 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
11039 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
11041 addReplySds(c
,sdscatprintf(sdsempty(),
11042 "+Key at:%p refcount:%d, value swapped at: page %llu "
11043 "using %llu pages\r\n",
11044 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
11045 (unsigned long long) key
->vm
.usedpages
));
11047 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
11048 lookupKeyRead(c
->db
,c
->argv
[2]);
11049 addReply(c
,shared
.ok
);
11050 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
11051 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
11054 if (!server
.vm_enabled
) {
11055 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11059 addReply(c
,shared
.nokeyerr
);
11062 key
= dictGetEntryKey(de
);
11063 val
= dictGetEntryVal(de
);
11064 /* If the key is shared we want to create a copy */
11065 if (key
->refcount
> 1) {
11066 robj
*newkey
= dupStringObject(key
);
11068 key
= dictGetEntryKey(de
) = newkey
;
11071 if (key
->storage
!= REDIS_VM_MEMORY
) {
11072 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
11073 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
11074 dictGetEntryVal(de
) = NULL
;
11075 addReply(c
,shared
.ok
);
11077 addReply(c
,shared
.err
);
11079 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
11084 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
11086 for (j
= 0; j
< keys
; j
++) {
11087 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
11088 key
= createStringObject(buf
,strlen(buf
));
11089 if (lookupKeyRead(c
->db
,key
) != NULL
) {
11093 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
11094 val
= createStringObject(buf
,strlen(buf
));
11095 dictAdd(c
->db
->dict
,key
,val
);
11097 addReply(c
,shared
.ok
);
11098 } else if (!strcasecmp(c
->argv
[1]->ptr
,"digest") && c
->argc
== 2) {
11099 unsigned char digest
[20];
11100 sds d
= sdsnew("+");
11103 computeDatasetDigest(digest
);
11104 for (j
= 0; j
< 20; j
++)
11105 d
= sdscatprintf(d
, "%02x",digest
[j
]);
11107 d
= sdscatlen(d
,"\r\n",2);
11110 addReplySds(c
,sdsnew(
11111 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11115 static void _redisAssert(char *estr
, char *file
, int line
) {
11116 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
11117 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true",file
,line
,estr
);
11118 #ifdef HAVE_BACKTRACE
11119 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11120 *((char*)-1) = 'x';
11124 static void _redisPanic(char *msg
, char *file
, int line
) {
11125 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
11126 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
11127 #ifdef HAVE_BACKTRACE
11128 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11129 *((char*)-1) = 'x';
11133 /* =================================== Main! ================================ */
11136 int linuxOvercommitMemoryValue(void) {
11137 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
11140 if (!fp
) return -1;
11141 if (fgets(buf
,64,fp
) == NULL
) {
11150 void linuxOvercommitMemoryWarning(void) {
11151 if (linuxOvercommitMemoryValue() == 0) {
11152 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.");
11155 #endif /* __linux__ */
11157 static void daemonize(void) {
11161 if (fork() != 0) exit(0); /* parent exits */
11162 setsid(); /* create a new session */
11164 /* Every output goes to /dev/null. If Redis is daemonized but
11165 * the 'logfile' is set to 'stdout' in the configuration file
11166 * it will not log at all. */
11167 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
11168 dup2(fd
, STDIN_FILENO
);
11169 dup2(fd
, STDOUT_FILENO
);
11170 dup2(fd
, STDERR_FILENO
);
11171 if (fd
> STDERR_FILENO
) close(fd
);
11173 /* Try to write the pid file */
11174 fp
= fopen(server
.pidfile
,"w");
11176 fprintf(fp
,"%d\n",getpid());
11181 static void version() {
11182 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
11183 REDIS_GIT_SHA1
, atoi(REDIS_GIT_DIRTY
) > 0);
11187 static void usage() {
11188 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
11189 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
11193 int main(int argc
, char **argv
) {
11196 initServerConfig();
11197 sortCommandTable();
11199 if (strcmp(argv
[1], "-v") == 0 ||
11200 strcmp(argv
[1], "--version") == 0) version();
11201 if (strcmp(argv
[1], "--help") == 0) usage();
11202 resetServerSaveParams();
11203 loadServerConfig(argv
[1]);
11204 } else if ((argc
> 2)) {
11207 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'");
11209 if (server
.daemonize
) daemonize();
11211 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
11213 linuxOvercommitMemoryWarning();
11215 start
= time(NULL
);
11216 if (server
.appendonly
) {
11217 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
11218 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
11220 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
11221 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
11223 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
11224 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
11226 aeDeleteEventLoop(server
.el
);
11230 /* ============================= Backtrace support ========================= */
11232 #ifdef HAVE_BACKTRACE
11233 static char *findFuncName(void *pointer
, unsigned long *offset
);
11235 static void *getMcontextEip(ucontext_t
*uc
) {
11236 #if defined(__FreeBSD__)
11237 return (void*) uc
->uc_mcontext
.mc_eip
;
11238 #elif defined(__dietlibc__)
11239 return (void*) uc
->uc_mcontext
.eip
;
11240 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11242 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11244 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11246 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11247 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11248 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11250 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11252 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11253 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
11254 #elif defined(__ia64__) /* Linux IA64 */
11255 return (void*) uc
->uc_mcontext
.sc_ip
;
11261 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
11263 char **messages
= NULL
;
11264 int i
, trace_size
= 0;
11265 unsigned long offset
=0;
11266 ucontext_t
*uc
= (ucontext_t
*) secret
;
11268 REDIS_NOTUSED(info
);
11270 redisLog(REDIS_WARNING
,
11271 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
11272 infostring
= genRedisInfoString();
11273 redisLog(REDIS_WARNING
, "%s",infostring
);
11274 /* It's not safe to sdsfree() the returned string under memory
11275 * corruption conditions. Let it leak as we are going to abort */
11277 trace_size
= backtrace(trace
, 100);
11278 /* overwrite sigaction with caller's address */
11279 if (getMcontextEip(uc
) != NULL
) {
11280 trace
[1] = getMcontextEip(uc
);
11282 messages
= backtrace_symbols(trace
, trace_size
);
11284 for (i
=1; i
<trace_size
; ++i
) {
11285 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
11287 p
= strchr(messages
[i
],'+');
11288 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
11289 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
11291 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
11294 /* free(messages); Don't call free() with possibly corrupted memory. */
11298 static void sigtermHandler(int sig
) {
11299 REDIS_NOTUSED(sig
);
11301 redisLog(REDIS_WARNING
,"SIGTERM received, scheduling shutting down...");
11302 server
.shutdown_asap
= 1;
11305 static void setupSigSegvAction(void) {
11306 struct sigaction act
;
11308 sigemptyset (&act
.sa_mask
);
11309 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11310 * is used. Otherwise, sa_handler is used */
11311 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
11312 act
.sa_sigaction
= segvHandler
;
11313 sigaction (SIGSEGV
, &act
, NULL
);
11314 sigaction (SIGBUS
, &act
, NULL
);
11315 sigaction (SIGFPE
, &act
, NULL
);
11316 sigaction (SIGILL
, &act
, NULL
);
11317 sigaction (SIGBUS
, &act
, NULL
);
11319 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
11320 act
.sa_handler
= sigtermHandler
;
11321 sigaction (SIGTERM
, &act
, NULL
);
11325 #include "staticsymbols.h"
11326 /* This function try to convert a pointer into a function name. It's used in
11327 * oreder to provide a backtrace under segmentation fault that's able to
11328 * display functions declared as static (otherwise the backtrace is useless). */
11329 static char *findFuncName(void *pointer
, unsigned long *offset
){
11331 unsigned long off
, minoff
= 0;
11333 /* Try to match against the Symbol with the smallest offset */
11334 for (i
=0; symsTable
[i
].pointer
; i
++) {
11335 unsigned long lp
= (unsigned long) pointer
;
11337 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
11338 off
=lp
-symsTable
[i
].pointer
;
11339 if (ret
< 0 || off
< minoff
) {
11345 if (ret
== -1) return NULL
;
11347 return symsTable
[ret
].name
;
11349 #else /* HAVE_BACKTRACE */
11350 static void setupSigSegvAction(void) {
11352 #endif /* HAVE_BACKTRACE */