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
124 #define REDIS_VMPOINTER 8
126 /* Objects encoding. Some kind of objects like Strings and Hashes can be
127 * internally represented in multiple ways. The 'encoding' field of the object
128 * is set to one of this fields for this object. */
129 #define REDIS_ENCODING_RAW 0 /* Raw representation */
130 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
131 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
132 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
133 #define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
134 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
136 static char* strencoding
[] = {
137 "raw", "int", "hashtable", "zipmap", "list", "ziplist"
140 /* Object types only used for dumping to disk */
141 #define REDIS_EXPIRETIME 253
142 #define REDIS_SELECTDB 254
143 #define REDIS_EOF 255
145 /* Defines related to the dump file format. To store 32 bits lengths for short
146 * keys requires a lot of space, so we check the most significant 2 bits of
147 * the first byte to interpreter the length:
149 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
150 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
151 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
152 * 11|000000 this means: specially encoded object will follow. The six bits
153 * number specify the kind of object that follows.
154 * See the REDIS_RDB_ENC_* defines.
156 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
157 * values, will fit inside. */
158 #define REDIS_RDB_6BITLEN 0
159 #define REDIS_RDB_14BITLEN 1
160 #define REDIS_RDB_32BITLEN 2
161 #define REDIS_RDB_ENCVAL 3
162 #define REDIS_RDB_LENERR UINT_MAX
164 /* When a length of a string object stored on disk has the first two bits
165 * set, the remaining two bits specify a special encoding for the object
166 * accordingly to the following defines: */
167 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
168 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
169 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
170 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
172 /* Virtual memory object->where field. */
173 #define REDIS_VM_MEMORY 0 /* The object is on memory */
174 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
175 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
176 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
178 /* Virtual memory static configuration stuff.
179 * Check vmFindContiguousPages() to know more about this magic numbers. */
180 #define REDIS_VM_MAX_NEAR_PAGES 65536
181 #define REDIS_VM_MAX_RANDOM_JUMP 4096
182 #define REDIS_VM_MAX_THREADS 32
183 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
184 /* The following is the *percentage* of completed I/O jobs to process when the
185 * handelr is called. While Virtual Memory I/O operations are performed by
186 * threads, this operations must be processed by the main thread when completed
187 * in order to take effect. */
188 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
191 #define REDIS_SLAVE 1 /* This client is a slave server */
192 #define REDIS_MASTER 2 /* This client is a master server */
193 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
194 #define REDIS_MULTI 8 /* This client is in a MULTI context */
195 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
196 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
197 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
199 /* Slave replication state - slave side */
200 #define REDIS_REPL_NONE 0 /* No active replication */
201 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
202 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
204 /* Slave replication state - from the point of view of master
205 * Note that in SEND_BULK and ONLINE state the slave receives new updates
206 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
207 * to start the next background saving in order to send updates to it. */
208 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
209 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
210 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
211 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
213 /* List related stuff */
217 /* Sort operations */
218 #define REDIS_SORT_GET 0
219 #define REDIS_SORT_ASC 1
220 #define REDIS_SORT_DESC 2
221 #define REDIS_SORTKEY_MAX 1024
224 #define REDIS_DEBUG 0
225 #define REDIS_VERBOSE 1
226 #define REDIS_NOTICE 2
227 #define REDIS_WARNING 3
229 /* Anti-warning macro... */
230 #define REDIS_NOTUSED(V) ((void) V)
232 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
233 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
235 /* Append only defines */
236 #define APPENDFSYNC_NO 0
237 #define APPENDFSYNC_ALWAYS 1
238 #define APPENDFSYNC_EVERYSEC 2
240 /* Zip structure related defaults */
241 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
242 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
243 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 1024
244 #define REDIS_LIST_MAX_ZIPLIST_VALUE 32
246 /* We can print the stacktrace, so our assert is defined this way: */
247 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
248 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
249 static void _redisAssert(char *estr
, char *file
, int line
);
250 static void _redisPanic(char *msg
, char *file
, int line
);
252 /*================================= Data types ============================== */
254 /* A redis object, that is a type able to hold a string / list / set */
256 /* The actual Redis Object */
257 typedef struct redisObject
{
259 unsigned storage
:2; /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
261 unsigned lru
:22; /* lru time (relative to server.lruclock) */
264 /* VM fields are only allocated if VM is active, otherwise the
265 * object allocation function will just allocate
266 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
267 * Redis without VM active will not have any overhead. */
270 /* The VM pointer structure - identifies an object in the swap file.
272 * This object is stored in place of the value
273 * object in the main key->value hash table representing a database.
274 * Note that the first fields (type, storage) are the same as the redisObject
275 * structure so that vmPointer strucuters can be accessed even when casted
276 * as redisObject structures.
278 * This is useful as we don't know if a value object is or not on disk, but we
279 * are always able to read obj->storage to check this. For vmPointer
280 * structures "type" is set to REDIS_VMPOINTER (even if without this field
281 * is still possible to check the kind of object from the value of 'storage').*/
282 typedef struct vmPointer
{
284 unsigned storage
:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
286 unsigned int vtype
; /* type of the object stored in the swap file */
287 off_t page
; /* the page at witch the object is stored on disk */
288 off_t usedpages
; /* number of pages used on disk */
291 /* Macro used to initalize a Redis object allocated on the stack.
292 * Note that this macro is taken near the structure definition to make sure
293 * we'll update it when the structure is changed, to avoid bugs like
294 * bug #85 introduced exactly in this way. */
295 #define initStaticStringObject(_var,_ptr) do { \
297 _var.type = REDIS_STRING; \
298 _var.encoding = REDIS_ENCODING_RAW; \
300 _var.storage = REDIS_VM_MEMORY; \
303 typedef struct redisDb
{
304 dict
*dict
; /* The keyspace for this DB */
305 dict
*expires
; /* Timeout of keys with a timeout set */
306 dict
*blocking_keys
; /* Keys with clients waiting for data (BLPOP) */
307 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
308 dict
*watched_keys
; /* WATCHED keys for MULTI/EXEC CAS */
312 /* Client MULTI/EXEC state */
313 typedef struct multiCmd
{
316 struct redisCommand
*cmd
;
319 typedef struct multiState
{
320 multiCmd
*commands
; /* Array of MULTI commands */
321 int count
; /* Total number of MULTI commands */
324 /* With multiplexing we need to take per-clinet state.
325 * Clients are taken in a liked list. */
326 typedef struct redisClient
{
331 robj
**argv
, **mbargv
;
333 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
334 int multibulk
; /* multi bulk command format active */
337 time_t lastinteraction
; /* time of the last interaction, used for timeout */
338 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
339 int slaveseldb
; /* slave selected db, if this client is a slave */
340 int authenticated
; /* when requirepass is non-NULL */
341 int replstate
; /* replication state if this is a slave */
342 int repldbfd
; /* replication DB file descriptor */
343 long repldboff
; /* replication DB file offset */
344 off_t repldbsize
; /* replication DB file size */
345 multiState mstate
; /* MULTI/EXEC state */
346 robj
**blocking_keys
; /* The key we are waiting to terminate a blocking
347 * operation such as BLPOP. Otherwise NULL. */
348 int blocking_keys_num
; /* Number of blocking keys */
349 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
350 * is >= blockingto then the operation timed out. */
351 list
*io_keys
; /* Keys this client is waiting to be loaded from the
352 * swap file in order to continue. */
353 list
*watched_keys
; /* Keys WATCHED for MULTI/EXEC CAS */
354 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
355 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
363 /* Global server state structure */
368 long long dirty
; /* changes to DB from the last save */
370 list
*slaves
, *monitors
;
371 char neterr
[ANET_ERR_LEN
];
373 int cronloops
; /* number of times the cron function run */
374 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
375 time_t lastsave
; /* Unix time of last save succeeede */
376 /* Fields used only for stats */
377 time_t stat_starttime
; /* server start time */
378 long long stat_numcommands
; /* number of processed commands */
379 long long stat_numconnections
; /* number of connections received */
380 long long stat_expiredkeys
; /* number of expired keys */
389 int no_appendfsync_on_rewrite
;
395 pid_t bgsavechildpid
;
396 pid_t bgrewritechildpid
;
397 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
398 sds aofbuf
; /* AOF buffer, written before entering the event loop */
399 struct saveparam
*saveparams
;
404 char *appendfilename
;
408 /* Replication related */
413 redisClient
*master
; /* client that is master for this slave */
415 unsigned int maxclients
;
416 unsigned long long maxmemory
;
417 unsigned int blpop_blocked_clients
;
418 unsigned int vm_blocked_clients
;
419 /* Sort parameters - qsort_r() is only available under BSD so we
420 * have to take this state global, in order to pass it to sortCompare() */
424 /* Virtual memory configuration */
429 unsigned long long vm_max_memory
;
430 /* Zip structure config */
431 size_t hash_max_zipmap_entries
;
432 size_t hash_max_zipmap_value
;
433 size_t list_max_ziplist_entries
;
434 size_t list_max_ziplist_value
;
435 /* Virtual memory state */
438 off_t vm_next_page
; /* Next probably empty page */
439 off_t vm_near_pages
; /* Number of pages allocated sequentially */
440 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
441 time_t unixtime
; /* Unix time sampled every second. */
442 /* Virtual memory I/O threads stuff */
443 /* An I/O thread process an element taken from the io_jobs queue and
444 * put the result of the operation in the io_done list. While the
445 * job is being processed, it's put on io_processing queue. */
446 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
447 list
*io_processing
; /* List of VM I/O jobs being processed */
448 list
*io_processed
; /* List of VM I/O jobs already processed */
449 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
450 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
451 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
452 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
453 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
454 int io_active_threads
; /* Number of running I/O threads */
455 int vm_max_threads
; /* Max number of I/O threads running at the same time */
456 /* Our main thread is blocked on the event loop, locking for sockets ready
457 * to be read or written, so when a threaded I/O operation is ready to be
458 * processed by the main thread, the I/O thread will use a unix pipe to
459 * awake the main thread. The followings are the two pipe FDs. */
460 int io_ready_pipe_read
;
461 int io_ready_pipe_write
;
462 /* Virtual memory stats */
463 unsigned long long vm_stats_used_pages
;
464 unsigned long long vm_stats_swapped_objects
;
465 unsigned long long vm_stats_swapouts
;
466 unsigned long long vm_stats_swapins
;
468 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
469 list
*pubsub_patterns
; /* A list of pubsub_patterns */
472 unsigned lruclock
:22; /* clock incrementing every minute, for LRU */
473 unsigned lruclock_padding
:10;
476 typedef struct pubsubPattern
{
481 typedef void redisCommandProc(redisClient
*c
);
482 typedef void redisVmPreloadProc(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
483 struct redisCommand
{
485 redisCommandProc
*proc
;
488 /* Use a function to determine which keys need to be loaded
489 * in the background prior to executing this command. Takes precedence
490 * over vm_firstkey and others, ignored when NULL */
491 redisVmPreloadProc
*vm_preload_proc
;
492 /* What keys should be loaded in background when calling this command? */
493 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
494 int vm_lastkey
; /* THe last argument that's a key */
495 int vm_keystep
; /* The step between first and last key */
498 struct redisFunctionSym
{
500 unsigned long pointer
;
503 typedef struct _redisSortObject
{
511 typedef struct _redisSortOperation
{
514 } redisSortOperation
;
516 /* ZSETs use a specialized version of Skiplists */
518 typedef struct zskiplistNode
{
519 struct zskiplistNode
**forward
;
520 struct zskiplistNode
*backward
;
526 typedef struct zskiplist
{
527 struct zskiplistNode
*header
, *tail
;
528 unsigned long length
;
532 typedef struct zset
{
537 /* Our shared "common" objects */
539 #define REDIS_SHARED_INTEGERS 10000
540 struct sharedObjectsStruct
{
541 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *cnegone
, *pong
, *space
,
542 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
543 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
544 *outofrangeerr
, *plus
,
545 *select0
, *select1
, *select2
, *select3
, *select4
,
546 *select5
, *select6
, *select7
, *select8
, *select9
,
547 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
548 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
549 *integers
[REDIS_SHARED_INTEGERS
];
552 /* Global vars that are actally used as constants. The following double
553 * values are used for double on-disk serialization, and are initialized
554 * at runtime to avoid strange compiler optimizations. */
556 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
558 /* VM threaded I/O request message */
559 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
560 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
561 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
562 typedef struct iojob
{
563 int type
; /* Request type, REDIS_IOJOB_* */
564 redisDb
*db
;/* Redis database */
565 robj
*key
; /* This I/O request is about swapping this key */
566 robj
*id
; /* Unique identifier of this job:
567 this is the object to swap for REDIS_IOREQ_*_SWAP, or the
568 vmpointer objct for REDIS_IOREQ_LOAD. */
569 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
570 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
571 off_t page
; /* Swap page where to read/write the object */
572 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
573 int canceled
; /* True if this command was canceled by blocking side of VM */
574 pthread_t thread
; /* ID of the thread processing this entry */
577 /*================================ Prototypes =============================== */
579 static void freeStringObject(robj
*o
);
580 static void freeListObject(robj
*o
);
581 static void freeSetObject(robj
*o
);
582 static void decrRefCount(void *o
);
583 static robj
*createObject(int type
, void *ptr
);
584 static void freeClient(redisClient
*c
);
585 static int rdbLoad(char *filename
);
586 static void addReply(redisClient
*c
, robj
*obj
);
587 static void addReplySds(redisClient
*c
, sds s
);
588 static void incrRefCount(robj
*o
);
589 static int rdbSaveBackground(char *filename
);
590 static robj
*createStringObject(char *ptr
, size_t len
);
591 static robj
*dupStringObject(robj
*o
);
592 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
593 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
594 static void flushAppendOnlyFile(void);
595 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
596 static int syncWithMaster(void);
597 static robj
*tryObjectEncoding(robj
*o
);
598 static robj
*getDecodedObject(robj
*o
);
599 static int removeExpire(redisDb
*db
, robj
*key
);
600 static int expireIfNeeded(redisDb
*db
, robj
*key
);
601 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
602 static int dbDelete(redisDb
*db
, robj
*key
);
603 static time_t getExpire(redisDb
*db
, robj
*key
);
604 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
605 static void updateSlavesWaitingBgsave(int bgsaveerr
);
606 static void freeMemoryIfNeeded(void);
607 static int processCommand(redisClient
*c
);
608 static void setupSigSegvAction(void);
609 static void rdbRemoveTempFile(pid_t childpid
);
610 static void aofRemoveTempFile(pid_t childpid
);
611 static size_t stringObjectLen(robj
*o
);
612 static void processInputBuffer(redisClient
*c
);
613 static zskiplist
*zslCreate(void);
614 static void zslFree(zskiplist
*zsl
);
615 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
616 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
617 static void initClientMultiState(redisClient
*c
);
618 static void freeClientMultiState(redisClient
*c
);
619 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
620 static void unblockClientWaitingData(redisClient
*c
);
621 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
622 static void vmInit(void);
623 static void vmMarkPagesFree(off_t page
, off_t count
);
624 static robj
*vmLoadObject(robj
*o
);
625 static robj
*vmPreviewObject(robj
*o
);
626 static int vmSwapOneObjectBlocking(void);
627 static int vmSwapOneObjectThreaded(void);
628 static int vmCanSwapOut(void);
629 static int tryFreeOneObjectFromFreelist(void);
630 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
631 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
632 static void vmCancelThreadedIOJob(robj
*o
);
633 static void lockThreadedIO(void);
634 static void unlockThreadedIO(void);
635 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
636 static void freeIOJob(iojob
*j
);
637 static void queueIOJob(iojob
*j
);
638 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
639 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
640 static void waitEmptyIOJobsQueue(void);
641 static void vmReopenSwapFile(void);
642 static int vmFreePage(off_t page
);
643 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
644 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
645 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
);
646 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
647 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
648 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
649 static struct redisCommand
*lookupCommand(char *name
);
650 static void call(redisClient
*c
, struct redisCommand
*cmd
);
651 static void resetClient(redisClient
*c
);
652 static void convertToRealHash(robj
*o
);
653 static void listTypeConvert(robj
*o
, int enc
);
654 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
655 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
656 static void freePubsubPattern(void *p
);
657 static int listMatchPubsubPattern(void *a
, void *b
);
658 static int compareStringObjects(robj
*a
, robj
*b
);
659 static int equalStringObjects(robj
*a
, robj
*b
);
661 static int rewriteAppendOnlyFileBackground(void);
662 static vmpointer
*vmSwapObjectBlocking(robj
*val
);
663 static int prepareForShutdown();
664 static void touchWatchedKey(redisDb
*db
, robj
*key
);
665 static void touchWatchedKeysOnFlush(int dbid
);
666 static void unwatchAllKeys(redisClient
*c
);
668 static void authCommand(redisClient
*c
);
669 static void pingCommand(redisClient
*c
);
670 static void echoCommand(redisClient
*c
);
671 static void setCommand(redisClient
*c
);
672 static void setnxCommand(redisClient
*c
);
673 static void setexCommand(redisClient
*c
);
674 static void getCommand(redisClient
*c
);
675 static void delCommand(redisClient
*c
);
676 static void existsCommand(redisClient
*c
);
677 static void incrCommand(redisClient
*c
);
678 static void decrCommand(redisClient
*c
);
679 static void incrbyCommand(redisClient
*c
);
680 static void decrbyCommand(redisClient
*c
);
681 static void selectCommand(redisClient
*c
);
682 static void randomkeyCommand(redisClient
*c
);
683 static void keysCommand(redisClient
*c
);
684 static void dbsizeCommand(redisClient
*c
);
685 static void lastsaveCommand(redisClient
*c
);
686 static void saveCommand(redisClient
*c
);
687 static void bgsaveCommand(redisClient
*c
);
688 static void bgrewriteaofCommand(redisClient
*c
);
689 static void shutdownCommand(redisClient
*c
);
690 static void moveCommand(redisClient
*c
);
691 static void renameCommand(redisClient
*c
);
692 static void renamenxCommand(redisClient
*c
);
693 static void lpushCommand(redisClient
*c
);
694 static void rpushCommand(redisClient
*c
);
695 static void lpushxCommand(redisClient
*c
);
696 static void rpushxCommand(redisClient
*c
);
697 static void linsertCommand(redisClient
*c
);
698 static void lpopCommand(redisClient
*c
);
699 static void rpopCommand(redisClient
*c
);
700 static void llenCommand(redisClient
*c
);
701 static void lindexCommand(redisClient
*c
);
702 static void lrangeCommand(redisClient
*c
);
703 static void ltrimCommand(redisClient
*c
);
704 static void typeCommand(redisClient
*c
);
705 static void lsetCommand(redisClient
*c
);
706 static void saddCommand(redisClient
*c
);
707 static void sremCommand(redisClient
*c
);
708 static void smoveCommand(redisClient
*c
);
709 static void sismemberCommand(redisClient
*c
);
710 static void scardCommand(redisClient
*c
);
711 static void spopCommand(redisClient
*c
);
712 static void srandmemberCommand(redisClient
*c
);
713 static void sinterCommand(redisClient
*c
);
714 static void sinterstoreCommand(redisClient
*c
);
715 static void sunionCommand(redisClient
*c
);
716 static void sunionstoreCommand(redisClient
*c
);
717 static void sdiffCommand(redisClient
*c
);
718 static void sdiffstoreCommand(redisClient
*c
);
719 static void syncCommand(redisClient
*c
);
720 static void flushdbCommand(redisClient
*c
);
721 static void flushallCommand(redisClient
*c
);
722 static void sortCommand(redisClient
*c
);
723 static void lremCommand(redisClient
*c
);
724 static void rpoplpushcommand(redisClient
*c
);
725 static void infoCommand(redisClient
*c
);
726 static void mgetCommand(redisClient
*c
);
727 static void monitorCommand(redisClient
*c
);
728 static void expireCommand(redisClient
*c
);
729 static void expireatCommand(redisClient
*c
);
730 static void getsetCommand(redisClient
*c
);
731 static void ttlCommand(redisClient
*c
);
732 static void slaveofCommand(redisClient
*c
);
733 static void debugCommand(redisClient
*c
);
734 static void msetCommand(redisClient
*c
);
735 static void msetnxCommand(redisClient
*c
);
736 static void zaddCommand(redisClient
*c
);
737 static void zincrbyCommand(redisClient
*c
);
738 static void zrangeCommand(redisClient
*c
);
739 static void zrangebyscoreCommand(redisClient
*c
);
740 static void zcountCommand(redisClient
*c
);
741 static void zrevrangeCommand(redisClient
*c
);
742 static void zcardCommand(redisClient
*c
);
743 static void zremCommand(redisClient
*c
);
744 static void zscoreCommand(redisClient
*c
);
745 static void zremrangebyscoreCommand(redisClient
*c
);
746 static void multiCommand(redisClient
*c
);
747 static void execCommand(redisClient
*c
);
748 static void discardCommand(redisClient
*c
);
749 static void blpopCommand(redisClient
*c
);
750 static void brpopCommand(redisClient
*c
);
751 static void appendCommand(redisClient
*c
);
752 static void substrCommand(redisClient
*c
);
753 static void zrankCommand(redisClient
*c
);
754 static void zrevrankCommand(redisClient
*c
);
755 static void hsetCommand(redisClient
*c
);
756 static void hsetnxCommand(redisClient
*c
);
757 static void hgetCommand(redisClient
*c
);
758 static void hmsetCommand(redisClient
*c
);
759 static void hmgetCommand(redisClient
*c
);
760 static void hdelCommand(redisClient
*c
);
761 static void hlenCommand(redisClient
*c
);
762 static void zremrangebyrankCommand(redisClient
*c
);
763 static void zunionstoreCommand(redisClient
*c
);
764 static void zinterstoreCommand(redisClient
*c
);
765 static void hkeysCommand(redisClient
*c
);
766 static void hvalsCommand(redisClient
*c
);
767 static void hgetallCommand(redisClient
*c
);
768 static void hexistsCommand(redisClient
*c
);
769 static void configCommand(redisClient
*c
);
770 static void hincrbyCommand(redisClient
*c
);
771 static void subscribeCommand(redisClient
*c
);
772 static void unsubscribeCommand(redisClient
*c
);
773 static void psubscribeCommand(redisClient
*c
);
774 static void punsubscribeCommand(redisClient
*c
);
775 static void publishCommand(redisClient
*c
);
776 static void watchCommand(redisClient
*c
);
777 static void unwatchCommand(redisClient
*c
);
779 /*================================= Globals ================================= */
782 static struct redisServer server
; /* server global state */
783 static struct redisCommand
*commandTable
;
784 static struct redisCommand readonlyCommandTable
[] = {
785 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
786 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
787 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
788 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
789 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
792 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
793 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
796 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
797 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
798 {"rpushx",rpushxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"lpushx",lpushxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
800 {"linsert",linsertCommand
,5,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
805 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
807 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
808 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
809 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
810 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
811 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
812 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
813 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
814 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
815 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
816 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
817 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
818 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
819 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
820 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
821 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
822 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
823 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
824 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
825 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
826 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
827 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
828 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
829 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
830 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
831 {"zunionstore",zunionstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
832 {"zinterstore",zinterstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
833 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
834 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
835 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
836 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
837 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
838 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
839 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
840 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
841 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
842 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
843 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
844 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
845 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
846 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
847 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
848 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
849 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
850 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
851 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
852 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
853 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
854 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
855 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
856 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
857 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
858 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
859 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
860 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
861 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
862 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
863 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
864 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
865 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
866 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
867 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
868 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
869 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
870 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
871 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
872 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
873 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
874 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
875 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
876 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
877 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,execBlockClientOnSwappedKeys
,0,0,0},
878 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
879 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
880 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
881 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
882 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
883 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
884 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
885 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
886 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
887 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
888 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
889 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
890 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
891 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
892 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
893 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
894 {"watch",watchCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
895 {"unwatch",unwatchCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0}
898 /*============================ Utility functions ============================ */
900 /* Glob-style pattern matching. */
901 static int stringmatchlen(const char *pattern
, int patternLen
,
902 const char *string
, int stringLen
, int nocase
)
907 while (pattern
[1] == '*') {
912 return 1; /* match */
914 if (stringmatchlen(pattern
+1, patternLen
-1,
915 string
, stringLen
, nocase
))
916 return 1; /* match */
920 return 0; /* no match */
924 return 0; /* no match */
934 not = pattern
[0] == '^';
941 if (pattern
[0] == '\\') {
944 if (pattern
[0] == string
[0])
946 } else if (pattern
[0] == ']') {
948 } else if (patternLen
== 0) {
952 } else if (pattern
[1] == '-' && patternLen
>= 3) {
953 int start
= pattern
[0];
954 int end
= pattern
[2];
962 start
= tolower(start
);
968 if (c
>= start
&& c
<= end
)
972 if (pattern
[0] == string
[0])
975 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
985 return 0; /* no match */
991 if (patternLen
>= 2) {
998 if (pattern
[0] != string
[0])
999 return 0; /* no match */
1001 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
1002 return 0; /* no match */
1010 if (stringLen
== 0) {
1011 while(*pattern
== '*') {
1018 if (patternLen
== 0 && stringLen
== 0)
1023 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
1024 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
1027 /* Convert a string representing an amount of memory into the number of
1028 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1031 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1033 static long long memtoll(const char *p
, int *err
) {
1036 long mul
; /* unit multiplier */
1038 unsigned int digits
;
1041 /* Search the first non digit character. */
1044 while(*u
&& isdigit(*u
)) u
++;
1045 if (*u
== '\0' || !strcasecmp(u
,"b")) {
1047 } else if (!strcasecmp(u
,"k")) {
1049 } else if (!strcasecmp(u
,"kb")) {
1051 } else if (!strcasecmp(u
,"m")) {
1053 } else if (!strcasecmp(u
,"mb")) {
1055 } else if (!strcasecmp(u
,"g")) {
1056 mul
= 1000L*1000*1000;
1057 } else if (!strcasecmp(u
,"gb")) {
1058 mul
= 1024L*1024*1024;
1064 if (digits
>= sizeof(buf
)) {
1068 memcpy(buf
,p
,digits
);
1070 val
= strtoll(buf
,NULL
,10);
1074 /* Convert a long long into a string. Returns the number of
1075 * characters needed to represent the number, that can be shorter if passed
1076 * buffer length is not enough to store the whole number. */
1077 static int ll2string(char *s
, size_t len
, long long value
) {
1079 unsigned long long v
;
1082 if (len
== 0) return 0;
1083 v
= (value
< 0) ? -value
: value
;
1084 p
= buf
+31; /* point to the last character */
1089 if (value
< 0) *p
-- = '-';
1092 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1098 static void redisLog(int level
, const char *fmt
, ...) {
1102 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1106 if (level
>= server
.verbosity
) {
1112 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1113 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1114 vfprintf(fp
, fmt
, ap
);
1120 if (server
.logfile
) fclose(fp
);
1123 /*====================== Hash table type implementation ==================== */
1125 /* This is an hash table type that uses the SDS dynamic strings libary as
1126 * keys and radis objects as values (objects can hold SDS strings,
1129 static void dictVanillaFree(void *privdata
, void *val
)
1131 DICT_NOTUSED(privdata
);
1135 static void dictListDestructor(void *privdata
, void *val
)
1137 DICT_NOTUSED(privdata
);
1138 listRelease((list
*)val
);
1141 static int dictSdsKeyCompare(void *privdata
, const void *key1
,
1145 DICT_NOTUSED(privdata
);
1147 l1
= sdslen((sds
)key1
);
1148 l2
= sdslen((sds
)key2
);
1149 if (l1
!= l2
) return 0;
1150 return memcmp(key1
, key2
, l1
) == 0;
1153 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1155 DICT_NOTUSED(privdata
);
1157 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1161 static void dictSdsDestructor(void *privdata
, void *val
)
1163 DICT_NOTUSED(privdata
);
1168 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1171 const robj
*o1
= key1
, *o2
= key2
;
1172 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1175 static unsigned int dictObjHash(const void *key
) {
1176 const robj
*o
= key
;
1177 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1180 static unsigned int dictSdsHash(const void *key
) {
1181 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
1184 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1187 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1190 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1191 o2
->encoding
== REDIS_ENCODING_INT
)
1192 return o1
->ptr
== o2
->ptr
;
1194 o1
= getDecodedObject(o1
);
1195 o2
= getDecodedObject(o2
);
1196 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1202 static unsigned int dictEncObjHash(const void *key
) {
1203 robj
*o
= (robj
*) key
;
1205 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1206 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1208 if (o
->encoding
== REDIS_ENCODING_INT
) {
1212 len
= ll2string(buf
,32,(long)o
->ptr
);
1213 return dictGenHashFunction((unsigned char*)buf
, len
);
1217 o
= getDecodedObject(o
);
1218 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1226 static dictType setDictType
= {
1227 dictEncObjHash
, /* hash function */
1230 dictEncObjKeyCompare
, /* key compare */
1231 dictRedisObjectDestructor
, /* key destructor */
1232 NULL
/* val destructor */
1235 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1236 static dictType zsetDictType
= {
1237 dictEncObjHash
, /* hash function */
1240 dictEncObjKeyCompare
, /* key compare */
1241 dictRedisObjectDestructor
, /* key destructor */
1242 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1245 /* Db->dict, keys are sds strings, vals are Redis objects. */
1246 static dictType dbDictType
= {
1247 dictSdsHash
, /* hash function */
1250 dictSdsKeyCompare
, /* key compare */
1251 dictSdsDestructor
, /* key destructor */
1252 dictRedisObjectDestructor
/* val destructor */
1256 static dictType keyptrDictType
= {
1257 dictSdsHash
, /* hash function */
1260 dictSdsKeyCompare
, /* key compare */
1261 NULL
, /* key destructor */
1262 NULL
/* val destructor */
1265 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1266 static dictType hashDictType
= {
1267 dictEncObjHash
, /* hash function */
1270 dictEncObjKeyCompare
, /* key compare */
1271 dictRedisObjectDestructor
, /* key destructor */
1272 dictRedisObjectDestructor
/* val destructor */
1275 /* Keylist hash table type has unencoded redis objects as keys and
1276 * lists as values. It's used for blocking operations (BLPOP) and to
1277 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1278 static dictType keylistDictType
= {
1279 dictObjHash
, /* hash function */
1282 dictObjKeyCompare
, /* key compare */
1283 dictRedisObjectDestructor
, /* key destructor */
1284 dictListDestructor
/* val destructor */
1287 static void version();
1289 /* ========================= Random utility functions ======================= */
1291 /* Redis generally does not try to recover from out of memory conditions
1292 * when allocating objects or strings, it is not clear if it will be possible
1293 * to report this condition to the client since the networking layer itself
1294 * is based on heap allocation for send buffers, so we simply abort.
1295 * At least the code will be simpler to read... */
1296 static void oom(const char *msg
) {
1297 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1302 /* ====================== Redis server networking stuff ===================== */
1303 static void closeTimedoutClients(void) {
1306 time_t now
= time(NULL
);
1309 listRewind(server
.clients
,&li
);
1310 while ((ln
= listNext(&li
)) != NULL
) {
1311 c
= listNodeValue(ln
);
1312 if (server
.maxidletime
&&
1313 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1314 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1315 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1316 listLength(c
->pubsub_patterns
) == 0 &&
1317 (now
- c
->lastinteraction
> server
.maxidletime
))
1319 redisLog(REDIS_VERBOSE
,"Closing idle client");
1321 } else if (c
->flags
& REDIS_BLOCKED
) {
1322 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1323 addReply(c
,shared
.nullmultibulk
);
1324 unblockClientWaitingData(c
);
1330 static int htNeedsResize(dict
*dict
) {
1331 long long size
, used
;
1333 size
= dictSlots(dict
);
1334 used
= dictSize(dict
);
1335 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1336 (used
*100/size
< REDIS_HT_MINFILL
));
1339 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1340 * we resize the hash table to save memory */
1341 static void tryResizeHashTables(void) {
1344 for (j
= 0; j
< server
.dbnum
; j
++) {
1345 if (htNeedsResize(server
.db
[j
].dict
))
1346 dictResize(server
.db
[j
].dict
);
1347 if (htNeedsResize(server
.db
[j
].expires
))
1348 dictResize(server
.db
[j
].expires
);
1352 /* Our hash table implementation performs rehashing incrementally while
1353 * we write/read from the hash table. Still if the server is idle, the hash
1354 * table will use two tables for a long time. So we try to use 1 millisecond
1355 * of CPU time at every serverCron() loop in order to rehash some key. */
1356 static void incrementallyRehash(void) {
1359 for (j
= 0; j
< server
.dbnum
; j
++) {
1360 if (dictIsRehashing(server
.db
[j
].dict
)) {
1361 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1362 break; /* already used our millisecond for this loop... */
1367 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1368 void backgroundSaveDoneHandler(int statloc
) {
1369 int exitcode
= WEXITSTATUS(statloc
);
1370 int bysignal
= WIFSIGNALED(statloc
);
1372 if (!bysignal
&& exitcode
== 0) {
1373 redisLog(REDIS_NOTICE
,
1374 "Background saving terminated with success");
1376 server
.lastsave
= time(NULL
);
1377 } else if (!bysignal
&& exitcode
!= 0) {
1378 redisLog(REDIS_WARNING
, "Background saving error");
1380 redisLog(REDIS_WARNING
,
1381 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1382 rdbRemoveTempFile(server
.bgsavechildpid
);
1384 server
.bgsavechildpid
= -1;
1385 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1386 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1387 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1390 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1392 void backgroundRewriteDoneHandler(int statloc
) {
1393 int exitcode
= WEXITSTATUS(statloc
);
1394 int bysignal
= WIFSIGNALED(statloc
);
1396 if (!bysignal
&& exitcode
== 0) {
1400 redisLog(REDIS_NOTICE
,
1401 "Background append only file rewriting terminated with success");
1402 /* Now it's time to flush the differences accumulated by the parent */
1403 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1404 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1406 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1409 /* Flush our data... */
1410 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1411 (signed) sdslen(server
.bgrewritebuf
)) {
1412 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
));
1416 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1417 /* Now our work is to rename the temp file into the stable file. And
1418 * switch the file descriptor used by the server for append only. */
1419 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1420 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1424 /* Mission completed... almost */
1425 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1426 if (server
.appendfd
!= -1) {
1427 /* If append only is actually enabled... */
1428 close(server
.appendfd
);
1429 server
.appendfd
= fd
;
1430 if (server
.appendfsync
!= APPENDFSYNC_NO
) aof_fsync(fd
);
1431 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1432 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1434 /* If append only is disabled we just generate a dump in this
1435 * format. Why not? */
1438 } else if (!bysignal
&& exitcode
!= 0) {
1439 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1441 redisLog(REDIS_WARNING
,
1442 "Background append only file rewriting terminated by signal %d",
1446 sdsfree(server
.bgrewritebuf
);
1447 server
.bgrewritebuf
= sdsempty();
1448 aofRemoveTempFile(server
.bgrewritechildpid
);
1449 server
.bgrewritechildpid
= -1;
1452 /* This function is called once a background process of some kind terminates,
1453 * as we want to avoid resizing the hash tables when there is a child in order
1454 * to play well with copy-on-write (otherwise when a resize happens lots of
1455 * memory pages are copied). The goal of this function is to update the ability
1456 * for dict.c to resize the hash tables accordingly to the fact we have o not
1457 * running childs. */
1458 static void updateDictResizePolicy(void) {
1459 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1462 dictDisableResize();
1465 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1466 int j
, loops
= server
.cronloops
++;
1467 REDIS_NOTUSED(eventLoop
);
1469 REDIS_NOTUSED(clientData
);
1471 /* We take a cached value of the unix time in the global state because
1472 * with virtual memory and aging there is to store the current time
1473 * in objects at every object access, and accuracy is not needed.
1474 * To access a global var is faster than calling time(NULL) */
1475 server
.unixtime
= time(NULL
);
1476 /* We have just 21 bits per object for LRU information.
1477 * So we use an (eventually wrapping) LRU clock with minutes resolution.
1479 * When we need to select what object to swap, we compute the minimum
1480 * time distance between the current lruclock and the object last access
1481 * lruclock info. Even if clocks will wrap on overflow, there is
1482 * the interesting property that we are sure that at least
1483 * ABS(A-B) minutes passed between current time and timestamp B.
1485 * This is not precise but we don't need at all precision, but just
1486 * something statistically reasonable.
1488 server
.lruclock
= (time(NULL
)/60)&((1<<21)-1);
1490 /* We received a SIGTERM, shutting down here in a safe way, as it is
1491 * not ok doing so inside the signal handler. */
1492 if (server
.shutdown_asap
) {
1493 if (prepareForShutdown() == REDIS_OK
) exit(0);
1494 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1497 /* Show some info about non-empty databases */
1498 for (j
= 0; j
< server
.dbnum
; j
++) {
1499 long long size
, used
, vkeys
;
1501 size
= dictSlots(server
.db
[j
].dict
);
1502 used
= dictSize(server
.db
[j
].dict
);
1503 vkeys
= dictSize(server
.db
[j
].expires
);
1504 if (!(loops
% 50) && (used
|| vkeys
)) {
1505 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1506 /* dictPrintStats(server.dict); */
1510 /* We don't want to resize the hash tables while a bacground saving
1511 * is in progress: the saving child is created using fork() that is
1512 * implemented with a copy-on-write semantic in most modern systems, so
1513 * if we resize the HT while there is the saving child at work actually
1514 * a lot of memory movements in the parent will cause a lot of pages
1516 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1517 if (!(loops
% 10)) tryResizeHashTables();
1518 if (server
.activerehashing
) incrementallyRehash();
1521 /* Show information about connected clients */
1522 if (!(loops
% 50)) {
1523 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1524 listLength(server
.clients
)-listLength(server
.slaves
),
1525 listLength(server
.slaves
),
1526 zmalloc_used_memory());
1529 /* Close connections of timedout clients */
1530 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1531 closeTimedoutClients();
1533 /* Check if a background saving or AOF rewrite in progress terminated */
1534 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1538 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1539 if (pid
== server
.bgsavechildpid
) {
1540 backgroundSaveDoneHandler(statloc
);
1542 backgroundRewriteDoneHandler(statloc
);
1544 updateDictResizePolicy();
1547 /* If there is not a background saving in progress check if
1548 * we have to save now */
1549 time_t now
= time(NULL
);
1550 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1551 struct saveparam
*sp
= server
.saveparams
+j
;
1553 if (server
.dirty
>= sp
->changes
&&
1554 now
-server
.lastsave
> sp
->seconds
) {
1555 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1556 sp
->changes
, sp
->seconds
);
1557 rdbSaveBackground(server
.dbfilename
);
1563 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1564 * will use few CPU cycles if there are few expiring keys, otherwise
1565 * it will get more aggressive to avoid that too much memory is used by
1566 * keys that can be removed from the keyspace. */
1567 for (j
= 0; j
< server
.dbnum
; j
++) {
1569 redisDb
*db
= server
.db
+j
;
1571 /* Continue to expire if at the end of the cycle more than 25%
1572 * of the keys were expired. */
1574 long num
= dictSize(db
->expires
);
1575 time_t now
= time(NULL
);
1578 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1579 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1584 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1585 t
= (time_t) dictGetEntryVal(de
);
1587 sds key
= dictGetEntryKey(de
);
1588 robj
*keyobj
= createStringObject(key
,sdslen(key
));
1590 dbDelete(db
,keyobj
);
1591 decrRefCount(keyobj
);
1593 server
.stat_expiredkeys
++;
1596 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1599 /* Swap a few keys on disk if we are over the memory limit and VM
1600 * is enbled. Try to free objects from the free list first. */
1601 if (vmCanSwapOut()) {
1602 while (server
.vm_enabled
&& zmalloc_used_memory() >
1603 server
.vm_max_memory
)
1607 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1608 retval
= (server
.vm_max_threads
== 0) ?
1609 vmSwapOneObjectBlocking() :
1610 vmSwapOneObjectThreaded();
1611 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1612 zmalloc_used_memory() >
1613 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1615 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1617 /* Note that when using threade I/O we free just one object,
1618 * because anyway when the I/O thread in charge to swap this
1619 * object out will finish, the handler of completed jobs
1620 * will try to swap more objects if we are still out of memory. */
1621 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1625 /* Check if we should connect to a MASTER */
1626 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1627 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1628 if (syncWithMaster() == REDIS_OK
) {
1629 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1630 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1636 /* This function gets called every time Redis is entering the
1637 * main loop of the event driven library, that is, before to sleep
1638 * for ready file descriptors. */
1639 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1640 REDIS_NOTUSED(eventLoop
);
1642 /* Awake clients that got all the swapped keys they requested */
1643 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1647 listRewind(server
.io_ready_clients
,&li
);
1648 while((ln
= listNext(&li
))) {
1649 redisClient
*c
= ln
->value
;
1650 struct redisCommand
*cmd
;
1652 /* Resume the client. */
1653 listDelNode(server
.io_ready_clients
,ln
);
1654 c
->flags
&= (~REDIS_IO_WAIT
);
1655 server
.vm_blocked_clients
--;
1656 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1657 readQueryFromClient
, c
);
1658 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1659 assert(cmd
!= NULL
);
1662 /* There may be more data to process in the input buffer. */
1663 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1664 processInputBuffer(c
);
1667 /* Write the AOF buffer on disk */
1668 flushAppendOnlyFile();
1671 static void createSharedObjects(void) {
1674 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1675 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1676 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1677 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1678 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1679 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1680 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1681 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1682 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1683 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1684 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1685 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1686 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1687 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1688 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1689 "-ERR no such key\r\n"));
1690 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1691 "-ERR syntax error\r\n"));
1692 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1693 "-ERR source and destination objects are the same\r\n"));
1694 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1695 "-ERR index out of range\r\n"));
1696 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1697 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1698 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1699 shared
.select0
= createStringObject("select 0\r\n",10);
1700 shared
.select1
= createStringObject("select 1\r\n",10);
1701 shared
.select2
= createStringObject("select 2\r\n",10);
1702 shared
.select3
= createStringObject("select 3\r\n",10);
1703 shared
.select4
= createStringObject("select 4\r\n",10);
1704 shared
.select5
= createStringObject("select 5\r\n",10);
1705 shared
.select6
= createStringObject("select 6\r\n",10);
1706 shared
.select7
= createStringObject("select 7\r\n",10);
1707 shared
.select8
= createStringObject("select 8\r\n",10);
1708 shared
.select9
= createStringObject("select 9\r\n",10);
1709 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1710 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1711 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1712 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1713 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1714 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1715 shared
.mbulk3
= createStringObject("*3\r\n",4);
1716 shared
.mbulk4
= createStringObject("*4\r\n",4);
1717 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1718 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1719 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1723 static void appendServerSaveParams(time_t seconds
, int changes
) {
1724 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1725 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1726 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1727 server
.saveparamslen
++;
1730 static void resetServerSaveParams() {
1731 zfree(server
.saveparams
);
1732 server
.saveparams
= NULL
;
1733 server
.saveparamslen
= 0;
1736 static void initServerConfig() {
1737 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1738 server
.port
= REDIS_SERVERPORT
;
1739 server
.verbosity
= REDIS_VERBOSE
;
1740 server
.maxidletime
= REDIS_MAXIDLETIME
;
1741 server
.saveparams
= NULL
;
1742 server
.logfile
= NULL
; /* NULL = log on standard output */
1743 server
.bindaddr
= NULL
;
1744 server
.glueoutputbuf
= 1;
1745 server
.daemonize
= 0;
1746 server
.appendonly
= 0;
1747 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1748 server
.no_appendfsync_on_rewrite
= 0;
1749 server
.lastfsync
= time(NULL
);
1750 server
.appendfd
= -1;
1751 server
.appendseldb
= -1; /* Make sure the first time will not match */
1752 server
.pidfile
= zstrdup("/var/run/redis.pid");
1753 server
.dbfilename
= zstrdup("dump.rdb");
1754 server
.appendfilename
= zstrdup("appendonly.aof");
1755 server
.requirepass
= NULL
;
1756 server
.rdbcompression
= 1;
1757 server
.activerehashing
= 1;
1758 server
.maxclients
= 0;
1759 server
.blpop_blocked_clients
= 0;
1760 server
.maxmemory
= 0;
1761 server
.vm_enabled
= 0;
1762 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1763 server
.vm_page_size
= 256; /* 256 bytes per page */
1764 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1765 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1766 server
.vm_max_threads
= 4;
1767 server
.vm_blocked_clients
= 0;
1768 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1769 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1770 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1771 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1772 server
.shutdown_asap
= 0;
1774 resetServerSaveParams();
1776 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1777 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1778 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1779 /* Replication related */
1781 server
.masterauth
= NULL
;
1782 server
.masterhost
= NULL
;
1783 server
.masterport
= 6379;
1784 server
.master
= NULL
;
1785 server
.replstate
= REDIS_REPL_NONE
;
1787 /* Double constants initialization */
1789 R_PosInf
= 1.0/R_Zero
;
1790 R_NegInf
= -1.0/R_Zero
;
1791 R_Nan
= R_Zero
/R_Zero
;
1794 static void initServer() {
1797 signal(SIGHUP
, SIG_IGN
);
1798 signal(SIGPIPE
, SIG_IGN
);
1799 setupSigSegvAction();
1801 server
.devnull
= fopen("/dev/null","w");
1802 if (server
.devnull
== NULL
) {
1803 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1806 server
.clients
= listCreate();
1807 server
.slaves
= listCreate();
1808 server
.monitors
= listCreate();
1809 server
.objfreelist
= listCreate();
1810 createSharedObjects();
1811 server
.el
= aeCreateEventLoop();
1812 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1813 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1814 if (server
.fd
== -1) {
1815 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1818 for (j
= 0; j
< server
.dbnum
; j
++) {
1819 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1820 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1821 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1822 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1823 if (server
.vm_enabled
)
1824 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1825 server
.db
[j
].id
= j
;
1827 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1828 server
.pubsub_patterns
= listCreate();
1829 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1830 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1831 server
.cronloops
= 0;
1832 server
.bgsavechildpid
= -1;
1833 server
.bgrewritechildpid
= -1;
1834 server
.bgrewritebuf
= sdsempty();
1835 server
.aofbuf
= sdsempty();
1836 server
.lastsave
= time(NULL
);
1838 server
.stat_numcommands
= 0;
1839 server
.stat_numconnections
= 0;
1840 server
.stat_expiredkeys
= 0;
1841 server
.stat_starttime
= time(NULL
);
1842 server
.unixtime
= time(NULL
);
1843 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1844 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1845 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1847 if (server
.appendonly
) {
1848 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1849 if (server
.appendfd
== -1) {
1850 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1856 if (server
.vm_enabled
) vmInit();
1859 /* Empty the whole database */
1860 static long long emptyDb() {
1862 long long removed
= 0;
1864 for (j
= 0; j
< server
.dbnum
; j
++) {
1865 removed
+= dictSize(server
.db
[j
].dict
);
1866 dictEmpty(server
.db
[j
].dict
);
1867 dictEmpty(server
.db
[j
].expires
);
1872 static int yesnotoi(char *s
) {
1873 if (!strcasecmp(s
,"yes")) return 1;
1874 else if (!strcasecmp(s
,"no")) return 0;
1878 /* I agree, this is a very rudimental way to load a configuration...
1879 will improve later if the config gets more complex */
1880 static void loadServerConfig(char *filename
) {
1882 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1886 if (filename
[0] == '-' && filename
[1] == '\0')
1889 if ((fp
= fopen(filename
,"r")) == NULL
) {
1890 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1895 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1901 line
= sdstrim(line
," \t\r\n");
1903 /* Skip comments and blank lines*/
1904 if (line
[0] == '#' || line
[0] == '\0') {
1909 /* Split into arguments */
1910 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1911 sdstolower(argv
[0]);
1913 /* Execute config directives */
1914 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1915 server
.maxidletime
= atoi(argv
[1]);
1916 if (server
.maxidletime
< 0) {
1917 err
= "Invalid timeout value"; goto loaderr
;
1919 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1920 server
.port
= atoi(argv
[1]);
1921 if (server
.port
< 1 || server
.port
> 65535) {
1922 err
= "Invalid port"; goto loaderr
;
1924 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1925 server
.bindaddr
= zstrdup(argv
[1]);
1926 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1927 int seconds
= atoi(argv
[1]);
1928 int changes
= atoi(argv
[2]);
1929 if (seconds
< 1 || changes
< 0) {
1930 err
= "Invalid save parameters"; goto loaderr
;
1932 appendServerSaveParams(seconds
,changes
);
1933 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1934 if (chdir(argv
[1]) == -1) {
1935 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1936 argv
[1], strerror(errno
));
1939 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1940 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1941 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1942 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1943 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1945 err
= "Invalid log level. Must be one of debug, notice, warning";
1948 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1951 server
.logfile
= zstrdup(argv
[1]);
1952 if (!strcasecmp(server
.logfile
,"stdout")) {
1953 zfree(server
.logfile
);
1954 server
.logfile
= NULL
;
1956 if (server
.logfile
) {
1957 /* Test if we are able to open the file. The server will not
1958 * be able to abort just for this problem later... */
1959 logfp
= fopen(server
.logfile
,"a");
1960 if (logfp
== NULL
) {
1961 err
= sdscatprintf(sdsempty(),
1962 "Can't open the log file: %s", strerror(errno
));
1967 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1968 server
.dbnum
= atoi(argv
[1]);
1969 if (server
.dbnum
< 1) {
1970 err
= "Invalid number of databases"; goto loaderr
;
1972 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1973 loadServerConfig(argv
[1]);
1974 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1975 server
.maxclients
= atoi(argv
[1]);
1976 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1977 server
.maxmemory
= memtoll(argv
[1],NULL
);
1978 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1979 server
.masterhost
= sdsnew(argv
[1]);
1980 server
.masterport
= atoi(argv
[2]);
1981 server
.replstate
= REDIS_REPL_CONNECT
;
1982 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1983 server
.masterauth
= zstrdup(argv
[1]);
1984 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1985 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1986 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1988 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1989 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1990 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1992 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1993 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1994 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1996 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1997 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1998 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
2000 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
2001 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
2002 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
2004 } else if (!strcasecmp(argv
[0],"appendfilename") && argc
== 2) {
2005 zfree(server
.appendfilename
);
2006 server
.appendfilename
= zstrdup(argv
[1]);
2007 } else if (!strcasecmp(argv
[0],"no-appendfsync-on-rewrite")
2009 if ((server
.no_appendfsync_on_rewrite
= yesnotoi(argv
[1])) == -1) {
2010 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
2012 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
2013 if (!strcasecmp(argv
[1],"no")) {
2014 server
.appendfsync
= APPENDFSYNC_NO
;
2015 } else if (!strcasecmp(argv
[1],"always")) {
2016 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
2017 } else if (!strcasecmp(argv
[1],"everysec")) {
2018 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
2020 err
= "argument must be 'no', 'always' or 'everysec'";
2023 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
2024 server
.requirepass
= zstrdup(argv
[1]);
2025 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
2026 zfree(server
.pidfile
);
2027 server
.pidfile
= zstrdup(argv
[1]);
2028 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
2029 zfree(server
.dbfilename
);
2030 server
.dbfilename
= zstrdup(argv
[1]);
2031 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
2032 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
2033 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
2035 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
2036 zfree(server
.vm_swap_file
);
2037 server
.vm_swap_file
= zstrdup(argv
[1]);
2038 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
2039 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
2040 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
2041 server
.vm_page_size
= memtoll(argv
[1], NULL
);
2042 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
2043 server
.vm_pages
= memtoll(argv
[1], NULL
);
2044 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
2045 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
2046 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
2047 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
2048 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
2049 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
2050 } else if (!strcasecmp(argv
[0],"list-max-ziplist-entries") && argc
== 2){
2051 server
.list_max_ziplist_entries
= memtoll(argv
[1], NULL
);
2052 } else if (!strcasecmp(argv
[0],"list-max-ziplist-value") && argc
== 2){
2053 server
.list_max_ziplist_value
= memtoll(argv
[1], NULL
);
2055 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
2057 for (j
= 0; j
< argc
; j
++)
2062 if (fp
!= stdin
) fclose(fp
);
2066 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
2067 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
2068 fprintf(stderr
, ">>> '%s'\n", line
);
2069 fprintf(stderr
, "%s\n", err
);
2073 static void freeClientArgv(redisClient
*c
) {
2076 for (j
= 0; j
< c
->argc
; j
++)
2077 decrRefCount(c
->argv
[j
]);
2078 for (j
= 0; j
< c
->mbargc
; j
++)
2079 decrRefCount(c
->mbargv
[j
]);
2084 static void freeClient(redisClient
*c
) {
2087 /* Note that if the client we are freeing is blocked into a blocking
2088 * call, we have to set querybuf to NULL *before* to call
2089 * unblockClientWaitingData() to avoid processInputBuffer() will get
2090 * called. Also it is important to remove the file events after
2091 * this, because this call adds the READABLE event. */
2092 sdsfree(c
->querybuf
);
2094 if (c
->flags
& REDIS_BLOCKED
)
2095 unblockClientWaitingData(c
);
2097 /* UNWATCH all the keys */
2099 listRelease(c
->watched_keys
);
2100 /* Unsubscribe from all the pubsub channels */
2101 pubsubUnsubscribeAllChannels(c
,0);
2102 pubsubUnsubscribeAllPatterns(c
,0);
2103 dictRelease(c
->pubsub_channels
);
2104 listRelease(c
->pubsub_patterns
);
2105 /* Obvious cleanup */
2106 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2107 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2108 listRelease(c
->reply
);
2111 /* Remove from the list of clients */
2112 ln
= listSearchKey(server
.clients
,c
);
2113 redisAssert(ln
!= NULL
);
2114 listDelNode(server
.clients
,ln
);
2115 /* Remove from the list of clients that are now ready to be restarted
2116 * after waiting for swapped keys */
2117 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2118 ln
= listSearchKey(server
.io_ready_clients
,c
);
2120 listDelNode(server
.io_ready_clients
,ln
);
2121 server
.vm_blocked_clients
--;
2124 /* Remove from the list of clients waiting for swapped keys */
2125 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2126 ln
= listFirst(c
->io_keys
);
2127 dontWaitForSwappedKey(c
,ln
->value
);
2129 listRelease(c
->io_keys
);
2130 /* Master/slave cleanup */
2131 if (c
->flags
& REDIS_SLAVE
) {
2132 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2134 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2135 ln
= listSearchKey(l
,c
);
2136 redisAssert(ln
!= NULL
);
2139 if (c
->flags
& REDIS_MASTER
) {
2140 server
.master
= NULL
;
2141 server
.replstate
= REDIS_REPL_CONNECT
;
2143 /* Release memory */
2146 freeClientMultiState(c
);
2150 #define GLUEREPLY_UP_TO (1024)
2151 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2153 char buf
[GLUEREPLY_UP_TO
];
2158 listRewind(c
->reply
,&li
);
2159 while((ln
= listNext(&li
))) {
2163 objlen
= sdslen(o
->ptr
);
2164 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2165 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2167 listDelNode(c
->reply
,ln
);
2169 if (copylen
== 0) return;
2173 /* Now the output buffer is empty, add the new single element */
2174 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2175 listAddNodeHead(c
->reply
,o
);
2178 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2179 redisClient
*c
= privdata
;
2180 int nwritten
= 0, totwritten
= 0, objlen
;
2183 REDIS_NOTUSED(mask
);
2185 /* Use writev() if we have enough buffers to send */
2186 if (!server
.glueoutputbuf
&&
2187 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2188 !(c
->flags
& REDIS_MASTER
))
2190 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2194 while(listLength(c
->reply
)) {
2195 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2196 glueReplyBuffersIfNeeded(c
);
2198 o
= listNodeValue(listFirst(c
->reply
));
2199 objlen
= sdslen(o
->ptr
);
2202 listDelNode(c
->reply
,listFirst(c
->reply
));
2206 if (c
->flags
& REDIS_MASTER
) {
2207 /* Don't reply to a master */
2208 nwritten
= objlen
- c
->sentlen
;
2210 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2211 if (nwritten
<= 0) break;
2213 c
->sentlen
+= nwritten
;
2214 totwritten
+= nwritten
;
2215 /* If we fully sent the object on head go to the next one */
2216 if (c
->sentlen
== objlen
) {
2217 listDelNode(c
->reply
,listFirst(c
->reply
));
2220 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2221 * bytes, in a single threaded server it's a good idea to serve
2222 * other clients as well, even if a very large request comes from
2223 * super fast link that is always able to accept data (in real world
2224 * scenario think about 'KEYS *' against the loopback interfae) */
2225 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2227 if (nwritten
== -1) {
2228 if (errno
== EAGAIN
) {
2231 redisLog(REDIS_VERBOSE
,
2232 "Error writing to client: %s", strerror(errno
));
2237 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2238 if (listLength(c
->reply
) == 0) {
2240 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2244 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2246 redisClient
*c
= privdata
;
2247 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2249 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2250 int offset
, ion
= 0;
2252 REDIS_NOTUSED(mask
);
2255 while (listLength(c
->reply
)) {
2256 offset
= c
->sentlen
;
2260 /* fill-in the iov[] array */
2261 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2262 o
= listNodeValue(node
);
2263 objlen
= sdslen(o
->ptr
);
2265 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2268 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2269 break; /* no more iovecs */
2271 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2272 iov
[ion
].iov_len
= objlen
- offset
;
2273 willwrite
+= objlen
- offset
;
2274 offset
= 0; /* just for the first item */
2281 /* write all collected blocks at once */
2282 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2283 if (errno
!= EAGAIN
) {
2284 redisLog(REDIS_VERBOSE
,
2285 "Error writing to client: %s", strerror(errno
));
2292 totwritten
+= nwritten
;
2293 offset
= c
->sentlen
;
2295 /* remove written robjs from c->reply */
2296 while (nwritten
&& listLength(c
->reply
)) {
2297 o
= listNodeValue(listFirst(c
->reply
));
2298 objlen
= sdslen(o
->ptr
);
2300 if(nwritten
>= objlen
- offset
) {
2301 listDelNode(c
->reply
, listFirst(c
->reply
));
2302 nwritten
-= objlen
- offset
;
2306 c
->sentlen
+= nwritten
;
2314 c
->lastinteraction
= time(NULL
);
2316 if (listLength(c
->reply
) == 0) {
2318 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2322 static int qsortRedisCommands(const void *r1
, const void *r2
) {
2324 ((struct redisCommand
*)r1
)->name
,
2325 ((struct redisCommand
*)r2
)->name
);
2328 static void sortCommandTable() {
2329 /* Copy and sort the read-only version of the command table */
2330 commandTable
= (struct redisCommand
*)malloc(sizeof(readonlyCommandTable
));
2331 memcpy(commandTable
,readonlyCommandTable
,sizeof(readonlyCommandTable
));
2333 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2334 sizeof(struct redisCommand
),qsortRedisCommands
);
2337 static struct redisCommand
*lookupCommand(char *name
) {
2338 struct redisCommand tmp
= {name
,NULL
,0,0,NULL
,0,0,0};
2342 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2343 sizeof(struct redisCommand
),
2344 qsortRedisCommands
);
2347 /* resetClient prepare the client to process the next command */
2348 static void resetClient(redisClient
*c
) {
2354 /* Call() is the core of Redis execution of a command */
2355 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2358 dirty
= server
.dirty
;
2360 dirty
= server
.dirty
-dirty
;
2362 if (server
.appendonly
&& dirty
)
2363 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2364 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2365 listLength(server
.slaves
))
2366 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2367 if (listLength(server
.monitors
))
2368 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2369 server
.stat_numcommands
++;
2372 /* If this function gets called we already read a whole
2373 * command, argments are in the client argv/argc fields.
2374 * processCommand() execute the command or prepare the
2375 * server for a bulk read from the client.
2377 * If 1 is returned the client is still alive and valid and
2378 * and other operations can be performed by the caller. Otherwise
2379 * if 0 is returned the client was destroied (i.e. after QUIT). */
2380 static int processCommand(redisClient
*c
) {
2381 struct redisCommand
*cmd
;
2383 /* Free some memory if needed (maxmemory setting) */
2384 if (server
.maxmemory
) freeMemoryIfNeeded();
2386 /* Handle the multi bulk command type. This is an alternative protocol
2387 * supported by Redis in order to receive commands that are composed of
2388 * multiple binary-safe "bulk" arguments. The latency of processing is
2389 * a bit higher but this allows things like multi-sets, so if this
2390 * protocol is used only for MSET and similar commands this is a big win. */
2391 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2392 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2393 if (c
->multibulk
<= 0) {
2397 decrRefCount(c
->argv
[c
->argc
-1]);
2401 } else if (c
->multibulk
) {
2402 if (c
->bulklen
== -1) {
2403 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2404 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2408 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2409 decrRefCount(c
->argv
[0]);
2410 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2412 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2417 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2421 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2422 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2426 if (c
->multibulk
== 0) {
2430 /* Here we need to swap the multi-bulk argc/argv with the
2431 * normal argc/argv of the client structure. */
2433 c
->argv
= c
->mbargv
;
2434 c
->mbargv
= auxargv
;
2437 c
->argc
= c
->mbargc
;
2438 c
->mbargc
= auxargc
;
2440 /* We need to set bulklen to something different than -1
2441 * in order for the code below to process the command without
2442 * to try to read the last argument of a bulk command as
2443 * a special argument. */
2445 /* continue below and process the command */
2452 /* -- end of multi bulk commands processing -- */
2454 /* The QUIT command is handled as a special case. Normal command
2455 * procs are unable to close the client connection safely */
2456 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2461 /* Now lookup the command and check ASAP about trivial error conditions
2462 * such wrong arity, bad command name and so forth. */
2463 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2466 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2467 (char*)c
->argv
[0]->ptr
));
2470 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2471 (c
->argc
< -cmd
->arity
)) {
2473 sdscatprintf(sdsempty(),
2474 "-ERR wrong number of arguments for '%s' command\r\n",
2478 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2479 /* This is a bulk command, we have to read the last argument yet. */
2480 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2482 decrRefCount(c
->argv
[c
->argc
-1]);
2483 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2485 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2490 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2491 /* It is possible that the bulk read is already in the
2492 * buffer. Check this condition and handle it accordingly.
2493 * This is just a fast path, alternative to call processInputBuffer().
2494 * It's a good idea since the code is small and this condition
2495 * happens most of the times. */
2496 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2497 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2499 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2501 /* Otherwise return... there is to read the last argument
2502 * from the socket. */
2506 /* Let's try to encode the bulk object to save space. */
2507 if (cmd
->flags
& REDIS_CMD_BULK
)
2508 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2510 /* Check if the user is authenticated */
2511 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2512 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2517 /* Handle the maxmemory directive */
2518 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2519 zmalloc_used_memory() > server
.maxmemory
)
2521 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2526 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2527 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2529 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2530 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2531 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2536 /* Exec the command */
2537 if (c
->flags
& REDIS_MULTI
&&
2538 cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
&&
2539 cmd
->proc
!= multiCommand
&& cmd
->proc
!= watchCommand
)
2541 queueMultiCommand(c
,cmd
);
2542 addReply(c
,shared
.queued
);
2544 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2545 blockClientOnSwappedKeys(c
,cmd
)) return 1;
2549 /* Prepare the client for the next command */
2554 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2559 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2560 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2561 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2562 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2565 if (argc
<= REDIS_STATIC_ARGS
) {
2568 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2571 lenobj
= createObject(REDIS_STRING
,
2572 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2573 lenobj
->refcount
= 0;
2574 outv
[outc
++] = lenobj
;
2575 for (j
= 0; j
< argc
; j
++) {
2576 lenobj
= createObject(REDIS_STRING
,
2577 sdscatprintf(sdsempty(),"$%lu\r\n",
2578 (unsigned long) stringObjectLen(argv
[j
])));
2579 lenobj
->refcount
= 0;
2580 outv
[outc
++] = lenobj
;
2581 outv
[outc
++] = argv
[j
];
2582 outv
[outc
++] = shared
.crlf
;
2585 /* Increment all the refcounts at start and decrement at end in order to
2586 * be sure to free objects if there is no slave in a replication state
2587 * able to be feed with commands */
2588 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2589 listRewind(slaves
,&li
);
2590 while((ln
= listNext(&li
))) {
2591 redisClient
*slave
= ln
->value
;
2593 /* Don't feed slaves that are still waiting for BGSAVE to start */
2594 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2596 /* Feed all the other slaves, MONITORs and so on */
2597 if (slave
->slaveseldb
!= dictid
) {
2601 case 0: selectcmd
= shared
.select0
; break;
2602 case 1: selectcmd
= shared
.select1
; break;
2603 case 2: selectcmd
= shared
.select2
; break;
2604 case 3: selectcmd
= shared
.select3
; break;
2605 case 4: selectcmd
= shared
.select4
; break;
2606 case 5: selectcmd
= shared
.select5
; break;
2607 case 6: selectcmd
= shared
.select6
; break;
2608 case 7: selectcmd
= shared
.select7
; break;
2609 case 8: selectcmd
= shared
.select8
; break;
2610 case 9: selectcmd
= shared
.select9
; break;
2612 selectcmd
= createObject(REDIS_STRING
,
2613 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2614 selectcmd
->refcount
= 0;
2617 addReply(slave
,selectcmd
);
2618 slave
->slaveseldb
= dictid
;
2620 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2622 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2623 if (outv
!= static_outv
) zfree(outv
);
2626 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2627 s
= sdscatlen(s
,"\"",1);
2632 s
= sdscatprintf(s
,"\\%c",*p
);
2634 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2635 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2636 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2637 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2638 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2641 s
= sdscatprintf(s
,"%c",*p
);
2643 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2648 return sdscatlen(s
,"\"",1);
2651 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2655 sds cmdrepr
= sdsnew("+");
2659 gettimeofday(&tv
,NULL
);
2660 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2661 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2663 for (j
= 0; j
< argc
; j
++) {
2664 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2665 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2667 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2668 sdslen(argv
[j
]->ptr
));
2671 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2673 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2674 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2676 listRewind(monitors
,&li
);
2677 while((ln
= listNext(&li
))) {
2678 redisClient
*monitor
= ln
->value
;
2679 addReply(monitor
,cmdobj
);
2681 decrRefCount(cmdobj
);
2684 static void processInputBuffer(redisClient
*c
) {
2686 /* Before to process the input buffer, make sure the client is not
2687 * waitig for a blocking operation such as BLPOP. Note that the first
2688 * iteration the client is never blocked, otherwise the processInputBuffer
2689 * would not be called at all, but after the execution of the first commands
2690 * in the input buffer the client may be blocked, and the "goto again"
2691 * will try to reiterate. The following line will make it return asap. */
2692 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2693 if (c
->bulklen
== -1) {
2694 /* Read the first line of the query */
2695 char *p
= strchr(c
->querybuf
,'\n');
2702 query
= c
->querybuf
;
2703 c
->querybuf
= sdsempty();
2704 querylen
= 1+(p
-(query
));
2705 if (sdslen(query
) > querylen
) {
2706 /* leave data after the first line of the query in the buffer */
2707 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2709 *p
= '\0'; /* remove "\n" */
2710 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2711 sdsupdatelen(query
);
2713 /* Now we can split the query in arguments */
2714 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2717 if (c
->argv
) zfree(c
->argv
);
2718 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2720 for (j
= 0; j
< argc
; j
++) {
2721 if (sdslen(argv
[j
])) {
2722 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2730 /* Execute the command. If the client is still valid
2731 * after processCommand() return and there is something
2732 * on the query buffer try to process the next command. */
2733 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2735 /* Nothing to process, argc == 0. Just process the query
2736 * buffer if it's not empty or return to the caller */
2737 if (sdslen(c
->querybuf
)) goto again
;
2740 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2741 redisLog(REDIS_VERBOSE
, "Client protocol error");
2746 /* Bulk read handling. Note that if we are at this point
2747 the client already sent a command terminated with a newline,
2748 we are reading the bulk data that is actually the last
2749 argument of the command. */
2750 int qbl
= sdslen(c
->querybuf
);
2752 if (c
->bulklen
<= qbl
) {
2753 /* Copy everything but the final CRLF as final argument */
2754 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2756 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2757 /* Process the command. If the client is still valid after
2758 * the processing and there is more data in the buffer
2759 * try to parse it. */
2760 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2766 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2767 redisClient
*c
= (redisClient
*) privdata
;
2768 char buf
[REDIS_IOBUF_LEN
];
2771 REDIS_NOTUSED(mask
);
2773 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2775 if (errno
== EAGAIN
) {
2778 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2782 } else if (nread
== 0) {
2783 redisLog(REDIS_VERBOSE
, "Client closed connection");
2788 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2789 c
->lastinteraction
= time(NULL
);
2793 processInputBuffer(c
);
2796 static int selectDb(redisClient
*c
, int id
) {
2797 if (id
< 0 || id
>= server
.dbnum
)
2799 c
->db
= &server
.db
[id
];
2803 static void *dupClientReplyValue(void *o
) {
2804 incrRefCount((robj
*)o
);
2808 static int listMatchObjects(void *a
, void *b
) {
2809 return equalStringObjects(a
,b
);
2812 static redisClient
*createClient(int fd
) {
2813 redisClient
*c
= zmalloc(sizeof(*c
));
2815 anetNonBlock(NULL
,fd
);
2816 anetTcpNoDelay(NULL
,fd
);
2817 if (!c
) return NULL
;
2820 c
->querybuf
= sdsempty();
2829 c
->lastinteraction
= time(NULL
);
2830 c
->authenticated
= 0;
2831 c
->replstate
= REDIS_REPL_NONE
;
2832 c
->reply
= listCreate();
2833 listSetFreeMethod(c
->reply
,decrRefCount
);
2834 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2835 c
->blocking_keys
= NULL
;
2836 c
->blocking_keys_num
= 0;
2837 c
->io_keys
= listCreate();
2838 c
->watched_keys
= listCreate();
2839 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2840 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2841 c
->pubsub_patterns
= listCreate();
2842 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2843 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2844 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2845 readQueryFromClient
, c
) == AE_ERR
) {
2849 listAddNodeTail(server
.clients
,c
);
2850 initClientMultiState(c
);
2854 static void addReply(redisClient
*c
, robj
*obj
) {
2855 if (listLength(c
->reply
) == 0 &&
2856 (c
->replstate
== REDIS_REPL_NONE
||
2857 c
->replstate
== REDIS_REPL_ONLINE
) &&
2858 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2859 sendReplyToClient
, c
) == AE_ERR
) return;
2861 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2862 obj
= dupStringObject(obj
);
2863 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2865 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2868 static void addReplySds(redisClient
*c
, sds s
) {
2869 robj
*o
= createObject(REDIS_STRING
,s
);
2874 static void addReplyDouble(redisClient
*c
, double d
) {
2877 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2878 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2879 (unsigned long) strlen(buf
),buf
));
2882 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2887 addReply(c
,shared
.czero
);
2889 } else if (ll
== 1) {
2890 addReply(c
,shared
.cone
);
2894 len
= ll2string(buf
+1,sizeof(buf
)-1,ll
);
2897 addReplySds(c
,sdsnewlen(buf
,len
+3));
2900 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2905 addReply(c
,shared
.czero
);
2907 } else if (ul
== 1) {
2908 addReply(c
,shared
.cone
);
2911 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2912 addReplySds(c
,sdsnewlen(buf
,len
));
2915 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2919 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2920 len
= sdslen(obj
->ptr
);
2922 long n
= (long)obj
->ptr
;
2924 /* Compute how many bytes will take this integer as a radix 10 string */
2930 while((n
= n
/10) != 0) {
2935 intlen
= ll2string(buf
+1,sizeof(buf
)-1,(long long)len
);
2936 buf
[intlen
+1] = '\r';
2937 buf
[intlen
+2] = '\n';
2938 addReplySds(c
,sdsnewlen(buf
,intlen
+3));
2941 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2942 addReplyBulkLen(c
,obj
);
2944 addReply(c
,shared
.crlf
);
2947 static void addReplyBulkSds(redisClient
*c
, sds s
) {
2948 robj
*o
= createStringObject(s
, sdslen(s
));
2953 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2954 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2956 addReply(c
,shared
.nullbulk
);
2958 robj
*o
= createStringObject(s
,strlen(s
));
2964 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2969 REDIS_NOTUSED(mask
);
2970 REDIS_NOTUSED(privdata
);
2972 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2973 if (cfd
== AE_ERR
) {
2974 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2977 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2978 if ((c
= createClient(cfd
)) == NULL
) {
2979 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2980 close(cfd
); /* May be already closed, just ingore errors */
2983 /* If maxclient directive is set and this is one client more... close the
2984 * connection. Note that we create the client instead to check before
2985 * for this condition, since now the socket is already set in nonblocking
2986 * mode and we can send an error for free using the Kernel I/O */
2987 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2988 char *err
= "-ERR max number of clients reached\r\n";
2990 /* That's a best effort error message, don't check write errors */
2991 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2992 /* Nothing to do, Just to avoid the warning... */
2997 server
.stat_numconnections
++;
3000 /* ======================= Redis objects implementation ===================== */
3002 static robj
*createObject(int type
, void *ptr
) {
3005 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3006 if (listLength(server
.objfreelist
)) {
3007 listNode
*head
= listFirst(server
.objfreelist
);
3008 o
= listNodeValue(head
);
3009 listDelNode(server
.objfreelist
,head
);
3010 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3012 if (server
.vm_enabled
)
3013 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3014 o
= zmalloc(sizeof(*o
));
3017 o
->encoding
= REDIS_ENCODING_RAW
;
3020 if (server
.vm_enabled
) {
3021 /* Note that this code may run in the context of an I/O thread
3022 * and accessing server.lruclock in theory is an error
3023 * (no locks). But in practice this is safe, and even if we read
3024 * garbage Redis will not fail. */
3025 o
->lru
= server
.lruclock
;
3026 o
->storage
= REDIS_VM_MEMORY
;
3031 static robj
*createStringObject(char *ptr
, size_t len
) {
3032 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
3035 static robj
*createStringObjectFromLongLong(long long value
) {
3037 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3038 incrRefCount(shared
.integers
[value
]);
3039 o
= shared
.integers
[value
];
3041 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
3042 o
= createObject(REDIS_STRING
, NULL
);
3043 o
->encoding
= REDIS_ENCODING_INT
;
3044 o
->ptr
= (void*)((long)value
);
3046 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
3052 static robj
*dupStringObject(robj
*o
) {
3053 assert(o
->encoding
== REDIS_ENCODING_RAW
);
3054 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
3057 static robj
*createListObject(void) {
3058 list
*l
= listCreate();
3059 robj
*o
= createObject(REDIS_LIST
,l
);
3060 listSetFreeMethod(l
,decrRefCount
);
3061 o
->encoding
= REDIS_ENCODING_LIST
;
3065 static robj
*createZiplistObject(void) {
3066 unsigned char *zl
= ziplistNew();
3067 robj
*o
= createObject(REDIS_LIST
,zl
);
3068 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
3072 static robj
*createSetObject(void) {
3073 dict
*d
= dictCreate(&setDictType
,NULL
);
3074 return createObject(REDIS_SET
,d
);
3077 static robj
*createHashObject(void) {
3078 /* All the Hashes start as zipmaps. Will be automatically converted
3079 * into hash tables if there are enough elements or big elements
3081 unsigned char *zm
= zipmapNew();
3082 robj
*o
= createObject(REDIS_HASH
,zm
);
3083 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
3087 static robj
*createZsetObject(void) {
3088 zset
*zs
= zmalloc(sizeof(*zs
));
3090 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
3091 zs
->zsl
= zslCreate();
3092 return createObject(REDIS_ZSET
,zs
);
3095 static void freeStringObject(robj
*o
) {
3096 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3101 static void freeListObject(robj
*o
) {
3102 switch (o
->encoding
) {
3103 case REDIS_ENCODING_LIST
:
3104 listRelease((list
*) o
->ptr
);
3106 case REDIS_ENCODING_ZIPLIST
:
3110 redisPanic("Unknown list encoding type");
3114 static void freeSetObject(robj
*o
) {
3115 dictRelease((dict
*) o
->ptr
);
3118 static void freeZsetObject(robj
*o
) {
3121 dictRelease(zs
->dict
);
3126 static void freeHashObject(robj
*o
) {
3127 switch (o
->encoding
) {
3128 case REDIS_ENCODING_HT
:
3129 dictRelease((dict
*) o
->ptr
);
3131 case REDIS_ENCODING_ZIPMAP
:
3135 redisPanic("Unknown hash encoding type");
3140 static void incrRefCount(robj
*o
) {
3144 static void decrRefCount(void *obj
) {
3147 /* Object is a swapped out value, or in the process of being loaded. */
3148 if (server
.vm_enabled
&&
3149 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3151 vmpointer
*vp
= obj
;
3152 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(o
);
3153 vmMarkPagesFree(vp
->page
,vp
->usedpages
);
3154 server
.vm_stats_swapped_objects
--;
3159 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3160 /* Object is in memory, or in the process of being swapped out.
3162 * If the object is being swapped out, abort the operation on
3163 * decrRefCount even if the refcount does not drop to 0: the object
3164 * is referenced at least two times, as value of the key AND as
3165 * job->val in the iojob. So if we don't invalidate the iojob, when it is
3166 * done but the relevant key was removed in the meantime, the
3167 * complete jobs handler will not find the key about the job and the
3168 * assert will fail. */
3169 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3170 vmCancelThreadedIOJob(o
);
3171 if (--(o
->refcount
) == 0) {
3173 case REDIS_STRING
: freeStringObject(o
); break;
3174 case REDIS_LIST
: freeListObject(o
); break;
3175 case REDIS_SET
: freeSetObject(o
); break;
3176 case REDIS_ZSET
: freeZsetObject(o
); break;
3177 case REDIS_HASH
: freeHashObject(o
); break;
3178 default: redisPanic("Unknown object type"); break;
3180 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3181 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3182 !listAddNodeHead(server
.objfreelist
,o
))
3184 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3188 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3189 if (o
->type
!= type
) {
3190 addReply(c
,shared
.wrongtypeerr
);
3196 /* Check if the nul-terminated string 's' can be represented by a long
3197 * (that is, is a number that fits into long without any other space or
3198 * character before or after the digits).
3200 * If so, the function returns REDIS_OK and *longval is set to the value
3201 * of the number. Otherwise REDIS_ERR is returned */
3202 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3203 char buf
[32], *endptr
;
3207 value
= strtol(s
, &endptr
, 10);
3208 if (endptr
[0] != '\0') return REDIS_ERR
;
3209 slen
= ll2string(buf
,32,value
);
3211 /* If the number converted back into a string is not identical
3212 * then it's not possible to encode the string as integer */
3213 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3214 if (longval
) *longval
= value
;
3218 /* Try to encode a string object in order to save space */
3219 static robj
*tryObjectEncoding(robj
*o
) {
3223 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3224 return o
; /* Already encoded */
3226 /* It's not safe to encode shared objects: shared objects can be shared
3227 * everywhere in the "object space" of Redis. Encoded objects can only
3228 * appear as "values" (and not, for instance, as keys) */
3229 if (o
->refcount
> 1) return o
;
3231 /* Currently we try to encode only strings */
3232 redisAssert(o
->type
== REDIS_STRING
);
3234 /* Check if we can represent this string as a long integer */
3235 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3237 /* Ok, this object can be encoded */
3238 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3240 incrRefCount(shared
.integers
[value
]);
3241 return shared
.integers
[value
];
3243 o
->encoding
= REDIS_ENCODING_INT
;
3245 o
->ptr
= (void*) value
;
3250 /* Get a decoded version of an encoded object (returned as a new object).
3251 * If the object is already raw-encoded just increment the ref count. */
3252 static robj
*getDecodedObject(robj
*o
) {
3255 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3259 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3262 ll2string(buf
,32,(long)o
->ptr
);
3263 dec
= createStringObject(buf
,strlen(buf
));
3266 redisPanic("Unknown encoding type");
3270 /* Compare two string objects via strcmp() or alike.
3271 * Note that the objects may be integer-encoded. In such a case we
3272 * use ll2string() to get a string representation of the numbers on the stack
3273 * and compare the strings, it's much faster than calling getDecodedObject().
3275 * Important note: if objects are not integer encoded, but binary-safe strings,
3276 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3278 static int compareStringObjects(robj
*a
, robj
*b
) {
3279 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3280 char bufa
[128], bufb
[128], *astr
, *bstr
;
3283 if (a
== b
) return 0;
3284 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3285 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3291 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3292 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3298 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3301 /* Equal string objects return 1 if the two objects are the same from the
3302 * point of view of a string comparison, otherwise 0 is returned. Note that
3303 * this function is faster then checking for (compareStringObject(a,b) == 0)
3304 * because it can perform some more optimization. */
3305 static int equalStringObjects(robj
*a
, robj
*b
) {
3306 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3307 return a
->ptr
== b
->ptr
;
3309 return compareStringObjects(a
,b
) == 0;
3313 static size_t stringObjectLen(robj
*o
) {
3314 redisAssert(o
->type
== REDIS_STRING
);
3315 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3316 return sdslen(o
->ptr
);
3320 return ll2string(buf
,32,(long)o
->ptr
);
3324 static int getDoubleFromObject(robj
*o
, double *target
) {
3331 redisAssert(o
->type
== REDIS_STRING
);
3332 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3333 value
= strtod(o
->ptr
, &eptr
);
3334 if (eptr
[0] != '\0') return REDIS_ERR
;
3335 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3336 value
= (long)o
->ptr
;
3338 redisPanic("Unknown string encoding");
3346 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3348 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3350 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3352 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3361 static int getLongLongFromObject(robj
*o
, long long *target
) {
3368 redisAssert(o
->type
== REDIS_STRING
);
3369 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3370 value
= strtoll(o
->ptr
, &eptr
, 10);
3371 if (eptr
[0] != '\0') return REDIS_ERR
;
3372 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3373 value
= (long)o
->ptr
;
3375 redisPanic("Unknown string encoding");
3383 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3385 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3387 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3389 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3398 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3401 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3402 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3404 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3406 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3415 /* =========================== Keyspace access API ========================== */
3417 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3418 dictEntry
*de
= dictFind(db
->dict
,key
->ptr
);
3420 robj
*val
= dictGetEntryVal(de
);
3422 if (server
.vm_enabled
) {
3423 if (val
->storage
== REDIS_VM_MEMORY
||
3424 val
->storage
== REDIS_VM_SWAPPING
)
3426 /* If we were swapping the object out, cancel the operation */
3427 if (val
->storage
== REDIS_VM_SWAPPING
)
3428 vmCancelThreadedIOJob(val
);
3429 /* Update the access time for the aging algorithm. */
3430 val
->lru
= server
.lruclock
;
3432 int notify
= (val
->storage
== REDIS_VM_LOADING
);
3434 /* Our value was swapped on disk. Bring it at home. */
3435 redisAssert(val
->type
== REDIS_VMPOINTER
);
3436 val
= vmLoadObject(val
);
3437 dictGetEntryVal(de
) = val
;
3439 /* Clients blocked by the VM subsystem may be waiting for
3441 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3450 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3451 expireIfNeeded(db
,key
);
3452 return lookupKey(db
,key
);
3455 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3456 deleteIfVolatile(db
,key
);
3457 touchWatchedKey(db
,key
);
3458 return lookupKey(db
,key
);
3461 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3462 robj
*o
= lookupKeyRead(c
->db
, key
);
3463 if (!o
) addReply(c
,reply
);
3467 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3468 robj
*o
= lookupKeyWrite(c
->db
, key
);
3469 if (!o
) addReply(c
,reply
);
3473 /* Add the key to the DB. If the key already exists REDIS_ERR is returned,
3474 * otherwise REDIS_OK is returned, and the caller should increment the
3475 * refcount of 'val'. */
3476 static int dbAdd(redisDb
*db
, robj
*key
, robj
*val
) {
3477 /* Perform a lookup before adding the key, as we need to copy the
3479 if (dictFind(db
->dict
, key
->ptr
) != NULL
) {
3482 sds copy
= sdsdup(key
->ptr
);
3483 dictAdd(db
->dict
, copy
, val
);
3488 /* If the key does not exist, this is just like dbAdd(). Otherwise
3489 * the value associated to the key is replaced with the new one.
3491 * On update (key already existed) 0 is returned. Otherwise 1. */
3492 static int dbReplace(redisDb
*db
, robj
*key
, robj
*val
) {
3493 if (dictFind(db
->dict
,key
->ptr
) == NULL
) {
3494 sds copy
= sdsdup(key
->ptr
);
3495 dictAdd(db
->dict
, copy
, val
);
3498 dictReplace(db
->dict
, key
->ptr
, val
);
3503 static int dbExists(redisDb
*db
, robj
*key
) {
3504 return dictFind(db
->dict
,key
->ptr
) != NULL
;
3507 /* Return a random key, in form of a Redis object.
3508 * If there are no keys, NULL is returned.
3510 * The function makes sure to return keys not already expired. */
3511 static robj
*dbRandomKey(redisDb
*db
) {
3512 struct dictEntry
*de
;
3518 de
= dictGetRandomKey(db
->dict
);
3519 if (de
== NULL
) return NULL
;
3521 key
= dictGetEntryKey(de
);
3522 keyobj
= createStringObject(key
,sdslen(key
));
3523 if (dictFind(db
->expires
,key
)) {
3524 if (expireIfNeeded(db
,keyobj
)) {
3525 decrRefCount(keyobj
);
3526 continue; /* search for another key. This expired. */
3533 /* Delete a key, value, and associated expiration entry if any, from the DB */
3534 static int dbDelete(redisDb
*db
, robj
*key
) {
3535 /* Deleting an entry from the expires dict will not free the sds of
3536 * the key, because it is shared with the main dictionary. */
3537 if (dictSize(db
->expires
) > 0) dictDelete(db
->expires
,key
->ptr
);
3538 return dictDelete(db
->dict
,key
->ptr
) == DICT_OK
;
3541 /*============================ RDB saving/loading =========================== */
3543 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3544 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3548 static int rdbSaveTime(FILE *fp
, time_t t
) {
3549 int32_t t32
= (int32_t) t
;
3550 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3554 /* check rdbLoadLen() comments for more info */
3555 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3556 unsigned char buf
[2];
3559 /* Save a 6 bit len */
3560 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3561 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3562 } else if (len
< (1<<14)) {
3563 /* Save a 14 bit len */
3564 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3566 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3568 /* Save a 32 bit len */
3569 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3570 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3572 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3577 /* Encode 'value' as an integer if possible (if integer will fit the
3578 * supported range). If the function sucessful encoded the integer
3579 * then the (up to 5 bytes) encoded representation is written in the
3580 * string pointed by 'enc' and the length is returned. Otherwise
3582 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3583 /* Finally check if it fits in our ranges */
3584 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3585 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3586 enc
[1] = value
&0xFF;
3588 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3589 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3590 enc
[1] = value
&0xFF;
3591 enc
[2] = (value
>>8)&0xFF;
3593 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3594 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3595 enc
[1] = value
&0xFF;
3596 enc
[2] = (value
>>8)&0xFF;
3597 enc
[3] = (value
>>16)&0xFF;
3598 enc
[4] = (value
>>24)&0xFF;
3605 /* String objects in the form "2391" "-100" without any space and with a
3606 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3607 * encoded as integers to save space */
3608 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3610 char *endptr
, buf
[32];
3612 /* Check if it's possible to encode this value as a number */
3613 value
= strtoll(s
, &endptr
, 10);
3614 if (endptr
[0] != '\0') return 0;
3615 ll2string(buf
,32,value
);
3617 /* If the number converted back into a string is not identical
3618 * then it's not possible to encode the string as integer */
3619 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3621 return rdbEncodeInteger(value
,enc
);
3624 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3625 size_t comprlen
, outlen
;
3629 /* We require at least four bytes compression for this to be worth it */
3630 if (len
<= 4) return 0;
3632 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3633 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3634 if (comprlen
== 0) {
3638 /* Data compressed! Let's save it on disk */
3639 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3640 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3641 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3642 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3643 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3652 /* Save a string objet as [len][data] on disk. If the object is a string
3653 * representation of an integer value we try to safe it in a special form */
3654 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3657 /* Try integer encoding */
3659 unsigned char buf
[5];
3660 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3661 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3666 /* Try LZF compression - under 20 bytes it's unable to compress even
3667 * aaaaaaaaaaaaaaaaaa so skip it */
3668 if (server
.rdbcompression
&& len
> 20) {
3671 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3672 if (retval
== -1) return -1;
3673 if (retval
> 0) return 0;
3674 /* retval == 0 means data can't be compressed, save the old way */
3677 /* Store verbatim */
3678 if (rdbSaveLen(fp
,len
) == -1) return -1;
3679 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3683 /* Save a long long value as either an encoded string or a string. */
3684 static int rdbSaveLongLongAsStringObject(FILE *fp
, long long value
) {
3685 unsigned char buf
[32];
3686 int enclen
= rdbEncodeInteger(value
,buf
);
3688 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3690 /* Encode as string */
3691 enclen
= ll2string((char*)buf
,32,value
);
3692 redisAssert(enclen
< 32);
3693 if (rdbSaveLen(fp
,enclen
) == -1) return -1;
3694 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3699 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3700 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3701 /* Avoid to decode the object, then encode it again, if the
3702 * object is alrady integer encoded. */
3703 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3704 return rdbSaveLongLongAsStringObject(fp
,(long)obj
->ptr
);
3706 redisAssert(obj
->encoding
== REDIS_ENCODING_RAW
);
3707 return rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3711 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3712 * 8 bit integer specifing the length of the representation.
3713 * This 8 bit integer has special values in order to specify the following
3719 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3720 unsigned char buf
[128];
3726 } else if (!isfinite(val
)) {
3728 buf
[0] = (val
< 0) ? 255 : 254;
3730 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3731 /* Check if the float is in a safe range to be casted into a
3732 * long long. We are assuming that long long is 64 bit here.
3733 * Also we are assuming that there are no implementations around where
3734 * double has precision < 52 bit.
3736 * Under this assumptions we test if a double is inside an interval
3737 * where casting to long long is safe. Then using two castings we
3738 * make sure the decimal part is zero. If all this is true we use
3739 * integer printing function that is much faster. */
3740 double min
= -4503599627370495; /* (2^52)-1 */
3741 double max
= 4503599627370496; /* -(2^52) */
3742 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3743 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3746 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3747 buf
[0] = strlen((char*)buf
+1);
3750 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3754 /* Save a Redis object. */
3755 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3756 if (o
->type
== REDIS_STRING
) {
3757 /* Save a string value */
3758 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3759 } else if (o
->type
== REDIS_LIST
) {
3760 /* Save a list value */
3761 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
3763 unsigned char *vstr
;
3767 if (rdbSaveLen(fp
,ziplistLen(o
->ptr
)) == -1) return -1;
3768 p
= ziplistIndex(o
->ptr
,0);
3769 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
3771 if (rdbSaveRawString(fp
,vstr
,vlen
) == -1)
3774 if (rdbSaveLongLongAsStringObject(fp
,vlong
) == -1)
3777 p
= ziplistNext(o
->ptr
,p
);
3779 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
3780 list
*list
= o
->ptr
;
3784 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3785 listRewind(list
,&li
);
3786 while((ln
= listNext(&li
))) {
3787 robj
*eleobj
= listNodeValue(ln
);
3788 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3791 redisPanic("Unknown list encoding");
3793 } else if (o
->type
== REDIS_SET
) {
3794 /* Save a set value */
3796 dictIterator
*di
= dictGetIterator(set
);
3799 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3800 while((de
= dictNext(di
)) != NULL
) {
3801 robj
*eleobj
= dictGetEntryKey(de
);
3803 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3805 dictReleaseIterator(di
);
3806 } else if (o
->type
== REDIS_ZSET
) {
3807 /* Save a set value */
3809 dictIterator
*di
= dictGetIterator(zs
->dict
);
3812 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3813 while((de
= dictNext(di
)) != NULL
) {
3814 robj
*eleobj
= dictGetEntryKey(de
);
3815 double *score
= dictGetEntryVal(de
);
3817 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3818 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3820 dictReleaseIterator(di
);
3821 } else if (o
->type
== REDIS_HASH
) {
3822 /* Save a hash value */
3823 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3824 unsigned char *p
= zipmapRewind(o
->ptr
);
3825 unsigned int count
= zipmapLen(o
->ptr
);
3826 unsigned char *key
, *val
;
3827 unsigned int klen
, vlen
;
3829 if (rdbSaveLen(fp
,count
) == -1) return -1;
3830 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3831 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3832 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3835 dictIterator
*di
= dictGetIterator(o
->ptr
);
3838 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3839 while((de
= dictNext(di
)) != NULL
) {
3840 robj
*key
= dictGetEntryKey(de
);
3841 robj
*val
= dictGetEntryVal(de
);
3843 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3844 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3846 dictReleaseIterator(di
);
3849 redisPanic("Unknown object type");
3854 /* Return the length the object will have on disk if saved with
3855 * the rdbSaveObject() function. Currently we use a trick to get
3856 * this length with very little changes to the code. In the future
3857 * we could switch to a faster solution. */
3858 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3859 if (fp
== NULL
) fp
= server
.devnull
;
3861 assert(rdbSaveObject(fp
,o
) != 1);
3865 /* Return the number of pages required to save this object in the swap file */
3866 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3867 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3869 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3872 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3873 static int rdbSave(char *filename
) {
3874 dictIterator
*di
= NULL
;
3879 time_t now
= time(NULL
);
3881 /* Wait for I/O therads to terminate, just in case this is a
3882 * foreground-saving, to avoid seeking the swap file descriptor at the
3884 if (server
.vm_enabled
)
3885 waitEmptyIOJobsQueue();
3887 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3888 fp
= fopen(tmpfile
,"w");
3890 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3893 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3894 for (j
= 0; j
< server
.dbnum
; j
++) {
3895 redisDb
*db
= server
.db
+j
;
3897 if (dictSize(d
) == 0) continue;
3898 di
= dictGetIterator(d
);
3904 /* Write the SELECT DB opcode */
3905 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3906 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3908 /* Iterate this DB writing every entry */
3909 while((de
= dictNext(di
)) != NULL
) {
3910 sds keystr
= dictGetEntryKey(de
);
3911 robj key
, *o
= dictGetEntryVal(de
);
3914 initStaticStringObject(key
,keystr
);
3915 expiretime
= getExpire(db
,&key
);
3917 /* Save the expire time */
3918 if (expiretime
!= -1) {
3919 /* If this key is already expired skip it */
3920 if (expiretime
< now
) continue;
3921 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3922 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3924 /* Save the key and associated value. This requires special
3925 * handling if the value is swapped out. */
3926 if (!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
||
3927 o
->storage
== REDIS_VM_SWAPPING
) {
3928 /* Save type, key, value */
3929 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3930 if (rdbSaveStringObject(fp
,&key
) == -1) goto werr
;
3931 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3933 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3935 /* Get a preview of the object in memory */
3936 po
= vmPreviewObject(o
);
3937 /* Save type, key, value */
3938 if (rdbSaveType(fp
,po
->type
) == -1) goto werr
;
3939 if (rdbSaveStringObject(fp
,&key
) == -1) goto werr
;
3940 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3941 /* Remove the loaded object from memory */
3945 dictReleaseIterator(di
);
3948 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3950 /* Make sure data will not remain on the OS's output buffers */
3955 /* Use RENAME to make sure the DB file is changed atomically only
3956 * if the generate DB file is ok. */
3957 if (rename(tmpfile
,filename
) == -1) {
3958 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3962 redisLog(REDIS_NOTICE
,"DB saved on disk");
3964 server
.lastsave
= time(NULL
);
3970 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3971 if (di
) dictReleaseIterator(di
);
3975 static int rdbSaveBackground(char *filename
) {
3978 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3979 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3980 if ((childpid
= fork()) == 0) {
3982 if (server
.vm_enabled
) vmReopenSwapFile();
3984 if (rdbSave(filename
) == REDIS_OK
) {
3991 if (childpid
== -1) {
3992 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3996 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3997 server
.bgsavechildpid
= childpid
;
3998 updateDictResizePolicy();
4001 return REDIS_OK
; /* unreached */
4004 static void rdbRemoveTempFile(pid_t childpid
) {
4007 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
4011 static int rdbLoadType(FILE *fp
) {
4013 if (fread(&type
,1,1,fp
) == 0) return -1;
4017 static time_t rdbLoadTime(FILE *fp
) {
4019 if (fread(&t32
,4,1,fp
) == 0) return -1;
4020 return (time_t) t32
;
4023 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
4024 * of this file for a description of how this are stored on disk.
4026 * isencoded is set to 1 if the readed length is not actually a length but
4027 * an "encoding type", check the above comments for more info */
4028 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
4029 unsigned char buf
[2];
4033 if (isencoded
) *isencoded
= 0;
4034 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
4035 type
= (buf
[0]&0xC0)>>6;
4036 if (type
== REDIS_RDB_6BITLEN
) {
4037 /* Read a 6 bit len */
4039 } else if (type
== REDIS_RDB_ENCVAL
) {
4040 /* Read a 6 bit len encoding type */
4041 if (isencoded
) *isencoded
= 1;
4043 } else if (type
== REDIS_RDB_14BITLEN
) {
4044 /* Read a 14 bit len */
4045 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
4046 return ((buf
[0]&0x3F)<<8)|buf
[1];
4048 /* Read a 32 bit len */
4049 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
4054 /* Load an integer-encoded object from file 'fp', with the specified
4055 * encoding type 'enctype'. If encode is true the function may return
4056 * an integer-encoded object as reply, otherwise the returned object
4057 * will always be encoded as a raw string. */
4058 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
4059 unsigned char enc
[4];
4062 if (enctype
== REDIS_RDB_ENC_INT8
) {
4063 if (fread(enc
,1,1,fp
) == 0) return NULL
;
4064 val
= (signed char)enc
[0];
4065 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
4067 if (fread(enc
,2,1,fp
) == 0) return NULL
;
4068 v
= enc
[0]|(enc
[1]<<8);
4070 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
4072 if (fread(enc
,4,1,fp
) == 0) return NULL
;
4073 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
4076 val
= 0; /* anti-warning */
4077 redisPanic("Unknown RDB integer encoding type");
4080 return createStringObjectFromLongLong(val
);
4082 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
4085 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
4086 unsigned int len
, clen
;
4087 unsigned char *c
= NULL
;
4090 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4091 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4092 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
4093 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
4094 if (fread(c
,clen
,1,fp
) == 0) goto err
;
4095 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
4097 return createObject(REDIS_STRING
,val
);
4104 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
4109 len
= rdbLoadLen(fp
,&isencoded
);
4112 case REDIS_RDB_ENC_INT8
:
4113 case REDIS_RDB_ENC_INT16
:
4114 case REDIS_RDB_ENC_INT32
:
4115 return rdbLoadIntegerObject(fp
,len
,encode
);
4116 case REDIS_RDB_ENC_LZF
:
4117 return rdbLoadLzfStringObject(fp
);
4119 redisPanic("Unknown RDB encoding type");
4123 if (len
== REDIS_RDB_LENERR
) return NULL
;
4124 val
= sdsnewlen(NULL
,len
);
4125 if (len
&& fread(val
,len
,1,fp
) == 0) {
4129 return createObject(REDIS_STRING
,val
);
4132 static robj
*rdbLoadStringObject(FILE *fp
) {
4133 return rdbGenericLoadStringObject(fp
,0);
4136 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
4137 return rdbGenericLoadStringObject(fp
,1);
4140 /* For information about double serialization check rdbSaveDoubleValue() */
4141 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
4145 if (fread(&len
,1,1,fp
) == 0) return -1;
4147 case 255: *val
= R_NegInf
; return 0;
4148 case 254: *val
= R_PosInf
; return 0;
4149 case 253: *val
= R_Nan
; return 0;
4151 if (fread(buf
,len
,1,fp
) == 0) return -1;
4153 sscanf(buf
, "%lg", val
);
4158 /* Load a Redis object of the specified type from the specified file.
4159 * On success a newly allocated object is returned, otherwise NULL. */
4160 static robj
*rdbLoadObject(int type
, FILE *fp
) {
4161 robj
*o
, *ele
, *dec
;
4164 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
4165 if (type
== REDIS_STRING
) {
4166 /* Read string value */
4167 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4168 o
= tryObjectEncoding(o
);
4169 } else if (type
== REDIS_LIST
) {
4170 /* Read list value */
4171 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4173 /* Use a real list when there are too many entries */
4174 if (len
> server
.list_max_ziplist_entries
) {
4175 o
= createListObject();
4177 o
= createZiplistObject();
4180 /* Load every single element of the list */
4182 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4184 /* If we are using a ziplist and the value is too big, convert
4185 * the object to a real list. */
4186 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
&&
4187 ele
->encoding
== REDIS_ENCODING_RAW
&&
4188 sdslen(ele
->ptr
) > server
.list_max_ziplist_value
)
4189 listTypeConvert(o
,REDIS_ENCODING_LIST
);
4191 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4192 dec
= getDecodedObject(ele
);
4193 o
->ptr
= ziplistPush(o
->ptr
,dec
->ptr
,sdslen(dec
->ptr
),REDIS_TAIL
);
4197 ele
= tryObjectEncoding(ele
);
4198 listAddNodeTail(o
->ptr
,ele
);
4201 } else if (type
== REDIS_SET
) {
4202 /* Read list/set value */
4203 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4204 o
= createSetObject();
4205 /* It's faster to expand the dict to the right size asap in order
4206 * to avoid rehashing */
4207 if (len
> DICT_HT_INITIAL_SIZE
)
4208 dictExpand(o
->ptr
,len
);
4209 /* Load every single element of the list/set */
4211 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4212 ele
= tryObjectEncoding(ele
);
4213 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
4215 } else if (type
== REDIS_ZSET
) {
4216 /* Read list/set value */
4220 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4221 o
= createZsetObject();
4223 /* Load every single element of the list/set */
4226 double *score
= zmalloc(sizeof(double));
4228 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4229 ele
= tryObjectEncoding(ele
);
4230 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
4231 dictAdd(zs
->dict
,ele
,score
);
4232 zslInsert(zs
->zsl
,*score
,ele
);
4233 incrRefCount(ele
); /* added to skiplist */
4235 } else if (type
== REDIS_HASH
) {
4238 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4239 o
= createHashObject();
4240 /* Too many entries? Use an hash table. */
4241 if (hashlen
> server
.hash_max_zipmap_entries
)
4242 convertToRealHash(o
);
4243 /* Load every key/value, then set it into the zipmap or hash
4244 * table, as needed. */
4248 if ((key
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4249 if ((val
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4250 /* If we are using a zipmap and there are too big values
4251 * the object is converted to real hash table encoding. */
4252 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4253 ((key
->encoding
== REDIS_ENCODING_RAW
&&
4254 sdslen(key
->ptr
) > server
.hash_max_zipmap_value
) ||
4255 (val
->encoding
== REDIS_ENCODING_RAW
&&
4256 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
)))
4258 convertToRealHash(o
);
4261 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
4262 unsigned char *zm
= o
->ptr
;
4263 robj
*deckey
, *decval
;
4265 /* We need raw string objects to add them to the zipmap */
4266 deckey
= getDecodedObject(key
);
4267 decval
= getDecodedObject(val
);
4268 zm
= zipmapSet(zm
,deckey
->ptr
,sdslen(deckey
->ptr
),
4269 decval
->ptr
,sdslen(decval
->ptr
),NULL
);
4271 decrRefCount(deckey
);
4272 decrRefCount(decval
);
4276 key
= tryObjectEncoding(key
);
4277 val
= tryObjectEncoding(val
);
4278 dictAdd((dict
*)o
->ptr
,key
,val
);
4282 redisPanic("Unknown object type");
4287 static int rdbLoad(char *filename
) {
4290 int type
, retval
, rdbver
;
4291 int swap_all_values
= 0;
4292 redisDb
*db
= server
.db
+0;
4294 time_t expiretime
, now
= time(NULL
);
4296 fp
= fopen(filename
,"r");
4297 if (!fp
) return REDIS_ERR
;
4298 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4300 if (memcmp(buf
,"REDIS",5) != 0) {
4302 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4305 rdbver
= atoi(buf
+5);
4308 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4317 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4318 if (type
== REDIS_EXPIRETIME
) {
4319 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4320 /* We read the time so we need to read the object type again */
4321 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4323 if (type
== REDIS_EOF
) break;
4324 /* Handle SELECT DB opcode as a special case */
4325 if (type
== REDIS_SELECTDB
) {
4326 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4328 if (dbid
>= (unsigned)server
.dbnum
) {
4329 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4332 db
= server
.db
+dbid
;
4336 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4338 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4339 /* Check if the key already expired */
4340 if (expiretime
!= -1 && expiretime
< now
) {
4345 /* Add the new object in the hash table */
4346 retval
= dbAdd(db
,key
,val
);
4347 if (retval
== REDIS_ERR
) {
4348 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4351 /* Set the expire time if needed */
4352 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4354 /* Handle swapping while loading big datasets when VM is on */
4356 /* If we detecter we are hopeless about fitting something in memory
4357 * we just swap every new key on disk. Directly...
4358 * Note that's important to check for this condition before resorting
4359 * to random sampling, otherwise we may try to swap already
4361 if (swap_all_values
) {
4362 dictEntry
*de
= dictFind(db
->dict
,key
->ptr
);
4364 /* de may be NULL since the key already expired */
4367 val
= dictGetEntryVal(de
);
4369 if (val
->refcount
== 1 &&
4370 (vp
= vmSwapObjectBlocking(val
)) != NULL
)
4371 dictGetEntryVal(de
) = vp
;
4378 /* Flush data on disk once 32 MB of additional RAM are used... */
4380 if ((zmalloc_used_memory() - server
.vm_max_memory
) > 1024*1024*32)
4383 /* If we have still some hope of having some value fitting memory
4384 * then we try random sampling. */
4385 if (!swap_all_values
&& server
.vm_enabled
&& force_swapout
) {
4386 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4387 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4389 if (zmalloc_used_memory() > server
.vm_max_memory
)
4390 swap_all_values
= 1; /* We are already using too much mem */
4396 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4397 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4399 return REDIS_ERR
; /* Just to avoid warning */
4402 /*================================== Shutdown =============================== */
4403 static int prepareForShutdown() {
4404 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4405 /* Kill the saving child if there is a background saving in progress.
4406 We want to avoid race conditions, for instance our saving child may
4407 overwrite the synchronous saving did by SHUTDOWN. */
4408 if (server
.bgsavechildpid
!= -1) {
4409 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4410 kill(server
.bgsavechildpid
,SIGKILL
);
4411 rdbRemoveTempFile(server
.bgsavechildpid
);
4413 if (server
.appendonly
) {
4414 /* Append only file: fsync() the AOF and exit */
4415 aof_fsync(server
.appendfd
);
4416 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4418 /* Snapshotting. Perform a SYNC SAVE and exit */
4419 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4420 if (server
.daemonize
)
4421 unlink(server
.pidfile
);
4422 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4424 /* Ooops.. error saving! The best we can do is to continue
4425 * operating. Note that if there was a background saving process,
4426 * in the next cron() Redis will be notified that the background
4427 * saving aborted, handling special stuff like slaves pending for
4428 * synchronization... */
4429 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4433 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4437 /*================================== Commands =============================== */
4439 static void authCommand(redisClient
*c
) {
4440 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4441 c
->authenticated
= 1;
4442 addReply(c
,shared
.ok
);
4444 c
->authenticated
= 0;
4445 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4449 static void pingCommand(redisClient
*c
) {
4450 addReply(c
,shared
.pong
);
4453 static void echoCommand(redisClient
*c
) {
4454 addReplyBulk(c
,c
->argv
[1]);
4457 /*=================================== Strings =============================== */
4459 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4461 long seconds
= 0; /* initialized to avoid an harmness warning */
4464 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4467 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4472 touchWatchedKey(c
->db
,key
);
4473 if (nx
) deleteIfVolatile(c
->db
,key
);
4474 retval
= dbAdd(c
->db
,key
,val
);
4475 if (retval
== REDIS_ERR
) {
4477 dbReplace(c
->db
,key
,val
);
4480 addReply(c
,shared
.czero
);
4487 removeExpire(c
->db
,key
);
4488 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4489 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4492 static void setCommand(redisClient
*c
) {
4493 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4496 static void setnxCommand(redisClient
*c
) {
4497 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4500 static void setexCommand(redisClient
*c
) {
4501 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4504 static int getGenericCommand(redisClient
*c
) {
4507 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4510 if (o
->type
!= REDIS_STRING
) {
4511 addReply(c
,shared
.wrongtypeerr
);
4519 static void getCommand(redisClient
*c
) {
4520 getGenericCommand(c
);
4523 static void getsetCommand(redisClient
*c
) {
4524 if (getGenericCommand(c
) == REDIS_ERR
) return;
4525 dbReplace(c
->db
,c
->argv
[1],c
->argv
[2]);
4526 incrRefCount(c
->argv
[2]);
4528 removeExpire(c
->db
,c
->argv
[1]);
4531 static void mgetCommand(redisClient
*c
) {
4534 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4535 for (j
= 1; j
< c
->argc
; j
++) {
4536 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4538 addReply(c
,shared
.nullbulk
);
4540 if (o
->type
!= REDIS_STRING
) {
4541 addReply(c
,shared
.nullbulk
);
4549 static void msetGenericCommand(redisClient
*c
, int nx
) {
4550 int j
, busykeys
= 0;
4552 if ((c
->argc
% 2) == 0) {
4553 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4556 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4557 * set nothing at all if at least one already key exists. */
4559 for (j
= 1; j
< c
->argc
; j
+= 2) {
4560 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4566 addReply(c
, shared
.czero
);
4570 for (j
= 1; j
< c
->argc
; j
+= 2) {
4571 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4572 dbReplace(c
->db
,c
->argv
[j
],c
->argv
[j
+1]);
4573 incrRefCount(c
->argv
[j
+1]);
4574 removeExpire(c
->db
,c
->argv
[j
]);
4576 server
.dirty
+= (c
->argc
-1)/2;
4577 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4580 static void msetCommand(redisClient
*c
) {
4581 msetGenericCommand(c
,0);
4584 static void msetnxCommand(redisClient
*c
) {
4585 msetGenericCommand(c
,1);
4588 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4592 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4593 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4594 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4597 o
= createStringObjectFromLongLong(value
);
4598 dbReplace(c
->db
,c
->argv
[1],o
);
4600 addReply(c
,shared
.colon
);
4602 addReply(c
,shared
.crlf
);
4605 static void incrCommand(redisClient
*c
) {
4606 incrDecrCommand(c
,1);
4609 static void decrCommand(redisClient
*c
) {
4610 incrDecrCommand(c
,-1);
4613 static void incrbyCommand(redisClient
*c
) {
4616 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4617 incrDecrCommand(c
,incr
);
4620 static void decrbyCommand(redisClient
*c
) {
4623 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4624 incrDecrCommand(c
,-incr
);
4627 static void appendCommand(redisClient
*c
) {
4632 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4634 /* Create the key */
4635 retval
= dbAdd(c
->db
,c
->argv
[1],c
->argv
[2]);
4636 incrRefCount(c
->argv
[2]);
4637 totlen
= stringObjectLen(c
->argv
[2]);
4639 if (o
->type
!= REDIS_STRING
) {
4640 addReply(c
,shared
.wrongtypeerr
);
4643 /* If the object is specially encoded or shared we have to make
4645 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4646 robj
*decoded
= getDecodedObject(o
);
4648 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4649 decrRefCount(decoded
);
4650 dbReplace(c
->db
,c
->argv
[1],o
);
4653 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4654 o
->ptr
= sdscatlen(o
->ptr
,
4655 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4657 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4658 (unsigned long) c
->argv
[2]->ptr
);
4660 totlen
= sdslen(o
->ptr
);
4663 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4666 static void substrCommand(redisClient
*c
) {
4668 long start
= atoi(c
->argv
[2]->ptr
);
4669 long end
= atoi(c
->argv
[3]->ptr
);
4670 size_t rangelen
, strlen
;
4673 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4674 checkType(c
,o
,REDIS_STRING
)) return;
4676 o
= getDecodedObject(o
);
4677 strlen
= sdslen(o
->ptr
);
4679 /* convert negative indexes */
4680 if (start
< 0) start
= strlen
+start
;
4681 if (end
< 0) end
= strlen
+end
;
4682 if (start
< 0) start
= 0;
4683 if (end
< 0) end
= 0;
4685 /* indexes sanity checks */
4686 if (start
> end
|| (size_t)start
>= strlen
) {
4687 /* Out of range start or start > end result in null reply */
4688 addReply(c
,shared
.nullbulk
);
4692 if ((size_t)end
>= strlen
) end
= strlen
-1;
4693 rangelen
= (end
-start
)+1;
4695 /* Return the result */
4696 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4697 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4698 addReplySds(c
,range
);
4699 addReply(c
,shared
.crlf
);
4703 /* ========================= Type agnostic commands ========================= */
4705 static void delCommand(redisClient
*c
) {
4708 for (j
= 1; j
< c
->argc
; j
++) {
4709 if (dbDelete(c
->db
,c
->argv
[j
])) {
4710 touchWatchedKey(c
->db
,c
->argv
[j
]);
4715 addReplyLongLong(c
,deleted
);
4718 static void existsCommand(redisClient
*c
) {
4719 expireIfNeeded(c
->db
,c
->argv
[1]);
4720 if (dbExists(c
->db
,c
->argv
[1])) {
4721 addReply(c
, shared
.cone
);
4723 addReply(c
, shared
.czero
);
4727 static void selectCommand(redisClient
*c
) {
4728 int id
= atoi(c
->argv
[1]->ptr
);
4730 if (selectDb(c
,id
) == REDIS_ERR
) {
4731 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4733 addReply(c
,shared
.ok
);
4737 static void randomkeyCommand(redisClient
*c
) {
4740 if ((key
= dbRandomKey(c
->db
)) == NULL
) {
4741 addReply(c
,shared
.nullbulk
);
4745 addReplyBulk(c
,key
);
4749 static void keysCommand(redisClient
*c
) {
4752 sds pattern
= c
->argv
[1]->ptr
;
4753 int plen
= sdslen(pattern
);
4754 unsigned long numkeys
= 0;
4755 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4757 di
= dictGetIterator(c
->db
->dict
);
4759 decrRefCount(lenobj
);
4760 while((de
= dictNext(di
)) != NULL
) {
4761 sds key
= dictGetEntryKey(de
);
4764 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4765 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4766 keyobj
= createStringObject(key
,sdslen(key
));
4767 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4768 addReplyBulk(c
,keyobj
);
4771 decrRefCount(keyobj
);
4774 dictReleaseIterator(di
);
4775 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4778 static void dbsizeCommand(redisClient
*c
) {
4780 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4783 static void lastsaveCommand(redisClient
*c
) {
4785 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4788 static void typeCommand(redisClient
*c
) {
4792 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4797 case REDIS_STRING
: type
= "+string"; break;
4798 case REDIS_LIST
: type
= "+list"; break;
4799 case REDIS_SET
: type
= "+set"; break;
4800 case REDIS_ZSET
: type
= "+zset"; break;
4801 case REDIS_HASH
: type
= "+hash"; break;
4802 default: type
= "+unknown"; break;
4805 addReplySds(c
,sdsnew(type
));
4806 addReply(c
,shared
.crlf
);
4809 static void saveCommand(redisClient
*c
) {
4810 if (server
.bgsavechildpid
!= -1) {
4811 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4814 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4815 addReply(c
,shared
.ok
);
4817 addReply(c
,shared
.err
);
4821 static void bgsaveCommand(redisClient
*c
) {
4822 if (server
.bgsavechildpid
!= -1) {
4823 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4826 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4827 char *status
= "+Background saving started\r\n";
4828 addReplySds(c
,sdsnew(status
));
4830 addReply(c
,shared
.err
);
4834 static void shutdownCommand(redisClient
*c
) {
4835 if (prepareForShutdown() == REDIS_OK
)
4837 addReplySds(c
, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4840 static void renameGenericCommand(redisClient
*c
, int nx
) {
4843 /* To use the same key as src and dst is probably an error */
4844 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4845 addReply(c
,shared
.sameobjecterr
);
4849 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4853 deleteIfVolatile(c
->db
,c
->argv
[2]);
4854 if (dbAdd(c
->db
,c
->argv
[2],o
) == REDIS_ERR
) {
4857 addReply(c
,shared
.czero
);
4860 dbReplace(c
->db
,c
->argv
[2],o
);
4862 dbDelete(c
->db
,c
->argv
[1]);
4863 touchWatchedKey(c
->db
,c
->argv
[2]);
4865 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4868 static void renameCommand(redisClient
*c
) {
4869 renameGenericCommand(c
,0);
4872 static void renamenxCommand(redisClient
*c
) {
4873 renameGenericCommand(c
,1);
4876 static void moveCommand(redisClient
*c
) {
4881 /* Obtain source and target DB pointers */
4884 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4885 addReply(c
,shared
.outofrangeerr
);
4889 selectDb(c
,srcid
); /* Back to the source DB */
4891 /* If the user is moving using as target the same
4892 * DB as the source DB it is probably an error. */
4894 addReply(c
,shared
.sameobjecterr
);
4898 /* Check if the element exists and get a reference */
4899 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4901 addReply(c
,shared
.czero
);
4905 /* Try to add the element to the target DB */
4906 deleteIfVolatile(dst
,c
->argv
[1]);
4907 if (dbAdd(dst
,c
->argv
[1],o
) == REDIS_ERR
) {
4908 addReply(c
,shared
.czero
);
4913 /* OK! key moved, free the entry in the source DB */
4914 dbDelete(src
,c
->argv
[1]);
4916 addReply(c
,shared
.cone
);
4919 /* =================================== Lists ================================ */
4922 /* Check the argument length to see if it requires us to convert the ziplist
4923 * to a real list. Only check raw-encoded objects because integer encoded
4924 * objects are never too long. */
4925 static void listTypeTryConversion(robj
*subject
, robj
*value
) {
4926 if (subject
->encoding
!= REDIS_ENCODING_ZIPLIST
) return;
4927 if (value
->encoding
== REDIS_ENCODING_RAW
&&
4928 sdslen(value
->ptr
) > server
.list_max_ziplist_value
)
4929 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
4932 static void listTypePush(robj
*subject
, robj
*value
, int where
) {
4933 /* Check if we need to convert the ziplist */
4934 listTypeTryConversion(subject
,value
);
4935 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
&&
4936 ziplistLen(subject
->ptr
) >= server
.list_max_ziplist_entries
)
4937 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
4939 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4940 int pos
= (where
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4941 value
= getDecodedObject(value
);
4942 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),pos
);
4943 decrRefCount(value
);
4944 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4945 if (where
== REDIS_HEAD
) {
4946 listAddNodeHead(subject
->ptr
,value
);
4948 listAddNodeTail(subject
->ptr
,value
);
4950 incrRefCount(value
);
4952 redisPanic("Unknown list encoding");
4956 static robj
*listTypePop(robj
*subject
, int where
) {
4958 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4960 unsigned char *vstr
;
4963 int pos
= (where
== REDIS_HEAD
) ? 0 : -1;
4964 p
= ziplistIndex(subject
->ptr
,pos
);
4965 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
4967 value
= createStringObject((char*)vstr
,vlen
);
4969 value
= createStringObjectFromLongLong(vlong
);
4971 /* We only need to delete an element when it exists */
4972 subject
->ptr
= ziplistDelete(subject
->ptr
,&p
);
4974 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4975 list
*list
= subject
->ptr
;
4977 if (where
== REDIS_HEAD
) {
4978 ln
= listFirst(list
);
4980 ln
= listLast(list
);
4983 value
= listNodeValue(ln
);
4984 incrRefCount(value
);
4985 listDelNode(list
,ln
);
4988 redisPanic("Unknown list encoding");
4993 static unsigned long listTypeLength(robj
*subject
) {
4994 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4995 return ziplistLen(subject
->ptr
);
4996 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4997 return listLength((list
*)subject
->ptr
);
4999 redisPanic("Unknown list encoding");
5003 /* Structure to hold set iteration abstraction. */
5006 unsigned char encoding
;
5007 unsigned char direction
; /* Iteration direction */
5012 /* Structure for an entry while iterating over a list. */
5014 listTypeIterator
*li
;
5015 unsigned char *zi
; /* Entry in ziplist */
5016 listNode
*ln
; /* Entry in linked list */
5019 /* Initialize an iterator at the specified index. */
5020 static listTypeIterator
*listTypeInitIterator(robj
*subject
, int index
, unsigned char direction
) {
5021 listTypeIterator
*li
= zmalloc(sizeof(listTypeIterator
));
5022 li
->subject
= subject
;
5023 li
->encoding
= subject
->encoding
;
5024 li
->direction
= direction
;
5025 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5026 li
->zi
= ziplistIndex(subject
->ptr
,index
);
5027 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5028 li
->ln
= listIndex(subject
->ptr
,index
);
5030 redisPanic("Unknown list encoding");
5035 /* Clean up the iterator. */
5036 static void listTypeReleaseIterator(listTypeIterator
*li
) {
5040 /* Stores pointer to current the entry in the provided entry structure
5041 * and advances the position of the iterator. Returns 1 when the current
5042 * entry is in fact an entry, 0 otherwise. */
5043 static int listTypeNext(listTypeIterator
*li
, listTypeEntry
*entry
) {
5044 /* Protect from converting when iterating */
5045 redisAssert(li
->subject
->encoding
== li
->encoding
);
5048 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5050 if (entry
->zi
!= NULL
) {
5051 if (li
->direction
== REDIS_TAIL
)
5052 li
->zi
= ziplistNext(li
->subject
->ptr
,li
->zi
);
5054 li
->zi
= ziplistPrev(li
->subject
->ptr
,li
->zi
);
5057 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5059 if (entry
->ln
!= NULL
) {
5060 if (li
->direction
== REDIS_TAIL
)
5061 li
->ln
= li
->ln
->next
;
5063 li
->ln
= li
->ln
->prev
;
5067 redisPanic("Unknown list encoding");
5072 /* Return entry or NULL at the current position of the iterator. */
5073 static robj
*listTypeGet(listTypeEntry
*entry
) {
5074 listTypeIterator
*li
= entry
->li
;
5076 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5077 unsigned char *vstr
;
5080 redisAssert(entry
->zi
!= NULL
);
5081 if (ziplistGet(entry
->zi
,&vstr
,&vlen
,&vlong
)) {
5083 value
= createStringObject((char*)vstr
,vlen
);
5085 value
= createStringObjectFromLongLong(vlong
);
5088 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5089 redisAssert(entry
->ln
!= NULL
);
5090 value
= listNodeValue(entry
->ln
);
5091 incrRefCount(value
);
5093 redisPanic("Unknown list encoding");
5098 static void listTypeInsert(listTypeEntry
*entry
, robj
*value
, int where
) {
5099 robj
*subject
= entry
->li
->subject
;
5100 if (entry
->li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5101 value
= getDecodedObject(value
);
5102 if (where
== REDIS_TAIL
) {
5103 unsigned char *next
= ziplistNext(subject
->ptr
,entry
->zi
);
5105 /* When we insert after the current element, but the current element
5106 * is the tail of the list, we need to do a push. */
5108 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),REDIS_TAIL
);
5110 subject
->ptr
= ziplistInsert(subject
->ptr
,next
,value
->ptr
,sdslen(value
->ptr
));
5113 subject
->ptr
= ziplistInsert(subject
->ptr
,entry
->zi
,value
->ptr
,sdslen(value
->ptr
));
5115 decrRefCount(value
);
5116 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
5117 if (where
== REDIS_TAIL
) {
5118 listInsertNode(subject
->ptr
,entry
->ln
,value
,AL_START_TAIL
);
5120 listInsertNode(subject
->ptr
,entry
->ln
,value
,AL_START_HEAD
);
5122 incrRefCount(value
);
5124 redisPanic("Unknown list encoding");
5128 /* Compare the given object with the entry at the current position. */
5129 static int listTypeEqual(listTypeEntry
*entry
, robj
*o
) {
5130 listTypeIterator
*li
= entry
->li
;
5131 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5132 redisAssert(o
->encoding
== REDIS_ENCODING_RAW
);
5133 return ziplistCompare(entry
->zi
,o
->ptr
,sdslen(o
->ptr
));
5134 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5135 return equalStringObjects(o
,listNodeValue(entry
->ln
));
5137 redisPanic("Unknown list encoding");
5141 /* Delete the element pointed to. */
5142 static void listTypeDelete(listTypeEntry
*entry
) {
5143 listTypeIterator
*li
= entry
->li
;
5144 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5145 unsigned char *p
= entry
->zi
;
5146 li
->subject
->ptr
= ziplistDelete(li
->subject
->ptr
,&p
);
5148 /* Update position of the iterator depending on the direction */
5149 if (li
->direction
== REDIS_TAIL
)
5152 li
->zi
= ziplistPrev(li
->subject
->ptr
,p
);
5153 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
5155 if (li
->direction
== REDIS_TAIL
)
5156 next
= entry
->ln
->next
;
5158 next
= entry
->ln
->prev
;
5159 listDelNode(li
->subject
->ptr
,entry
->ln
);
5162 redisPanic("Unknown list encoding");
5166 static void listTypeConvert(robj
*subject
, int enc
) {
5167 listTypeIterator
*li
;
5168 listTypeEntry entry
;
5169 redisAssert(subject
->type
== REDIS_LIST
);
5171 if (enc
== REDIS_ENCODING_LIST
) {
5172 list
*l
= listCreate();
5173 listSetFreeMethod(l
,decrRefCount
);
5175 /* listTypeGet returns a robj with incremented refcount */
5176 li
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5177 while (listTypeNext(li
,&entry
)) listAddNodeTail(l
,listTypeGet(&entry
));
5178 listTypeReleaseIterator(li
);
5180 subject
->encoding
= REDIS_ENCODING_LIST
;
5181 zfree(subject
->ptr
);
5184 redisPanic("Unsupported list conversion");
5188 static void pushGenericCommand(redisClient
*c
, int where
) {
5189 robj
*lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5191 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5192 addReply(c
,shared
.cone
);
5195 lobj
= createZiplistObject();
5196 dbAdd(c
->db
,c
->argv
[1],lobj
);
5198 if (lobj
->type
!= REDIS_LIST
) {
5199 addReply(c
,shared
.wrongtypeerr
);
5202 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5203 addReply(c
,shared
.cone
);
5207 listTypePush(lobj
,c
->argv
[2],where
);
5208 addReplyLongLong(c
,listTypeLength(lobj
));
5212 static void lpushCommand(redisClient
*c
) {
5213 pushGenericCommand(c
,REDIS_HEAD
);
5216 static void rpushCommand(redisClient
*c
) {
5217 pushGenericCommand(c
,REDIS_TAIL
);
5220 static void pushxGenericCommand(redisClient
*c
, robj
*refval
, robj
*val
, int where
) {
5222 listTypeIterator
*iter
;
5223 listTypeEntry entry
;
5226 if ((subject
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5227 checkType(c
,subject
,REDIS_LIST
)) return;
5229 if (refval
!= NULL
) {
5230 /* Note: we expect refval to be string-encoded because it is *not* the
5231 * last argument of the multi-bulk LINSERT. */
5232 redisAssert(refval
->encoding
== REDIS_ENCODING_RAW
);
5234 /* We're not sure if this value can be inserted yet, but we cannot
5235 * convert the list inside the iterator. We don't want to loop over
5236 * the list twice (once to see if the value can be inserted and once
5237 * to do the actual insert), so we assume this value can be inserted
5238 * and convert the ziplist to a regular list if necessary. */
5239 listTypeTryConversion(subject
,val
);
5241 /* Seek refval from head to tail */
5242 iter
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5243 while (listTypeNext(iter
,&entry
)) {
5244 if (listTypeEqual(&entry
,refval
)) {
5245 listTypeInsert(&entry
,val
,where
);
5250 listTypeReleaseIterator(iter
);
5253 /* Check if the length exceeds the ziplist length threshold. */
5254 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
&&
5255 ziplistLen(subject
->ptr
) > server
.list_max_ziplist_entries
)
5256 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
5259 /* Notify client of a failed insert */
5260 addReply(c
,shared
.cnegone
);
5264 listTypePush(subject
,val
,where
);
5268 addReplyUlong(c
,listTypeLength(subject
));
5271 static void lpushxCommand(redisClient
*c
) {
5272 pushxGenericCommand(c
,NULL
,c
->argv
[2],REDIS_HEAD
);
5275 static void rpushxCommand(redisClient
*c
) {
5276 pushxGenericCommand(c
,NULL
,c
->argv
[2],REDIS_TAIL
);
5279 static void linsertCommand(redisClient
*c
) {
5280 if (strcasecmp(c
->argv
[2]->ptr
,"after") == 0) {
5281 pushxGenericCommand(c
,c
->argv
[3],c
->argv
[4],REDIS_TAIL
);
5282 } else if (strcasecmp(c
->argv
[2]->ptr
,"before") == 0) {
5283 pushxGenericCommand(c
,c
->argv
[3],c
->argv
[4],REDIS_HEAD
);
5285 addReply(c
,shared
.syntaxerr
);
5289 static void llenCommand(redisClient
*c
) {
5290 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
);
5291 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5292 addReplyUlong(c
,listTypeLength(o
));
5295 static void lindexCommand(redisClient
*c
) {
5296 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5297 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5298 int index
= atoi(c
->argv
[2]->ptr
);
5301 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5303 unsigned char *vstr
;
5306 p
= ziplistIndex(o
->ptr
,index
);
5307 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
5309 value
= createStringObject((char*)vstr
,vlen
);
5311 value
= createStringObjectFromLongLong(vlong
);
5313 addReplyBulk(c
,value
);
5314 decrRefCount(value
);
5316 addReply(c
,shared
.nullbulk
);
5318 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5319 listNode
*ln
= listIndex(o
->ptr
,index
);
5321 value
= listNodeValue(ln
);
5322 addReplyBulk(c
,value
);
5324 addReply(c
,shared
.nullbulk
);
5327 redisPanic("Unknown list encoding");
5331 static void lsetCommand(redisClient
*c
) {
5332 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
);
5333 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5334 int index
= atoi(c
->argv
[2]->ptr
);
5335 robj
*value
= c
->argv
[3];
5337 listTypeTryConversion(o
,value
);
5338 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5339 unsigned char *p
, *zl
= o
->ptr
;
5340 p
= ziplistIndex(zl
,index
);
5342 addReply(c
,shared
.outofrangeerr
);
5344 o
->ptr
= ziplistDelete(o
->ptr
,&p
);
5345 value
= getDecodedObject(value
);
5346 o
->ptr
= ziplistInsert(o
->ptr
,p
,value
->ptr
,sdslen(value
->ptr
));
5347 decrRefCount(value
);
5348 addReply(c
,shared
.ok
);
5351 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5352 listNode
*ln
= listIndex(o
->ptr
,index
);
5354 addReply(c
,shared
.outofrangeerr
);
5356 decrRefCount((robj
*)listNodeValue(ln
));
5357 listNodeValue(ln
) = value
;
5358 incrRefCount(value
);
5359 addReply(c
,shared
.ok
);
5363 redisPanic("Unknown list encoding");
5367 static void popGenericCommand(redisClient
*c
, int where
) {
5368 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5369 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5371 robj
*value
= listTypePop(o
,where
);
5372 if (value
== NULL
) {
5373 addReply(c
,shared
.nullbulk
);
5375 addReplyBulk(c
,value
);
5376 decrRefCount(value
);
5377 if (listTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5382 static void lpopCommand(redisClient
*c
) {
5383 popGenericCommand(c
,REDIS_HEAD
);
5386 static void rpopCommand(redisClient
*c
) {
5387 popGenericCommand(c
,REDIS_TAIL
);
5390 static void lrangeCommand(redisClient
*c
) {
5392 int start
= atoi(c
->argv
[2]->ptr
);
5393 int end
= atoi(c
->argv
[3]->ptr
);
5396 listTypeEntry entry
;
5398 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5399 || checkType(c
,o
,REDIS_LIST
)) return;
5400 llen
= listTypeLength(o
);
5402 /* convert negative indexes */
5403 if (start
< 0) start
= llen
+start
;
5404 if (end
< 0) end
= llen
+end
;
5405 if (start
< 0) start
= 0;
5406 if (end
< 0) end
= 0;
5408 /* indexes sanity checks */
5409 if (start
> end
|| start
>= llen
) {
5410 /* Out of range start or start > end result in empty list */
5411 addReply(c
,shared
.emptymultibulk
);
5414 if (end
>= llen
) end
= llen
-1;
5415 rangelen
= (end
-start
)+1;
5417 /* Return the result in form of a multi-bulk reply */
5418 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
5419 listTypeIterator
*li
= listTypeInitIterator(o
,start
,REDIS_TAIL
);
5420 for (j
= 0; j
< rangelen
; j
++) {
5421 redisAssert(listTypeNext(li
,&entry
));
5422 value
= listTypeGet(&entry
);
5423 addReplyBulk(c
,value
);
5424 decrRefCount(value
);
5426 listTypeReleaseIterator(li
);
5429 static void ltrimCommand(redisClient
*c
) {
5431 int start
= atoi(c
->argv
[2]->ptr
);
5432 int end
= atoi(c
->argv
[3]->ptr
);
5434 int j
, ltrim
, rtrim
;
5438 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
5439 checkType(c
,o
,REDIS_LIST
)) return;
5440 llen
= listTypeLength(o
);
5442 /* convert negative indexes */
5443 if (start
< 0) start
= llen
+start
;
5444 if (end
< 0) end
= llen
+end
;
5445 if (start
< 0) start
= 0;
5446 if (end
< 0) end
= 0;
5448 /* indexes sanity checks */
5449 if (start
> end
|| start
>= llen
) {
5450 /* Out of range start or start > end result in empty list */
5454 if (end
>= llen
) end
= llen
-1;
5459 /* Remove list elements to perform the trim */
5460 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5461 o
->ptr
= ziplistDeleteRange(o
->ptr
,0,ltrim
);
5462 o
->ptr
= ziplistDeleteRange(o
->ptr
,-rtrim
,rtrim
);
5463 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5465 for (j
= 0; j
< ltrim
; j
++) {
5466 ln
= listFirst(list
);
5467 listDelNode(list
,ln
);
5469 for (j
= 0; j
< rtrim
; j
++) {
5470 ln
= listLast(list
);
5471 listDelNode(list
,ln
);
5474 redisPanic("Unknown list encoding");
5476 if (listTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5478 addReply(c
,shared
.ok
);
5481 static void lremCommand(redisClient
*c
) {
5482 robj
*subject
, *obj
= c
->argv
[3];
5483 int toremove
= atoi(c
->argv
[2]->ptr
);
5485 listTypeEntry entry
;
5487 subject
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
);
5488 if (subject
== NULL
|| checkType(c
,subject
,REDIS_LIST
)) return;
5490 /* Make sure obj is raw when we're dealing with a ziplist */
5491 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5492 obj
= getDecodedObject(obj
);
5494 listTypeIterator
*li
;
5496 toremove
= -toremove
;
5497 li
= listTypeInitIterator(subject
,-1,REDIS_HEAD
);
5499 li
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5502 while (listTypeNext(li
,&entry
)) {
5503 if (listTypeEqual(&entry
,obj
)) {
5504 listTypeDelete(&entry
);
5507 if (toremove
&& removed
== toremove
) break;
5510 listTypeReleaseIterator(li
);
5512 /* Clean up raw encoded object */
5513 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5516 if (listTypeLength(subject
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5517 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
5520 /* This is the semantic of this command:
5521 * RPOPLPUSH srclist dstlist:
5522 * IF LLEN(srclist) > 0
5523 * element = RPOP srclist
5524 * LPUSH dstlist element
5531 * The idea is to be able to get an element from a list in a reliable way
5532 * since the element is not just returned but pushed against another list
5533 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5535 static void rpoplpushcommand(redisClient
*c
) {
5537 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5538 checkType(c
,sobj
,REDIS_LIST
)) return;
5540 if (listTypeLength(sobj
) == 0) {
5541 addReply(c
,shared
.nullbulk
);
5543 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5544 if (dobj
&& checkType(c
,dobj
,REDIS_LIST
)) return;
5545 value
= listTypePop(sobj
,REDIS_TAIL
);
5547 /* Add the element to the target list (unless it's directly
5548 * passed to some BLPOP-ing client */
5549 if (!handleClientsWaitingListPush(c
,c
->argv
[2],value
)) {
5550 /* Create the list if the key does not exist */
5552 dobj
= createZiplistObject();
5553 dbAdd(c
->db
,c
->argv
[2],dobj
);
5555 listTypePush(dobj
,value
,REDIS_HEAD
);
5558 /* Send the element to the client as reply as well */
5559 addReplyBulk(c
,value
);
5561 /* listTypePop returns an object with its refcount incremented */
5562 decrRefCount(value
);
5564 /* Delete the source list when it is empty */
5565 if (listTypeLength(sobj
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5570 /* ==================================== Sets ================================ */
5572 static void saddCommand(redisClient
*c
) {
5575 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5577 set
= createSetObject();
5578 dbAdd(c
->db
,c
->argv
[1],set
);
5580 if (set
->type
!= REDIS_SET
) {
5581 addReply(c
,shared
.wrongtypeerr
);
5585 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5586 incrRefCount(c
->argv
[2]);
5588 addReply(c
,shared
.cone
);
5590 addReply(c
,shared
.czero
);
5594 static void sremCommand(redisClient
*c
) {
5597 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5598 checkType(c
,set
,REDIS_SET
)) return;
5600 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5602 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5603 if (dictSize((dict
*)set
->ptr
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5604 addReply(c
,shared
.cone
);
5606 addReply(c
,shared
.czero
);
5610 static void smoveCommand(redisClient
*c
) {
5611 robj
*srcset
, *dstset
;
5613 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5614 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5616 /* If the source key does not exist return 0, if it's of the wrong type
5618 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5619 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5622 /* Error if the destination key is not a set as well */
5623 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5624 addReply(c
,shared
.wrongtypeerr
);
5627 /* Remove the element from the source set */
5628 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5629 /* Key not found in the src set! return zero */
5630 addReply(c
,shared
.czero
);
5633 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5634 dbDelete(c
->db
,c
->argv
[1]);
5636 /* Add the element to the destination set */
5638 dstset
= createSetObject();
5639 dbAdd(c
->db
,c
->argv
[2],dstset
);
5641 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5642 incrRefCount(c
->argv
[3]);
5643 addReply(c
,shared
.cone
);
5646 static void sismemberCommand(redisClient
*c
) {
5649 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5650 checkType(c
,set
,REDIS_SET
)) return;
5652 if (dictFind(set
->ptr
,c
->argv
[2]))
5653 addReply(c
,shared
.cone
);
5655 addReply(c
,shared
.czero
);
5658 static void scardCommand(redisClient
*c
) {
5662 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5663 checkType(c
,o
,REDIS_SET
)) return;
5666 addReplyUlong(c
,dictSize(s
));
5669 static void spopCommand(redisClient
*c
) {
5673 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5674 checkType(c
,set
,REDIS_SET
)) return;
5676 de
= dictGetRandomKey(set
->ptr
);
5678 addReply(c
,shared
.nullbulk
);
5680 robj
*ele
= dictGetEntryKey(de
);
5682 addReplyBulk(c
,ele
);
5683 dictDelete(set
->ptr
,ele
);
5684 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5685 if (dictSize((dict
*)set
->ptr
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5690 static void srandmemberCommand(redisClient
*c
) {
5694 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5695 checkType(c
,set
,REDIS_SET
)) return;
5697 de
= dictGetRandomKey(set
->ptr
);
5699 addReply(c
,shared
.nullbulk
);
5701 robj
*ele
= dictGetEntryKey(de
);
5703 addReplyBulk(c
,ele
);
5707 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5708 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5710 return dictSize(*d1
)-dictSize(*d2
);
5713 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5714 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5717 robj
*lenobj
= NULL
, *dstset
= NULL
;
5718 unsigned long j
, cardinality
= 0;
5720 for (j
= 0; j
< setsnum
; j
++) {
5724 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5725 lookupKeyRead(c
->db
,setskeys
[j
]);
5729 if (dbDelete(c
->db
,dstkey
))
5731 addReply(c
,shared
.czero
);
5733 addReply(c
,shared
.emptymultibulk
);
5737 if (setobj
->type
!= REDIS_SET
) {
5739 addReply(c
,shared
.wrongtypeerr
);
5742 dv
[j
] = setobj
->ptr
;
5744 /* Sort sets from the smallest to largest, this will improve our
5745 * algorithm's performace */
5746 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5748 /* The first thing we should output is the total number of elements...
5749 * since this is a multi-bulk write, but at this stage we don't know
5750 * the intersection set size, so we use a trick, append an empty object
5751 * to the output list and save the pointer to later modify it with the
5754 lenobj
= createObject(REDIS_STRING
,NULL
);
5756 decrRefCount(lenobj
);
5758 /* If we have a target key where to store the resulting set
5759 * create this key with an empty set inside */
5760 dstset
= createSetObject();
5763 /* Iterate all the elements of the first (smallest) set, and test
5764 * the element against all the other sets, if at least one set does
5765 * not include the element it is discarded */
5766 di
= dictGetIterator(dv
[0]);
5768 while((de
= dictNext(di
)) != NULL
) {
5771 for (j
= 1; j
< setsnum
; j
++)
5772 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5774 continue; /* at least one set does not contain the member */
5775 ele
= dictGetEntryKey(de
);
5777 addReplyBulk(c
,ele
);
5780 dictAdd(dstset
->ptr
,ele
,NULL
);
5784 dictReleaseIterator(di
);
5787 /* Store the resulting set into the target, if the intersection
5788 * is not an empty set. */
5789 dbDelete(c
->db
,dstkey
);
5790 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5791 dbAdd(c
->db
,dstkey
,dstset
);
5792 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5794 decrRefCount(dstset
);
5795 addReply(c
,shared
.czero
);
5799 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5804 static void sinterCommand(redisClient
*c
) {
5805 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5808 static void sinterstoreCommand(redisClient
*c
) {
5809 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5812 #define REDIS_OP_UNION 0
5813 #define REDIS_OP_DIFF 1
5814 #define REDIS_OP_INTER 2
5816 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5817 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5820 robj
*dstset
= NULL
;
5821 int j
, cardinality
= 0;
5823 for (j
= 0; j
< setsnum
; j
++) {
5827 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5828 lookupKeyRead(c
->db
,setskeys
[j
]);
5833 if (setobj
->type
!= REDIS_SET
) {
5835 addReply(c
,shared
.wrongtypeerr
);
5838 dv
[j
] = setobj
->ptr
;
5841 /* We need a temp set object to store our union. If the dstkey
5842 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5843 * this set object will be the resulting object to set into the target key*/
5844 dstset
= createSetObject();
5846 /* Iterate all the elements of all the sets, add every element a single
5847 * time to the result set */
5848 for (j
= 0; j
< setsnum
; j
++) {
5849 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5850 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5852 di
= dictGetIterator(dv
[j
]);
5854 while((de
= dictNext(di
)) != NULL
) {
5857 /* dictAdd will not add the same element multiple times */
5858 ele
= dictGetEntryKey(de
);
5859 if (op
== REDIS_OP_UNION
|| j
== 0) {
5860 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5864 } else if (op
== REDIS_OP_DIFF
) {
5865 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5870 dictReleaseIterator(di
);
5872 /* result set is empty? Exit asap. */
5873 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5876 /* Output the content of the resulting set, if not in STORE mode */
5878 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5879 di
= dictGetIterator(dstset
->ptr
);
5880 while((de
= dictNext(di
)) != NULL
) {
5883 ele
= dictGetEntryKey(de
);
5884 addReplyBulk(c
,ele
);
5886 dictReleaseIterator(di
);
5887 decrRefCount(dstset
);
5889 /* If we have a target key where to store the resulting set
5890 * create this key with the result set inside */
5891 dbDelete(c
->db
,dstkey
);
5892 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5893 dbAdd(c
->db
,dstkey
,dstset
);
5894 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5896 decrRefCount(dstset
);
5897 addReply(c
,shared
.czero
);
5904 static void sunionCommand(redisClient
*c
) {
5905 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5908 static void sunionstoreCommand(redisClient
*c
) {
5909 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5912 static void sdiffCommand(redisClient
*c
) {
5913 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5916 static void sdiffstoreCommand(redisClient
*c
) {
5917 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5920 /* ==================================== ZSets =============================== */
5922 /* ZSETs are ordered sets using two data structures to hold the same elements
5923 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5926 * The elements are added to an hash table mapping Redis objects to scores.
5927 * At the same time the elements are added to a skip list mapping scores
5928 * to Redis objects (so objects are sorted by scores in this "view"). */
5930 /* This skiplist implementation is almost a C translation of the original
5931 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5932 * Alternative to Balanced Trees", modified in three ways:
5933 * a) this implementation allows for repeated values.
5934 * b) the comparison is not just by key (our 'score') but by satellite data.
5935 * c) there is a back pointer, so it's a doubly linked list with the back
5936 * pointers being only at "level 1". This allows to traverse the list
5937 * from tail to head, useful for ZREVRANGE. */
5939 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5940 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5942 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5944 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5952 static zskiplist
*zslCreate(void) {
5956 zsl
= zmalloc(sizeof(*zsl
));
5959 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5960 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5961 zsl
->header
->forward
[j
] = NULL
;
5963 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5964 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5965 zsl
->header
->span
[j
] = 0;
5967 zsl
->header
->backward
= NULL
;
5972 static void zslFreeNode(zskiplistNode
*node
) {
5973 decrRefCount(node
->obj
);
5974 zfree(node
->forward
);
5979 static void zslFree(zskiplist
*zsl
) {
5980 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5982 zfree(zsl
->header
->forward
);
5983 zfree(zsl
->header
->span
);
5986 next
= node
->forward
[0];
5993 static int zslRandomLevel(void) {
5995 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5997 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
6000 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
6001 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6002 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
6006 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6007 /* store rank that is crossed to reach the insert position */
6008 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
6010 while (x
->forward
[i
] &&
6011 (x
->forward
[i
]->score
< score
||
6012 (x
->forward
[i
]->score
== score
&&
6013 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
6014 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
6019 /* we assume the key is not already inside, since we allow duplicated
6020 * scores, and the re-insertion of score and redis object should never
6021 * happpen since the caller of zslInsert() should test in the hash table
6022 * if the element is already inside or not. */
6023 level
= zslRandomLevel();
6024 if (level
> zsl
->level
) {
6025 for (i
= zsl
->level
; i
< level
; i
++) {
6027 update
[i
] = zsl
->header
;
6028 update
[i
]->span
[i
-1] = zsl
->length
;
6032 x
= zslCreateNode(level
,score
,obj
);
6033 for (i
= 0; i
< level
; i
++) {
6034 x
->forward
[i
] = update
[i
]->forward
[i
];
6035 update
[i
]->forward
[i
] = x
;
6037 /* update span covered by update[i] as x is inserted here */
6039 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
6040 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
6044 /* increment span for untouched levels */
6045 for (i
= level
; i
< zsl
->level
; i
++) {
6046 update
[i
]->span
[i
-1]++;
6049 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
6051 x
->forward
[0]->backward
= x
;
6057 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
6058 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
6060 for (i
= 0; i
< zsl
->level
; i
++) {
6061 if (update
[i
]->forward
[i
] == x
) {
6063 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
6065 update
[i
]->forward
[i
] = x
->forward
[i
];
6067 /* invariant: i > 0, because update[0]->forward[0]
6068 * is always equal to x */
6069 update
[i
]->span
[i
-1] -= 1;
6072 if (x
->forward
[0]) {
6073 x
->forward
[0]->backward
= x
->backward
;
6075 zsl
->tail
= x
->backward
;
6077 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
6082 /* Delete an element with matching score/object from the skiplist. */
6083 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
6084 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6088 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6089 while (x
->forward
[i
] &&
6090 (x
->forward
[i
]->score
< score
||
6091 (x
->forward
[i
]->score
== score
&&
6092 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
6096 /* We may have multiple elements with the same score, what we need
6097 * is to find the element with both the right score and object. */
6099 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
6100 zslDeleteNode(zsl
, x
, update
);
6104 return 0; /* not found */
6106 return 0; /* not found */
6109 /* Delete all the elements with score between min and max from the skiplist.
6110 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
6111 * Note that this function takes the reference to the hash table view of the
6112 * sorted set, in order to remove the elements from the hash table too. */
6113 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
6114 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6115 unsigned long removed
= 0;
6119 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6120 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
6124 /* We may have multiple elements with the same score, what we need
6125 * is to find the element with both the right score and object. */
6127 while (x
&& x
->score
<= max
) {
6128 zskiplistNode
*next
= x
->forward
[0];
6129 zslDeleteNode(zsl
, x
, update
);
6130 dictDelete(dict
,x
->obj
);
6135 return removed
; /* not found */
6138 /* Delete all the elements with rank between start and end from the skiplist.
6139 * Start and end are inclusive. Note that start and end need to be 1-based */
6140 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
6141 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6142 unsigned long traversed
= 0, removed
= 0;
6146 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6147 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
6148 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
6156 while (x
&& traversed
<= end
) {
6157 zskiplistNode
*next
= x
->forward
[0];
6158 zslDeleteNode(zsl
, x
, update
);
6159 dictDelete(dict
,x
->obj
);
6168 /* Find the first node having a score equal or greater than the specified one.
6169 * Returns NULL if there is no match. */
6170 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
6175 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6176 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
6179 /* We may have multiple elements with the same score, what we need
6180 * is to find the element with both the right score and object. */
6181 return x
->forward
[0];
6184 /* Find the rank for an element by both score and key.
6185 * Returns 0 when the element cannot be found, rank otherwise.
6186 * Note that the rank is 1-based due to the span of zsl->header to the
6188 static unsigned long zslistTypeGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
6190 unsigned long rank
= 0;
6194 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6195 while (x
->forward
[i
] &&
6196 (x
->forward
[i
]->score
< score
||
6197 (x
->forward
[i
]->score
== score
&&
6198 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
6199 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
6203 /* x might be equal to zsl->header, so test if obj is non-NULL */
6204 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
6211 /* Finds an element by its rank. The rank argument needs to be 1-based. */
6212 zskiplistNode
* zslistTypeGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
6214 unsigned long traversed
= 0;
6218 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6219 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
6221 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
6224 if (traversed
== rank
) {
6231 /* The actual Z-commands implementations */
6233 /* This generic command implements both ZADD and ZINCRBY.
6234 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
6235 * the increment if the operation is a ZINCRBY (doincrement == 1). */
6236 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
6241 if (isnan(scoreval
)) {
6242 addReplySds(c
,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
6246 zsetobj
= lookupKeyWrite(c
->db
,key
);
6247 if (zsetobj
== NULL
) {
6248 zsetobj
= createZsetObject();
6249 dbAdd(c
->db
,key
,zsetobj
);
6251 if (zsetobj
->type
!= REDIS_ZSET
) {
6252 addReply(c
,shared
.wrongtypeerr
);
6258 /* Ok now since we implement both ZADD and ZINCRBY here the code
6259 * needs to handle the two different conditions. It's all about setting
6260 * '*score', that is, the new score to set, to the right value. */
6261 score
= zmalloc(sizeof(double));
6265 /* Read the old score. If the element was not present starts from 0 */
6266 de
= dictFind(zs
->dict
,ele
);
6268 double *oldscore
= dictGetEntryVal(de
);
6269 *score
= *oldscore
+ scoreval
;
6273 if (isnan(*score
)) {
6275 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6277 /* Note that we don't need to check if the zset may be empty and
6278 * should be removed here, as we can only obtain Nan as score if
6279 * there was already an element in the sorted set. */
6286 /* What follows is a simple remove and re-insert operation that is common
6287 * to both ZADD and ZINCRBY... */
6288 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
6289 /* case 1: New element */
6290 incrRefCount(ele
); /* added to hash */
6291 zslInsert(zs
->zsl
,*score
,ele
);
6292 incrRefCount(ele
); /* added to skiplist */
6295 addReplyDouble(c
,*score
);
6297 addReply(c
,shared
.cone
);
6302 /* case 2: Score update operation */
6303 de
= dictFind(zs
->dict
,ele
);
6304 redisAssert(de
!= NULL
);
6305 oldscore
= dictGetEntryVal(de
);
6306 if (*score
!= *oldscore
) {
6309 /* Remove and insert the element in the skip list with new score */
6310 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
6311 redisAssert(deleted
!= 0);
6312 zslInsert(zs
->zsl
,*score
,ele
);
6314 /* Update the score in the hash table */
6315 dictReplace(zs
->dict
,ele
,score
);
6321 addReplyDouble(c
,*score
);
6323 addReply(c
,shared
.czero
);
6327 static void zaddCommand(redisClient
*c
) {
6330 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6331 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
6334 static void zincrbyCommand(redisClient
*c
) {
6337 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6338 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
6341 static void zremCommand(redisClient
*c
) {
6348 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6349 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6352 de
= dictFind(zs
->dict
,c
->argv
[2]);
6354 addReply(c
,shared
.czero
);
6357 /* Delete from the skiplist */
6358 oldscore
= dictGetEntryVal(de
);
6359 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
6360 redisAssert(deleted
!= 0);
6362 /* Delete from the hash table */
6363 dictDelete(zs
->dict
,c
->argv
[2]);
6364 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6365 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6367 addReply(c
,shared
.cone
);
6370 static void zremrangebyscoreCommand(redisClient
*c
) {
6377 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
6378 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
6380 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6381 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6384 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
6385 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6386 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6387 server
.dirty
+= deleted
;
6388 addReplyLongLong(c
,deleted
);
6391 static void zremrangebyrankCommand(redisClient
*c
) {
6399 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6400 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6402 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6403 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6405 llen
= zs
->zsl
->length
;
6407 /* convert negative indexes */
6408 if (start
< 0) start
= llen
+start
;
6409 if (end
< 0) end
= llen
+end
;
6410 if (start
< 0) start
= 0;
6411 if (end
< 0) end
= 0;
6413 /* indexes sanity checks */
6414 if (start
> end
|| start
>= llen
) {
6415 addReply(c
,shared
.czero
);
6418 if (end
>= llen
) end
= llen
-1;
6420 /* increment start and end because zsl*Rank functions
6421 * use 1-based rank */
6422 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
6423 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6424 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6425 server
.dirty
+= deleted
;
6426 addReplyLongLong(c
, deleted
);
6434 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
6435 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
6436 unsigned long size1
, size2
;
6437 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
6438 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
6439 return size1
- size2
;
6442 #define REDIS_AGGR_SUM 1
6443 #define REDIS_AGGR_MIN 2
6444 #define REDIS_AGGR_MAX 3
6445 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6447 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
6448 if (aggregate
== REDIS_AGGR_SUM
) {
6449 *target
= *target
+ val
;
6450 } else if (aggregate
== REDIS_AGGR_MIN
) {
6451 *target
= val
< *target
? val
: *target
;
6452 } else if (aggregate
== REDIS_AGGR_MAX
) {
6453 *target
= val
> *target
? val
: *target
;
6456 redisPanic("Unknown ZUNION/INTER aggregate type");
6460 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
6462 int aggregate
= REDIS_AGGR_SUM
;
6469 /* expect setnum input keys to be given */
6470 setnum
= atoi(c
->argv
[2]->ptr
);
6472 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6476 /* test if the expected number of keys would overflow */
6477 if (3+setnum
> c
->argc
) {
6478 addReply(c
,shared
.syntaxerr
);
6482 /* read keys to be used for input */
6483 src
= zmalloc(sizeof(zsetopsrc
) * setnum
);
6484 for (i
= 0, j
= 3; i
< setnum
; i
++, j
++) {
6485 robj
*obj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6489 if (obj
->type
== REDIS_ZSET
) {
6490 src
[i
].dict
= ((zset
*)obj
->ptr
)->dict
;
6491 } else if (obj
->type
== REDIS_SET
) {
6492 src
[i
].dict
= (obj
->ptr
);
6495 addReply(c
,shared
.wrongtypeerr
);
6500 /* default all weights to 1 */
6501 src
[i
].weight
= 1.0;
6504 /* parse optional extra arguments */
6506 int remaining
= c
->argc
- j
;
6509 if (remaining
>= (setnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
6511 for (i
= 0; i
< setnum
; i
++, j
++, remaining
--) {
6512 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
6515 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
6517 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
6518 aggregate
= REDIS_AGGR_SUM
;
6519 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
6520 aggregate
= REDIS_AGGR_MIN
;
6521 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
6522 aggregate
= REDIS_AGGR_MAX
;
6525 addReply(c
,shared
.syntaxerr
);
6531 addReply(c
,shared
.syntaxerr
);
6537 /* sort sets from the smallest to largest, this will improve our
6538 * algorithm's performance */
6539 qsort(src
,setnum
,sizeof(zsetopsrc
),qsortCompareZsetopsrcByCardinality
);
6541 dstobj
= createZsetObject();
6542 dstzset
= dstobj
->ptr
;
6544 if (op
== REDIS_OP_INTER
) {
6545 /* skip going over all entries if the smallest zset is NULL or empty */
6546 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
6547 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6548 * from small to large, all src[i > 0].dict are non-empty too */
6549 di
= dictGetIterator(src
[0].dict
);
6550 while((de
= dictNext(di
)) != NULL
) {
6551 double *score
= zmalloc(sizeof(double)), value
;
6552 *score
= src
[0].weight
* zunionInterDictValue(de
);
6554 for (j
= 1; j
< setnum
; j
++) {
6555 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6557 value
= src
[j
].weight
* zunionInterDictValue(other
);
6558 zunionInterAggregate(score
, value
, aggregate
);
6564 /* skip entry when not present in every source dict */
6568 robj
*o
= dictGetEntryKey(de
);
6569 dictAdd(dstzset
->dict
,o
,score
);
6570 incrRefCount(o
); /* added to dictionary */
6571 zslInsert(dstzset
->zsl
,*score
,o
);
6572 incrRefCount(o
); /* added to skiplist */
6575 dictReleaseIterator(di
);
6577 } else if (op
== REDIS_OP_UNION
) {
6578 for (i
= 0; i
< setnum
; i
++) {
6579 if (!src
[i
].dict
) continue;
6581 di
= dictGetIterator(src
[i
].dict
);
6582 while((de
= dictNext(di
)) != NULL
) {
6583 /* skip key when already processed */
6584 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6586 double *score
= zmalloc(sizeof(double)), value
;
6587 *score
= src
[i
].weight
* zunionInterDictValue(de
);
6589 /* because the zsets are sorted by size, its only possible
6590 * for sets at larger indices to hold this entry */
6591 for (j
= (i
+1); j
< setnum
; j
++) {
6592 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6594 value
= src
[j
].weight
* zunionInterDictValue(other
);
6595 zunionInterAggregate(score
, value
, aggregate
);
6599 robj
*o
= dictGetEntryKey(de
);
6600 dictAdd(dstzset
->dict
,o
,score
);
6601 incrRefCount(o
); /* added to dictionary */
6602 zslInsert(dstzset
->zsl
,*score
,o
);
6603 incrRefCount(o
); /* added to skiplist */
6605 dictReleaseIterator(di
);
6608 /* unknown operator */
6609 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6612 dbDelete(c
->db
,dstkey
);
6613 if (dstzset
->zsl
->length
) {
6614 dbAdd(c
->db
,dstkey
,dstobj
);
6615 addReplyLongLong(c
, dstzset
->zsl
->length
);
6618 decrRefCount(dstobj
);
6619 addReply(c
, shared
.czero
);
6624 static void zunionstoreCommand(redisClient
*c
) {
6625 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6628 static void zinterstoreCommand(redisClient
*c
) {
6629 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6632 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6644 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6645 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6647 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6649 } else if (c
->argc
>= 5) {
6650 addReply(c
,shared
.syntaxerr
);
6654 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6655 || checkType(c
,o
,REDIS_ZSET
)) return;
6660 /* convert negative indexes */
6661 if (start
< 0) start
= llen
+start
;
6662 if (end
< 0) end
= llen
+end
;
6663 if (start
< 0) start
= 0;
6664 if (end
< 0) end
= 0;
6666 /* indexes sanity checks */
6667 if (start
> end
|| start
>= llen
) {
6668 /* Out of range start or start > end result in empty list */
6669 addReply(c
,shared
.emptymultibulk
);
6672 if (end
>= llen
) end
= llen
-1;
6673 rangelen
= (end
-start
)+1;
6675 /* check if starting point is trivial, before searching
6676 * the element in log(N) time */
6678 ln
= start
== 0 ? zsl
->tail
: zslistTypeGetElementByRank(zsl
, llen
-start
);
6681 zsl
->header
->forward
[0] : zslistTypeGetElementByRank(zsl
, start
+1);
6684 /* Return the result in form of a multi-bulk reply */
6685 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6686 withscores
? (rangelen
*2) : rangelen
));
6687 for (j
= 0; j
< rangelen
; j
++) {
6689 addReplyBulk(c
,ele
);
6691 addReplyDouble(c
,ln
->score
);
6692 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6696 static void zrangeCommand(redisClient
*c
) {
6697 zrangeGenericCommand(c
,0);
6700 static void zrevrangeCommand(redisClient
*c
) {
6701 zrangeGenericCommand(c
,1);
6704 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6705 * If justcount is non-zero, just the count is returned. */
6706 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6709 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6710 int offset
= 0, limit
= -1;
6714 /* Parse the min-max interval. If one of the values is prefixed
6715 * by the "(" character, it's considered "open". For instance
6716 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6717 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6718 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6719 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6722 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6724 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6725 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6728 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6731 /* Parse "WITHSCORES": note that if the command was called with
6732 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6733 * enter the following paths to parse WITHSCORES and LIMIT. */
6734 if (c
->argc
== 5 || c
->argc
== 8) {
6735 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6740 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6744 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6749 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6750 addReply(c
,shared
.syntaxerr
);
6752 } else if (c
->argc
== (7 + withscores
)) {
6753 offset
= atoi(c
->argv
[5]->ptr
);
6754 limit
= atoi(c
->argv
[6]->ptr
);
6755 if (offset
< 0) offset
= 0;
6758 /* Ok, lookup the key and get the range */
6759 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6761 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6763 if (o
->type
!= REDIS_ZSET
) {
6764 addReply(c
,shared
.wrongtypeerr
);
6766 zset
*zsetobj
= o
->ptr
;
6767 zskiplist
*zsl
= zsetobj
->zsl
;
6769 robj
*ele
, *lenobj
= NULL
;
6770 unsigned long rangelen
= 0;
6772 /* Get the first node with the score >= min, or with
6773 * score > min if 'minex' is true. */
6774 ln
= zslFirstWithScore(zsl
,min
);
6775 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6778 /* No element matching the speciifed interval */
6779 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6783 /* We don't know in advance how many matching elements there
6784 * are in the list, so we push this object that will represent
6785 * the multi-bulk length in the output buffer, and will "fix"
6788 lenobj
= createObject(REDIS_STRING
,NULL
);
6790 decrRefCount(lenobj
);
6793 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6796 ln
= ln
->forward
[0];
6799 if (limit
== 0) break;
6802 addReplyBulk(c
,ele
);
6804 addReplyDouble(c
,ln
->score
);
6806 ln
= ln
->forward
[0];
6808 if (limit
> 0) limit
--;
6811 addReplyLongLong(c
,(long)rangelen
);
6813 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6814 withscores
? (rangelen
*2) : rangelen
);
6820 static void zrangebyscoreCommand(redisClient
*c
) {
6821 genericZrangebyscoreCommand(c
,0);
6824 static void zcountCommand(redisClient
*c
) {
6825 genericZrangebyscoreCommand(c
,1);
6828 static void zcardCommand(redisClient
*c
) {
6832 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6833 checkType(c
,o
,REDIS_ZSET
)) return;
6836 addReplyUlong(c
,zs
->zsl
->length
);
6839 static void zscoreCommand(redisClient
*c
) {
6844 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6845 checkType(c
,o
,REDIS_ZSET
)) return;
6848 de
= dictFind(zs
->dict
,c
->argv
[2]);
6850 addReply(c
,shared
.nullbulk
);
6852 double *score
= dictGetEntryVal(de
);
6854 addReplyDouble(c
,*score
);
6858 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6866 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6867 checkType(c
,o
,REDIS_ZSET
)) return;
6871 de
= dictFind(zs
->dict
,c
->argv
[2]);
6873 addReply(c
,shared
.nullbulk
);
6877 score
= dictGetEntryVal(de
);
6878 rank
= zslistTypeGetRank(zsl
, *score
, c
->argv
[2]);
6881 addReplyLongLong(c
, zsl
->length
- rank
);
6883 addReplyLongLong(c
, rank
-1);
6886 addReply(c
,shared
.nullbulk
);
6890 static void zrankCommand(redisClient
*c
) {
6891 zrankGenericCommand(c
, 0);
6894 static void zrevrankCommand(redisClient
*c
) {
6895 zrankGenericCommand(c
, 1);
6898 /* ========================= Hashes utility functions ======================= */
6899 #define REDIS_HASH_KEY 1
6900 #define REDIS_HASH_VALUE 2
6902 /* Check the length of a number of objects to see if we need to convert a
6903 * zipmap to a real hash. Note that we only check string encoded objects
6904 * as their string length can be queried in constant time. */
6905 static void hashTypeTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6907 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6909 for (i
= start
; i
<= end
; i
++) {
6910 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6911 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6913 convertToRealHash(subject
);
6919 /* Encode given objects in-place when the hash uses a dict. */
6920 static void hashTypeTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6921 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6922 if (o1
) *o1
= tryObjectEncoding(*o1
);
6923 if (o2
) *o2
= tryObjectEncoding(*o2
);
6927 /* Get the value from a hash identified by key. Returns either a string
6928 * object or NULL if the value cannot be found. The refcount of the object
6929 * is always increased by 1 when the value was found. */
6930 static robj
*hashTypeGet(robj
*o
, robj
*key
) {
6932 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6935 key
= getDecodedObject(key
);
6936 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6937 value
= createStringObject((char*)v
,vlen
);
6941 dictEntry
*de
= dictFind(o
->ptr
,key
);
6943 value
= dictGetEntryVal(de
);
6944 incrRefCount(value
);
6950 /* Test if the key exists in the given hash. Returns 1 if the key
6951 * exists and 0 when it doesn't. */
6952 static int hashTypeExists(robj
*o
, robj
*key
) {
6953 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6954 key
= getDecodedObject(key
);
6955 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6961 if (dictFind(o
->ptr
,key
) != NULL
) {
6968 /* Add an element, discard the old if the key already exists.
6969 * Return 0 on insert and 1 on update. */
6970 static int hashTypeSet(robj
*o
, robj
*key
, robj
*value
) {
6972 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6973 key
= getDecodedObject(key
);
6974 value
= getDecodedObject(value
);
6975 o
->ptr
= zipmapSet(o
->ptr
,
6976 key
->ptr
,sdslen(key
->ptr
),
6977 value
->ptr
,sdslen(value
->ptr
), &update
);
6979 decrRefCount(value
);
6981 /* Check if the zipmap needs to be upgraded to a real hash table */
6982 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6983 convertToRealHash(o
);
6985 if (dictReplace(o
->ptr
,key
,value
)) {
6992 incrRefCount(value
);
6997 /* Delete an element from a hash.
6998 * Return 1 on deleted and 0 on not found. */
6999 static int hashTypeDelete(robj
*o
, robj
*key
) {
7001 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7002 key
= getDecodedObject(key
);
7003 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
7006 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
7007 /* Always check if the dictionary needs a resize after a delete. */
7008 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
7013 /* Return the number of elements in a hash. */
7014 static unsigned long hashTypeLength(robj
*o
) {
7015 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
7016 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
7019 /* Structure to hold hash iteration abstration. Note that iteration over
7020 * hashes involves both fields and values. Because it is possible that
7021 * not both are required, store pointers in the iterator to avoid
7022 * unnecessary memory allocation for fields/values. */
7026 unsigned char *zk
, *zv
;
7027 unsigned int zklen
, zvlen
;
7033 static hashTypeIterator
*hashTypeInitIterator(robj
*subject
) {
7034 hashTypeIterator
*hi
= zmalloc(sizeof(hashTypeIterator
));
7035 hi
->encoding
= subject
->encoding
;
7036 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7037 hi
->zi
= zipmapRewind(subject
->ptr
);
7038 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
7039 hi
->di
= dictGetIterator(subject
->ptr
);
7046 static void hashTypeReleaseIterator(hashTypeIterator
*hi
) {
7047 if (hi
->encoding
== REDIS_ENCODING_HT
) {
7048 dictReleaseIterator(hi
->di
);
7053 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
7054 * could be found and REDIS_ERR when the iterator reaches the end. */
7055 static int hashTypeNext(hashTypeIterator
*hi
) {
7056 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7057 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
7058 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
7060 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
7065 /* Get key or value object at current iteration position.
7066 * This increases the refcount of the field object by 1. */
7067 static robj
*hashTypeCurrent(hashTypeIterator
*hi
, int what
) {
7069 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7070 if (what
& REDIS_HASH_KEY
) {
7071 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
7073 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
7076 if (what
& REDIS_HASH_KEY
) {
7077 o
= dictGetEntryKey(hi
->de
);
7079 o
= dictGetEntryVal(hi
->de
);
7086 static robj
*hashTypeLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
7087 robj
*o
= lookupKeyWrite(c
->db
,key
);
7089 o
= createHashObject();
7092 if (o
->type
!= REDIS_HASH
) {
7093 addReply(c
,shared
.wrongtypeerr
);
7100 /* ============================= Hash commands ============================== */
7101 static void hsetCommand(redisClient
*c
) {
7105 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7106 hashTypeTryConversion(o
,c
->argv
,2,3);
7107 hashTypeTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
7108 update
= hashTypeSet(o
,c
->argv
[2],c
->argv
[3]);
7109 addReply(c
, update
? shared
.czero
: shared
.cone
);
7113 static void hsetnxCommand(redisClient
*c
) {
7115 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7116 hashTypeTryConversion(o
,c
->argv
,2,3);
7118 if (hashTypeExists(o
, c
->argv
[2])) {
7119 addReply(c
, shared
.czero
);
7121 hashTypeTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
7122 hashTypeSet(o
,c
->argv
[2],c
->argv
[3]);
7123 addReply(c
, shared
.cone
);
7128 static void hmsetCommand(redisClient
*c
) {
7132 if ((c
->argc
% 2) == 1) {
7133 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
7137 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7138 hashTypeTryConversion(o
,c
->argv
,2,c
->argc
-1);
7139 for (i
= 2; i
< c
->argc
; i
+= 2) {
7140 hashTypeTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
7141 hashTypeSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
7143 addReply(c
, shared
.ok
);
7147 static void hincrbyCommand(redisClient
*c
) {
7148 long long value
, incr
;
7149 robj
*o
, *current
, *new;
7151 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
7152 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7153 if ((current
= hashTypeGet(o
,c
->argv
[2])) != NULL
) {
7154 if (getLongLongFromObjectOrReply(c
,current
,&value
,
7155 "hash value is not an integer") != REDIS_OK
) {
7156 decrRefCount(current
);
7159 decrRefCount(current
);
7165 new = createStringObjectFromLongLong(value
);
7166 hashTypeTryObjectEncoding(o
,&c
->argv
[2],NULL
);
7167 hashTypeSet(o
,c
->argv
[2],new);
7169 addReplyLongLong(c
,value
);
7173 static void hgetCommand(redisClient
*c
) {
7175 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
7176 checkType(c
,o
,REDIS_HASH
)) return;
7178 if ((value
= hashTypeGet(o
,c
->argv
[2])) != NULL
) {
7179 addReplyBulk(c
,value
);
7180 decrRefCount(value
);
7182 addReply(c
,shared
.nullbulk
);
7186 static void hmgetCommand(redisClient
*c
) {
7189 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
7190 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
7191 addReply(c
,shared
.wrongtypeerr
);
7194 /* Note the check for o != NULL happens inside the loop. This is
7195 * done because objects that cannot be found are considered to be
7196 * an empty hash. The reply should then be a series of NULLs. */
7197 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
7198 for (i
= 2; i
< c
->argc
; i
++) {
7199 if (o
!= NULL
&& (value
= hashTypeGet(o
,c
->argv
[i
])) != NULL
) {
7200 addReplyBulk(c
,value
);
7201 decrRefCount(value
);
7203 addReply(c
,shared
.nullbulk
);
7208 static void hdelCommand(redisClient
*c
) {
7210 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7211 checkType(c
,o
,REDIS_HASH
)) return;
7213 if (hashTypeDelete(o
,c
->argv
[2])) {
7214 if (hashTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
7215 addReply(c
,shared
.cone
);
7218 addReply(c
,shared
.czero
);
7222 static void hlenCommand(redisClient
*c
) {
7224 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7225 checkType(c
,o
,REDIS_HASH
)) return;
7227 addReplyUlong(c
,hashTypeLength(o
));
7230 static void genericHgetallCommand(redisClient
*c
, int flags
) {
7231 robj
*o
, *lenobj
, *obj
;
7232 unsigned long count
= 0;
7233 hashTypeIterator
*hi
;
7235 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
7236 || checkType(c
,o
,REDIS_HASH
)) return;
7238 lenobj
= createObject(REDIS_STRING
,NULL
);
7240 decrRefCount(lenobj
);
7242 hi
= hashTypeInitIterator(o
);
7243 while (hashTypeNext(hi
) != REDIS_ERR
) {
7244 if (flags
& REDIS_HASH_KEY
) {
7245 obj
= hashTypeCurrent(hi
,REDIS_HASH_KEY
);
7246 addReplyBulk(c
,obj
);
7250 if (flags
& REDIS_HASH_VALUE
) {
7251 obj
= hashTypeCurrent(hi
,REDIS_HASH_VALUE
);
7252 addReplyBulk(c
,obj
);
7257 hashTypeReleaseIterator(hi
);
7259 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
7262 static void hkeysCommand(redisClient
*c
) {
7263 genericHgetallCommand(c
,REDIS_HASH_KEY
);
7266 static void hvalsCommand(redisClient
*c
) {
7267 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
7270 static void hgetallCommand(redisClient
*c
) {
7271 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
7274 static void hexistsCommand(redisClient
*c
) {
7276 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7277 checkType(c
,o
,REDIS_HASH
)) return;
7279 addReply(c
, hashTypeExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
7282 static void convertToRealHash(robj
*o
) {
7283 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
7284 unsigned int klen
, vlen
;
7285 dict
*dict
= dictCreate(&hashDictType
,NULL
);
7287 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
7288 p
= zipmapRewind(zm
);
7289 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
7290 robj
*keyobj
, *valobj
;
7292 keyobj
= createStringObject((char*)key
,klen
);
7293 valobj
= createStringObject((char*)val
,vlen
);
7294 keyobj
= tryObjectEncoding(keyobj
);
7295 valobj
= tryObjectEncoding(valobj
);
7296 dictAdd(dict
,keyobj
,valobj
);
7298 o
->encoding
= REDIS_ENCODING_HT
;
7303 /* ========================= Non type-specific commands ==================== */
7305 static void flushdbCommand(redisClient
*c
) {
7306 server
.dirty
+= dictSize(c
->db
->dict
);
7307 touchWatchedKeysOnFlush(c
->db
->id
);
7308 dictEmpty(c
->db
->dict
);
7309 dictEmpty(c
->db
->expires
);
7310 addReply(c
,shared
.ok
);
7313 static void flushallCommand(redisClient
*c
) {
7314 touchWatchedKeysOnFlush(-1);
7315 server
.dirty
+= emptyDb();
7316 addReply(c
,shared
.ok
);
7317 if (server
.bgsavechildpid
!= -1) {
7318 kill(server
.bgsavechildpid
,SIGKILL
);
7319 rdbRemoveTempFile(server
.bgsavechildpid
);
7321 rdbSave(server
.dbfilename
);
7325 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
7326 redisSortOperation
*so
= zmalloc(sizeof(*so
));
7328 so
->pattern
= pattern
;
7332 /* Return the value associated to the key with a name obtained
7333 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7334 * The returned object will always have its refcount increased by 1
7335 * when it is non-NULL. */
7336 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
7339 robj keyobj
, fieldobj
, *o
;
7340 int prefixlen
, sublen
, postfixlen
, fieldlen
;
7341 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7345 char buf
[REDIS_SORTKEY_MAX
+1];
7346 } keyname
, fieldname
;
7348 /* If the pattern is "#" return the substitution object itself in order
7349 * to implement the "SORT ... GET #" feature. */
7350 spat
= pattern
->ptr
;
7351 if (spat
[0] == '#' && spat
[1] == '\0') {
7352 incrRefCount(subst
);
7356 /* The substitution object may be specially encoded. If so we create
7357 * a decoded object on the fly. Otherwise getDecodedObject will just
7358 * increment the ref count, that we'll decrement later. */
7359 subst
= getDecodedObject(subst
);
7362 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
7363 p
= strchr(spat
,'*');
7365 decrRefCount(subst
);
7369 /* Find out if we're dealing with a hash dereference. */
7370 if ((f
= strstr(p
+1, "->")) != NULL
) {
7371 fieldlen
= sdslen(spat
)-(f
-spat
);
7372 /* this also copies \0 character */
7373 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
7374 fieldname
.len
= fieldlen
-2;
7380 sublen
= sdslen(ssub
);
7381 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
7382 memcpy(keyname
.buf
,spat
,prefixlen
);
7383 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
7384 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
7385 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
7386 keyname
.len
= prefixlen
+sublen
+postfixlen
;
7387 decrRefCount(subst
);
7389 /* Lookup substituted key */
7390 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
7391 o
= lookupKeyRead(db
,&keyobj
);
7392 if (o
== NULL
) return NULL
;
7395 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
7397 /* Retrieve value from hash by the field name. This operation
7398 * already increases the refcount of the returned object. */
7399 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
7400 o
= hashTypeGet(o
, &fieldobj
);
7402 if (o
->type
!= REDIS_STRING
) return NULL
;
7404 /* Every object that this function returns needs to have its refcount
7405 * increased. sortCommand decreases it again. */
7412 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7413 * the additional parameter is not standard but a BSD-specific we have to
7414 * pass sorting parameters via the global 'server' structure */
7415 static int sortCompare(const void *s1
, const void *s2
) {
7416 const redisSortObject
*so1
= s1
, *so2
= s2
;
7419 if (!server
.sort_alpha
) {
7420 /* Numeric sorting. Here it's trivial as we precomputed scores */
7421 if (so1
->u
.score
> so2
->u
.score
) {
7423 } else if (so1
->u
.score
< so2
->u
.score
) {
7429 /* Alphanumeric sorting */
7430 if (server
.sort_bypattern
) {
7431 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
7432 /* At least one compare object is NULL */
7433 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
7435 else if (so1
->u
.cmpobj
== NULL
)
7440 /* We have both the objects, use strcoll */
7441 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
7444 /* Compare elements directly. */
7445 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
7448 return server
.sort_desc
? -cmp
: cmp
;
7451 /* The SORT command is the most complex command in Redis. Warning: this code
7452 * is optimized for speed and a bit less for readability */
7453 static void sortCommand(redisClient
*c
) {
7455 unsigned int outputlen
= 0;
7456 int desc
= 0, alpha
= 0;
7457 int limit_start
= 0, limit_count
= -1, start
, end
;
7458 int j
, dontsort
= 0, vectorlen
;
7459 int getop
= 0; /* GET operation counter */
7460 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
7461 redisSortObject
*vector
; /* Resulting vector to sort */
7463 /* Lookup the key to sort. It must be of the right types */
7464 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
7465 if (sortval
== NULL
) {
7466 addReply(c
,shared
.emptymultibulk
);
7469 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
7470 sortval
->type
!= REDIS_ZSET
)
7472 addReply(c
,shared
.wrongtypeerr
);
7476 /* Create a list of operations to perform for every sorted element.
7477 * Operations can be GET/DEL/INCR/DECR */
7478 operations
= listCreate();
7479 listSetFreeMethod(operations
,zfree
);
7482 /* Now we need to protect sortval incrementing its count, in the future
7483 * SORT may have options able to overwrite/delete keys during the sorting
7484 * and the sorted key itself may get destroied */
7485 incrRefCount(sortval
);
7487 /* The SORT command has an SQL-alike syntax, parse it */
7488 while(j
< c
->argc
) {
7489 int leftargs
= c
->argc
-j
-1;
7490 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
7492 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
7494 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
7496 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
7497 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
7498 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
7500 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
7501 storekey
= c
->argv
[j
+1];
7503 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
7504 sortby
= c
->argv
[j
+1];
7505 /* If the BY pattern does not contain '*', i.e. it is constant,
7506 * we don't need to sort nor to lookup the weight keys. */
7507 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
7509 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
7510 listAddNodeTail(operations
,createSortOperation(
7511 REDIS_SORT_GET
,c
->argv
[j
+1]));
7515 decrRefCount(sortval
);
7516 listRelease(operations
);
7517 addReply(c
,shared
.syntaxerr
);
7523 /* Load the sorting vector with all the objects to sort */
7524 switch(sortval
->type
) {
7525 case REDIS_LIST
: vectorlen
= listTypeLength(sortval
); break;
7526 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
7527 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
7528 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7530 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
7533 if (sortval
->type
== REDIS_LIST
) {
7534 listTypeIterator
*li
= listTypeInitIterator(sortval
,0,REDIS_TAIL
);
7535 listTypeEntry entry
;
7536 while(listTypeNext(li
,&entry
)) {
7537 vector
[j
].obj
= listTypeGet(&entry
);
7538 vector
[j
].u
.score
= 0;
7539 vector
[j
].u
.cmpobj
= NULL
;
7542 listTypeReleaseIterator(li
);
7548 if (sortval
->type
== REDIS_SET
) {
7551 zset
*zs
= sortval
->ptr
;
7555 di
= dictGetIterator(set
);
7556 while((setele
= dictNext(di
)) != NULL
) {
7557 vector
[j
].obj
= dictGetEntryKey(setele
);
7558 vector
[j
].u
.score
= 0;
7559 vector
[j
].u
.cmpobj
= NULL
;
7562 dictReleaseIterator(di
);
7564 redisAssert(j
== vectorlen
);
7566 /* Now it's time to load the right scores in the sorting vector */
7567 if (dontsort
== 0) {
7568 for (j
= 0; j
< vectorlen
; j
++) {
7571 /* lookup value to sort by */
7572 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7573 if (!byval
) continue;
7575 /* use object itself to sort by */
7576 byval
= vector
[j
].obj
;
7580 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7582 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7583 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7584 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7585 /* Don't need to decode the object if it's
7586 * integer-encoded (the only encoding supported) so
7587 * far. We can just cast it */
7588 vector
[j
].u
.score
= (long)byval
->ptr
;
7590 redisAssert(1 != 1);
7594 /* when the object was retrieved using lookupKeyByPattern,
7595 * its refcount needs to be decreased. */
7597 decrRefCount(byval
);
7602 /* We are ready to sort the vector... perform a bit of sanity check
7603 * on the LIMIT option too. We'll use a partial version of quicksort. */
7604 start
= (limit_start
< 0) ? 0 : limit_start
;
7605 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7606 if (start
>= vectorlen
) {
7607 start
= vectorlen
-1;
7610 if (end
>= vectorlen
) end
= vectorlen
-1;
7612 if (dontsort
== 0) {
7613 server
.sort_desc
= desc
;
7614 server
.sort_alpha
= alpha
;
7615 server
.sort_bypattern
= sortby
? 1 : 0;
7616 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7617 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7619 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7622 /* Send command output to the output buffer, performing the specified
7623 * GET/DEL/INCR/DECR operations if any. */
7624 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7625 if (storekey
== NULL
) {
7626 /* STORE option not specified, sent the sorting result to client */
7627 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7628 for (j
= start
; j
<= end
; j
++) {
7632 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7633 listRewind(operations
,&li
);
7634 while((ln
= listNext(&li
))) {
7635 redisSortOperation
*sop
= ln
->value
;
7636 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7639 if (sop
->type
== REDIS_SORT_GET
) {
7641 addReply(c
,shared
.nullbulk
);
7643 addReplyBulk(c
,val
);
7647 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7652 robj
*sobj
= createZiplistObject();
7654 /* STORE option specified, set the sorting result as a List object */
7655 for (j
= start
; j
<= end
; j
++) {
7660 listTypePush(sobj
,vector
[j
].obj
,REDIS_TAIL
);
7662 listRewind(operations
,&li
);
7663 while((ln
= listNext(&li
))) {
7664 redisSortOperation
*sop
= ln
->value
;
7665 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7668 if (sop
->type
== REDIS_SORT_GET
) {
7669 if (!val
) val
= createStringObject("",0);
7671 /* listTypePush does an incrRefCount, so we should take care
7672 * care of the incremented refcount caused by either
7673 * lookupKeyByPattern or createStringObject("",0) */
7674 listTypePush(sobj
,val
,REDIS_TAIL
);
7678 redisAssert(sop
->type
== REDIS_SORT_GET
);
7683 dbReplace(c
->db
,storekey
,sobj
);
7684 /* Note: we add 1 because the DB is dirty anyway since even if the
7685 * SORT result is empty a new key is set and maybe the old content
7687 server
.dirty
+= 1+outputlen
;
7688 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7692 if (sortval
->type
== REDIS_LIST
)
7693 for (j
= 0; j
< vectorlen
; j
++)
7694 decrRefCount(vector
[j
].obj
);
7695 decrRefCount(sortval
);
7696 listRelease(operations
);
7697 for (j
= 0; j
< vectorlen
; j
++) {
7698 if (alpha
&& vector
[j
].u
.cmpobj
)
7699 decrRefCount(vector
[j
].u
.cmpobj
);
7704 /* Convert an amount of bytes into a human readable string in the form
7705 * of 100B, 2G, 100M, 4K, and so forth. */
7706 static void bytesToHuman(char *s
, unsigned long long n
) {
7711 sprintf(s
,"%lluB",n
);
7713 } else if (n
< (1024*1024)) {
7714 d
= (double)n
/(1024);
7715 sprintf(s
,"%.2fK",d
);
7716 } else if (n
< (1024LL*1024*1024)) {
7717 d
= (double)n
/(1024*1024);
7718 sprintf(s
,"%.2fM",d
);
7719 } else if (n
< (1024LL*1024*1024*1024)) {
7720 d
= (double)n
/(1024LL*1024*1024);
7721 sprintf(s
,"%.2fG",d
);
7725 /* Create the string returned by the INFO command. This is decoupled
7726 * by the INFO command itself as we need to report the same information
7727 * on memory corruption problems. */
7728 static sds
genRedisInfoString(void) {
7730 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7734 bytesToHuman(hmem
,zmalloc_used_memory());
7735 info
= sdscatprintf(sdsempty(),
7736 "redis_version:%s\r\n"
7737 "redis_git_sha1:%s\r\n"
7738 "redis_git_dirty:%d\r\n"
7740 "multiplexing_api:%s\r\n"
7741 "process_id:%ld\r\n"
7742 "uptime_in_seconds:%ld\r\n"
7743 "uptime_in_days:%ld\r\n"
7744 "connected_clients:%d\r\n"
7745 "connected_slaves:%d\r\n"
7746 "blocked_clients:%d\r\n"
7747 "used_memory:%zu\r\n"
7748 "used_memory_human:%s\r\n"
7749 "changes_since_last_save:%lld\r\n"
7750 "bgsave_in_progress:%d\r\n"
7751 "last_save_time:%ld\r\n"
7752 "bgrewriteaof_in_progress:%d\r\n"
7753 "total_connections_received:%lld\r\n"
7754 "total_commands_processed:%lld\r\n"
7755 "expired_keys:%lld\r\n"
7756 "hash_max_zipmap_entries:%zu\r\n"
7757 "hash_max_zipmap_value:%zu\r\n"
7758 "pubsub_channels:%ld\r\n"
7759 "pubsub_patterns:%u\r\n"
7764 strtol(REDIS_GIT_DIRTY
,NULL
,10) > 0,
7765 (sizeof(long) == 8) ? "64" : "32",
7770 listLength(server
.clients
)-listLength(server
.slaves
),
7771 listLength(server
.slaves
),
7772 server
.blpop_blocked_clients
,
7773 zmalloc_used_memory(),
7776 server
.bgsavechildpid
!= -1,
7778 server
.bgrewritechildpid
!= -1,
7779 server
.stat_numconnections
,
7780 server
.stat_numcommands
,
7781 server
.stat_expiredkeys
,
7782 server
.hash_max_zipmap_entries
,
7783 server
.hash_max_zipmap_value
,
7784 dictSize(server
.pubsub_channels
),
7785 listLength(server
.pubsub_patterns
),
7786 server
.vm_enabled
!= 0,
7787 server
.masterhost
== NULL
? "master" : "slave"
7789 if (server
.masterhost
) {
7790 info
= sdscatprintf(info
,
7791 "master_host:%s\r\n"
7792 "master_port:%d\r\n"
7793 "master_link_status:%s\r\n"
7794 "master_last_io_seconds_ago:%d\r\n"
7797 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7799 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7802 if (server
.vm_enabled
) {
7804 info
= sdscatprintf(info
,
7805 "vm_conf_max_memory:%llu\r\n"
7806 "vm_conf_page_size:%llu\r\n"
7807 "vm_conf_pages:%llu\r\n"
7808 "vm_stats_used_pages:%llu\r\n"
7809 "vm_stats_swapped_objects:%llu\r\n"
7810 "vm_stats_swappin_count:%llu\r\n"
7811 "vm_stats_swappout_count:%llu\r\n"
7812 "vm_stats_io_newjobs_len:%lu\r\n"
7813 "vm_stats_io_processing_len:%lu\r\n"
7814 "vm_stats_io_processed_len:%lu\r\n"
7815 "vm_stats_io_active_threads:%lu\r\n"
7816 "vm_stats_blocked_clients:%lu\r\n"
7817 ,(unsigned long long) server
.vm_max_memory
,
7818 (unsigned long long) server
.vm_page_size
,
7819 (unsigned long long) server
.vm_pages
,
7820 (unsigned long long) server
.vm_stats_used_pages
,
7821 (unsigned long long) server
.vm_stats_swapped_objects
,
7822 (unsigned long long) server
.vm_stats_swapins
,
7823 (unsigned long long) server
.vm_stats_swapouts
,
7824 (unsigned long) listLength(server
.io_newjobs
),
7825 (unsigned long) listLength(server
.io_processing
),
7826 (unsigned long) listLength(server
.io_processed
),
7827 (unsigned long) server
.io_active_threads
,
7828 (unsigned long) server
.vm_blocked_clients
7832 for (j
= 0; j
< server
.dbnum
; j
++) {
7833 long long keys
, vkeys
;
7835 keys
= dictSize(server
.db
[j
].dict
);
7836 vkeys
= dictSize(server
.db
[j
].expires
);
7837 if (keys
|| vkeys
) {
7838 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7845 static void infoCommand(redisClient
*c
) {
7846 sds info
= genRedisInfoString();
7847 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7848 (unsigned long)sdslen(info
)));
7849 addReplySds(c
,info
);
7850 addReply(c
,shared
.crlf
);
7853 static void monitorCommand(redisClient
*c
) {
7854 /* ignore MONITOR if aleady slave or in monitor mode */
7855 if (c
->flags
& REDIS_SLAVE
) return;
7857 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7859 listAddNodeTail(server
.monitors
,c
);
7860 addReply(c
,shared
.ok
);
7863 /* ================================= Expire ================================= */
7864 static int removeExpire(redisDb
*db
, robj
*key
) {
7865 /* An expire may only be removed if there is a corresponding entry in the
7866 * main dict. Otherwise, the key will never be freed. */
7867 redisAssert(dictFind(db
->dict
,key
->ptr
) != NULL
);
7868 if (dictDelete(db
->expires
,key
->ptr
) == DICT_OK
) {
7875 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7878 /* Reuse the sds from the main dict in the expire dict */
7879 redisAssert((de
= dictFind(db
->dict
,key
->ptr
)) != NULL
);
7880 if (dictAdd(db
->expires
,dictGetEntryKey(de
),(void*)when
) == DICT_ERR
) {
7887 /* Return the expire time of the specified key, or -1 if no expire
7888 * is associated with this key (i.e. the key is non volatile) */
7889 static time_t getExpire(redisDb
*db
, robj
*key
) {
7892 /* No expire? return ASAP */
7893 if (dictSize(db
->expires
) == 0 ||
7894 (de
= dictFind(db
->expires
,key
->ptr
)) == NULL
) return -1;
7896 /* The entry was found in the expire dict, this means it should also
7897 * be present in the main dict (safety check). */
7898 redisAssert(dictFind(db
->dict
,key
->ptr
) != NULL
);
7899 return (time_t) dictGetEntryVal(de
);
7902 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7903 time_t when
= getExpire(db
,key
);
7904 if (when
< 0) return 0;
7906 /* Return when this key has not expired */
7907 if (time(NULL
) <= when
) return 0;
7909 /* Delete the key */
7910 server
.stat_expiredkeys
++;
7912 return dbDelete(db
,key
);
7915 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7916 if (getExpire(db
,key
) < 0) return 0;
7918 /* Delete the key */
7919 server
.stat_expiredkeys
++;
7921 return dbDelete(db
,key
);
7924 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7928 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7932 de
= dictFind(c
->db
->dict
,key
->ptr
);
7934 addReply(c
,shared
.czero
);
7938 if (dbDelete(c
->db
,key
)) server
.dirty
++;
7939 addReply(c
, shared
.cone
);
7942 time_t when
= time(NULL
)+seconds
;
7943 if (setExpire(c
->db
,key
,when
)) {
7944 addReply(c
,shared
.cone
);
7947 addReply(c
,shared
.czero
);
7953 static void expireCommand(redisClient
*c
) {
7954 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7957 static void expireatCommand(redisClient
*c
) {
7958 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7961 static void ttlCommand(redisClient
*c
) {
7965 expire
= getExpire(c
->db
,c
->argv
[1]);
7967 ttl
= (int) (expire
-time(NULL
));
7968 if (ttl
< 0) ttl
= -1;
7970 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7973 /* ================================ MULTI/EXEC ============================== */
7975 /* Client state initialization for MULTI/EXEC */
7976 static void initClientMultiState(redisClient
*c
) {
7977 c
->mstate
.commands
= NULL
;
7978 c
->mstate
.count
= 0;
7981 /* Release all the resources associated with MULTI/EXEC state */
7982 static void freeClientMultiState(redisClient
*c
) {
7985 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7987 multiCmd
*mc
= c
->mstate
.commands
+j
;
7989 for (i
= 0; i
< mc
->argc
; i
++)
7990 decrRefCount(mc
->argv
[i
]);
7993 zfree(c
->mstate
.commands
);
7996 /* Add a new command into the MULTI commands queue */
7997 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
8001 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
8002 sizeof(multiCmd
)*(c
->mstate
.count
+1));
8003 mc
= c
->mstate
.commands
+c
->mstate
.count
;
8006 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
8007 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
8008 for (j
= 0; j
< c
->argc
; j
++)
8009 incrRefCount(mc
->argv
[j
]);
8013 static void multiCommand(redisClient
*c
) {
8014 if (c
->flags
& REDIS_MULTI
) {
8015 addReplySds(c
,sdsnew("-ERR MULTI calls can not be nested\r\n"));
8018 c
->flags
|= REDIS_MULTI
;
8019 addReply(c
,shared
.ok
);
8022 static void discardCommand(redisClient
*c
) {
8023 if (!(c
->flags
& REDIS_MULTI
)) {
8024 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
8028 freeClientMultiState(c
);
8029 initClientMultiState(c
);
8030 c
->flags
&= (~REDIS_MULTI
);
8032 addReply(c
,shared
.ok
);
8035 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
8036 * implememntation for more information. */
8037 static void execCommandReplicateMulti(redisClient
*c
) {
8038 struct redisCommand
*cmd
;
8039 robj
*multistring
= createStringObject("MULTI",5);
8041 cmd
= lookupCommand("multi");
8042 if (server
.appendonly
)
8043 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
8044 if (listLength(server
.slaves
))
8045 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
8046 decrRefCount(multistring
);
8049 static void execCommand(redisClient
*c
) {
8054 if (!(c
->flags
& REDIS_MULTI
)) {
8055 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
8059 /* Check if we need to abort the EXEC if some WATCHed key was touched.
8060 * A failed EXEC will return a multi bulk nil object. */
8061 if (c
->flags
& REDIS_DIRTY_CAS
) {
8062 freeClientMultiState(c
);
8063 initClientMultiState(c
);
8064 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
8066 addReply(c
,shared
.nullmultibulk
);
8070 /* Replicate a MULTI request now that we are sure the block is executed.
8071 * This way we'll deliver the MULTI/..../EXEC block as a whole and
8072 * both the AOF and the replication link will have the same consistency
8073 * and atomicity guarantees. */
8074 execCommandReplicateMulti(c
);
8076 /* Exec all the queued commands */
8077 unwatchAllKeys(c
); /* Unwatch ASAP otherwise we'll waste CPU cycles */
8078 orig_argv
= c
->argv
;
8079 orig_argc
= c
->argc
;
8080 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
8081 for (j
= 0; j
< c
->mstate
.count
; j
++) {
8082 c
->argc
= c
->mstate
.commands
[j
].argc
;
8083 c
->argv
= c
->mstate
.commands
[j
].argv
;
8084 call(c
,c
->mstate
.commands
[j
].cmd
);
8086 c
->argv
= orig_argv
;
8087 c
->argc
= orig_argc
;
8088 freeClientMultiState(c
);
8089 initClientMultiState(c
);
8090 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
8091 /* Make sure the EXEC command is always replicated / AOF, since we
8092 * always send the MULTI command (we can't know beforehand if the
8093 * next operations will contain at least a modification to the DB). */
8097 /* =========================== Blocking Operations ========================= */
8099 /* Currently Redis blocking operations support is limited to list POP ops,
8100 * so the current implementation is not fully generic, but it is also not
8101 * completely specific so it will not require a rewrite to support new
8102 * kind of blocking operations in the future.
8104 * Still it's important to note that list blocking operations can be already
8105 * used as a notification mechanism in order to implement other blocking
8106 * operations at application level, so there must be a very strong evidence
8107 * of usefulness and generality before new blocking operations are implemented.
8109 * This is how the current blocking POP works, we use BLPOP as example:
8110 * - If the user calls BLPOP and the key exists and contains a non empty list
8111 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
8112 * if there is not to block.
8113 * - If instead BLPOP is called and the key does not exists or the list is
8114 * empty we need to block. In order to do so we remove the notification for
8115 * new data to read in the client socket (so that we'll not serve new
8116 * requests if the blocking request is not served). Also we put the client
8117 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
8118 * blocking for this keys.
8119 * - If a PUSH operation against a key with blocked clients waiting is
8120 * performed, we serve the first in the list: basically instead to push
8121 * the new element inside the list we return it to the (first / oldest)
8122 * blocking client, unblock the client, and remove it form the list.
8124 * The above comment and the source code should be enough in order to understand
8125 * the implementation and modify / fix it later.
8128 /* Set a client in blocking mode for the specified key, with the specified
8130 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
8135 c
->blocking_keys
= zmalloc(sizeof(robj
*)*numkeys
);
8136 c
->blocking_keys_num
= numkeys
;
8137 c
->blockingto
= timeout
;
8138 for (j
= 0; j
< numkeys
; j
++) {
8139 /* Add the key in the client structure, to map clients -> keys */
8140 c
->blocking_keys
[j
] = keys
[j
];
8141 incrRefCount(keys
[j
]);
8143 /* And in the other "side", to map keys -> clients */
8144 de
= dictFind(c
->db
->blocking_keys
,keys
[j
]);
8148 /* For every key we take a list of clients blocked for it */
8150 retval
= dictAdd(c
->db
->blocking_keys
,keys
[j
],l
);
8151 incrRefCount(keys
[j
]);
8152 assert(retval
== DICT_OK
);
8154 l
= dictGetEntryVal(de
);
8156 listAddNodeTail(l
,c
);
8158 /* Mark the client as a blocked client */
8159 c
->flags
|= REDIS_BLOCKED
;
8160 server
.blpop_blocked_clients
++;
8163 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
8164 static void unblockClientWaitingData(redisClient
*c
) {
8169 assert(c
->blocking_keys
!= NULL
);
8170 /* The client may wait for multiple keys, so unblock it for every key. */
8171 for (j
= 0; j
< c
->blocking_keys_num
; j
++) {
8172 /* Remove this client from the list of clients waiting for this key. */
8173 de
= dictFind(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
8175 l
= dictGetEntryVal(de
);
8176 listDelNode(l
,listSearchKey(l
,c
));
8177 /* If the list is empty we need to remove it to avoid wasting memory */
8178 if (listLength(l
) == 0)
8179 dictDelete(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
8180 decrRefCount(c
->blocking_keys
[j
]);
8182 /* Cleanup the client structure */
8183 zfree(c
->blocking_keys
);
8184 c
->blocking_keys
= NULL
;
8185 c
->flags
&= (~REDIS_BLOCKED
);
8186 server
.blpop_blocked_clients
--;
8187 /* We want to process data if there is some command waiting
8188 * in the input buffer. Note that this is safe even if
8189 * unblockClientWaitingData() gets called from freeClient() because
8190 * freeClient() will be smart enough to call this function
8191 * *after* c->querybuf was set to NULL. */
8192 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
8195 /* This should be called from any function PUSHing into lists.
8196 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
8197 * 'ele' is the element pushed.
8199 * If the function returns 0 there was no client waiting for a list push
8202 * If the function returns 1 there was a client waiting for a list push
8203 * against this key, the element was passed to this client thus it's not
8204 * needed to actually add it to the list and the caller should return asap. */
8205 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
8206 struct dictEntry
*de
;
8207 redisClient
*receiver
;
8211 de
= dictFind(c
->db
->blocking_keys
,key
);
8212 if (de
== NULL
) return 0;
8213 l
= dictGetEntryVal(de
);
8216 receiver
= ln
->value
;
8218 addReplySds(receiver
,sdsnew("*2\r\n"));
8219 addReplyBulk(receiver
,key
);
8220 addReplyBulk(receiver
,ele
);
8221 unblockClientWaitingData(receiver
);
8225 /* Blocking RPOP/LPOP */
8226 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
8231 for (j
= 1; j
< c
->argc
-1; j
++) {
8232 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
8234 if (o
->type
!= REDIS_LIST
) {
8235 addReply(c
,shared
.wrongtypeerr
);
8238 list
*list
= o
->ptr
;
8239 if (listLength(list
) != 0) {
8240 /* If the list contains elements fall back to the usual
8241 * non-blocking POP operation */
8242 robj
*argv
[2], **orig_argv
;
8245 /* We need to alter the command arguments before to call
8246 * popGenericCommand() as the command takes a single key. */
8247 orig_argv
= c
->argv
;
8248 orig_argc
= c
->argc
;
8249 argv
[1] = c
->argv
[j
];
8253 /* Also the return value is different, we need to output
8254 * the multi bulk reply header and the key name. The
8255 * "real" command will add the last element (the value)
8256 * for us. If this souds like an hack to you it's just
8257 * because it is... */
8258 addReplySds(c
,sdsnew("*2\r\n"));
8259 addReplyBulk(c
,argv
[1]);
8260 popGenericCommand(c
,where
);
8262 /* Fix the client structure with the original stuff */
8263 c
->argv
= orig_argv
;
8264 c
->argc
= orig_argc
;
8270 /* If the list is empty or the key does not exists we must block */
8271 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
8272 if (timeout
> 0) timeout
+= time(NULL
);
8273 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
8276 static void blpopCommand(redisClient
*c
) {
8277 blockingPopGenericCommand(c
,REDIS_HEAD
);
8280 static void brpopCommand(redisClient
*c
) {
8281 blockingPopGenericCommand(c
,REDIS_TAIL
);
8284 /* =============================== Replication ============================= */
8286 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8287 ssize_t nwritten
, ret
= size
;
8288 time_t start
= time(NULL
);
8292 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
8293 nwritten
= write(fd
,ptr
,size
);
8294 if (nwritten
== -1) return -1;
8298 if ((time(NULL
)-start
) > timeout
) {
8306 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8307 ssize_t nread
, totread
= 0;
8308 time_t start
= time(NULL
);
8312 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
8313 nread
= read(fd
,ptr
,size
);
8314 if (nread
== -1) return -1;
8319 if ((time(NULL
)-start
) > timeout
) {
8327 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8334 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
8337 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
8348 static void syncCommand(redisClient
*c
) {
8349 /* ignore SYNC if aleady slave or in monitor mode */
8350 if (c
->flags
& REDIS_SLAVE
) return;
8352 /* SYNC can't be issued when the server has pending data to send to
8353 * the client about already issued commands. We need a fresh reply
8354 * buffer registering the differences between the BGSAVE and the current
8355 * dataset, so that we can copy to other slaves if needed. */
8356 if (listLength(c
->reply
) != 0) {
8357 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8361 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
8362 /* Here we need to check if there is a background saving operation
8363 * in progress, or if it is required to start one */
8364 if (server
.bgsavechildpid
!= -1) {
8365 /* Ok a background save is in progress. Let's check if it is a good
8366 * one for replication, i.e. if there is another slave that is
8367 * registering differences since the server forked to save */
8372 listRewind(server
.slaves
,&li
);
8373 while((ln
= listNext(&li
))) {
8375 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
8378 /* Perfect, the server is already registering differences for
8379 * another slave. Set the right state, and copy the buffer. */
8380 listRelease(c
->reply
);
8381 c
->reply
= listDup(slave
->reply
);
8382 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8383 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
8385 /* No way, we need to wait for the next BGSAVE in order to
8386 * register differences */
8387 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8388 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
8391 /* Ok we don't have a BGSAVE in progress, let's start one */
8392 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
8393 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8394 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
8395 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
8398 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8401 c
->flags
|= REDIS_SLAVE
;
8403 listAddNodeTail(server
.slaves
,c
);
8407 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
8408 redisClient
*slave
= privdata
;
8410 REDIS_NOTUSED(mask
);
8411 char buf
[REDIS_IOBUF_LEN
];
8412 ssize_t nwritten
, buflen
;
8414 if (slave
->repldboff
== 0) {
8415 /* Write the bulk write count before to transfer the DB. In theory here
8416 * we don't know how much room there is in the output buffer of the
8417 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8418 * operations) will never be smaller than the few bytes we need. */
8421 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8423 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
8431 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
8432 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
8434 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
8435 (buflen
== 0) ? "premature EOF" : strerror(errno
));
8439 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
8440 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
8445 slave
->repldboff
+= nwritten
;
8446 if (slave
->repldboff
== slave
->repldbsize
) {
8447 close(slave
->repldbfd
);
8448 slave
->repldbfd
= -1;
8449 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8450 slave
->replstate
= REDIS_REPL_ONLINE
;
8451 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
8452 sendReplyToClient
, slave
) == AE_ERR
) {
8456 addReplySds(slave
,sdsempty());
8457 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
8461 /* This function is called at the end of every backgrond saving.
8462 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8463 * otherwise REDIS_ERR is passed to the function.
8465 * The goal of this function is to handle slaves waiting for a successful
8466 * background saving in order to perform non-blocking synchronization. */
8467 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
8469 int startbgsave
= 0;
8472 listRewind(server
.slaves
,&li
);
8473 while((ln
= listNext(&li
))) {
8474 redisClient
*slave
= ln
->value
;
8476 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
8478 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8479 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
8480 struct redis_stat buf
;
8482 if (bgsaveerr
!= REDIS_OK
) {
8484 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
8487 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
8488 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
8490 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
8493 slave
->repldboff
= 0;
8494 slave
->repldbsize
= buf
.st_size
;
8495 slave
->replstate
= REDIS_REPL_SEND_BULK
;
8496 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8497 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
8504 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8507 listRewind(server
.slaves
,&li
);
8508 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
8509 while((ln
= listNext(&li
))) {
8510 redisClient
*slave
= ln
->value
;
8512 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
8519 static int syncWithMaster(void) {
8520 char buf
[1024], tmpfile
[256], authcmd
[1024];
8522 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
8523 int dfd
, maxtries
= 5;
8526 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
8531 /* AUTH with the master if required. */
8532 if(server
.masterauth
) {
8533 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
8534 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
8536 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
8540 /* Read the AUTH result. */
8541 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8543 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
8547 if (buf
[0] != '+') {
8549 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
8554 /* Issue the SYNC command */
8555 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
8557 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
8561 /* Read the bulk write count */
8562 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8564 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
8568 if (buf
[0] != '$') {
8570 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8573 dumpsize
= strtol(buf
+1,NULL
,10);
8574 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8575 /* Read the bulk write data on a temp file */
8577 snprintf(tmpfile
,256,
8578 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8579 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8580 if (dfd
!= -1) break;
8585 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8589 int nread
, nwritten
;
8591 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8593 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8599 nwritten
= write(dfd
,buf
,nread
);
8600 if (nwritten
== -1) {
8601 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8609 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8610 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8616 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8617 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8621 server
.master
= createClient(fd
);
8622 server
.master
->flags
|= REDIS_MASTER
;
8623 server
.master
->authenticated
= 1;
8624 server
.replstate
= REDIS_REPL_CONNECTED
;
8628 static void slaveofCommand(redisClient
*c
) {
8629 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8630 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8631 if (server
.masterhost
) {
8632 sdsfree(server
.masterhost
);
8633 server
.masterhost
= NULL
;
8634 if (server
.master
) freeClient(server
.master
);
8635 server
.replstate
= REDIS_REPL_NONE
;
8636 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8639 sdsfree(server
.masterhost
);
8640 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8641 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8642 if (server
.master
) freeClient(server
.master
);
8643 server
.replstate
= REDIS_REPL_CONNECT
;
8644 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8645 server
.masterhost
, server
.masterport
);
8647 addReply(c
,shared
.ok
);
8650 /* ============================ Maxmemory directive ======================== */
8652 /* Try to free one object form the pre-allocated objects free list.
8653 * This is useful under low mem conditions as by default we take 1 million
8654 * free objects allocated. On success REDIS_OK is returned, otherwise
8656 static int tryFreeOneObjectFromFreelist(void) {
8659 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8660 if (listLength(server
.objfreelist
)) {
8661 listNode
*head
= listFirst(server
.objfreelist
);
8662 o
= listNodeValue(head
);
8663 listDelNode(server
.objfreelist
,head
);
8664 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8668 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8673 /* This function gets called when 'maxmemory' is set on the config file to limit
8674 * the max memory used by the server, and we are out of memory.
8675 * This function will try to, in order:
8677 * - Free objects from the free list
8678 * - Try to remove keys with an EXPIRE set
8680 * It is not possible to free enough memory to reach used-memory < maxmemory
8681 * the server will start refusing commands that will enlarge even more the
8684 static void freeMemoryIfNeeded(void) {
8685 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8686 int j
, k
, freed
= 0;
8688 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8689 for (j
= 0; j
< server
.dbnum
; j
++) {
8691 robj
*minkey
= NULL
;
8692 struct dictEntry
*de
;
8694 if (dictSize(server
.db
[j
].expires
)) {
8696 /* From a sample of three keys drop the one nearest to
8697 * the natural expire */
8698 for (k
= 0; k
< 3; k
++) {
8701 de
= dictGetRandomKey(server
.db
[j
].expires
);
8702 t
= (time_t) dictGetEntryVal(de
);
8703 if (minttl
== -1 || t
< minttl
) {
8704 minkey
= dictGetEntryKey(de
);
8708 dbDelete(server
.db
+j
,minkey
);
8711 if (!freed
) return; /* nothing to free... */
8715 /* ============================== Append Only file ========================== */
8717 /* Called when the user switches from "appendonly yes" to "appendonly no"
8718 * at runtime using the CONFIG command. */
8719 static void stopAppendOnly(void) {
8720 flushAppendOnlyFile();
8721 aof_fsync(server
.appendfd
);
8722 close(server
.appendfd
);
8724 server
.appendfd
= -1;
8725 server
.appendseldb
= -1;
8726 server
.appendonly
= 0;
8727 /* rewrite operation in progress? kill it, wait child exit */
8728 if (server
.bgsavechildpid
!= -1) {
8731 if (kill(server
.bgsavechildpid
,SIGKILL
) != -1)
8732 wait3(&statloc
,0,NULL
);
8733 /* reset the buffer accumulating changes while the child saves */
8734 sdsfree(server
.bgrewritebuf
);
8735 server
.bgrewritebuf
= sdsempty();
8736 server
.bgsavechildpid
= -1;
8740 /* Called when the user switches from "appendonly no" to "appendonly yes"
8741 * at runtime using the CONFIG command. */
8742 static int startAppendOnly(void) {
8743 server
.appendonly
= 1;
8744 server
.lastfsync
= time(NULL
);
8745 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
8746 if (server
.appendfd
== -1) {
8747 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno
));
8750 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
8751 server
.appendonly
= 0;
8752 close(server
.appendfd
);
8753 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
));
8759 /* Write the append only file buffer on disk.
8761 * Since we are required to write the AOF before replying to the client,
8762 * and the only way the client socket can get a write is entering when the
8763 * the event loop, we accumulate all the AOF writes in a memory
8764 * buffer and write it on disk using this function just before entering
8765 * the event loop again. */
8766 static void flushAppendOnlyFile(void) {
8770 if (sdslen(server
.aofbuf
) == 0) return;
8772 /* We want to perform a single write. This should be guaranteed atomic
8773 * at least if the filesystem we are writing is a real physical one.
8774 * While this will save us against the server being killed I don't think
8775 * there is much to do about the whole server stopping for power problems
8777 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8778 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8779 /* Ooops, we are in troubles. The best thing to do for now is
8780 * aborting instead of giving the illusion that everything is
8781 * working as expected. */
8782 if (nwritten
== -1) {
8783 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8785 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8789 sdsfree(server
.aofbuf
);
8790 server
.aofbuf
= sdsempty();
8792 /* Don't Fsync if no-appendfsync-on-rewrite is set to yes and we have
8793 * childs performing heavy I/O on disk. */
8794 if (server
.no_appendfsync_on_rewrite
&&
8795 (server
.bgrewritechildpid
!= -1 || server
.bgsavechildpid
!= -1))
8797 /* Fsync if needed */
8799 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8800 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8801 now
-server
.lastfsync
> 1))
8803 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8804 * flushing metadata. */
8805 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8806 server
.lastfsync
= now
;
8810 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8812 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8813 for (j
= 0; j
< argc
; j
++) {
8814 robj
*o
= getDecodedObject(argv
[j
]);
8815 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8816 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8817 buf
= sdscatlen(buf
,"\r\n",2);
8823 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8828 /* Make sure we can use strtol */
8829 seconds
= getDecodedObject(seconds
);
8830 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8831 decrRefCount(seconds
);
8833 argv
[0] = createStringObject("EXPIREAT",8);
8835 argv
[2] = createObject(REDIS_STRING
,
8836 sdscatprintf(sdsempty(),"%ld",when
));
8837 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8838 decrRefCount(argv
[0]);
8839 decrRefCount(argv
[2]);
8843 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8844 sds buf
= sdsempty();
8847 /* The DB this command was targetting is not the same as the last command
8848 * we appendend. To issue a SELECT command is needed. */
8849 if (dictid
!= server
.appendseldb
) {
8852 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8853 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8854 (unsigned long)strlen(seldb
),seldb
);
8855 server
.appendseldb
= dictid
;
8858 if (cmd
->proc
== expireCommand
) {
8859 /* Translate EXPIRE into EXPIREAT */
8860 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8861 } else if (cmd
->proc
== setexCommand
) {
8862 /* Translate SETEX to SET and EXPIREAT */
8863 tmpargv
[0] = createStringObject("SET",3);
8864 tmpargv
[1] = argv
[1];
8865 tmpargv
[2] = argv
[3];
8866 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8867 decrRefCount(tmpargv
[0]);
8868 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8870 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8873 /* Append to the AOF buffer. This will be flushed on disk just before
8874 * of re-entering the event loop, so before the client will get a
8875 * positive reply about the operation performed. */
8876 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8878 /* If a background append only file rewriting is in progress we want to
8879 * accumulate the differences between the child DB and the current one
8880 * in a buffer, so that when the child process will do its work we
8881 * can append the differences to the new append only file. */
8882 if (server
.bgrewritechildpid
!= -1)
8883 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8888 /* In Redis commands are always executed in the context of a client, so in
8889 * order to load the append only file we need to create a fake client. */
8890 static struct redisClient
*createFakeClient(void) {
8891 struct redisClient
*c
= zmalloc(sizeof(*c
));
8895 c
->querybuf
= sdsempty();
8899 /* We set the fake client as a slave waiting for the synchronization
8900 * so that Redis will not try to send replies to this client. */
8901 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8902 c
->reply
= listCreate();
8903 listSetFreeMethod(c
->reply
,decrRefCount
);
8904 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8905 initClientMultiState(c
);
8909 static void freeFakeClient(struct redisClient
*c
) {
8910 sdsfree(c
->querybuf
);
8911 listRelease(c
->reply
);
8912 freeClientMultiState(c
);
8916 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8917 * error (the append only file is zero-length) REDIS_ERR is returned. On
8918 * fatal error an error message is logged and the program exists. */
8919 int loadAppendOnlyFile(char *filename
) {
8920 struct redisClient
*fakeClient
;
8921 FILE *fp
= fopen(filename
,"r");
8922 struct redis_stat sb
;
8923 int appendonly
= server
.appendonly
;
8925 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8929 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8933 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8934 * to the same file we're about to read. */
8935 server
.appendonly
= 0;
8937 fakeClient
= createFakeClient();
8944 struct redisCommand
*cmd
;
8947 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8953 if (buf
[0] != '*') goto fmterr
;
8955 argv
= zmalloc(sizeof(robj
*)*argc
);
8956 for (j
= 0; j
< argc
; j
++) {
8957 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8958 if (buf
[0] != '$') goto fmterr
;
8959 len
= strtol(buf
+1,NULL
,10);
8960 argsds
= sdsnewlen(NULL
,len
);
8961 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8962 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8963 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8966 /* Command lookup */
8967 cmd
= lookupCommand(argv
[0]->ptr
);
8969 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8972 /* Try object encoding */
8973 if (cmd
->flags
& REDIS_CMD_BULK
)
8974 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8975 /* Run the command in the context of a fake client */
8976 fakeClient
->argc
= argc
;
8977 fakeClient
->argv
= argv
;
8978 cmd
->proc(fakeClient
);
8979 /* Discard the reply objects list from the fake client */
8980 while(listLength(fakeClient
->reply
))
8981 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8982 /* Clean up, ready for the next command */
8983 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8985 /* Handle swapping while loading big datasets when VM is on */
8987 if ((zmalloc_used_memory() - server
.vm_max_memory
) > 1024*1024*32)
8990 if (server
.vm_enabled
&& force_swapout
) {
8991 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8992 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8997 /* This point can only be reached when EOF is reached without errors.
8998 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8999 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
9002 freeFakeClient(fakeClient
);
9003 server
.appendonly
= appendonly
;
9008 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
9010 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
9014 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
9018 /* Write binary-safe string into a file in the bulkformat
9019 * $<count>\r\n<payload>\r\n */
9020 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
9024 clen
= 1+ll2string(cbuf
+1,sizeof(cbuf
)-1,len
);
9025 cbuf
[clen
++] = '\r';
9026 cbuf
[clen
++] = '\n';
9027 if (fwrite(cbuf
,clen
,1,fp
) == 0) return 0;
9028 if (len
> 0 && fwrite(s
,len
,1,fp
) == 0) return 0;
9029 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
9033 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
9034 static int fwriteBulkDouble(FILE *fp
, double d
) {
9035 char buf
[128], dbuf
[128];
9037 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
9038 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
9039 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
9040 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
9044 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
9045 static int fwriteBulkLongLong(FILE *fp
, long long l
) {
9046 char bbuf
[128], lbuf
[128];
9047 unsigned int blen
, llen
;
9048 llen
= ll2string(lbuf
,32,l
);
9049 blen
= snprintf(bbuf
,sizeof(bbuf
),"$%u\r\n%s\r\n",llen
,lbuf
);
9050 if (fwrite(bbuf
,blen
,1,fp
) == 0) return 0;
9054 /* Delegate writing an object to writing a bulk string or bulk long long. */
9055 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
9056 /* Avoid using getDecodedObject to help copy-on-write (we are often
9057 * in a child process when this function is called). */
9058 if (obj
->encoding
== REDIS_ENCODING_INT
) {
9059 return fwriteBulkLongLong(fp
,(long)obj
->ptr
);
9060 } else if (obj
->encoding
== REDIS_ENCODING_RAW
) {
9061 return fwriteBulkString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
9063 redisPanic("Unknown string encoding");
9067 /* Write a sequence of commands able to fully rebuild the dataset into
9068 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
9069 static int rewriteAppendOnlyFile(char *filename
) {
9070 dictIterator
*di
= NULL
;
9075 time_t now
= time(NULL
);
9077 /* Note that we have to use a different temp name here compared to the
9078 * one used by rewriteAppendOnlyFileBackground() function. */
9079 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
9080 fp
= fopen(tmpfile
,"w");
9082 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
9085 for (j
= 0; j
< server
.dbnum
; j
++) {
9086 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
9087 redisDb
*db
= server
.db
+j
;
9089 if (dictSize(d
) == 0) continue;
9090 di
= dictGetIterator(d
);
9096 /* SELECT the new DB */
9097 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
9098 if (fwriteBulkLongLong(fp
,j
) == 0) goto werr
;
9100 /* Iterate this DB writing every entry */
9101 while((de
= dictNext(di
)) != NULL
) {
9102 sds keystr
= dictGetEntryKey(de
);
9107 keystr
= dictGetEntryKey(de
);
9108 o
= dictGetEntryVal(de
);
9109 initStaticStringObject(key
,keystr
);
9110 /* If the value for this key is swapped, load a preview in memory.
9111 * We use a "swapped" flag to remember if we need to free the
9112 * value object instead to just increment the ref count anyway
9113 * in order to avoid copy-on-write of pages if we are forked() */
9114 if (!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
||
9115 o
->storage
== REDIS_VM_SWAPPING
) {
9118 o
= vmPreviewObject(o
);
9121 expiretime
= getExpire(db
,&key
);
9123 /* Save the key and associated value */
9124 if (o
->type
== REDIS_STRING
) {
9125 /* Emit a SET command */
9126 char cmd
[]="*3\r\n$3\r\nSET\r\n";
9127 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9129 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9130 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
9131 } else if (o
->type
== REDIS_LIST
) {
9132 /* Emit the RPUSHes needed to rebuild the list */
9133 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
9134 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
9135 unsigned char *zl
= o
->ptr
;
9136 unsigned char *p
= ziplistIndex(zl
,0);
9137 unsigned char *vstr
;
9141 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
9142 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9143 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9145 if (fwriteBulkString(fp
,(char*)vstr
,vlen
) == 0)
9148 if (fwriteBulkLongLong(fp
,vlong
) == 0)
9151 p
= ziplistNext(zl
,p
);
9153 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
9154 list
*list
= o
->ptr
;
9158 listRewind(list
,&li
);
9159 while((ln
= listNext(&li
))) {
9160 robj
*eleobj
= listNodeValue(ln
);
9162 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9163 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9164 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9167 redisPanic("Unknown list encoding");
9169 } else if (o
->type
== REDIS_SET
) {
9170 /* Emit the SADDs needed to rebuild the set */
9172 dictIterator
*di
= dictGetIterator(set
);
9175 while((de
= dictNext(di
)) != NULL
) {
9176 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
9177 robj
*eleobj
= dictGetEntryKey(de
);
9179 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9180 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9181 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9183 dictReleaseIterator(di
);
9184 } else if (o
->type
== REDIS_ZSET
) {
9185 /* Emit the ZADDs needed to rebuild the sorted set */
9187 dictIterator
*di
= dictGetIterator(zs
->dict
);
9190 while((de
= dictNext(di
)) != NULL
) {
9191 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
9192 robj
*eleobj
= dictGetEntryKey(de
);
9193 double *score
= dictGetEntryVal(de
);
9195 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9196 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9197 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
9198 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9200 dictReleaseIterator(di
);
9201 } else if (o
->type
== REDIS_HASH
) {
9202 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
9204 /* Emit the HSETs needed to rebuild the hash */
9205 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9206 unsigned char *p
= zipmapRewind(o
->ptr
);
9207 unsigned char *field
, *val
;
9208 unsigned int flen
, vlen
;
9210 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
9211 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9212 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9213 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
9215 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
9219 dictIterator
*di
= dictGetIterator(o
->ptr
);
9222 while((de
= dictNext(di
)) != NULL
) {
9223 robj
*field
= dictGetEntryKey(de
);
9224 robj
*val
= dictGetEntryVal(de
);
9226 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9227 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9228 if (fwriteBulkObject(fp
,field
) == -1) return -1;
9229 if (fwriteBulkObject(fp
,val
) == -1) return -1;
9231 dictReleaseIterator(di
);
9234 redisPanic("Unknown object type");
9236 /* Save the expire time */
9237 if (expiretime
!= -1) {
9238 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
9239 /* If this key is already expired skip it */
9240 if (expiretime
< now
) continue;
9241 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9242 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9243 if (fwriteBulkLongLong(fp
,expiretime
) == 0) goto werr
;
9245 if (swapped
) decrRefCount(o
);
9247 dictReleaseIterator(di
);
9250 /* Make sure data will not remain on the OS's output buffers */
9252 aof_fsync(fileno(fp
));
9255 /* Use RENAME to make sure the DB file is changed atomically only
9256 * if the generate DB file is ok. */
9257 if (rename(tmpfile
,filename
) == -1) {
9258 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
9262 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
9268 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
9269 if (di
) dictReleaseIterator(di
);
9273 /* This is how rewriting of the append only file in background works:
9275 * 1) The user calls BGREWRITEAOF
9276 * 2) Redis calls this function, that forks():
9277 * 2a) the child rewrite the append only file in a temp file.
9278 * 2b) the parent accumulates differences in server.bgrewritebuf.
9279 * 3) When the child finished '2a' exists.
9280 * 4) The parent will trap the exit code, if it's OK, will append the
9281 * data accumulated into server.bgrewritebuf into the temp file, and
9282 * finally will rename(2) the temp file in the actual file name.
9283 * The the new file is reopened as the new append only file. Profit!
9285 static int rewriteAppendOnlyFileBackground(void) {
9288 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
9289 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
9290 if ((childpid
= fork()) == 0) {
9294 if (server
.vm_enabled
) vmReopenSwapFile();
9296 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
9297 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
9304 if (childpid
== -1) {
9305 redisLog(REDIS_WARNING
,
9306 "Can't rewrite append only file in background: fork: %s",
9310 redisLog(REDIS_NOTICE
,
9311 "Background append only file rewriting started by pid %d",childpid
);
9312 server
.bgrewritechildpid
= childpid
;
9313 updateDictResizePolicy();
9314 /* We set appendseldb to -1 in order to force the next call to the
9315 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9316 * accumulated by the parent into server.bgrewritebuf will start
9317 * with a SELECT statement and it will be safe to merge. */
9318 server
.appendseldb
= -1;
9321 return REDIS_OK
; /* unreached */
9324 static void bgrewriteaofCommand(redisClient
*c
) {
9325 if (server
.bgrewritechildpid
!= -1) {
9326 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9329 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
9330 char *status
= "+Background append only file rewriting started\r\n";
9331 addReplySds(c
,sdsnew(status
));
9333 addReply(c
,shared
.err
);
9337 static void aofRemoveTempFile(pid_t childpid
) {
9340 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
9344 /* Virtual Memory is composed mainly of two subsystems:
9345 * - Blocking Virutal Memory
9346 * - Threaded Virtual Memory I/O
9347 * The two parts are not fully decoupled, but functions are split among two
9348 * different sections of the source code (delimited by comments) in order to
9349 * make more clear what functionality is about the blocking VM and what about
9350 * the threaded (not blocking) VM.
9354 * Redis VM is a blocking VM (one that blocks reading swapped values from
9355 * disk into memory when a value swapped out is needed in memory) that is made
9356 * unblocking by trying to examine the command argument vector in order to
9357 * load in background values that will likely be needed in order to exec
9358 * the command. The command is executed only once all the relevant keys
9359 * are loaded into memory.
9361 * This basically is almost as simple of a blocking VM, but almost as parallel
9362 * as a fully non-blocking VM.
9365 /* =================== Virtual Memory - Blocking Side ====================== */
9367 /* Create a VM pointer object. This kind of objects are used in place of
9368 * values in the key -> value hash table, for swapped out objects. */
9369 static vmpointer
*createVmPointer(int vtype
) {
9370 vmpointer
*vp
= zmalloc(sizeof(vmpointer
));
9372 vp
->type
= REDIS_VMPOINTER
;
9373 vp
->storage
= REDIS_VM_SWAPPED
;
9378 static void vmInit(void) {
9384 if (server
.vm_max_threads
!= 0)
9385 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9387 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
9388 /* Try to open the old swap file, otherwise create it */
9389 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
9390 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
9392 if (server
.vm_fp
== NULL
) {
9393 redisLog(REDIS_WARNING
,
9394 "Can't open the swap file: %s. Exiting.",
9398 server
.vm_fd
= fileno(server
.vm_fp
);
9399 /* Lock the swap file for writing, this is useful in order to avoid
9400 * another instance to use the same swap file for a config error. */
9401 fl
.l_type
= F_WRLCK
;
9402 fl
.l_whence
= SEEK_SET
;
9403 fl
.l_start
= fl
.l_len
= 0;
9404 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
9405 redisLog(REDIS_WARNING
,
9406 "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
));
9410 server
.vm_next_page
= 0;
9411 server
.vm_near_pages
= 0;
9412 server
.vm_stats_used_pages
= 0;
9413 server
.vm_stats_swapped_objects
= 0;
9414 server
.vm_stats_swapouts
= 0;
9415 server
.vm_stats_swapins
= 0;
9416 totsize
= server
.vm_pages
*server
.vm_page_size
;
9417 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
9418 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
9419 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
9423 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
9425 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
9426 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
9427 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
9428 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
9430 /* Initialize threaded I/O (used by Virtual Memory) */
9431 server
.io_newjobs
= listCreate();
9432 server
.io_processing
= listCreate();
9433 server
.io_processed
= listCreate();
9434 server
.io_ready_clients
= listCreate();
9435 pthread_mutex_init(&server
.io_mutex
,NULL
);
9436 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
9437 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
9438 server
.io_active_threads
= 0;
9439 if (pipe(pipefds
) == -1) {
9440 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
9444 server
.io_ready_pipe_read
= pipefds
[0];
9445 server
.io_ready_pipe_write
= pipefds
[1];
9446 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
9447 /* LZF requires a lot of stack */
9448 pthread_attr_init(&server
.io_threads_attr
);
9449 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
9450 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
9451 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
9452 /* Listen for events in the threaded I/O pipe */
9453 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
9454 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
9455 oom("creating file event");
9458 /* Mark the page as used */
9459 static void vmMarkPageUsed(off_t page
) {
9460 off_t byte
= page
/8;
9462 redisAssert(vmFreePage(page
) == 1);
9463 server
.vm_bitmap
[byte
] |= 1<<bit
;
9466 /* Mark N contiguous pages as used, with 'page' being the first. */
9467 static void vmMarkPagesUsed(off_t page
, off_t count
) {
9470 for (j
= 0; j
< count
; j
++)
9471 vmMarkPageUsed(page
+j
);
9472 server
.vm_stats_used_pages
+= count
;
9473 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
9474 (long long)count
, (long long)page
);
9477 /* Mark the page as free */
9478 static void vmMarkPageFree(off_t page
) {
9479 off_t byte
= page
/8;
9481 redisAssert(vmFreePage(page
) == 0);
9482 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
9485 /* Mark N contiguous pages as free, with 'page' being the first. */
9486 static void vmMarkPagesFree(off_t page
, off_t count
) {
9489 for (j
= 0; j
< count
; j
++)
9490 vmMarkPageFree(page
+j
);
9491 server
.vm_stats_used_pages
-= count
;
9492 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
9493 (long long)count
, (long long)page
);
9496 /* Test if the page is free */
9497 static int vmFreePage(off_t page
) {
9498 off_t byte
= page
/8;
9500 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
9503 /* Find N contiguous free pages storing the first page of the cluster in *first.
9504 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9505 * REDIS_ERR is returned.
9507 * This function uses a simple algorithm: we try to allocate
9508 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9509 * again from the start of the swap file searching for free spaces.
9511 * If it looks pretty clear that there are no free pages near our offset
9512 * we try to find less populated places doing a forward jump of
9513 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9514 * without hurry, and then we jump again and so forth...
9516 * This function can be improved using a free list to avoid to guess
9517 * too much, since we could collect data about freed pages.
9519 * note: I implemented this function just after watching an episode of
9520 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9522 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
9523 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
9525 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
9526 server
.vm_near_pages
= 0;
9527 server
.vm_next_page
= 0;
9529 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
9530 base
= server
.vm_next_page
;
9532 while(offset
< server
.vm_pages
) {
9533 off_t
this = base
+offset
;
9535 /* If we overflow, restart from page zero */
9536 if (this >= server
.vm_pages
) {
9537 this -= server
.vm_pages
;
9539 /* Just overflowed, what we found on tail is no longer
9540 * interesting, as it's no longer contiguous. */
9544 if (vmFreePage(this)) {
9545 /* This is a free page */
9547 /* Already got N free pages? Return to the caller, with success */
9549 *first
= this-(n
-1);
9550 server
.vm_next_page
= this+1;
9551 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
9555 /* The current one is not a free page */
9559 /* Fast-forward if the current page is not free and we already
9560 * searched enough near this place. */
9562 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
9563 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
9565 /* Note that even if we rewind after the jump, we are don't need
9566 * to make sure numfree is set to zero as we only jump *if* it
9567 * is set to zero. */
9569 /* Otherwise just check the next page */
9576 /* Write the specified object at the specified page of the swap file */
9577 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
9578 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9579 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9580 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9581 redisLog(REDIS_WARNING
,
9582 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9586 rdbSaveObject(server
.vm_fp
,o
);
9587 fflush(server
.vm_fp
);
9588 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9592 /* Transfers the 'val' object to disk. Store all the information
9593 * a 'vmpointer' object containing all the information needed to load the
9594 * object back later is returned.
9596 * If we can't find enough contiguous empty pages to swap the object on disk
9597 * NULL is returned. */
9598 static vmpointer
*vmSwapObjectBlocking(robj
*val
) {
9599 off_t pages
= rdbSavedObjectPages(val
,NULL
);
9603 assert(val
->storage
== REDIS_VM_MEMORY
);
9604 assert(val
->refcount
== 1);
9605 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return NULL
;
9606 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return NULL
;
9608 vp
= createVmPointer(val
->type
);
9610 vp
->usedpages
= pages
;
9611 decrRefCount(val
); /* Deallocate the object from memory. */
9612 vmMarkPagesUsed(page
,pages
);
9613 redisLog(REDIS_DEBUG
,"VM: object %p swapped out at %lld (%lld pages)",
9615 (unsigned long long) page
, (unsigned long long) pages
);
9616 server
.vm_stats_swapped_objects
++;
9617 server
.vm_stats_swapouts
++;
9621 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
9624 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9625 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9626 redisLog(REDIS_WARNING
,
9627 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9631 o
= rdbLoadObject(type
,server
.vm_fp
);
9633 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
9636 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9640 /* Load the specified object from swap to memory.
9641 * The newly allocated object is returned.
9643 * If preview is true the unserialized object is returned to the caller but
9644 * the pages are not marked as freed, nor the vp object is freed. */
9645 static robj
*vmGenericLoadObject(vmpointer
*vp
, int preview
) {
9648 redisAssert(vp
->type
== REDIS_VMPOINTER
&&
9649 (vp
->storage
== REDIS_VM_SWAPPED
|| vp
->storage
== REDIS_VM_LOADING
));
9650 val
= vmReadObjectFromSwap(vp
->page
,vp
->vtype
);
9652 redisLog(REDIS_DEBUG
, "VM: object %p loaded from disk", (void*)vp
);
9653 vmMarkPagesFree(vp
->page
,vp
->usedpages
);
9655 server
.vm_stats_swapped_objects
--;
9657 redisLog(REDIS_DEBUG
, "VM: object %p previewed from disk", (void*)vp
);
9659 server
.vm_stats_swapins
++;
9663 /* Plain object loading, from swap to memory.
9665 * 'o' is actually a redisVmPointer structure that will be freed by the call.
9666 * The return value is the loaded object. */
9667 static robj
*vmLoadObject(robj
*o
) {
9668 /* If we are loading the object in background, stop it, we
9669 * need to load this object synchronously ASAP. */
9670 if (o
->storage
== REDIS_VM_LOADING
)
9671 vmCancelThreadedIOJob(o
);
9672 return vmGenericLoadObject((vmpointer
*)o
,0);
9675 /* Just load the value on disk, without to modify the key.
9676 * This is useful when we want to perform some operation on the value
9677 * without to really bring it from swap to memory, like while saving the
9678 * dataset or rewriting the append only log. */
9679 static robj
*vmPreviewObject(robj
*o
) {
9680 return vmGenericLoadObject((vmpointer
*)o
,1);
9683 /* How a good candidate is this object for swapping?
9684 * The better candidate it is, the greater the returned value.
9686 * Currently we try to perform a fast estimation of the object size in
9687 * memory, and combine it with aging informations.
9689 * Basically swappability = idle-time * log(estimated size)
9691 * Bigger objects are preferred over smaller objects, but not
9692 * proportionally, this is why we use the logarithm. This algorithm is
9693 * just a first try and will probably be tuned later. */
9694 static double computeObjectSwappability(robj
*o
) {
9695 /* actual age can be >= minage, but not < minage. As we use wrapping
9696 * 21 bit clocks with minutes resolution for the LRU. */
9697 time_t minage
= abs(server
.lruclock
- o
->lru
);
9698 long asize
= 0, elesize
;
9703 struct dictEntry
*de
;
9706 if (minage
<= 0) return 0;
9709 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9712 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9716 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
9717 asize
= sizeof(*o
)+ziplistSize(o
->ptr
);
9721 asize
= sizeof(list
);
9724 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9725 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9726 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9732 z
= (o
->type
== REDIS_ZSET
);
9733 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9735 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9736 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9738 de
= dictGetRandomKey(d
);
9739 ele
= dictGetEntryKey(de
);
9740 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9741 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9742 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9743 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9747 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9748 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9749 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9750 unsigned int klen
, vlen
;
9751 unsigned char *key
, *val
;
9753 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9757 asize
= len
*(klen
+vlen
+3);
9758 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9760 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9762 de
= dictGetRandomKey(d
);
9763 ele
= dictGetEntryKey(de
);
9764 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9765 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9766 ele
= dictGetEntryVal(de
);
9767 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9768 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9769 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9774 return (double)minage
*log(1+asize
);
9777 /* Try to swap an object that's a good candidate for swapping.
9778 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9779 * to swap any object at all.
9781 * If 'usethreaded' is true, Redis will try to swap the object in background
9782 * using I/O threads. */
9783 static int vmSwapOneObject(int usethreads
) {
9785 struct dictEntry
*best
= NULL
;
9786 double best_swappability
= 0;
9787 redisDb
*best_db
= NULL
;
9791 for (j
= 0; j
< server
.dbnum
; j
++) {
9792 redisDb
*db
= server
.db
+j
;
9793 /* Why maxtries is set to 100?
9794 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9795 * are swappable objects */
9798 if (dictSize(db
->dict
) == 0) continue;
9799 for (i
= 0; i
< 5; i
++) {
9801 double swappability
;
9803 if (maxtries
) maxtries
--;
9804 de
= dictGetRandomKey(db
->dict
);
9805 val
= dictGetEntryVal(de
);
9806 /* Only swap objects that are currently in memory.
9808 * Also don't swap shared objects: not a good idea in general and
9809 * we need to ensure that the main thread does not touch the
9810 * object while the I/O thread is using it, but we can't
9811 * control other keys without adding additional mutex. */
9812 if (val
->storage
!= REDIS_VM_MEMORY
|| val
->refcount
!= 1) {
9813 if (maxtries
) i
--; /* don't count this try */
9816 swappability
= computeObjectSwappability(val
);
9817 if (!best
|| swappability
> best_swappability
) {
9819 best_swappability
= swappability
;
9824 if (best
== NULL
) return REDIS_ERR
;
9825 key
= dictGetEntryKey(best
);
9826 val
= dictGetEntryVal(best
);
9828 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9829 key
, best_swappability
);
9833 robj
*keyobj
= createStringObject(key
,sdslen(key
));
9834 vmSwapObjectThreaded(keyobj
,val
,best_db
);
9835 decrRefCount(keyobj
);
9840 if ((vp
= vmSwapObjectBlocking(val
)) != NULL
) {
9841 dictGetEntryVal(best
) = vp
;
9849 static int vmSwapOneObjectBlocking() {
9850 return vmSwapOneObject(0);
9853 static int vmSwapOneObjectThreaded() {
9854 return vmSwapOneObject(1);
9857 /* Return true if it's safe to swap out objects in a given moment.
9858 * Basically we don't want to swap objects out while there is a BGSAVE
9859 * or a BGAEOREWRITE running in backgroud. */
9860 static int vmCanSwapOut(void) {
9861 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9864 /* =================== Virtual Memory - Threaded I/O ======================= */
9866 static void freeIOJob(iojob
*j
) {
9867 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9868 j
->type
== REDIS_IOJOB_DO_SWAP
||
9869 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9871 /* we fix the storage type, otherwise decrRefCount() will try to
9872 * kill the I/O thread Job (that does no longer exists). */
9873 if (j
->val
->storage
== REDIS_VM_SWAPPING
)
9874 j
->val
->storage
= REDIS_VM_MEMORY
;
9875 decrRefCount(j
->val
);
9877 decrRefCount(j
->key
);
9881 /* Every time a thread finished a Job, it writes a byte into the write side
9882 * of an unix pipe in order to "awake" the main thread, and this function
9884 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9888 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9890 REDIS_NOTUSED(mask
);
9891 REDIS_NOTUSED(privdata
);
9893 /* For every byte we read in the read side of the pipe, there is one
9894 * I/O job completed to process. */
9895 while((retval
= read(fd
,buf
,1)) == 1) {
9898 struct dictEntry
*de
;
9900 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9902 /* Get the processed element (the oldest one) */
9904 assert(listLength(server
.io_processed
) != 0);
9905 if (toprocess
== -1) {
9906 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9907 if (toprocess
<= 0) toprocess
= 1;
9909 ln
= listFirst(server
.io_processed
);
9911 listDelNode(server
.io_processed
,ln
);
9913 /* If this job is marked as canceled, just ignore it */
9918 /* Post process it in the main thread, as there are things we
9919 * can do just here to avoid race conditions and/or invasive locks */
9920 redisLog(REDIS_DEBUG
,"COMPLETED Job type: %d, ID %p, key: %s", j
->type
, (void*)j
->id
, (unsigned char*)j
->key
->ptr
);
9921 de
= dictFind(j
->db
->dict
,j
->key
->ptr
);
9922 redisAssert(de
!= NULL
);
9923 if (j
->type
== REDIS_IOJOB_LOAD
) {
9925 vmpointer
*vp
= dictGetEntryVal(de
);
9927 /* Key loaded, bring it at home */
9928 vmMarkPagesFree(vp
->page
,vp
->usedpages
);
9929 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9930 (unsigned char*) j
->key
->ptr
);
9931 server
.vm_stats_swapped_objects
--;
9932 server
.vm_stats_swapins
++;
9933 dictGetEntryVal(de
) = j
->val
;
9934 incrRefCount(j
->val
);
9936 /* Handle clients waiting for this key to be loaded. */
9937 handleClientsBlockedOnSwappedKey(db
,j
->key
);
9940 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9941 /* Now we know the amount of pages required to swap this object.
9942 * Let's find some space for it, and queue this task again
9943 * rebranded as REDIS_IOJOB_DO_SWAP. */
9944 if (!vmCanSwapOut() ||
9945 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9947 /* Ooops... no space or we can't swap as there is
9948 * a fork()ed Redis trying to save stuff on disk. */
9949 j
->val
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9952 /* Note that we need to mark this pages as used now,
9953 * if the job will be canceled, we'll mark them as freed
9955 vmMarkPagesUsed(j
->page
,j
->pages
);
9956 j
->type
= REDIS_IOJOB_DO_SWAP
;
9961 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9964 /* Key swapped. We can finally free some memory. */
9965 if (j
->val
->storage
!= REDIS_VM_SWAPPING
) {
9966 vmpointer
*vp
= (vmpointer
*) j
->id
;
9967 printf("storage: %d\n",vp
->storage
);
9968 printf("key->name: %s\n",(char*)j
->key
->ptr
);
9969 printf("val: %p\n",(void*)j
->val
);
9970 printf("val->type: %d\n",j
->val
->type
);
9971 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9973 redisAssert(j
->val
->storage
== REDIS_VM_SWAPPING
);
9974 vp
= createVmPointer(j
->val
->type
);
9976 vp
->usedpages
= j
->pages
;
9977 dictGetEntryVal(de
) = vp
;
9978 /* Fix the storage otherwise decrRefCount will attempt to
9979 * remove the associated I/O job */
9980 j
->val
->storage
= REDIS_VM_MEMORY
;
9981 decrRefCount(j
->val
);
9982 redisLog(REDIS_DEBUG
,
9983 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9984 (unsigned char*) j
->key
->ptr
,
9985 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9986 server
.vm_stats_swapped_objects
++;
9987 server
.vm_stats_swapouts
++;
9989 /* Put a few more swap requests in queue if we are still
9991 if (trytoswap
&& vmCanSwapOut() &&
9992 zmalloc_used_memory() > server
.vm_max_memory
)
9997 more
= listLength(server
.io_newjobs
) <
9998 (unsigned) server
.vm_max_threads
;
10000 /* Don't waste CPU time if swappable objects are rare. */
10001 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
10009 if (processed
== toprocess
) return;
10011 if (retval
< 0 && errno
!= EAGAIN
) {
10012 redisLog(REDIS_WARNING
,
10013 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
10018 static void lockThreadedIO(void) {
10019 pthread_mutex_lock(&server
.io_mutex
);
10022 static void unlockThreadedIO(void) {
10023 pthread_mutex_unlock(&server
.io_mutex
);
10026 /* Remove the specified object from the threaded I/O queue if still not
10027 * processed, otherwise make sure to flag it as canceled. */
10028 static void vmCancelThreadedIOJob(robj
*o
) {
10030 server
.io_newjobs
, /* 0 */
10031 server
.io_processing
, /* 1 */
10032 server
.io_processed
/* 2 */
10036 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
10039 /* Search for a matching object in one of the queues */
10040 for (i
= 0; i
< 3; i
++) {
10044 listRewind(lists
[i
],&li
);
10045 while ((ln
= listNext(&li
)) != NULL
) {
10046 iojob
*job
= ln
->value
;
10048 if (job
->canceled
) continue; /* Skip this, already canceled. */
10049 if (job
->id
== o
) {
10050 redisLog(REDIS_DEBUG
,"*** CANCELED %p (key %s) (type %d) (LIST ID %d)\n",
10051 (void*)job
, (char*)job
->key
->ptr
, job
->type
, i
);
10052 /* Mark the pages as free since the swap didn't happened
10053 * or happened but is now discarded. */
10054 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
10055 vmMarkPagesFree(job
->page
,job
->pages
);
10056 /* Cancel the job. It depends on the list the job is
10059 case 0: /* io_newjobs */
10060 /* If the job was yet not processed the best thing to do
10061 * is to remove it from the queue at all */
10063 listDelNode(lists
[i
],ln
);
10065 case 1: /* io_processing */
10066 /* Oh Shi- the thread is messing with the Job:
10068 * Probably it's accessing the object if this is a
10069 * PREPARE_SWAP or DO_SWAP job.
10070 * If it's a LOAD job it may be reading from disk and
10071 * if we don't wait for the job to terminate before to
10072 * cancel it, maybe in a few microseconds data can be
10073 * corrupted in this pages. So the short story is:
10075 * Better to wait for the job to move into the
10076 * next queue (processed)... */
10078 /* We try again and again until the job is completed. */
10079 unlockThreadedIO();
10080 /* But let's wait some time for the I/O thread
10081 * to finish with this job. After all this condition
10082 * should be very rare. */
10085 case 2: /* io_processed */
10086 /* The job was already processed, that's easy...
10087 * just mark it as canceled so that we'll ignore it
10088 * when processing completed jobs. */
10092 /* Finally we have to adjust the storage type of the object
10093 * in order to "UNDO" the operaiton. */
10094 if (o
->storage
== REDIS_VM_LOADING
)
10095 o
->storage
= REDIS_VM_SWAPPED
;
10096 else if (o
->storage
== REDIS_VM_SWAPPING
)
10097 o
->storage
= REDIS_VM_MEMORY
;
10098 unlockThreadedIO();
10099 redisLog(REDIS_DEBUG
,"*** DONE");
10104 unlockThreadedIO();
10105 printf("Not found: %p\n", (void*)o
);
10106 redisAssert(1 != 1); /* We should never reach this */
10109 static void *IOThreadEntryPoint(void *arg
) {
10112 REDIS_NOTUSED(arg
);
10114 pthread_detach(pthread_self());
10116 /* Get a new job to process */
10118 if (listLength(server
.io_newjobs
) == 0) {
10119 /* No new jobs in queue, exit. */
10120 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
10121 (long) pthread_self());
10122 server
.io_active_threads
--;
10123 unlockThreadedIO();
10126 ln
= listFirst(server
.io_newjobs
);
10128 listDelNode(server
.io_newjobs
,ln
);
10129 /* Add the job in the processing queue */
10130 j
->thread
= pthread_self();
10131 listAddNodeTail(server
.io_processing
,j
);
10132 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
10133 unlockThreadedIO();
10134 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
10135 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
10137 /* Process the Job */
10138 if (j
->type
== REDIS_IOJOB_LOAD
) {
10139 vmpointer
*vp
= (vmpointer
*)j
->id
;
10140 j
->val
= vmReadObjectFromSwap(j
->page
,vp
->vtype
);
10141 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
10142 FILE *fp
= fopen("/dev/null","w+");
10143 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
10145 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
10146 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
10150 /* Done: insert the job into the processed queue */
10151 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
10152 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
10154 listDelNode(server
.io_processing
,ln
);
10155 listAddNodeTail(server
.io_processed
,j
);
10156 unlockThreadedIO();
10158 /* Signal the main thread there is new stuff to process */
10159 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
10161 return NULL
; /* never reached */
10164 static void spawnIOThread(void) {
10166 sigset_t mask
, omask
;
10169 sigemptyset(&mask
);
10170 sigaddset(&mask
,SIGCHLD
);
10171 sigaddset(&mask
,SIGHUP
);
10172 sigaddset(&mask
,SIGPIPE
);
10173 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
10174 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
10175 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
10179 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
10180 server
.io_active_threads
++;
10183 /* We need to wait for the last thread to exit before we are able to
10184 * fork() in order to BGSAVE or BGREWRITEAOF. */
10185 static void waitEmptyIOJobsQueue(void) {
10187 int io_processed_len
;
10190 if (listLength(server
.io_newjobs
) == 0 &&
10191 listLength(server
.io_processing
) == 0 &&
10192 server
.io_active_threads
== 0)
10194 unlockThreadedIO();
10197 /* While waiting for empty jobs queue condition we post-process some
10198 * finshed job, as I/O threads may be hanging trying to write against
10199 * the io_ready_pipe_write FD but there are so much pending jobs that
10200 * it's blocking. */
10201 io_processed_len
= listLength(server
.io_processed
);
10202 unlockThreadedIO();
10203 if (io_processed_len
) {
10204 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
10205 usleep(1000); /* 1 millisecond */
10207 usleep(10000); /* 10 milliseconds */
10212 static void vmReopenSwapFile(void) {
10213 /* Note: we don't close the old one as we are in the child process
10214 * and don't want to mess at all with the original file object. */
10215 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
10216 if (server
.vm_fp
== NULL
) {
10217 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
10218 server
.vm_swap_file
);
10221 server
.vm_fd
= fileno(server
.vm_fp
);
10224 /* This function must be called while with threaded IO locked */
10225 static void queueIOJob(iojob
*j
) {
10226 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
10227 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
10228 listAddNodeTail(server
.io_newjobs
,j
);
10229 if (server
.io_active_threads
< server
.vm_max_threads
)
10233 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
10236 j
= zmalloc(sizeof(*j
));
10237 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
10241 j
->id
= j
->val
= val
;
10244 j
->thread
= (pthread_t
) -1;
10245 val
->storage
= REDIS_VM_SWAPPING
;
10249 unlockThreadedIO();
10253 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
10255 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
10256 * If there is not already a job loading the key, it is craeted.
10257 * The key is added to the io_keys list in the client structure, and also
10258 * in the hash table mapping swapped keys to waiting clients, that is,
10259 * server.io_waited_keys. */
10260 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
10261 struct dictEntry
*de
;
10265 /* If the key does not exist or is already in RAM we don't need to
10266 * block the client at all. */
10267 de
= dictFind(c
->db
->dict
,key
->ptr
);
10268 if (de
== NULL
) return 0;
10269 o
= dictGetEntryVal(de
);
10270 if (o
->storage
== REDIS_VM_MEMORY
) {
10272 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
10273 /* We were swapping the key, undo it! */
10274 vmCancelThreadedIOJob(o
);
10278 /* OK: the key is either swapped, or being loaded just now. */
10280 /* Add the key to the list of keys this client is waiting for.
10281 * This maps clients to keys they are waiting for. */
10282 listAddNodeTail(c
->io_keys
,key
);
10285 /* Add the client to the swapped keys => clients waiting map. */
10286 de
= dictFind(c
->db
->io_keys
,key
);
10290 /* For every key we take a list of clients blocked for it */
10292 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
10294 assert(retval
== DICT_OK
);
10296 l
= dictGetEntryVal(de
);
10298 listAddNodeTail(l
,c
);
10300 /* Are we already loading the key from disk? If not create a job */
10301 if (o
->storage
== REDIS_VM_SWAPPED
) {
10303 vmpointer
*vp
= (vmpointer
*)o
;
10305 o
->storage
= REDIS_VM_LOADING
;
10306 j
= zmalloc(sizeof(*j
));
10307 j
->type
= REDIS_IOJOB_LOAD
;
10312 j
->page
= vp
->page
;
10315 j
->thread
= (pthread_t
) -1;
10318 unlockThreadedIO();
10323 /* Preload keys for any command with first, last and step values for
10324 * the command keys prototype, as defined in the command table. */
10325 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10327 if (cmd
->vm_firstkey
== 0) return;
10328 last
= cmd
->vm_lastkey
;
10329 if (last
< 0) last
= argc
+last
;
10330 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
10331 redisAssert(j
< argc
);
10332 waitForSwappedKey(c
,argv
[j
]);
10336 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10337 * Note that the number of keys to preload is user-defined, so we need to
10338 * apply a sanity check against argc. */
10339 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10341 REDIS_NOTUSED(cmd
);
10343 num
= atoi(argv
[2]->ptr
);
10344 if (num
> (argc
-3)) return;
10345 for (i
= 0; i
< num
; i
++) {
10346 waitForSwappedKey(c
,argv
[3+i
]);
10350 /* Preload keys needed to execute the entire MULTI/EXEC block.
10352 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10353 * and will block the client when any command requires a swapped out value. */
10354 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10356 struct redisCommand
*mcmd
;
10358 REDIS_NOTUSED(cmd
);
10359 REDIS_NOTUSED(argc
);
10360 REDIS_NOTUSED(argv
);
10362 if (!(c
->flags
& REDIS_MULTI
)) return;
10363 for (i
= 0; i
< c
->mstate
.count
; i
++) {
10364 mcmd
= c
->mstate
.commands
[i
].cmd
;
10365 margc
= c
->mstate
.commands
[i
].argc
;
10366 margv
= c
->mstate
.commands
[i
].argv
;
10368 if (mcmd
->vm_preload_proc
!= NULL
) {
10369 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
10371 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
10376 /* Is this client attempting to run a command against swapped keys?
10377 * If so, block it ASAP, load the keys in background, then resume it.
10379 * The important idea about this function is that it can fail! If keys will
10380 * still be swapped when the client is resumed, this key lookups will
10381 * just block loading keys from disk. In practical terms this should only
10382 * happen with SORT BY command or if there is a bug in this function.
10384 * Return 1 if the client is marked as blocked, 0 if the client can
10385 * continue as the keys it is going to access appear to be in memory. */
10386 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
10387 if (cmd
->vm_preload_proc
!= NULL
) {
10388 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
10390 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
10393 /* If the client was blocked for at least one key, mark it as blocked. */
10394 if (listLength(c
->io_keys
)) {
10395 c
->flags
|= REDIS_IO_WAIT
;
10396 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
10397 server
.vm_blocked_clients
++;
10404 /* Remove the 'key' from the list of blocked keys for a given client.
10406 * The function returns 1 when there are no longer blocking keys after
10407 * the current one was removed (and the client can be unblocked). */
10408 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
10412 struct dictEntry
*de
;
10414 /* Remove the key from the list of keys this client is waiting for. */
10415 listRewind(c
->io_keys
,&li
);
10416 while ((ln
= listNext(&li
)) != NULL
) {
10417 if (equalStringObjects(ln
->value
,key
)) {
10418 listDelNode(c
->io_keys
,ln
);
10422 assert(ln
!= NULL
);
10424 /* Remove the client form the key => waiting clients map. */
10425 de
= dictFind(c
->db
->io_keys
,key
);
10426 assert(de
!= NULL
);
10427 l
= dictGetEntryVal(de
);
10428 ln
= listSearchKey(l
,c
);
10429 assert(ln
!= NULL
);
10431 if (listLength(l
) == 0)
10432 dictDelete(c
->db
->io_keys
,key
);
10434 return listLength(c
->io_keys
) == 0;
10437 /* Every time we now a key was loaded back in memory, we handle clients
10438 * waiting for this key if any. */
10439 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
10440 struct dictEntry
*de
;
10445 de
= dictFind(db
->io_keys
,key
);
10448 l
= dictGetEntryVal(de
);
10449 len
= listLength(l
);
10450 /* Note: we can't use something like while(listLength(l)) as the list
10451 * can be freed by the calling function when we remove the last element. */
10454 redisClient
*c
= ln
->value
;
10456 if (dontWaitForSwappedKey(c
,key
)) {
10457 /* Put the client in the list of clients ready to go as we
10458 * loaded all the keys about it. */
10459 listAddNodeTail(server
.io_ready_clients
,c
);
10464 /* =========================== Remote Configuration ========================= */
10466 static void configSetCommand(redisClient
*c
) {
10467 robj
*o
= getDecodedObject(c
->argv
[3]);
10470 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
10471 zfree(server
.dbfilename
);
10472 server
.dbfilename
= zstrdup(o
->ptr
);
10473 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
10474 zfree(server
.requirepass
);
10475 server
.requirepass
= zstrdup(o
->ptr
);
10476 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
10477 zfree(server
.masterauth
);
10478 server
.masterauth
= zstrdup(o
->ptr
);
10479 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
10480 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10481 ll
< 0) goto badfmt
;
10482 server
.maxmemory
= ll
;
10483 } else if (!strcasecmp(c
->argv
[2]->ptr
,"timeout")) {
10484 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10485 ll
< 0 || ll
> LONG_MAX
) goto badfmt
;
10486 server
.maxidletime
= ll
;
10487 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
10488 if (!strcasecmp(o
->ptr
,"no")) {
10489 server
.appendfsync
= APPENDFSYNC_NO
;
10490 } else if (!strcasecmp(o
->ptr
,"everysec")) {
10491 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
10492 } else if (!strcasecmp(o
->ptr
,"always")) {
10493 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
10497 } else if (!strcasecmp(c
->argv
[2]->ptr
,"no-appendfsync-on-rewrite")) {
10498 int yn
= yesnotoi(o
->ptr
);
10500 if (yn
== -1) goto badfmt
;
10501 server
.no_appendfsync_on_rewrite
= yn
;
10502 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendonly")) {
10503 int old
= server
.appendonly
;
10504 int new = yesnotoi(o
->ptr
);
10506 if (new == -1) goto badfmt
;
10511 if (startAppendOnly() == REDIS_ERR
) {
10512 addReplySds(c
,sdscatprintf(sdsempty(),
10513 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10519 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
10521 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
10523 /* Perform sanity check before setting the new config:
10524 * - Even number of args
10525 * - Seconds >= 1, changes >= 0 */
10527 sdsfreesplitres(v
,vlen
);
10530 for (j
= 0; j
< vlen
; j
++) {
10534 val
= strtoll(v
[j
], &eptr
, 10);
10535 if (eptr
[0] != '\0' ||
10536 ((j
& 1) == 0 && val
< 1) ||
10537 ((j
& 1) == 1 && val
< 0)) {
10538 sdsfreesplitres(v
,vlen
);
10542 /* Finally set the new config */
10543 resetServerSaveParams();
10544 for (j
= 0; j
< vlen
; j
+= 2) {
10548 seconds
= strtoll(v
[j
],NULL
,10);
10549 changes
= strtoll(v
[j
+1],NULL
,10);
10550 appendServerSaveParams(seconds
, changes
);
10552 sdsfreesplitres(v
,vlen
);
10554 addReplySds(c
,sdscatprintf(sdsempty(),
10555 "-ERR not supported CONFIG parameter %s\r\n",
10556 (char*)c
->argv
[2]->ptr
));
10561 addReply(c
,shared
.ok
);
10564 badfmt
: /* Bad format errors */
10565 addReplySds(c
,sdscatprintf(sdsempty(),
10566 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10568 (char*)c
->argv
[2]->ptr
));
10572 static void configGetCommand(redisClient
*c
) {
10573 robj
*o
= getDecodedObject(c
->argv
[2]);
10574 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
10575 char *pattern
= o
->ptr
;
10578 addReply(c
,lenobj
);
10579 decrRefCount(lenobj
);
10581 if (stringmatch(pattern
,"dbfilename",0)) {
10582 addReplyBulkCString(c
,"dbfilename");
10583 addReplyBulkCString(c
,server
.dbfilename
);
10586 if (stringmatch(pattern
,"requirepass",0)) {
10587 addReplyBulkCString(c
,"requirepass");
10588 addReplyBulkCString(c
,server
.requirepass
);
10591 if (stringmatch(pattern
,"masterauth",0)) {
10592 addReplyBulkCString(c
,"masterauth");
10593 addReplyBulkCString(c
,server
.masterauth
);
10596 if (stringmatch(pattern
,"maxmemory",0)) {
10599 ll2string(buf
,128,server
.maxmemory
);
10600 addReplyBulkCString(c
,"maxmemory");
10601 addReplyBulkCString(c
,buf
);
10604 if (stringmatch(pattern
,"timeout",0)) {
10607 ll2string(buf
,128,server
.maxidletime
);
10608 addReplyBulkCString(c
,"timeout");
10609 addReplyBulkCString(c
,buf
);
10612 if (stringmatch(pattern
,"appendonly",0)) {
10613 addReplyBulkCString(c
,"appendonly");
10614 addReplyBulkCString(c
,server
.appendonly
? "yes" : "no");
10617 if (stringmatch(pattern
,"no-appendfsync-on-rewrite",0)) {
10618 addReplyBulkCString(c
,"no-appendfsync-on-rewrite");
10619 addReplyBulkCString(c
,server
.no_appendfsync_on_rewrite
? "yes" : "no");
10622 if (stringmatch(pattern
,"appendfsync",0)) {
10625 switch(server
.appendfsync
) {
10626 case APPENDFSYNC_NO
: policy
= "no"; break;
10627 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
10628 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
10629 default: policy
= "unknown"; break; /* too harmless to panic */
10631 addReplyBulkCString(c
,"appendfsync");
10632 addReplyBulkCString(c
,policy
);
10635 if (stringmatch(pattern
,"save",0)) {
10636 sds buf
= sdsempty();
10639 for (j
= 0; j
< server
.saveparamslen
; j
++) {
10640 buf
= sdscatprintf(buf
,"%ld %d",
10641 server
.saveparams
[j
].seconds
,
10642 server
.saveparams
[j
].changes
);
10643 if (j
!= server
.saveparamslen
-1)
10644 buf
= sdscatlen(buf
," ",1);
10646 addReplyBulkCString(c
,"save");
10647 addReplyBulkCString(c
,buf
);
10652 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
10655 static void configCommand(redisClient
*c
) {
10656 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
10657 if (c
->argc
!= 4) goto badarity
;
10658 configSetCommand(c
);
10659 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
10660 if (c
->argc
!= 3) goto badarity
;
10661 configGetCommand(c
);
10662 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
10663 if (c
->argc
!= 2) goto badarity
;
10664 server
.stat_numcommands
= 0;
10665 server
.stat_numconnections
= 0;
10666 server
.stat_expiredkeys
= 0;
10667 server
.stat_starttime
= time(NULL
);
10668 addReply(c
,shared
.ok
);
10670 addReplySds(c
,sdscatprintf(sdsempty(),
10671 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10676 addReplySds(c
,sdscatprintf(sdsempty(),
10677 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10678 (char*) c
->argv
[1]->ptr
));
10681 /* =========================== Pubsub implementation ======================== */
10683 static void freePubsubPattern(void *p
) {
10684 pubsubPattern
*pat
= p
;
10686 decrRefCount(pat
->pattern
);
10690 static int listMatchPubsubPattern(void *a
, void *b
) {
10691 pubsubPattern
*pa
= a
, *pb
= b
;
10693 return (pa
->client
== pb
->client
) &&
10694 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10697 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10698 * 0 if the client was already subscribed to that channel. */
10699 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10700 struct dictEntry
*de
;
10701 list
*clients
= NULL
;
10704 /* Add the channel to the client -> channels hash table */
10705 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10707 incrRefCount(channel
);
10708 /* Add the client to the channel -> list of clients hash table */
10709 de
= dictFind(server
.pubsub_channels
,channel
);
10711 clients
= listCreate();
10712 dictAdd(server
.pubsub_channels
,channel
,clients
);
10713 incrRefCount(channel
);
10715 clients
= dictGetEntryVal(de
);
10717 listAddNodeTail(clients
,c
);
10719 /* Notify the client */
10720 addReply(c
,shared
.mbulk3
);
10721 addReply(c
,shared
.subscribebulk
);
10722 addReplyBulk(c
,channel
);
10723 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10727 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10728 * 0 if the client was not subscribed to the specified channel. */
10729 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10730 struct dictEntry
*de
;
10735 /* Remove the channel from the client -> channels hash table */
10736 incrRefCount(channel
); /* channel may be just a pointer to the same object
10737 we have in the hash tables. Protect it... */
10738 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10740 /* Remove the client from the channel -> clients list hash table */
10741 de
= dictFind(server
.pubsub_channels
,channel
);
10742 assert(de
!= NULL
);
10743 clients
= dictGetEntryVal(de
);
10744 ln
= listSearchKey(clients
,c
);
10745 assert(ln
!= NULL
);
10746 listDelNode(clients
,ln
);
10747 if (listLength(clients
) == 0) {
10748 /* Free the list and associated hash entry at all if this was
10749 * the latest client, so that it will be possible to abuse
10750 * Redis PUBSUB creating millions of channels. */
10751 dictDelete(server
.pubsub_channels
,channel
);
10754 /* Notify the client */
10756 addReply(c
,shared
.mbulk3
);
10757 addReply(c
,shared
.unsubscribebulk
);
10758 addReplyBulk(c
,channel
);
10759 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10760 listLength(c
->pubsub_patterns
));
10763 decrRefCount(channel
); /* it is finally safe to release it */
10767 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10768 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10771 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10773 pubsubPattern
*pat
;
10774 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10775 incrRefCount(pattern
);
10776 pat
= zmalloc(sizeof(*pat
));
10777 pat
->pattern
= getDecodedObject(pattern
);
10779 listAddNodeTail(server
.pubsub_patterns
,pat
);
10781 /* Notify the client */
10782 addReply(c
,shared
.mbulk3
);
10783 addReply(c
,shared
.psubscribebulk
);
10784 addReplyBulk(c
,pattern
);
10785 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10789 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10790 * 0 if the client was not subscribed to the specified channel. */
10791 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10796 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10797 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10799 listDelNode(c
->pubsub_patterns
,ln
);
10801 pat
.pattern
= pattern
;
10802 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10803 listDelNode(server
.pubsub_patterns
,ln
);
10805 /* Notify the client */
10807 addReply(c
,shared
.mbulk3
);
10808 addReply(c
,shared
.punsubscribebulk
);
10809 addReplyBulk(c
,pattern
);
10810 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10811 listLength(c
->pubsub_patterns
));
10813 decrRefCount(pattern
);
10817 /* Unsubscribe from all the channels. Return the number of channels the
10818 * client was subscribed from. */
10819 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10820 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10824 while((de
= dictNext(di
)) != NULL
) {
10825 robj
*channel
= dictGetEntryKey(de
);
10827 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10829 dictReleaseIterator(di
);
10833 /* Unsubscribe from all the patterns. Return the number of patterns the
10834 * client was subscribed from. */
10835 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10840 listRewind(c
->pubsub_patterns
,&li
);
10841 while ((ln
= listNext(&li
)) != NULL
) {
10842 robj
*pattern
= ln
->value
;
10844 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10849 /* Publish a message */
10850 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10852 struct dictEntry
*de
;
10856 /* Send to clients listening for that channel */
10857 de
= dictFind(server
.pubsub_channels
,channel
);
10859 list
*list
= dictGetEntryVal(de
);
10863 listRewind(list
,&li
);
10864 while ((ln
= listNext(&li
)) != NULL
) {
10865 redisClient
*c
= ln
->value
;
10867 addReply(c
,shared
.mbulk3
);
10868 addReply(c
,shared
.messagebulk
);
10869 addReplyBulk(c
,channel
);
10870 addReplyBulk(c
,message
);
10874 /* Send to clients listening to matching channels */
10875 if (listLength(server
.pubsub_patterns
)) {
10876 listRewind(server
.pubsub_patterns
,&li
);
10877 channel
= getDecodedObject(channel
);
10878 while ((ln
= listNext(&li
)) != NULL
) {
10879 pubsubPattern
*pat
= ln
->value
;
10881 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10882 sdslen(pat
->pattern
->ptr
),
10883 (char*)channel
->ptr
,
10884 sdslen(channel
->ptr
),0)) {
10885 addReply(pat
->client
,shared
.mbulk4
);
10886 addReply(pat
->client
,shared
.pmessagebulk
);
10887 addReplyBulk(pat
->client
,pat
->pattern
);
10888 addReplyBulk(pat
->client
,channel
);
10889 addReplyBulk(pat
->client
,message
);
10893 decrRefCount(channel
);
10898 static void subscribeCommand(redisClient
*c
) {
10901 for (j
= 1; j
< c
->argc
; j
++)
10902 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10905 static void unsubscribeCommand(redisClient
*c
) {
10906 if (c
->argc
== 1) {
10907 pubsubUnsubscribeAllChannels(c
,1);
10912 for (j
= 1; j
< c
->argc
; j
++)
10913 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10917 static void psubscribeCommand(redisClient
*c
) {
10920 for (j
= 1; j
< c
->argc
; j
++)
10921 pubsubSubscribePattern(c
,c
->argv
[j
]);
10924 static void punsubscribeCommand(redisClient
*c
) {
10925 if (c
->argc
== 1) {
10926 pubsubUnsubscribeAllPatterns(c
,1);
10931 for (j
= 1; j
< c
->argc
; j
++)
10932 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10936 static void publishCommand(redisClient
*c
) {
10937 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10938 addReplyLongLong(c
,receivers
);
10941 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10943 * The implementation uses a per-DB hash table mapping keys to list of clients
10944 * WATCHing those keys, so that given a key that is going to be modified
10945 * we can mark all the associated clients as dirty.
10947 * Also every client contains a list of WATCHed keys so that's possible to
10948 * un-watch such keys when the client is freed or when UNWATCH is called. */
10950 /* In the client->watched_keys list we need to use watchedKey structures
10951 * as in order to identify a key in Redis we need both the key name and the
10953 typedef struct watchedKey
{
10958 /* Watch for the specified key */
10959 static void watchForKey(redisClient
*c
, robj
*key
) {
10960 list
*clients
= NULL
;
10965 /* Check if we are already watching for this key */
10966 listRewind(c
->watched_keys
,&li
);
10967 while((ln
= listNext(&li
))) {
10968 wk
= listNodeValue(ln
);
10969 if (wk
->db
== c
->db
&& equalStringObjects(key
,wk
->key
))
10970 return; /* Key already watched */
10972 /* This key is not already watched in this DB. Let's add it */
10973 clients
= dictFetchValue(c
->db
->watched_keys
,key
);
10975 clients
= listCreate();
10976 dictAdd(c
->db
->watched_keys
,key
,clients
);
10979 listAddNodeTail(clients
,c
);
10980 /* Add the new key to the lits of keys watched by this client */
10981 wk
= zmalloc(sizeof(*wk
));
10985 listAddNodeTail(c
->watched_keys
,wk
);
10988 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10989 * flag is up to the caller. */
10990 static void unwatchAllKeys(redisClient
*c
) {
10994 if (listLength(c
->watched_keys
) == 0) return;
10995 listRewind(c
->watched_keys
,&li
);
10996 while((ln
= listNext(&li
))) {
11000 /* Lookup the watched key -> clients list and remove the client
11002 wk
= listNodeValue(ln
);
11003 clients
= dictFetchValue(wk
->db
->watched_keys
, wk
->key
);
11004 assert(clients
!= NULL
);
11005 listDelNode(clients
,listSearchKey(clients
,c
));
11006 /* Kill the entry at all if this was the only client */
11007 if (listLength(clients
) == 0)
11008 dictDelete(wk
->db
->watched_keys
, wk
->key
);
11009 /* Remove this watched key from the client->watched list */
11010 listDelNode(c
->watched_keys
,ln
);
11011 decrRefCount(wk
->key
);
11016 /* "Touch" a key, so that if this key is being WATCHed by some client the
11017 * next EXEC will fail. */
11018 static void touchWatchedKey(redisDb
*db
, robj
*key
) {
11023 if (dictSize(db
->watched_keys
) == 0) return;
11024 clients
= dictFetchValue(db
->watched_keys
, key
);
11025 if (!clients
) return;
11027 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
11028 /* Check if we are already watching for this key */
11029 listRewind(clients
,&li
);
11030 while((ln
= listNext(&li
))) {
11031 redisClient
*c
= listNodeValue(ln
);
11033 c
->flags
|= REDIS_DIRTY_CAS
;
11037 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
11038 * flush but will be deleted as effect of the flushing operation should
11039 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
11040 * a FLUSHALL operation (all the DBs flushed). */
11041 static void touchWatchedKeysOnFlush(int dbid
) {
11045 /* For every client, check all the waited keys */
11046 listRewind(server
.clients
,&li1
);
11047 while((ln
= listNext(&li1
))) {
11048 redisClient
*c
= listNodeValue(ln
);
11049 listRewind(c
->watched_keys
,&li2
);
11050 while((ln
= listNext(&li2
))) {
11051 watchedKey
*wk
= listNodeValue(ln
);
11053 /* For every watched key matching the specified DB, if the
11054 * key exists, mark the client as dirty, as the key will be
11056 if (dbid
== -1 || wk
->db
->id
== dbid
) {
11057 if (dictFind(wk
->db
->dict
, wk
->key
->ptr
) != NULL
)
11058 c
->flags
|= REDIS_DIRTY_CAS
;
11064 static void watchCommand(redisClient
*c
) {
11067 if (c
->flags
& REDIS_MULTI
) {
11068 addReplySds(c
,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
11071 for (j
= 1; j
< c
->argc
; j
++)
11072 watchForKey(c
,c
->argv
[j
]);
11073 addReply(c
,shared
.ok
);
11076 static void unwatchCommand(redisClient
*c
) {
11078 c
->flags
&= (~REDIS_DIRTY_CAS
);
11079 addReply(c
,shared
.ok
);
11082 /* ================================= Debugging ============================== */
11084 /* Compute the sha1 of string at 's' with 'len' bytes long.
11085 * The SHA1 is then xored againt the string pointed by digest.
11086 * Since xor is commutative, this operation is used in order to
11087 * "add" digests relative to unordered elements.
11089 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
11090 static void xorDigest(unsigned char *digest
, void *ptr
, size_t len
) {
11092 unsigned char hash
[20], *s
= ptr
;
11096 SHA1Update(&ctx
,s
,len
);
11097 SHA1Final(hash
,&ctx
);
11099 for (j
= 0; j
< 20; j
++)
11100 digest
[j
] ^= hash
[j
];
11103 static void xorObjectDigest(unsigned char *digest
, robj
*o
) {
11104 o
= getDecodedObject(o
);
11105 xorDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
11109 /* This function instead of just computing the SHA1 and xoring it
11110 * against diget, also perform the digest of "digest" itself and
11111 * replace the old value with the new one.
11113 * So the final digest will be:
11115 * digest = SHA1(digest xor SHA1(data))
11117 * This function is used every time we want to preserve the order so
11118 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
11120 * Also note that mixdigest("foo") followed by mixdigest("bar")
11121 * will lead to a different digest compared to "fo", "obar".
11123 static void mixDigest(unsigned char *digest
, void *ptr
, size_t len
) {
11127 xorDigest(digest
,s
,len
);
11129 SHA1Update(&ctx
,digest
,20);
11130 SHA1Final(digest
,&ctx
);
11133 static void mixObjectDigest(unsigned char *digest
, robj
*o
) {
11134 o
= getDecodedObject(o
);
11135 mixDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
11139 /* Compute the dataset digest. Since keys, sets elements, hashes elements
11140 * are not ordered, we use a trick: every aggregate digest is the xor
11141 * of the digests of their elements. This way the order will not change
11142 * the result. For list instead we use a feedback entering the output digest
11143 * as input in order to ensure that a different ordered list will result in
11144 * a different digest. */
11145 static void computeDatasetDigest(unsigned char *final
) {
11146 unsigned char digest
[20];
11148 dictIterator
*di
= NULL
;
11153 memset(final
,0,20); /* Start with a clean result */
11155 for (j
= 0; j
< server
.dbnum
; j
++) {
11156 redisDb
*db
= server
.db
+j
;
11158 if (dictSize(db
->dict
) == 0) continue;
11159 di
= dictGetIterator(db
->dict
);
11161 /* hash the DB id, so the same dataset moved in a different
11162 * DB will lead to a different digest */
11164 mixDigest(final
,&aux
,sizeof(aux
));
11166 /* Iterate this DB writing every entry */
11167 while((de
= dictNext(di
)) != NULL
) {
11172 memset(digest
,0,20); /* This key-val digest */
11173 key
= dictGetEntryKey(de
);
11174 keyobj
= createStringObject(key
,sdslen(key
));
11176 mixDigest(digest
,key
,sdslen(key
));
11178 /* Make sure the key is loaded if VM is active */
11179 o
= lookupKeyRead(db
,keyobj
);
11181 aux
= htonl(o
->type
);
11182 mixDigest(digest
,&aux
,sizeof(aux
));
11183 expiretime
= getExpire(db
,keyobj
);
11185 /* Save the key and associated value */
11186 if (o
->type
== REDIS_STRING
) {
11187 mixObjectDigest(digest
,o
);
11188 } else if (o
->type
== REDIS_LIST
) {
11189 listTypeIterator
*li
= listTypeInitIterator(o
,0,REDIS_TAIL
);
11190 listTypeEntry entry
;
11191 while(listTypeNext(li
,&entry
)) {
11192 robj
*eleobj
= listTypeGet(&entry
);
11193 mixObjectDigest(digest
,eleobj
);
11194 decrRefCount(eleobj
);
11196 listTypeReleaseIterator(li
);
11197 } else if (o
->type
== REDIS_SET
) {
11198 dict
*set
= o
->ptr
;
11199 dictIterator
*di
= dictGetIterator(set
);
11202 while((de
= dictNext(di
)) != NULL
) {
11203 robj
*eleobj
= dictGetEntryKey(de
);
11205 xorObjectDigest(digest
,eleobj
);
11207 dictReleaseIterator(di
);
11208 } else if (o
->type
== REDIS_ZSET
) {
11210 dictIterator
*di
= dictGetIterator(zs
->dict
);
11213 while((de
= dictNext(di
)) != NULL
) {
11214 robj
*eleobj
= dictGetEntryKey(de
);
11215 double *score
= dictGetEntryVal(de
);
11216 unsigned char eledigest
[20];
11218 snprintf(buf
,sizeof(buf
),"%.17g",*score
);
11219 memset(eledigest
,0,20);
11220 mixObjectDigest(eledigest
,eleobj
);
11221 mixDigest(eledigest
,buf
,strlen(buf
));
11222 xorDigest(digest
,eledigest
,20);
11224 dictReleaseIterator(di
);
11225 } else if (o
->type
== REDIS_HASH
) {
11226 hashTypeIterator
*hi
;
11229 hi
= hashTypeInitIterator(o
);
11230 while (hashTypeNext(hi
) != REDIS_ERR
) {
11231 unsigned char eledigest
[20];
11233 memset(eledigest
,0,20);
11234 obj
= hashTypeCurrent(hi
,REDIS_HASH_KEY
);
11235 mixObjectDigest(eledigest
,obj
);
11237 obj
= hashTypeCurrent(hi
,REDIS_HASH_VALUE
);
11238 mixObjectDigest(eledigest
,obj
);
11240 xorDigest(digest
,eledigest
,20);
11242 hashTypeReleaseIterator(hi
);
11244 redisPanic("Unknown object type");
11246 /* If the key has an expire, add it to the mix */
11247 if (expiretime
!= -1) xorDigest(digest
,"!!expire!!",10);
11248 /* We can finally xor the key-val digest to the final digest */
11249 xorDigest(final
,digest
,20);
11250 decrRefCount(keyobj
);
11252 dictReleaseIterator(di
);
11256 static void debugCommand(redisClient
*c
) {
11257 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
11258 *((char*)-1) = 'x';
11259 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
11260 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
11261 addReply(c
,shared
.err
);
11265 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
11266 addReply(c
,shared
.err
);
11269 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
11270 addReply(c
,shared
.ok
);
11271 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
11273 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
11274 addReply(c
,shared
.err
);
11277 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
11278 addReply(c
,shared
.ok
);
11279 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
11280 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]->ptr
);
11284 addReply(c
,shared
.nokeyerr
);
11287 val
= dictGetEntryVal(de
);
11288 if (!server
.vm_enabled
|| (val
->storage
== REDIS_VM_MEMORY
||
11289 val
->storage
== REDIS_VM_SWAPPING
)) {
11293 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
11294 strenc
= strencoding
[val
->encoding
];
11296 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
11299 addReplySds(c
,sdscatprintf(sdsempty(),
11300 "+Value at:%p refcount:%d "
11301 "encoding:%s serializedlength:%lld\r\n",
11302 (void*)val
, val
->refcount
,
11303 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
11305 vmpointer
*vp
= (vmpointer
*) val
;
11306 addReplySds(c
,sdscatprintf(sdsempty(),
11307 "+Value swapped at: page %llu "
11308 "using %llu pages\r\n",
11309 (unsigned long long) vp
->page
,
11310 (unsigned long long) vp
->usedpages
));
11312 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
11313 lookupKeyRead(c
->db
,c
->argv
[2]);
11314 addReply(c
,shared
.ok
);
11315 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
11316 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]->ptr
);
11320 if (!server
.vm_enabled
) {
11321 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11325 addReply(c
,shared
.nokeyerr
);
11328 val
= dictGetEntryVal(de
);
11330 if (val
->storage
!= REDIS_VM_MEMORY
) {
11331 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
11332 } else if (val
->refcount
!= 1) {
11333 addReplySds(c
,sdsnew("-ERR Object is shared\r\n"));
11334 } else if ((vp
= vmSwapObjectBlocking(val
)) != NULL
) {
11335 dictGetEntryVal(de
) = vp
;
11336 addReply(c
,shared
.ok
);
11338 addReply(c
,shared
.err
);
11340 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
11345 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
11347 for (j
= 0; j
< keys
; j
++) {
11348 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
11349 key
= createStringObject(buf
,strlen(buf
));
11350 if (lookupKeyRead(c
->db
,key
) != NULL
) {
11354 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
11355 val
= createStringObject(buf
,strlen(buf
));
11356 dbAdd(c
->db
,key
,val
);
11359 addReply(c
,shared
.ok
);
11360 } else if (!strcasecmp(c
->argv
[1]->ptr
,"digest") && c
->argc
== 2) {
11361 unsigned char digest
[20];
11362 sds d
= sdsnew("+");
11365 computeDatasetDigest(digest
);
11366 for (j
= 0; j
< 20; j
++)
11367 d
= sdscatprintf(d
, "%02x",digest
[j
]);
11369 d
= sdscatlen(d
,"\r\n",2);
11372 addReplySds(c
,sdsnew(
11373 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11377 static void _redisAssert(char *estr
, char *file
, int line
) {
11378 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
11379 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true",file
,line
,estr
);
11380 #ifdef HAVE_BACKTRACE
11381 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11382 *((char*)-1) = 'x';
11386 static void _redisPanic(char *msg
, char *file
, int line
) {
11387 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
11388 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
11389 #ifdef HAVE_BACKTRACE
11390 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11391 *((char*)-1) = 'x';
11395 /* =================================== Main! ================================ */
11398 int linuxOvercommitMemoryValue(void) {
11399 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
11402 if (!fp
) return -1;
11403 if (fgets(buf
,64,fp
) == NULL
) {
11412 void linuxOvercommitMemoryWarning(void) {
11413 if (linuxOvercommitMemoryValue() == 0) {
11414 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.");
11417 #endif /* __linux__ */
11419 static void daemonize(void) {
11423 if (fork() != 0) exit(0); /* parent exits */
11424 setsid(); /* create a new session */
11426 /* Every output goes to /dev/null. If Redis is daemonized but
11427 * the 'logfile' is set to 'stdout' in the configuration file
11428 * it will not log at all. */
11429 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
11430 dup2(fd
, STDIN_FILENO
);
11431 dup2(fd
, STDOUT_FILENO
);
11432 dup2(fd
, STDERR_FILENO
);
11433 if (fd
> STDERR_FILENO
) close(fd
);
11435 /* Try to write the pid file */
11436 fp
= fopen(server
.pidfile
,"w");
11438 fprintf(fp
,"%d\n",getpid());
11443 static void version() {
11444 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
11445 REDIS_GIT_SHA1
, atoi(REDIS_GIT_DIRTY
) > 0);
11449 static void usage() {
11450 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
11451 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
11455 int main(int argc
, char **argv
) {
11458 initServerConfig();
11459 sortCommandTable();
11461 if (strcmp(argv
[1], "-v") == 0 ||
11462 strcmp(argv
[1], "--version") == 0) version();
11463 if (strcmp(argv
[1], "--help") == 0) usage();
11464 resetServerSaveParams();
11465 loadServerConfig(argv
[1]);
11466 } else if ((argc
> 2)) {
11469 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'");
11471 if (server
.daemonize
) daemonize();
11473 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
11475 linuxOvercommitMemoryWarning();
11477 start
= time(NULL
);
11478 if (server
.appendonly
) {
11479 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
11480 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
11482 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
11483 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
11485 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
11486 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
11488 aeDeleteEventLoop(server
.el
);
11492 /* ============================= Backtrace support ========================= */
11494 #ifdef HAVE_BACKTRACE
11495 static char *findFuncName(void *pointer
, unsigned long *offset
);
11497 static void *getMcontextEip(ucontext_t
*uc
) {
11498 #if defined(__FreeBSD__)
11499 return (void*) uc
->uc_mcontext
.mc_eip
;
11500 #elif defined(__dietlibc__)
11501 return (void*) uc
->uc_mcontext
.eip
;
11502 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11504 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11506 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11508 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11509 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11510 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11512 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11514 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11515 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
11516 #elif defined(__ia64__) /* Linux IA64 */
11517 return (void*) uc
->uc_mcontext
.sc_ip
;
11523 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
11525 char **messages
= NULL
;
11526 int i
, trace_size
= 0;
11527 unsigned long offset
=0;
11528 ucontext_t
*uc
= (ucontext_t
*) secret
;
11530 REDIS_NOTUSED(info
);
11532 redisLog(REDIS_WARNING
,
11533 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
11534 infostring
= genRedisInfoString();
11535 redisLog(REDIS_WARNING
, "%s",infostring
);
11536 /* It's not safe to sdsfree() the returned string under memory
11537 * corruption conditions. Let it leak as we are going to abort */
11539 trace_size
= backtrace(trace
, 100);
11540 /* overwrite sigaction with caller's address */
11541 if (getMcontextEip(uc
) != NULL
) {
11542 trace
[1] = getMcontextEip(uc
);
11544 messages
= backtrace_symbols(trace
, trace_size
);
11546 for (i
=1; i
<trace_size
; ++i
) {
11547 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
11549 p
= strchr(messages
[i
],'+');
11550 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
11551 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
11553 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
11556 /* free(messages); Don't call free() with possibly corrupted memory. */
11560 static void sigtermHandler(int sig
) {
11561 REDIS_NOTUSED(sig
);
11563 redisLog(REDIS_WARNING
,"SIGTERM received, scheduling shutting down...");
11564 server
.shutdown_asap
= 1;
11567 static void setupSigSegvAction(void) {
11568 struct sigaction act
;
11570 sigemptyset (&act
.sa_mask
);
11571 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11572 * is used. Otherwise, sa_handler is used */
11573 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
11574 act
.sa_sigaction
= segvHandler
;
11575 sigaction (SIGSEGV
, &act
, NULL
);
11576 sigaction (SIGBUS
, &act
, NULL
);
11577 sigaction (SIGFPE
, &act
, NULL
);
11578 sigaction (SIGILL
, &act
, NULL
);
11579 sigaction (SIGBUS
, &act
, NULL
);
11581 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
11582 act
.sa_handler
= sigtermHandler
;
11583 sigaction (SIGTERM
, &act
, NULL
);
11587 #include "staticsymbols.h"
11588 /* This function try to convert a pointer into a function name. It's used in
11589 * oreder to provide a backtrace under segmentation fault that's able to
11590 * display functions declared as static (otherwise the backtrace is useless). */
11591 static char *findFuncName(void *pointer
, unsigned long *offset
){
11593 unsigned long off
, minoff
= 0;
11595 /* Try to match against the Symbol with the smallest offset */
11596 for (i
=0; symsTable
[i
].pointer
; i
++) {
11597 unsigned long lp
= (unsigned long) pointer
;
11599 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
11600 off
=lp
-symsTable
[i
].pointer
;
11601 if (ret
< 0 || off
< minoff
) {
11607 if (ret
== -1) return NULL
;
11609 return symsTable
[ret
].name
;
11611 #else /* HAVE_BACKTRACE */
11612 static void setupSigSegvAction(void) {
11614 #endif /* HAVE_BACKTRACE */