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 dictSdsDestructor
, /* 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
) {
3537 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
->ptr
);
3538 retval
= dictDelete(db
->dict
,key
->ptr
);
3540 return retval
== DICT_OK
;
3543 /*============================ RDB saving/loading =========================== */
3545 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3546 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3550 static int rdbSaveTime(FILE *fp
, time_t t
) {
3551 int32_t t32
= (int32_t) t
;
3552 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3556 /* check rdbLoadLen() comments for more info */
3557 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3558 unsigned char buf
[2];
3561 /* Save a 6 bit len */
3562 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3563 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3564 } else if (len
< (1<<14)) {
3565 /* Save a 14 bit len */
3566 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3568 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3570 /* Save a 32 bit len */
3571 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3572 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3574 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3579 /* Encode 'value' as an integer if possible (if integer will fit the
3580 * supported range). If the function sucessful encoded the integer
3581 * then the (up to 5 bytes) encoded representation is written in the
3582 * string pointed by 'enc' and the length is returned. Otherwise
3584 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3585 /* Finally check if it fits in our ranges */
3586 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3587 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3588 enc
[1] = value
&0xFF;
3590 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3591 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3592 enc
[1] = value
&0xFF;
3593 enc
[2] = (value
>>8)&0xFF;
3595 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3596 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3597 enc
[1] = value
&0xFF;
3598 enc
[2] = (value
>>8)&0xFF;
3599 enc
[3] = (value
>>16)&0xFF;
3600 enc
[4] = (value
>>24)&0xFF;
3607 /* String objects in the form "2391" "-100" without any space and with a
3608 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3609 * encoded as integers to save space */
3610 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3612 char *endptr
, buf
[32];
3614 /* Check if it's possible to encode this value as a number */
3615 value
= strtoll(s
, &endptr
, 10);
3616 if (endptr
[0] != '\0') return 0;
3617 ll2string(buf
,32,value
);
3619 /* If the number converted back into a string is not identical
3620 * then it's not possible to encode the string as integer */
3621 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3623 return rdbEncodeInteger(value
,enc
);
3626 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3627 size_t comprlen
, outlen
;
3631 /* We require at least four bytes compression for this to be worth it */
3632 if (len
<= 4) return 0;
3634 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3635 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3636 if (comprlen
== 0) {
3640 /* Data compressed! Let's save it on disk */
3641 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3642 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3643 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3644 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3645 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3654 /* Save a string objet as [len][data] on disk. If the object is a string
3655 * representation of an integer value we try to safe it in a special form */
3656 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3659 /* Try integer encoding */
3661 unsigned char buf
[5];
3662 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3663 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3668 /* Try LZF compression - under 20 bytes it's unable to compress even
3669 * aaaaaaaaaaaaaaaaaa so skip it */
3670 if (server
.rdbcompression
&& len
> 20) {
3673 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3674 if (retval
== -1) return -1;
3675 if (retval
> 0) return 0;
3676 /* retval == 0 means data can't be compressed, save the old way */
3679 /* Store verbatim */
3680 if (rdbSaveLen(fp
,len
) == -1) return -1;
3681 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3685 /* Save a long long value as either an encoded string or a string. */
3686 static int rdbSaveLongLongAsStringObject(FILE *fp
, long long value
) {
3687 unsigned char buf
[32];
3688 int enclen
= rdbEncodeInteger(value
,buf
);
3690 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3692 /* Encode as string */
3693 enclen
= ll2string((char*)buf
,32,value
);
3694 redisAssert(enclen
< 32);
3695 if (rdbSaveLen(fp
,enclen
) == -1) return -1;
3696 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3701 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3702 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3703 /* Avoid to decode the object, then encode it again, if the
3704 * object is alrady integer encoded. */
3705 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3706 return rdbSaveLongLongAsStringObject(fp
,(long)obj
->ptr
);
3708 redisAssert(obj
->encoding
== REDIS_ENCODING_RAW
);
3709 return rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3713 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3714 * 8 bit integer specifing the length of the representation.
3715 * This 8 bit integer has special values in order to specify the following
3721 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3722 unsigned char buf
[128];
3728 } else if (!isfinite(val
)) {
3730 buf
[0] = (val
< 0) ? 255 : 254;
3732 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3733 /* Check if the float is in a safe range to be casted into a
3734 * long long. We are assuming that long long is 64 bit here.
3735 * Also we are assuming that there are no implementations around where
3736 * double has precision < 52 bit.
3738 * Under this assumptions we test if a double is inside an interval
3739 * where casting to long long is safe. Then using two castings we
3740 * make sure the decimal part is zero. If all this is true we use
3741 * integer printing function that is much faster. */
3742 double min
= -4503599627370495; /* (2^52)-1 */
3743 double max
= 4503599627370496; /* -(2^52) */
3744 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3745 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3748 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3749 buf
[0] = strlen((char*)buf
+1);
3752 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3756 /* Save a Redis object. */
3757 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3758 if (o
->type
== REDIS_STRING
) {
3759 /* Save a string value */
3760 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3761 } else if (o
->type
== REDIS_LIST
) {
3762 /* Save a list value */
3763 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
3765 unsigned char *vstr
;
3769 if (rdbSaveLen(fp
,ziplistLen(o
->ptr
)) == -1) return -1;
3770 p
= ziplistIndex(o
->ptr
,0);
3771 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
3773 if (rdbSaveRawString(fp
,vstr
,vlen
) == -1)
3776 if (rdbSaveLongLongAsStringObject(fp
,vlong
) == -1)
3779 p
= ziplistNext(o
->ptr
,p
);
3781 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
3782 list
*list
= o
->ptr
;
3786 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3787 listRewind(list
,&li
);
3788 while((ln
= listNext(&li
))) {
3789 robj
*eleobj
= listNodeValue(ln
);
3790 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3793 redisPanic("Unknown list encoding");
3795 } else if (o
->type
== REDIS_SET
) {
3796 /* Save a set value */
3798 dictIterator
*di
= dictGetIterator(set
);
3801 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3802 while((de
= dictNext(di
)) != NULL
) {
3803 robj
*eleobj
= dictGetEntryKey(de
);
3805 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3807 dictReleaseIterator(di
);
3808 } else if (o
->type
== REDIS_ZSET
) {
3809 /* Save a set value */
3811 dictIterator
*di
= dictGetIterator(zs
->dict
);
3814 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3815 while((de
= dictNext(di
)) != NULL
) {
3816 robj
*eleobj
= dictGetEntryKey(de
);
3817 double *score
= dictGetEntryVal(de
);
3819 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3820 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3822 dictReleaseIterator(di
);
3823 } else if (o
->type
== REDIS_HASH
) {
3824 /* Save a hash value */
3825 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3826 unsigned char *p
= zipmapRewind(o
->ptr
);
3827 unsigned int count
= zipmapLen(o
->ptr
);
3828 unsigned char *key
, *val
;
3829 unsigned int klen
, vlen
;
3831 if (rdbSaveLen(fp
,count
) == -1) return -1;
3832 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3833 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3834 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3837 dictIterator
*di
= dictGetIterator(o
->ptr
);
3840 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3841 while((de
= dictNext(di
)) != NULL
) {
3842 robj
*key
= dictGetEntryKey(de
);
3843 robj
*val
= dictGetEntryVal(de
);
3845 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3846 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3848 dictReleaseIterator(di
);
3851 redisPanic("Unknown object type");
3856 /* Return the length the object will have on disk if saved with
3857 * the rdbSaveObject() function. Currently we use a trick to get
3858 * this length with very little changes to the code. In the future
3859 * we could switch to a faster solution. */
3860 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3861 if (fp
== NULL
) fp
= server
.devnull
;
3863 assert(rdbSaveObject(fp
,o
) != 1);
3867 /* Return the number of pages required to save this object in the swap file */
3868 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3869 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3871 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3874 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3875 static int rdbSave(char *filename
) {
3876 dictIterator
*di
= NULL
;
3881 time_t now
= time(NULL
);
3883 /* Wait for I/O therads to terminate, just in case this is a
3884 * foreground-saving, to avoid seeking the swap file descriptor at the
3886 if (server
.vm_enabled
)
3887 waitEmptyIOJobsQueue();
3889 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3890 fp
= fopen(tmpfile
,"w");
3892 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3895 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3896 for (j
= 0; j
< server
.dbnum
; j
++) {
3897 redisDb
*db
= server
.db
+j
;
3899 if (dictSize(d
) == 0) continue;
3900 di
= dictGetIterator(d
);
3906 /* Write the SELECT DB opcode */
3907 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3908 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3910 /* Iterate this DB writing every entry */
3911 while((de
= dictNext(di
)) != NULL
) {
3912 sds keystr
= dictGetEntryKey(de
);
3913 robj key
, *o
= dictGetEntryVal(de
);
3916 initStaticStringObject(key
,keystr
);
3917 expiretime
= getExpire(db
,&key
);
3919 /* Save the expire time */
3920 if (expiretime
!= -1) {
3921 /* If this key is already expired skip it */
3922 if (expiretime
< now
) continue;
3923 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3924 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3926 /* Save the key and associated value. This requires special
3927 * handling if the value is swapped out. */
3928 if (!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
||
3929 o
->storage
== REDIS_VM_SWAPPING
) {
3930 /* Save type, key, value */
3931 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3932 if (rdbSaveStringObject(fp
,&key
) == -1) goto werr
;
3933 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3935 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3937 /* Get a preview of the object in memory */
3938 po
= vmPreviewObject(o
);
3939 /* Save type, key, value */
3940 if (rdbSaveType(fp
,po
->type
) == -1) goto werr
;
3941 if (rdbSaveStringObject(fp
,&key
) == -1) goto werr
;
3942 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3943 /* Remove the loaded object from memory */
3947 dictReleaseIterator(di
);
3950 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3952 /* Make sure data will not remain on the OS's output buffers */
3957 /* Use RENAME to make sure the DB file is changed atomically only
3958 * if the generate DB file is ok. */
3959 if (rename(tmpfile
,filename
) == -1) {
3960 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3964 redisLog(REDIS_NOTICE
,"DB saved on disk");
3966 server
.lastsave
= time(NULL
);
3972 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3973 if (di
) dictReleaseIterator(di
);
3977 static int rdbSaveBackground(char *filename
) {
3980 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3981 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3982 if ((childpid
= fork()) == 0) {
3984 if (server
.vm_enabled
) vmReopenSwapFile();
3986 if (rdbSave(filename
) == REDIS_OK
) {
3993 if (childpid
== -1) {
3994 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3998 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3999 server
.bgsavechildpid
= childpid
;
4000 updateDictResizePolicy();
4003 return REDIS_OK
; /* unreached */
4006 static void rdbRemoveTempFile(pid_t childpid
) {
4009 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
4013 static int rdbLoadType(FILE *fp
) {
4015 if (fread(&type
,1,1,fp
) == 0) return -1;
4019 static time_t rdbLoadTime(FILE *fp
) {
4021 if (fread(&t32
,4,1,fp
) == 0) return -1;
4022 return (time_t) t32
;
4025 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
4026 * of this file for a description of how this are stored on disk.
4028 * isencoded is set to 1 if the readed length is not actually a length but
4029 * an "encoding type", check the above comments for more info */
4030 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
4031 unsigned char buf
[2];
4035 if (isencoded
) *isencoded
= 0;
4036 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
4037 type
= (buf
[0]&0xC0)>>6;
4038 if (type
== REDIS_RDB_6BITLEN
) {
4039 /* Read a 6 bit len */
4041 } else if (type
== REDIS_RDB_ENCVAL
) {
4042 /* Read a 6 bit len encoding type */
4043 if (isencoded
) *isencoded
= 1;
4045 } else if (type
== REDIS_RDB_14BITLEN
) {
4046 /* Read a 14 bit len */
4047 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
4048 return ((buf
[0]&0x3F)<<8)|buf
[1];
4050 /* Read a 32 bit len */
4051 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
4056 /* Load an integer-encoded object from file 'fp', with the specified
4057 * encoding type 'enctype'. If encode is true the function may return
4058 * an integer-encoded object as reply, otherwise the returned object
4059 * will always be encoded as a raw string. */
4060 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
4061 unsigned char enc
[4];
4064 if (enctype
== REDIS_RDB_ENC_INT8
) {
4065 if (fread(enc
,1,1,fp
) == 0) return NULL
;
4066 val
= (signed char)enc
[0];
4067 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
4069 if (fread(enc
,2,1,fp
) == 0) return NULL
;
4070 v
= enc
[0]|(enc
[1]<<8);
4072 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
4074 if (fread(enc
,4,1,fp
) == 0) return NULL
;
4075 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
4078 val
= 0; /* anti-warning */
4079 redisPanic("Unknown RDB integer encoding type");
4082 return createStringObjectFromLongLong(val
);
4084 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
4087 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
4088 unsigned int len
, clen
;
4089 unsigned char *c
= NULL
;
4092 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4093 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4094 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
4095 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
4096 if (fread(c
,clen
,1,fp
) == 0) goto err
;
4097 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
4099 return createObject(REDIS_STRING
,val
);
4106 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
4111 len
= rdbLoadLen(fp
,&isencoded
);
4114 case REDIS_RDB_ENC_INT8
:
4115 case REDIS_RDB_ENC_INT16
:
4116 case REDIS_RDB_ENC_INT32
:
4117 return rdbLoadIntegerObject(fp
,len
,encode
);
4118 case REDIS_RDB_ENC_LZF
:
4119 return rdbLoadLzfStringObject(fp
);
4121 redisPanic("Unknown RDB encoding type");
4125 if (len
== REDIS_RDB_LENERR
) return NULL
;
4126 val
= sdsnewlen(NULL
,len
);
4127 if (len
&& fread(val
,len
,1,fp
) == 0) {
4131 return createObject(REDIS_STRING
,val
);
4134 static robj
*rdbLoadStringObject(FILE *fp
) {
4135 return rdbGenericLoadStringObject(fp
,0);
4138 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
4139 return rdbGenericLoadStringObject(fp
,1);
4142 /* For information about double serialization check rdbSaveDoubleValue() */
4143 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
4147 if (fread(&len
,1,1,fp
) == 0) return -1;
4149 case 255: *val
= R_NegInf
; return 0;
4150 case 254: *val
= R_PosInf
; return 0;
4151 case 253: *val
= R_Nan
; return 0;
4153 if (fread(buf
,len
,1,fp
) == 0) return -1;
4155 sscanf(buf
, "%lg", val
);
4160 /* Load a Redis object of the specified type from the specified file.
4161 * On success a newly allocated object is returned, otherwise NULL. */
4162 static robj
*rdbLoadObject(int type
, FILE *fp
) {
4163 robj
*o
, *ele
, *dec
;
4166 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
4167 if (type
== REDIS_STRING
) {
4168 /* Read string value */
4169 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4170 o
= tryObjectEncoding(o
);
4171 } else if (type
== REDIS_LIST
) {
4172 /* Read list value */
4173 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4175 /* Use a real list when there are too many entries */
4176 if (len
> server
.list_max_ziplist_entries
) {
4177 o
= createListObject();
4179 o
= createZiplistObject();
4182 /* Load every single element of the list */
4184 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4186 /* If we are using a ziplist and the value is too big, convert
4187 * the object to a real list. */
4188 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
&&
4189 ele
->encoding
== REDIS_ENCODING_RAW
&&
4190 sdslen(ele
->ptr
) > server
.list_max_ziplist_value
)
4191 listTypeConvert(o
,REDIS_ENCODING_LIST
);
4193 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4194 dec
= getDecodedObject(ele
);
4195 o
->ptr
= ziplistPush(o
->ptr
,dec
->ptr
,sdslen(dec
->ptr
),REDIS_TAIL
);
4199 ele
= tryObjectEncoding(ele
);
4200 listAddNodeTail(o
->ptr
,ele
);
4203 } else if (type
== REDIS_SET
) {
4204 /* Read list/set value */
4205 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4206 o
= createSetObject();
4207 /* It's faster to expand the dict to the right size asap in order
4208 * to avoid rehashing */
4209 if (len
> DICT_HT_INITIAL_SIZE
)
4210 dictExpand(o
->ptr
,len
);
4211 /* Load every single element of the list/set */
4213 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4214 ele
= tryObjectEncoding(ele
);
4215 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
4217 } else if (type
== REDIS_ZSET
) {
4218 /* Read list/set value */
4222 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4223 o
= createZsetObject();
4225 /* Load every single element of the list/set */
4228 double *score
= zmalloc(sizeof(double));
4230 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4231 ele
= tryObjectEncoding(ele
);
4232 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
4233 dictAdd(zs
->dict
,ele
,score
);
4234 zslInsert(zs
->zsl
,*score
,ele
);
4235 incrRefCount(ele
); /* added to skiplist */
4237 } else if (type
== REDIS_HASH
) {
4240 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4241 o
= createHashObject();
4242 /* Too many entries? Use an hash table. */
4243 if (hashlen
> server
.hash_max_zipmap_entries
)
4244 convertToRealHash(o
);
4245 /* Load every key/value, then set it into the zipmap or hash
4246 * table, as needed. */
4250 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4251 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4252 /* If we are using a zipmap and there are too big values
4253 * the object is converted to real hash table encoding. */
4254 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4255 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
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
;
4264 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4265 val
->ptr
,sdslen(val
->ptr
),NULL
);
4270 key
= tryObjectEncoding(key
);
4271 val
= tryObjectEncoding(val
);
4272 dictAdd((dict
*)o
->ptr
,key
,val
);
4276 redisPanic("Unknown object type");
4281 static int rdbLoad(char *filename
) {
4284 int type
, retval
, rdbver
;
4285 int swap_all_values
= 0;
4286 redisDb
*db
= server
.db
+0;
4288 time_t expiretime
, now
= time(NULL
);
4290 fp
= fopen(filename
,"r");
4291 if (!fp
) return REDIS_ERR
;
4292 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4294 if (memcmp(buf
,"REDIS",5) != 0) {
4296 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4299 rdbver
= atoi(buf
+5);
4302 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4311 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4312 if (type
== REDIS_EXPIRETIME
) {
4313 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4314 /* We read the time so we need to read the object type again */
4315 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4317 if (type
== REDIS_EOF
) break;
4318 /* Handle SELECT DB opcode as a special case */
4319 if (type
== REDIS_SELECTDB
) {
4320 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4322 if (dbid
>= (unsigned)server
.dbnum
) {
4323 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4326 db
= server
.db
+dbid
;
4330 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4332 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4333 /* Check if the key already expired */
4334 if (expiretime
!= -1 && expiretime
< now
) {
4339 /* Add the new object in the hash table */
4340 retval
= dbAdd(db
,key
,val
);
4341 if (retval
== REDIS_ERR
) {
4342 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4345 /* Set the expire time if needed */
4346 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4348 /* Handle swapping while loading big datasets when VM is on */
4350 /* If we detecter we are hopeless about fitting something in memory
4351 * we just swap every new key on disk. Directly...
4352 * Note that's important to check for this condition before resorting
4353 * to random sampling, otherwise we may try to swap already
4355 if (swap_all_values
) {
4356 dictEntry
*de
= dictFind(db
->dict
,key
->ptr
);
4358 /* de may be NULL since the key already expired */
4361 val
= dictGetEntryVal(de
);
4363 if (val
->refcount
== 1 &&
4364 (vp
= vmSwapObjectBlocking(val
)) != NULL
)
4365 dictGetEntryVal(de
) = vp
;
4372 /* Flush data on disk once 32 MB of additional RAM are used... */
4374 if ((zmalloc_used_memory() - server
.vm_max_memory
) > 1024*1024*32)
4377 /* If we have still some hope of having some value fitting memory
4378 * then we try random sampling. */
4379 if (!swap_all_values
&& server
.vm_enabled
&& force_swapout
) {
4380 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4381 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4383 if (zmalloc_used_memory() > server
.vm_max_memory
)
4384 swap_all_values
= 1; /* We are already using too much mem */
4390 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4391 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4393 return REDIS_ERR
; /* Just to avoid warning */
4396 /*================================== Shutdown =============================== */
4397 static int prepareForShutdown() {
4398 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4399 /* Kill the saving child if there is a background saving in progress.
4400 We want to avoid race conditions, for instance our saving child may
4401 overwrite the synchronous saving did by SHUTDOWN. */
4402 if (server
.bgsavechildpid
!= -1) {
4403 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4404 kill(server
.bgsavechildpid
,SIGKILL
);
4405 rdbRemoveTempFile(server
.bgsavechildpid
);
4407 if (server
.appendonly
) {
4408 /* Append only file: fsync() the AOF and exit */
4409 aof_fsync(server
.appendfd
);
4410 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4412 /* Snapshotting. Perform a SYNC SAVE and exit */
4413 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4414 if (server
.daemonize
)
4415 unlink(server
.pidfile
);
4416 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4418 /* Ooops.. error saving! The best we can do is to continue
4419 * operating. Note that if there was a background saving process,
4420 * in the next cron() Redis will be notified that the background
4421 * saving aborted, handling special stuff like slaves pending for
4422 * synchronization... */
4423 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4427 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4431 /*================================== Commands =============================== */
4433 static void authCommand(redisClient
*c
) {
4434 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4435 c
->authenticated
= 1;
4436 addReply(c
,shared
.ok
);
4438 c
->authenticated
= 0;
4439 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4443 static void pingCommand(redisClient
*c
) {
4444 addReply(c
,shared
.pong
);
4447 static void echoCommand(redisClient
*c
) {
4448 addReplyBulk(c
,c
->argv
[1]);
4451 /*=================================== Strings =============================== */
4453 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4455 long seconds
= 0; /* initialized to avoid an harmness warning */
4458 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4461 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4466 touchWatchedKey(c
->db
,key
);
4467 if (nx
) deleteIfVolatile(c
->db
,key
);
4468 retval
= dbAdd(c
->db
,key
,val
);
4469 if (retval
== REDIS_ERR
) {
4471 dbReplace(c
->db
,key
,val
);
4474 addReply(c
,shared
.czero
);
4481 removeExpire(c
->db
,key
);
4482 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4483 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4486 static void setCommand(redisClient
*c
) {
4487 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4490 static void setnxCommand(redisClient
*c
) {
4491 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4494 static void setexCommand(redisClient
*c
) {
4495 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4498 static int getGenericCommand(redisClient
*c
) {
4501 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4504 if (o
->type
!= REDIS_STRING
) {
4505 addReply(c
,shared
.wrongtypeerr
);
4513 static void getCommand(redisClient
*c
) {
4514 getGenericCommand(c
);
4517 static void getsetCommand(redisClient
*c
) {
4518 if (getGenericCommand(c
) == REDIS_ERR
) return;
4519 dbReplace(c
->db
,c
->argv
[1],c
->argv
[2]);
4520 incrRefCount(c
->argv
[2]);
4522 removeExpire(c
->db
,c
->argv
[1]);
4525 static void mgetCommand(redisClient
*c
) {
4528 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4529 for (j
= 1; j
< c
->argc
; j
++) {
4530 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4532 addReply(c
,shared
.nullbulk
);
4534 if (o
->type
!= REDIS_STRING
) {
4535 addReply(c
,shared
.nullbulk
);
4543 static void msetGenericCommand(redisClient
*c
, int nx
) {
4544 int j
, busykeys
= 0;
4546 if ((c
->argc
% 2) == 0) {
4547 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4550 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4551 * set nothing at all if at least one already key exists. */
4553 for (j
= 1; j
< c
->argc
; j
+= 2) {
4554 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4560 addReply(c
, shared
.czero
);
4564 for (j
= 1; j
< c
->argc
; j
+= 2) {
4565 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4566 dbReplace(c
->db
,c
->argv
[j
],c
->argv
[j
+1]);
4567 incrRefCount(c
->argv
[j
+1]);
4568 removeExpire(c
->db
,c
->argv
[j
]);
4570 server
.dirty
+= (c
->argc
-1)/2;
4571 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4574 static void msetCommand(redisClient
*c
) {
4575 msetGenericCommand(c
,0);
4578 static void msetnxCommand(redisClient
*c
) {
4579 msetGenericCommand(c
,1);
4582 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4586 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4587 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4588 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4591 o
= createStringObjectFromLongLong(value
);
4592 dbReplace(c
->db
,c
->argv
[1],o
);
4594 addReply(c
,shared
.colon
);
4596 addReply(c
,shared
.crlf
);
4599 static void incrCommand(redisClient
*c
) {
4600 incrDecrCommand(c
,1);
4603 static void decrCommand(redisClient
*c
) {
4604 incrDecrCommand(c
,-1);
4607 static void incrbyCommand(redisClient
*c
) {
4610 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4611 incrDecrCommand(c
,incr
);
4614 static void decrbyCommand(redisClient
*c
) {
4617 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4618 incrDecrCommand(c
,-incr
);
4621 static void appendCommand(redisClient
*c
) {
4626 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4628 /* Create the key */
4629 retval
= dbAdd(c
->db
,c
->argv
[1],c
->argv
[2]);
4630 incrRefCount(c
->argv
[2]);
4631 totlen
= stringObjectLen(c
->argv
[2]);
4633 if (o
->type
!= REDIS_STRING
) {
4634 addReply(c
,shared
.wrongtypeerr
);
4637 /* If the object is specially encoded or shared we have to make
4639 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4640 robj
*decoded
= getDecodedObject(o
);
4642 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4643 decrRefCount(decoded
);
4644 dbReplace(c
->db
,c
->argv
[1],o
);
4647 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4648 o
->ptr
= sdscatlen(o
->ptr
,
4649 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4651 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4652 (unsigned long) c
->argv
[2]->ptr
);
4654 totlen
= sdslen(o
->ptr
);
4657 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4660 static void substrCommand(redisClient
*c
) {
4662 long start
= atoi(c
->argv
[2]->ptr
);
4663 long end
= atoi(c
->argv
[3]->ptr
);
4664 size_t rangelen
, strlen
;
4667 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4668 checkType(c
,o
,REDIS_STRING
)) return;
4670 o
= getDecodedObject(o
);
4671 strlen
= sdslen(o
->ptr
);
4673 /* convert negative indexes */
4674 if (start
< 0) start
= strlen
+start
;
4675 if (end
< 0) end
= strlen
+end
;
4676 if (start
< 0) start
= 0;
4677 if (end
< 0) end
= 0;
4679 /* indexes sanity checks */
4680 if (start
> end
|| (size_t)start
>= strlen
) {
4681 /* Out of range start or start > end result in null reply */
4682 addReply(c
,shared
.nullbulk
);
4686 if ((size_t)end
>= strlen
) end
= strlen
-1;
4687 rangelen
= (end
-start
)+1;
4689 /* Return the result */
4690 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4691 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4692 addReplySds(c
,range
);
4693 addReply(c
,shared
.crlf
);
4697 /* ========================= Type agnostic commands ========================= */
4699 static void delCommand(redisClient
*c
) {
4702 for (j
= 1; j
< c
->argc
; j
++) {
4703 if (dbDelete(c
->db
,c
->argv
[j
])) {
4704 touchWatchedKey(c
->db
,c
->argv
[j
]);
4709 addReplyLongLong(c
,deleted
);
4712 static void existsCommand(redisClient
*c
) {
4713 expireIfNeeded(c
->db
,c
->argv
[1]);
4714 if (dbExists(c
->db
,c
->argv
[1])) {
4715 addReply(c
, shared
.cone
);
4717 addReply(c
, shared
.czero
);
4721 static void selectCommand(redisClient
*c
) {
4722 int id
= atoi(c
->argv
[1]->ptr
);
4724 if (selectDb(c
,id
) == REDIS_ERR
) {
4725 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4727 addReply(c
,shared
.ok
);
4731 static void randomkeyCommand(redisClient
*c
) {
4734 if ((key
= dbRandomKey(c
->db
)) == NULL
) {
4735 addReply(c
,shared
.nullbulk
);
4739 addReplyBulk(c
,key
);
4743 static void keysCommand(redisClient
*c
) {
4746 sds pattern
= c
->argv
[1]->ptr
;
4747 int plen
= sdslen(pattern
);
4748 unsigned long numkeys
= 0;
4749 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4751 di
= dictGetIterator(c
->db
->dict
);
4753 decrRefCount(lenobj
);
4754 while((de
= dictNext(di
)) != NULL
) {
4755 sds key
= dictGetEntryKey(de
);
4758 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4759 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4760 keyobj
= createStringObject(key
,sdslen(key
));
4761 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4762 addReplyBulk(c
,keyobj
);
4765 decrRefCount(keyobj
);
4768 dictReleaseIterator(di
);
4769 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4772 static void dbsizeCommand(redisClient
*c
) {
4774 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4777 static void lastsaveCommand(redisClient
*c
) {
4779 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4782 static void typeCommand(redisClient
*c
) {
4786 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4791 case REDIS_STRING
: type
= "+string"; break;
4792 case REDIS_LIST
: type
= "+list"; break;
4793 case REDIS_SET
: type
= "+set"; break;
4794 case REDIS_ZSET
: type
= "+zset"; break;
4795 case REDIS_HASH
: type
= "+hash"; break;
4796 default: type
= "+unknown"; break;
4799 addReplySds(c
,sdsnew(type
));
4800 addReply(c
,shared
.crlf
);
4803 static void saveCommand(redisClient
*c
) {
4804 if (server
.bgsavechildpid
!= -1) {
4805 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4808 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4809 addReply(c
,shared
.ok
);
4811 addReply(c
,shared
.err
);
4815 static void bgsaveCommand(redisClient
*c
) {
4816 if (server
.bgsavechildpid
!= -1) {
4817 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4820 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4821 char *status
= "+Background saving started\r\n";
4822 addReplySds(c
,sdsnew(status
));
4824 addReply(c
,shared
.err
);
4828 static void shutdownCommand(redisClient
*c
) {
4829 if (prepareForShutdown() == REDIS_OK
)
4831 addReplySds(c
, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4834 static void renameGenericCommand(redisClient
*c
, int nx
) {
4837 /* To use the same key as src and dst is probably an error */
4838 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4839 addReply(c
,shared
.sameobjecterr
);
4843 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4847 deleteIfVolatile(c
->db
,c
->argv
[2]);
4848 if (dbAdd(c
->db
,c
->argv
[2],o
) == REDIS_ERR
) {
4851 addReply(c
,shared
.czero
);
4854 dbReplace(c
->db
,c
->argv
[2],o
);
4856 dbDelete(c
->db
,c
->argv
[1]);
4857 touchWatchedKey(c
->db
,c
->argv
[2]);
4859 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4862 static void renameCommand(redisClient
*c
) {
4863 renameGenericCommand(c
,0);
4866 static void renamenxCommand(redisClient
*c
) {
4867 renameGenericCommand(c
,1);
4870 static void moveCommand(redisClient
*c
) {
4875 /* Obtain source and target DB pointers */
4878 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4879 addReply(c
,shared
.outofrangeerr
);
4883 selectDb(c
,srcid
); /* Back to the source DB */
4885 /* If the user is moving using as target the same
4886 * DB as the source DB it is probably an error. */
4888 addReply(c
,shared
.sameobjecterr
);
4892 /* Check if the element exists and get a reference */
4893 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4895 addReply(c
,shared
.czero
);
4899 /* Try to add the element to the target DB */
4900 deleteIfVolatile(dst
,c
->argv
[1]);
4901 if (dbAdd(dst
,c
->argv
[1],o
) == REDIS_ERR
) {
4902 addReply(c
,shared
.czero
);
4907 /* OK! key moved, free the entry in the source DB */
4908 dbDelete(src
,c
->argv
[1]);
4910 addReply(c
,shared
.cone
);
4913 /* =================================== Lists ================================ */
4916 /* Check the argument length to see if it requires us to convert the ziplist
4917 * to a real list. Only check raw-encoded objects because integer encoded
4918 * objects are never too long. */
4919 static void listTypeTryConversion(robj
*subject
, robj
*value
) {
4920 if (subject
->encoding
!= REDIS_ENCODING_ZIPLIST
) return;
4921 if (value
->encoding
== REDIS_ENCODING_RAW
&&
4922 sdslen(value
->ptr
) > server
.list_max_ziplist_value
)
4923 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
4926 static void listTypePush(robj
*subject
, robj
*value
, int where
) {
4927 /* Check if we need to convert the ziplist */
4928 listTypeTryConversion(subject
,value
);
4929 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
&&
4930 ziplistLen(subject
->ptr
) >= server
.list_max_ziplist_entries
)
4931 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
4933 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4934 int pos
= (where
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4935 value
= getDecodedObject(value
);
4936 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),pos
);
4937 decrRefCount(value
);
4938 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4939 if (where
== REDIS_HEAD
) {
4940 listAddNodeHead(subject
->ptr
,value
);
4942 listAddNodeTail(subject
->ptr
,value
);
4944 incrRefCount(value
);
4946 redisPanic("Unknown list encoding");
4950 static robj
*listTypePop(robj
*subject
, int where
) {
4952 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4954 unsigned char *vstr
;
4957 int pos
= (where
== REDIS_HEAD
) ? 0 : -1;
4958 p
= ziplistIndex(subject
->ptr
,pos
);
4959 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
4961 value
= createStringObject((char*)vstr
,vlen
);
4963 value
= createStringObjectFromLongLong(vlong
);
4965 /* We only need to delete an element when it exists */
4966 subject
->ptr
= ziplistDelete(subject
->ptr
,&p
);
4968 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4969 list
*list
= subject
->ptr
;
4971 if (where
== REDIS_HEAD
) {
4972 ln
= listFirst(list
);
4974 ln
= listLast(list
);
4977 value
= listNodeValue(ln
);
4978 incrRefCount(value
);
4979 listDelNode(list
,ln
);
4982 redisPanic("Unknown list encoding");
4987 static unsigned long listTypeLength(robj
*subject
) {
4988 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4989 return ziplistLen(subject
->ptr
);
4990 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4991 return listLength((list
*)subject
->ptr
);
4993 redisPanic("Unknown list encoding");
4997 /* Structure to hold set iteration abstraction. */
5000 unsigned char encoding
;
5001 unsigned char direction
; /* Iteration direction */
5006 /* Structure for an entry while iterating over a list. */
5008 listTypeIterator
*li
;
5009 unsigned char *zi
; /* Entry in ziplist */
5010 listNode
*ln
; /* Entry in linked list */
5013 /* Initialize an iterator at the specified index. */
5014 static listTypeIterator
*listTypeInitIterator(robj
*subject
, int index
, unsigned char direction
) {
5015 listTypeIterator
*li
= zmalloc(sizeof(listTypeIterator
));
5016 li
->subject
= subject
;
5017 li
->encoding
= subject
->encoding
;
5018 li
->direction
= direction
;
5019 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5020 li
->zi
= ziplistIndex(subject
->ptr
,index
);
5021 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5022 li
->ln
= listIndex(subject
->ptr
,index
);
5024 redisPanic("Unknown list encoding");
5029 /* Clean up the iterator. */
5030 static void listTypeReleaseIterator(listTypeIterator
*li
) {
5034 /* Stores pointer to current the entry in the provided entry structure
5035 * and advances the position of the iterator. Returns 1 when the current
5036 * entry is in fact an entry, 0 otherwise. */
5037 static int listTypeNext(listTypeIterator
*li
, listTypeEntry
*entry
) {
5038 /* Protect from converting when iterating */
5039 redisAssert(li
->subject
->encoding
== li
->encoding
);
5042 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5044 if (entry
->zi
!= NULL
) {
5045 if (li
->direction
== REDIS_TAIL
)
5046 li
->zi
= ziplistNext(li
->subject
->ptr
,li
->zi
);
5048 li
->zi
= ziplistPrev(li
->subject
->ptr
,li
->zi
);
5051 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5053 if (entry
->ln
!= NULL
) {
5054 if (li
->direction
== REDIS_TAIL
)
5055 li
->ln
= li
->ln
->next
;
5057 li
->ln
= li
->ln
->prev
;
5061 redisPanic("Unknown list encoding");
5066 /* Return entry or NULL at the current position of the iterator. */
5067 static robj
*listTypeGet(listTypeEntry
*entry
) {
5068 listTypeIterator
*li
= entry
->li
;
5070 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5071 unsigned char *vstr
;
5074 redisAssert(entry
->zi
!= NULL
);
5075 if (ziplistGet(entry
->zi
,&vstr
,&vlen
,&vlong
)) {
5077 value
= createStringObject((char*)vstr
,vlen
);
5079 value
= createStringObjectFromLongLong(vlong
);
5082 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5083 redisAssert(entry
->ln
!= NULL
);
5084 value
= listNodeValue(entry
->ln
);
5085 incrRefCount(value
);
5087 redisPanic("Unknown list encoding");
5092 static void listTypeInsert(listTypeEntry
*entry
, robj
*value
, int where
) {
5093 robj
*subject
= entry
->li
->subject
;
5094 if (entry
->li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5095 value
= getDecodedObject(value
);
5096 if (where
== REDIS_TAIL
) {
5097 unsigned char *next
= ziplistNext(subject
->ptr
,entry
->zi
);
5099 /* When we insert after the current element, but the current element
5100 * is the tail of the list, we need to do a push. */
5102 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),REDIS_TAIL
);
5104 subject
->ptr
= ziplistInsert(subject
->ptr
,next
,value
->ptr
,sdslen(value
->ptr
));
5107 subject
->ptr
= ziplistInsert(subject
->ptr
,entry
->zi
,value
->ptr
,sdslen(value
->ptr
));
5109 decrRefCount(value
);
5110 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
5111 if (where
== REDIS_TAIL
) {
5112 listInsertNode(subject
->ptr
,entry
->ln
,value
,AL_START_TAIL
);
5114 listInsertNode(subject
->ptr
,entry
->ln
,value
,AL_START_HEAD
);
5116 incrRefCount(value
);
5118 redisPanic("Unknown list encoding");
5122 /* Compare the given object with the entry at the current position. */
5123 static int listTypeEqual(listTypeEntry
*entry
, robj
*o
) {
5124 listTypeIterator
*li
= entry
->li
;
5125 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5126 redisAssert(o
->encoding
== REDIS_ENCODING_RAW
);
5127 return ziplistCompare(entry
->zi
,o
->ptr
,sdslen(o
->ptr
));
5128 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
5129 return equalStringObjects(o
,listNodeValue(entry
->ln
));
5131 redisPanic("Unknown list encoding");
5135 /* Delete the element pointed to. */
5136 static void listTypeDelete(listTypeEntry
*entry
) {
5137 listTypeIterator
*li
= entry
->li
;
5138 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5139 unsigned char *p
= entry
->zi
;
5140 li
->subject
->ptr
= ziplistDelete(li
->subject
->ptr
,&p
);
5142 /* Update position of the iterator depending on the direction */
5143 if (li
->direction
== REDIS_TAIL
)
5146 li
->zi
= ziplistPrev(li
->subject
->ptr
,p
);
5147 } else if (entry
->li
->encoding
== REDIS_ENCODING_LIST
) {
5149 if (li
->direction
== REDIS_TAIL
)
5150 next
= entry
->ln
->next
;
5152 next
= entry
->ln
->prev
;
5153 listDelNode(li
->subject
->ptr
,entry
->ln
);
5156 redisPanic("Unknown list encoding");
5160 static void listTypeConvert(robj
*subject
, int enc
) {
5161 listTypeIterator
*li
;
5162 listTypeEntry entry
;
5163 redisAssert(subject
->type
== REDIS_LIST
);
5165 if (enc
== REDIS_ENCODING_LIST
) {
5166 list
*l
= listCreate();
5167 listSetFreeMethod(l
,decrRefCount
);
5169 /* listTypeGet returns a robj with incremented refcount */
5170 li
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5171 while (listTypeNext(li
,&entry
)) listAddNodeTail(l
,listTypeGet(&entry
));
5172 listTypeReleaseIterator(li
);
5174 subject
->encoding
= REDIS_ENCODING_LIST
;
5175 zfree(subject
->ptr
);
5178 redisPanic("Unsupported list conversion");
5182 static void pushGenericCommand(redisClient
*c
, int where
) {
5183 robj
*lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5185 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5186 addReply(c
,shared
.cone
);
5189 lobj
= createZiplistObject();
5190 dbAdd(c
->db
,c
->argv
[1],lobj
);
5192 if (lobj
->type
!= REDIS_LIST
) {
5193 addReply(c
,shared
.wrongtypeerr
);
5196 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
5197 addReply(c
,shared
.cone
);
5201 listTypePush(lobj
,c
->argv
[2],where
);
5202 addReplyLongLong(c
,listTypeLength(lobj
));
5206 static void lpushCommand(redisClient
*c
) {
5207 pushGenericCommand(c
,REDIS_HEAD
);
5210 static void rpushCommand(redisClient
*c
) {
5211 pushGenericCommand(c
,REDIS_TAIL
);
5214 static void pushxGenericCommand(redisClient
*c
, robj
*refval
, robj
*val
, int where
) {
5216 listTypeIterator
*iter
;
5217 listTypeEntry entry
;
5220 if ((subject
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5221 checkType(c
,subject
,REDIS_LIST
)) return;
5222 if (handleClientsWaitingListPush(c
,c
->argv
[1],val
)) {
5223 addReply(c
,shared
.cone
);
5227 if (refval
!= NULL
) {
5228 /* Note: we expect refval to be string-encoded because it is *not* the
5229 * last argument of the multi-bulk LINSERT. */
5230 redisAssert(refval
->encoding
== REDIS_ENCODING_RAW
);
5232 /* We're not sure if this value can be inserted yet, but we cannot
5233 * convert the list inside the iterator. We don't want to loop over
5234 * the list twice (once to see if the value can be inserted and once
5235 * to do the actual insert), so we assume this value can be inserted
5236 * and convert the ziplist to a regular list if necessary. */
5237 listTypeTryConversion(subject
,val
);
5239 /* Seek refval from head to tail */
5240 iter
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5241 while (listTypeNext(iter
,&entry
)) {
5242 if (listTypeEqual(&entry
,refval
)) {
5243 listTypeInsert(&entry
,val
,where
);
5248 listTypeReleaseIterator(iter
);
5251 /* Check if the length exceeds the ziplist length threshold. */
5252 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
&&
5253 ziplistLen(subject
->ptr
) > server
.list_max_ziplist_entries
)
5254 listTypeConvert(subject
,REDIS_ENCODING_LIST
);
5257 /* Notify client of a failed insert */
5258 addReply(c
,shared
.cnegone
);
5262 listTypePush(subject
,val
,where
);
5266 addReplyUlong(c
,listTypeLength(subject
));
5269 static void lpushxCommand(redisClient
*c
) {
5270 pushxGenericCommand(c
,NULL
,c
->argv
[2],REDIS_HEAD
);
5273 static void rpushxCommand(redisClient
*c
) {
5274 pushxGenericCommand(c
,NULL
,c
->argv
[2],REDIS_TAIL
);
5277 static void linsertCommand(redisClient
*c
) {
5278 if (strcasecmp(c
->argv
[2]->ptr
,"after") == 0) {
5279 pushxGenericCommand(c
,c
->argv
[3],c
->argv
[4],REDIS_TAIL
);
5280 } else if (strcasecmp(c
->argv
[2]->ptr
,"before") == 0) {
5281 pushxGenericCommand(c
,c
->argv
[3],c
->argv
[4],REDIS_HEAD
);
5283 addReply(c
,shared
.syntaxerr
);
5287 static void llenCommand(redisClient
*c
) {
5288 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
);
5289 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5290 addReplyUlong(c
,listTypeLength(o
));
5293 static void lindexCommand(redisClient
*c
) {
5294 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5295 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5296 int index
= atoi(c
->argv
[2]->ptr
);
5299 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5301 unsigned char *vstr
;
5304 p
= ziplistIndex(o
->ptr
,index
);
5305 if (ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
5307 value
= createStringObject((char*)vstr
,vlen
);
5309 value
= createStringObjectFromLongLong(vlong
);
5311 addReplyBulk(c
,value
);
5312 decrRefCount(value
);
5314 addReply(c
,shared
.nullbulk
);
5316 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5317 listNode
*ln
= listIndex(o
->ptr
,index
);
5319 value
= listNodeValue(ln
);
5320 addReplyBulk(c
,value
);
5322 addReply(c
,shared
.nullbulk
);
5325 redisPanic("Unknown list encoding");
5329 static void lsetCommand(redisClient
*c
) {
5330 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
);
5331 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5332 int index
= atoi(c
->argv
[2]->ptr
);
5333 robj
*value
= c
->argv
[3];
5335 listTypeTryConversion(o
,value
);
5336 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5337 unsigned char *p
, *zl
= o
->ptr
;
5338 p
= ziplistIndex(zl
,index
);
5340 addReply(c
,shared
.outofrangeerr
);
5342 o
->ptr
= ziplistDelete(o
->ptr
,&p
);
5343 value
= getDecodedObject(value
);
5344 o
->ptr
= ziplistInsert(o
->ptr
,p
,value
->ptr
,sdslen(value
->ptr
));
5345 decrRefCount(value
);
5346 addReply(c
,shared
.ok
);
5349 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5350 listNode
*ln
= listIndex(o
->ptr
,index
);
5352 addReply(c
,shared
.outofrangeerr
);
5354 decrRefCount((robj
*)listNodeValue(ln
));
5355 listNodeValue(ln
) = value
;
5356 incrRefCount(value
);
5357 addReply(c
,shared
.ok
);
5361 redisPanic("Unknown list encoding");
5365 static void popGenericCommand(redisClient
*c
, int where
) {
5366 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5367 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5369 robj
*value
= listTypePop(o
,where
);
5370 if (value
== NULL
) {
5371 addReply(c
,shared
.nullbulk
);
5373 addReplyBulk(c
,value
);
5374 decrRefCount(value
);
5375 if (listTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5380 static void lpopCommand(redisClient
*c
) {
5381 popGenericCommand(c
,REDIS_HEAD
);
5384 static void rpopCommand(redisClient
*c
) {
5385 popGenericCommand(c
,REDIS_TAIL
);
5388 static void lrangeCommand(redisClient
*c
) {
5390 int start
= atoi(c
->argv
[2]->ptr
);
5391 int end
= atoi(c
->argv
[3]->ptr
);
5394 listTypeEntry entry
;
5396 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5397 || checkType(c
,o
,REDIS_LIST
)) return;
5398 llen
= listTypeLength(o
);
5400 /* convert negative indexes */
5401 if (start
< 0) start
= llen
+start
;
5402 if (end
< 0) end
= llen
+end
;
5403 if (start
< 0) start
= 0;
5404 if (end
< 0) end
= 0;
5406 /* indexes sanity checks */
5407 if (start
> end
|| start
>= llen
) {
5408 /* Out of range start or start > end result in empty list */
5409 addReply(c
,shared
.emptymultibulk
);
5412 if (end
>= llen
) end
= llen
-1;
5413 rangelen
= (end
-start
)+1;
5415 /* Return the result in form of a multi-bulk reply */
5416 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
5417 listTypeIterator
*li
= listTypeInitIterator(o
,start
,REDIS_TAIL
);
5418 for (j
= 0; j
< rangelen
; j
++) {
5419 redisAssert(listTypeNext(li
,&entry
));
5420 value
= listTypeGet(&entry
);
5421 addReplyBulk(c
,value
);
5422 decrRefCount(value
);
5424 listTypeReleaseIterator(li
);
5427 static void ltrimCommand(redisClient
*c
) {
5429 int start
= atoi(c
->argv
[2]->ptr
);
5430 int end
= atoi(c
->argv
[3]->ptr
);
5432 int j
, ltrim
, rtrim
;
5436 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
5437 checkType(c
,o
,REDIS_LIST
)) return;
5438 llen
= listTypeLength(o
);
5440 /* convert negative indexes */
5441 if (start
< 0) start
= llen
+start
;
5442 if (end
< 0) end
= llen
+end
;
5443 if (start
< 0) start
= 0;
5444 if (end
< 0) end
= 0;
5446 /* indexes sanity checks */
5447 if (start
> end
|| start
>= llen
) {
5448 /* Out of range start or start > end result in empty list */
5452 if (end
>= llen
) end
= llen
-1;
5457 /* Remove list elements to perform the trim */
5458 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5459 o
->ptr
= ziplistDeleteRange(o
->ptr
,0,ltrim
);
5460 o
->ptr
= ziplistDeleteRange(o
->ptr
,-rtrim
,rtrim
);
5461 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5463 for (j
= 0; j
< ltrim
; j
++) {
5464 ln
= listFirst(list
);
5465 listDelNode(list
,ln
);
5467 for (j
= 0; j
< rtrim
; j
++) {
5468 ln
= listLast(list
);
5469 listDelNode(list
,ln
);
5472 redisPanic("Unknown list encoding");
5474 if (listTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5476 addReply(c
,shared
.ok
);
5479 static void lremCommand(redisClient
*c
) {
5480 robj
*subject
, *obj
= c
->argv
[3];
5481 int toremove
= atoi(c
->argv
[2]->ptr
);
5483 listTypeEntry entry
;
5485 subject
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
);
5486 if (subject
== NULL
|| checkType(c
,subject
,REDIS_LIST
)) return;
5488 /* Make sure obj is raw when we're dealing with a ziplist */
5489 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5490 obj
= getDecodedObject(obj
);
5492 listTypeIterator
*li
;
5494 toremove
= -toremove
;
5495 li
= listTypeInitIterator(subject
,-1,REDIS_HEAD
);
5497 li
= listTypeInitIterator(subject
,0,REDIS_TAIL
);
5500 while (listTypeNext(li
,&entry
)) {
5501 if (listTypeEqual(&entry
,obj
)) {
5502 listTypeDelete(&entry
);
5505 if (toremove
&& removed
== toremove
) break;
5508 listTypeReleaseIterator(li
);
5510 /* Clean up raw encoded object */
5511 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5514 if (listTypeLength(subject
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5515 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
5518 /* This is the semantic of this command:
5519 * RPOPLPUSH srclist dstlist:
5520 * IF LLEN(srclist) > 0
5521 * element = RPOP srclist
5522 * LPUSH dstlist element
5529 * The idea is to be able to get an element from a list in a reliable way
5530 * since the element is not just returned but pushed against another list
5531 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5533 static void rpoplpushcommand(redisClient
*c
) {
5535 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5536 checkType(c
,sobj
,REDIS_LIST
)) return;
5538 if (listTypeLength(sobj
) == 0) {
5539 addReply(c
,shared
.nullbulk
);
5541 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5542 if (dobj
&& checkType(c
,dobj
,REDIS_LIST
)) return;
5543 value
= listTypePop(sobj
,REDIS_TAIL
);
5545 /* Add the element to the target list (unless it's directly
5546 * passed to some BLPOP-ing client */
5547 if (!handleClientsWaitingListPush(c
,c
->argv
[2],value
)) {
5548 /* Create the list if the key does not exist */
5550 dobj
= createZiplistObject();
5551 dbAdd(c
->db
,c
->argv
[2],dobj
);
5553 listTypePush(dobj
,value
,REDIS_HEAD
);
5556 /* Send the element to the client as reply as well */
5557 addReplyBulk(c
,value
);
5559 /* listTypePop returns an object with its refcount incremented */
5560 decrRefCount(value
);
5562 /* Delete the source list when it is empty */
5563 if (listTypeLength(sobj
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5568 /* ==================================== Sets ================================ */
5570 static void saddCommand(redisClient
*c
) {
5573 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5575 set
= createSetObject();
5576 dbAdd(c
->db
,c
->argv
[1],set
);
5578 if (set
->type
!= REDIS_SET
) {
5579 addReply(c
,shared
.wrongtypeerr
);
5583 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5584 incrRefCount(c
->argv
[2]);
5586 addReply(c
,shared
.cone
);
5588 addReply(c
,shared
.czero
);
5592 static void sremCommand(redisClient
*c
) {
5595 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5596 checkType(c
,set
,REDIS_SET
)) return;
5598 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5600 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5601 if (dictSize((dict
*)set
->ptr
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5602 addReply(c
,shared
.cone
);
5604 addReply(c
,shared
.czero
);
5608 static void smoveCommand(redisClient
*c
) {
5609 robj
*srcset
, *dstset
;
5611 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5612 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5614 /* If the source key does not exist return 0, if it's of the wrong type
5616 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5617 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5620 /* Error if the destination key is not a set as well */
5621 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5622 addReply(c
,shared
.wrongtypeerr
);
5625 /* Remove the element from the source set */
5626 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5627 /* Key not found in the src set! return zero */
5628 addReply(c
,shared
.czero
);
5631 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5632 dbDelete(c
->db
,c
->argv
[1]);
5634 /* Add the element to the destination set */
5636 dstset
= createSetObject();
5637 dbAdd(c
->db
,c
->argv
[2],dstset
);
5639 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5640 incrRefCount(c
->argv
[3]);
5641 addReply(c
,shared
.cone
);
5644 static void sismemberCommand(redisClient
*c
) {
5647 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5648 checkType(c
,set
,REDIS_SET
)) return;
5650 if (dictFind(set
->ptr
,c
->argv
[2]))
5651 addReply(c
,shared
.cone
);
5653 addReply(c
,shared
.czero
);
5656 static void scardCommand(redisClient
*c
) {
5660 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5661 checkType(c
,o
,REDIS_SET
)) return;
5664 addReplyUlong(c
,dictSize(s
));
5667 static void spopCommand(redisClient
*c
) {
5671 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5672 checkType(c
,set
,REDIS_SET
)) return;
5674 de
= dictGetRandomKey(set
->ptr
);
5676 addReply(c
,shared
.nullbulk
);
5678 robj
*ele
= dictGetEntryKey(de
);
5680 addReplyBulk(c
,ele
);
5681 dictDelete(set
->ptr
,ele
);
5682 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5683 if (dictSize((dict
*)set
->ptr
) == 0) dbDelete(c
->db
,c
->argv
[1]);
5688 static void srandmemberCommand(redisClient
*c
) {
5692 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5693 checkType(c
,set
,REDIS_SET
)) return;
5695 de
= dictGetRandomKey(set
->ptr
);
5697 addReply(c
,shared
.nullbulk
);
5699 robj
*ele
= dictGetEntryKey(de
);
5701 addReplyBulk(c
,ele
);
5705 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5706 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5708 return dictSize(*d1
)-dictSize(*d2
);
5711 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5712 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5715 robj
*lenobj
= NULL
, *dstset
= NULL
;
5716 unsigned long j
, cardinality
= 0;
5718 for (j
= 0; j
< setsnum
; j
++) {
5722 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5723 lookupKeyRead(c
->db
,setskeys
[j
]);
5727 if (dbDelete(c
->db
,dstkey
))
5729 addReply(c
,shared
.czero
);
5731 addReply(c
,shared
.emptymultibulk
);
5735 if (setobj
->type
!= REDIS_SET
) {
5737 addReply(c
,shared
.wrongtypeerr
);
5740 dv
[j
] = setobj
->ptr
;
5742 /* Sort sets from the smallest to largest, this will improve our
5743 * algorithm's performace */
5744 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5746 /* The first thing we should output is the total number of elements...
5747 * since this is a multi-bulk write, but at this stage we don't know
5748 * the intersection set size, so we use a trick, append an empty object
5749 * to the output list and save the pointer to later modify it with the
5752 lenobj
= createObject(REDIS_STRING
,NULL
);
5754 decrRefCount(lenobj
);
5756 /* If we have a target key where to store the resulting set
5757 * create this key with an empty set inside */
5758 dstset
= createSetObject();
5761 /* Iterate all the elements of the first (smallest) set, and test
5762 * the element against all the other sets, if at least one set does
5763 * not include the element it is discarded */
5764 di
= dictGetIterator(dv
[0]);
5766 while((de
= dictNext(di
)) != NULL
) {
5769 for (j
= 1; j
< setsnum
; j
++)
5770 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5772 continue; /* at least one set does not contain the member */
5773 ele
= dictGetEntryKey(de
);
5775 addReplyBulk(c
,ele
);
5778 dictAdd(dstset
->ptr
,ele
,NULL
);
5782 dictReleaseIterator(di
);
5785 /* Store the resulting set into the target, if the intersection
5786 * is not an empty set. */
5787 dbDelete(c
->db
,dstkey
);
5788 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5789 dbAdd(c
->db
,dstkey
,dstset
);
5790 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5792 decrRefCount(dstset
);
5793 addReply(c
,shared
.czero
);
5797 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5802 static void sinterCommand(redisClient
*c
) {
5803 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5806 static void sinterstoreCommand(redisClient
*c
) {
5807 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5810 #define REDIS_OP_UNION 0
5811 #define REDIS_OP_DIFF 1
5812 #define REDIS_OP_INTER 2
5814 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5815 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5818 robj
*dstset
= NULL
;
5819 int j
, cardinality
= 0;
5821 for (j
= 0; j
< setsnum
; j
++) {
5825 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5826 lookupKeyRead(c
->db
,setskeys
[j
]);
5831 if (setobj
->type
!= REDIS_SET
) {
5833 addReply(c
,shared
.wrongtypeerr
);
5836 dv
[j
] = setobj
->ptr
;
5839 /* We need a temp set object to store our union. If the dstkey
5840 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5841 * this set object will be the resulting object to set into the target key*/
5842 dstset
= createSetObject();
5844 /* Iterate all the elements of all the sets, add every element a single
5845 * time to the result set */
5846 for (j
= 0; j
< setsnum
; j
++) {
5847 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5848 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5850 di
= dictGetIterator(dv
[j
]);
5852 while((de
= dictNext(di
)) != NULL
) {
5855 /* dictAdd will not add the same element multiple times */
5856 ele
= dictGetEntryKey(de
);
5857 if (op
== REDIS_OP_UNION
|| j
== 0) {
5858 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5862 } else if (op
== REDIS_OP_DIFF
) {
5863 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5868 dictReleaseIterator(di
);
5870 /* result set is empty? Exit asap. */
5871 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5874 /* Output the content of the resulting set, if not in STORE mode */
5876 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5877 di
= dictGetIterator(dstset
->ptr
);
5878 while((de
= dictNext(di
)) != NULL
) {
5881 ele
= dictGetEntryKey(de
);
5882 addReplyBulk(c
,ele
);
5884 dictReleaseIterator(di
);
5885 decrRefCount(dstset
);
5887 /* If we have a target key where to store the resulting set
5888 * create this key with the result set inside */
5889 dbDelete(c
->db
,dstkey
);
5890 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5891 dbAdd(c
->db
,dstkey
,dstset
);
5892 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5894 decrRefCount(dstset
);
5895 addReply(c
,shared
.czero
);
5902 static void sunionCommand(redisClient
*c
) {
5903 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5906 static void sunionstoreCommand(redisClient
*c
) {
5907 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5910 static void sdiffCommand(redisClient
*c
) {
5911 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5914 static void sdiffstoreCommand(redisClient
*c
) {
5915 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5918 /* ==================================== ZSets =============================== */
5920 /* ZSETs are ordered sets using two data structures to hold the same elements
5921 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5924 * The elements are added to an hash table mapping Redis objects to scores.
5925 * At the same time the elements are added to a skip list mapping scores
5926 * to Redis objects (so objects are sorted by scores in this "view"). */
5928 /* This skiplist implementation is almost a C translation of the original
5929 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5930 * Alternative to Balanced Trees", modified in three ways:
5931 * a) this implementation allows for repeated values.
5932 * b) the comparison is not just by key (our 'score') but by satellite data.
5933 * c) there is a back pointer, so it's a doubly linked list with the back
5934 * pointers being only at "level 1". This allows to traverse the list
5935 * from tail to head, useful for ZREVRANGE. */
5937 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5938 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5940 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5942 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5950 static zskiplist
*zslCreate(void) {
5954 zsl
= zmalloc(sizeof(*zsl
));
5957 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5958 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5959 zsl
->header
->forward
[j
] = NULL
;
5961 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5962 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5963 zsl
->header
->span
[j
] = 0;
5965 zsl
->header
->backward
= NULL
;
5970 static void zslFreeNode(zskiplistNode
*node
) {
5971 decrRefCount(node
->obj
);
5972 zfree(node
->forward
);
5977 static void zslFree(zskiplist
*zsl
) {
5978 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5980 zfree(zsl
->header
->forward
);
5981 zfree(zsl
->header
->span
);
5984 next
= node
->forward
[0];
5991 static int zslRandomLevel(void) {
5993 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5995 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5998 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5999 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6000 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
6004 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6005 /* store rank that is crossed to reach the insert position */
6006 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
6008 while (x
->forward
[i
] &&
6009 (x
->forward
[i
]->score
< score
||
6010 (x
->forward
[i
]->score
== score
&&
6011 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
6012 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
6017 /* we assume the key is not already inside, since we allow duplicated
6018 * scores, and the re-insertion of score and redis object should never
6019 * happpen since the caller of zslInsert() should test in the hash table
6020 * if the element is already inside or not. */
6021 level
= zslRandomLevel();
6022 if (level
> zsl
->level
) {
6023 for (i
= zsl
->level
; i
< level
; i
++) {
6025 update
[i
] = zsl
->header
;
6026 update
[i
]->span
[i
-1] = zsl
->length
;
6030 x
= zslCreateNode(level
,score
,obj
);
6031 for (i
= 0; i
< level
; i
++) {
6032 x
->forward
[i
] = update
[i
]->forward
[i
];
6033 update
[i
]->forward
[i
] = x
;
6035 /* update span covered by update[i] as x is inserted here */
6037 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
6038 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
6042 /* increment span for untouched levels */
6043 for (i
= level
; i
< zsl
->level
; i
++) {
6044 update
[i
]->span
[i
-1]++;
6047 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
6049 x
->forward
[0]->backward
= x
;
6055 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
6056 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
6058 for (i
= 0; i
< zsl
->level
; i
++) {
6059 if (update
[i
]->forward
[i
] == x
) {
6061 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
6063 update
[i
]->forward
[i
] = x
->forward
[i
];
6065 /* invariant: i > 0, because update[0]->forward[0]
6066 * is always equal to x */
6067 update
[i
]->span
[i
-1] -= 1;
6070 if (x
->forward
[0]) {
6071 x
->forward
[0]->backward
= x
->backward
;
6073 zsl
->tail
= x
->backward
;
6075 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
6080 /* Delete an element with matching score/object from the skiplist. */
6081 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
6082 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6086 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6087 while (x
->forward
[i
] &&
6088 (x
->forward
[i
]->score
< score
||
6089 (x
->forward
[i
]->score
== score
&&
6090 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
6094 /* We may have multiple elements with the same score, what we need
6095 * is to find the element with both the right score and object. */
6097 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
6098 zslDeleteNode(zsl
, x
, update
);
6102 return 0; /* not found */
6104 return 0; /* not found */
6107 /* Delete all the elements with score between min and max from the skiplist.
6108 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
6109 * Note that this function takes the reference to the hash table view of the
6110 * sorted set, in order to remove the elements from the hash table too. */
6111 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
6112 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6113 unsigned long removed
= 0;
6117 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6118 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
6122 /* We may have multiple elements with the same score, what we need
6123 * is to find the element with both the right score and object. */
6125 while (x
&& x
->score
<= max
) {
6126 zskiplistNode
*next
= x
->forward
[0];
6127 zslDeleteNode(zsl
, x
, update
);
6128 dictDelete(dict
,x
->obj
);
6133 return removed
; /* not found */
6136 /* Delete all the elements with rank between start and end from the skiplist.
6137 * Start and end are inclusive. Note that start and end need to be 1-based */
6138 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
6139 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
6140 unsigned long traversed
= 0, removed
= 0;
6144 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6145 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
6146 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
6154 while (x
&& traversed
<= end
) {
6155 zskiplistNode
*next
= x
->forward
[0];
6156 zslDeleteNode(zsl
, x
, update
);
6157 dictDelete(dict
,x
->obj
);
6166 /* Find the first node having a score equal or greater than the specified one.
6167 * Returns NULL if there is no match. */
6168 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
6173 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6174 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
6177 /* We may have multiple elements with the same score, what we need
6178 * is to find the element with both the right score and object. */
6179 return x
->forward
[0];
6182 /* Find the rank for an element by both score and key.
6183 * Returns 0 when the element cannot be found, rank otherwise.
6184 * Note that the rank is 1-based due to the span of zsl->header to the
6186 static unsigned long zslistTypeGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
6188 unsigned long rank
= 0;
6192 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6193 while (x
->forward
[i
] &&
6194 (x
->forward
[i
]->score
< score
||
6195 (x
->forward
[i
]->score
== score
&&
6196 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
6197 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
6201 /* x might be equal to zsl->header, so test if obj is non-NULL */
6202 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
6209 /* Finds an element by its rank. The rank argument needs to be 1-based. */
6210 zskiplistNode
* zslistTypeGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
6212 unsigned long traversed
= 0;
6216 for (i
= zsl
->level
-1; i
>= 0; i
--) {
6217 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
6219 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
6222 if (traversed
== rank
) {
6229 /* The actual Z-commands implementations */
6231 /* This generic command implements both ZADD and ZINCRBY.
6232 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
6233 * the increment if the operation is a ZINCRBY (doincrement == 1). */
6234 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
6239 if (isnan(scoreval
)) {
6240 addReplySds(c
,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
6244 zsetobj
= lookupKeyWrite(c
->db
,key
);
6245 if (zsetobj
== NULL
) {
6246 zsetobj
= createZsetObject();
6247 dbAdd(c
->db
,key
,zsetobj
);
6249 if (zsetobj
->type
!= REDIS_ZSET
) {
6250 addReply(c
,shared
.wrongtypeerr
);
6256 /* Ok now since we implement both ZADD and ZINCRBY here the code
6257 * needs to handle the two different conditions. It's all about setting
6258 * '*score', that is, the new score to set, to the right value. */
6259 score
= zmalloc(sizeof(double));
6263 /* Read the old score. If the element was not present starts from 0 */
6264 de
= dictFind(zs
->dict
,ele
);
6266 double *oldscore
= dictGetEntryVal(de
);
6267 *score
= *oldscore
+ scoreval
;
6271 if (isnan(*score
)) {
6273 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6275 /* Note that we don't need to check if the zset may be empty and
6276 * should be removed here, as we can only obtain Nan as score if
6277 * there was already an element in the sorted set. */
6284 /* What follows is a simple remove and re-insert operation that is common
6285 * to both ZADD and ZINCRBY... */
6286 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
6287 /* case 1: New element */
6288 incrRefCount(ele
); /* added to hash */
6289 zslInsert(zs
->zsl
,*score
,ele
);
6290 incrRefCount(ele
); /* added to skiplist */
6293 addReplyDouble(c
,*score
);
6295 addReply(c
,shared
.cone
);
6300 /* case 2: Score update operation */
6301 de
= dictFind(zs
->dict
,ele
);
6302 redisAssert(de
!= NULL
);
6303 oldscore
= dictGetEntryVal(de
);
6304 if (*score
!= *oldscore
) {
6307 /* Remove and insert the element in the skip list with new score */
6308 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
6309 redisAssert(deleted
!= 0);
6310 zslInsert(zs
->zsl
,*score
,ele
);
6312 /* Update the score in the hash table */
6313 dictReplace(zs
->dict
,ele
,score
);
6319 addReplyDouble(c
,*score
);
6321 addReply(c
,shared
.czero
);
6325 static void zaddCommand(redisClient
*c
) {
6328 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6329 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
6332 static void zincrbyCommand(redisClient
*c
) {
6335 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6336 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
6339 static void zremCommand(redisClient
*c
) {
6346 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6347 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6350 de
= dictFind(zs
->dict
,c
->argv
[2]);
6352 addReply(c
,shared
.czero
);
6355 /* Delete from the skiplist */
6356 oldscore
= dictGetEntryVal(de
);
6357 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
6358 redisAssert(deleted
!= 0);
6360 /* Delete from the hash table */
6361 dictDelete(zs
->dict
,c
->argv
[2]);
6362 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6363 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6365 addReply(c
,shared
.cone
);
6368 static void zremrangebyscoreCommand(redisClient
*c
) {
6375 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
6376 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
6378 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6379 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6382 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
6383 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6384 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6385 server
.dirty
+= deleted
;
6386 addReplyLongLong(c
,deleted
);
6389 static void zremrangebyrankCommand(redisClient
*c
) {
6397 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6398 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6400 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6401 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6403 llen
= zs
->zsl
->length
;
6405 /* convert negative indexes */
6406 if (start
< 0) start
= llen
+start
;
6407 if (end
< 0) end
= llen
+end
;
6408 if (start
< 0) start
= 0;
6409 if (end
< 0) end
= 0;
6411 /* indexes sanity checks */
6412 if (start
> end
|| start
>= llen
) {
6413 addReply(c
,shared
.czero
);
6416 if (end
>= llen
) end
= llen
-1;
6418 /* increment start and end because zsl*Rank functions
6419 * use 1-based rank */
6420 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
6421 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6422 if (dictSize(zs
->dict
) == 0) dbDelete(c
->db
,c
->argv
[1]);
6423 server
.dirty
+= deleted
;
6424 addReplyLongLong(c
, deleted
);
6432 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
6433 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
6434 unsigned long size1
, size2
;
6435 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
6436 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
6437 return size1
- size2
;
6440 #define REDIS_AGGR_SUM 1
6441 #define REDIS_AGGR_MIN 2
6442 #define REDIS_AGGR_MAX 3
6443 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6445 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
6446 if (aggregate
== REDIS_AGGR_SUM
) {
6447 *target
= *target
+ val
;
6448 } else if (aggregate
== REDIS_AGGR_MIN
) {
6449 *target
= val
< *target
? val
: *target
;
6450 } else if (aggregate
== REDIS_AGGR_MAX
) {
6451 *target
= val
> *target
? val
: *target
;
6454 redisPanic("Unknown ZUNION/INTER aggregate type");
6458 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
6460 int aggregate
= REDIS_AGGR_SUM
;
6467 /* expect setnum input keys to be given */
6468 setnum
= atoi(c
->argv
[2]->ptr
);
6470 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6474 /* test if the expected number of keys would overflow */
6475 if (3+setnum
> c
->argc
) {
6476 addReply(c
,shared
.syntaxerr
);
6480 /* read keys to be used for input */
6481 src
= zmalloc(sizeof(zsetopsrc
) * setnum
);
6482 for (i
= 0, j
= 3; i
< setnum
; i
++, j
++) {
6483 robj
*obj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6487 if (obj
->type
== REDIS_ZSET
) {
6488 src
[i
].dict
= ((zset
*)obj
->ptr
)->dict
;
6489 } else if (obj
->type
== REDIS_SET
) {
6490 src
[i
].dict
= (obj
->ptr
);
6493 addReply(c
,shared
.wrongtypeerr
);
6498 /* default all weights to 1 */
6499 src
[i
].weight
= 1.0;
6502 /* parse optional extra arguments */
6504 int remaining
= c
->argc
- j
;
6507 if (remaining
>= (setnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
6509 for (i
= 0; i
< setnum
; i
++, j
++, remaining
--) {
6510 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
6513 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
6515 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
6516 aggregate
= REDIS_AGGR_SUM
;
6517 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
6518 aggregate
= REDIS_AGGR_MIN
;
6519 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
6520 aggregate
= REDIS_AGGR_MAX
;
6523 addReply(c
,shared
.syntaxerr
);
6529 addReply(c
,shared
.syntaxerr
);
6535 /* sort sets from the smallest to largest, this will improve our
6536 * algorithm's performance */
6537 qsort(src
,setnum
,sizeof(zsetopsrc
),qsortCompareZsetopsrcByCardinality
);
6539 dstobj
= createZsetObject();
6540 dstzset
= dstobj
->ptr
;
6542 if (op
== REDIS_OP_INTER
) {
6543 /* skip going over all entries if the smallest zset is NULL or empty */
6544 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
6545 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6546 * from small to large, all src[i > 0].dict are non-empty too */
6547 di
= dictGetIterator(src
[0].dict
);
6548 while((de
= dictNext(di
)) != NULL
) {
6549 double *score
= zmalloc(sizeof(double)), value
;
6550 *score
= src
[0].weight
* zunionInterDictValue(de
);
6552 for (j
= 1; j
< setnum
; j
++) {
6553 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6555 value
= src
[j
].weight
* zunionInterDictValue(other
);
6556 zunionInterAggregate(score
, value
, aggregate
);
6562 /* skip entry when not present in every source dict */
6566 robj
*o
= dictGetEntryKey(de
);
6567 dictAdd(dstzset
->dict
,o
,score
);
6568 incrRefCount(o
); /* added to dictionary */
6569 zslInsert(dstzset
->zsl
,*score
,o
);
6570 incrRefCount(o
); /* added to skiplist */
6573 dictReleaseIterator(di
);
6575 } else if (op
== REDIS_OP_UNION
) {
6576 for (i
= 0; i
< setnum
; i
++) {
6577 if (!src
[i
].dict
) continue;
6579 di
= dictGetIterator(src
[i
].dict
);
6580 while((de
= dictNext(di
)) != NULL
) {
6581 /* skip key when already processed */
6582 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6584 double *score
= zmalloc(sizeof(double)), value
;
6585 *score
= src
[i
].weight
* zunionInterDictValue(de
);
6587 /* because the zsets are sorted by size, its only possible
6588 * for sets at larger indices to hold this entry */
6589 for (j
= (i
+1); j
< setnum
; j
++) {
6590 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6592 value
= src
[j
].weight
* zunionInterDictValue(other
);
6593 zunionInterAggregate(score
, value
, aggregate
);
6597 robj
*o
= dictGetEntryKey(de
);
6598 dictAdd(dstzset
->dict
,o
,score
);
6599 incrRefCount(o
); /* added to dictionary */
6600 zslInsert(dstzset
->zsl
,*score
,o
);
6601 incrRefCount(o
); /* added to skiplist */
6603 dictReleaseIterator(di
);
6606 /* unknown operator */
6607 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6610 dbDelete(c
->db
,dstkey
);
6611 if (dstzset
->zsl
->length
) {
6612 dbAdd(c
->db
,dstkey
,dstobj
);
6613 addReplyLongLong(c
, dstzset
->zsl
->length
);
6616 decrRefCount(dstobj
);
6617 addReply(c
, shared
.czero
);
6622 static void zunionstoreCommand(redisClient
*c
) {
6623 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6626 static void zinterstoreCommand(redisClient
*c
) {
6627 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6630 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6642 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6643 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6645 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6647 } else if (c
->argc
>= 5) {
6648 addReply(c
,shared
.syntaxerr
);
6652 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6653 || checkType(c
,o
,REDIS_ZSET
)) return;
6658 /* convert negative indexes */
6659 if (start
< 0) start
= llen
+start
;
6660 if (end
< 0) end
= llen
+end
;
6661 if (start
< 0) start
= 0;
6662 if (end
< 0) end
= 0;
6664 /* indexes sanity checks */
6665 if (start
> end
|| start
>= llen
) {
6666 /* Out of range start or start > end result in empty list */
6667 addReply(c
,shared
.emptymultibulk
);
6670 if (end
>= llen
) end
= llen
-1;
6671 rangelen
= (end
-start
)+1;
6673 /* check if starting point is trivial, before searching
6674 * the element in log(N) time */
6676 ln
= start
== 0 ? zsl
->tail
: zslistTypeGetElementByRank(zsl
, llen
-start
);
6679 zsl
->header
->forward
[0] : zslistTypeGetElementByRank(zsl
, start
+1);
6682 /* Return the result in form of a multi-bulk reply */
6683 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6684 withscores
? (rangelen
*2) : rangelen
));
6685 for (j
= 0; j
< rangelen
; j
++) {
6687 addReplyBulk(c
,ele
);
6689 addReplyDouble(c
,ln
->score
);
6690 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6694 static void zrangeCommand(redisClient
*c
) {
6695 zrangeGenericCommand(c
,0);
6698 static void zrevrangeCommand(redisClient
*c
) {
6699 zrangeGenericCommand(c
,1);
6702 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6703 * If justcount is non-zero, just the count is returned. */
6704 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6707 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6708 int offset
= 0, limit
= -1;
6712 /* Parse the min-max interval. If one of the values is prefixed
6713 * by the "(" character, it's considered "open". For instance
6714 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6715 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6716 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6717 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6720 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6722 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6723 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6726 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6729 /* Parse "WITHSCORES": note that if the command was called with
6730 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6731 * enter the following paths to parse WITHSCORES and LIMIT. */
6732 if (c
->argc
== 5 || c
->argc
== 8) {
6733 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6738 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6742 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6747 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6748 addReply(c
,shared
.syntaxerr
);
6750 } else if (c
->argc
== (7 + withscores
)) {
6751 offset
= atoi(c
->argv
[5]->ptr
);
6752 limit
= atoi(c
->argv
[6]->ptr
);
6753 if (offset
< 0) offset
= 0;
6756 /* Ok, lookup the key and get the range */
6757 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6759 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6761 if (o
->type
!= REDIS_ZSET
) {
6762 addReply(c
,shared
.wrongtypeerr
);
6764 zset
*zsetobj
= o
->ptr
;
6765 zskiplist
*zsl
= zsetobj
->zsl
;
6767 robj
*ele
, *lenobj
= NULL
;
6768 unsigned long rangelen
= 0;
6770 /* Get the first node with the score >= min, or with
6771 * score > min if 'minex' is true. */
6772 ln
= zslFirstWithScore(zsl
,min
);
6773 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6776 /* No element matching the speciifed interval */
6777 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6781 /* We don't know in advance how many matching elements there
6782 * are in the list, so we push this object that will represent
6783 * the multi-bulk length in the output buffer, and will "fix"
6786 lenobj
= createObject(REDIS_STRING
,NULL
);
6788 decrRefCount(lenobj
);
6791 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6794 ln
= ln
->forward
[0];
6797 if (limit
== 0) break;
6800 addReplyBulk(c
,ele
);
6802 addReplyDouble(c
,ln
->score
);
6804 ln
= ln
->forward
[0];
6806 if (limit
> 0) limit
--;
6809 addReplyLongLong(c
,(long)rangelen
);
6811 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6812 withscores
? (rangelen
*2) : rangelen
);
6818 static void zrangebyscoreCommand(redisClient
*c
) {
6819 genericZrangebyscoreCommand(c
,0);
6822 static void zcountCommand(redisClient
*c
) {
6823 genericZrangebyscoreCommand(c
,1);
6826 static void zcardCommand(redisClient
*c
) {
6830 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6831 checkType(c
,o
,REDIS_ZSET
)) return;
6834 addReplyUlong(c
,zs
->zsl
->length
);
6837 static void zscoreCommand(redisClient
*c
) {
6842 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6843 checkType(c
,o
,REDIS_ZSET
)) return;
6846 de
= dictFind(zs
->dict
,c
->argv
[2]);
6848 addReply(c
,shared
.nullbulk
);
6850 double *score
= dictGetEntryVal(de
);
6852 addReplyDouble(c
,*score
);
6856 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6864 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6865 checkType(c
,o
,REDIS_ZSET
)) return;
6869 de
= dictFind(zs
->dict
,c
->argv
[2]);
6871 addReply(c
,shared
.nullbulk
);
6875 score
= dictGetEntryVal(de
);
6876 rank
= zslistTypeGetRank(zsl
, *score
, c
->argv
[2]);
6879 addReplyLongLong(c
, zsl
->length
- rank
);
6881 addReplyLongLong(c
, rank
-1);
6884 addReply(c
,shared
.nullbulk
);
6888 static void zrankCommand(redisClient
*c
) {
6889 zrankGenericCommand(c
, 0);
6892 static void zrevrankCommand(redisClient
*c
) {
6893 zrankGenericCommand(c
, 1);
6896 /* ========================= Hashes utility functions ======================= */
6897 #define REDIS_HASH_KEY 1
6898 #define REDIS_HASH_VALUE 2
6900 /* Check the length of a number of objects to see if we need to convert a
6901 * zipmap to a real hash. Note that we only check string encoded objects
6902 * as their string length can be queried in constant time. */
6903 static void hashTypeTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6905 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6907 for (i
= start
; i
<= end
; i
++) {
6908 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6909 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6911 convertToRealHash(subject
);
6917 /* Encode given objects in-place when the hash uses a dict. */
6918 static void hashTypeTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6919 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6920 if (o1
) *o1
= tryObjectEncoding(*o1
);
6921 if (o2
) *o2
= tryObjectEncoding(*o2
);
6925 /* Get the value from a hash identified by key. Returns either a string
6926 * object or NULL if the value cannot be found. The refcount of the object
6927 * is always increased by 1 when the value was found. */
6928 static robj
*hashTypeGet(robj
*o
, robj
*key
) {
6930 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6933 key
= getDecodedObject(key
);
6934 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6935 value
= createStringObject((char*)v
,vlen
);
6939 dictEntry
*de
= dictFind(o
->ptr
,key
);
6941 value
= dictGetEntryVal(de
);
6942 incrRefCount(value
);
6948 /* Test if the key exists in the given hash. Returns 1 if the key
6949 * exists and 0 when it doesn't. */
6950 static int hashTypeExists(robj
*o
, robj
*key
) {
6951 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6952 key
= getDecodedObject(key
);
6953 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6959 if (dictFind(o
->ptr
,key
) != NULL
) {
6966 /* Add an element, discard the old if the key already exists.
6967 * Return 0 on insert and 1 on update. */
6968 static int hashTypeSet(robj
*o
, robj
*key
, robj
*value
) {
6970 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6971 key
= getDecodedObject(key
);
6972 value
= getDecodedObject(value
);
6973 o
->ptr
= zipmapSet(o
->ptr
,
6974 key
->ptr
,sdslen(key
->ptr
),
6975 value
->ptr
,sdslen(value
->ptr
), &update
);
6977 decrRefCount(value
);
6979 /* Check if the zipmap needs to be upgraded to a real hash table */
6980 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6981 convertToRealHash(o
);
6983 if (dictReplace(o
->ptr
,key
,value
)) {
6990 incrRefCount(value
);
6995 /* Delete an element from a hash.
6996 * Return 1 on deleted and 0 on not found. */
6997 static int hashTypeDelete(robj
*o
, robj
*key
) {
6999 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7000 key
= getDecodedObject(key
);
7001 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
7004 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
7005 /* Always check if the dictionary needs a resize after a delete. */
7006 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
7011 /* Return the number of elements in a hash. */
7012 static unsigned long hashTypeLength(robj
*o
) {
7013 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
7014 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
7017 /* Structure to hold hash iteration abstration. Note that iteration over
7018 * hashes involves both fields and values. Because it is possible that
7019 * not both are required, store pointers in the iterator to avoid
7020 * unnecessary memory allocation for fields/values. */
7024 unsigned char *zk
, *zv
;
7025 unsigned int zklen
, zvlen
;
7031 static hashTypeIterator
*hashTypeInitIterator(robj
*subject
) {
7032 hashTypeIterator
*hi
= zmalloc(sizeof(hashTypeIterator
));
7033 hi
->encoding
= subject
->encoding
;
7034 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7035 hi
->zi
= zipmapRewind(subject
->ptr
);
7036 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
7037 hi
->di
= dictGetIterator(subject
->ptr
);
7044 static void hashTypeReleaseIterator(hashTypeIterator
*hi
) {
7045 if (hi
->encoding
== REDIS_ENCODING_HT
) {
7046 dictReleaseIterator(hi
->di
);
7051 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
7052 * could be found and REDIS_ERR when the iterator reaches the end. */
7053 static int hashTypeNext(hashTypeIterator
*hi
) {
7054 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7055 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
7056 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
7058 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
7063 /* Get key or value object at current iteration position.
7064 * This increases the refcount of the field object by 1. */
7065 static robj
*hashTypeCurrent(hashTypeIterator
*hi
, int what
) {
7067 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7068 if (what
& REDIS_HASH_KEY
) {
7069 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
7071 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
7074 if (what
& REDIS_HASH_KEY
) {
7075 o
= dictGetEntryKey(hi
->de
);
7077 o
= dictGetEntryVal(hi
->de
);
7084 static robj
*hashTypeLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
7085 robj
*o
= lookupKeyWrite(c
->db
,key
);
7087 o
= createHashObject();
7090 if (o
->type
!= REDIS_HASH
) {
7091 addReply(c
,shared
.wrongtypeerr
);
7098 /* ============================= Hash commands ============================== */
7099 static void hsetCommand(redisClient
*c
) {
7103 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7104 hashTypeTryConversion(o
,c
->argv
,2,3);
7105 hashTypeTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
7106 update
= hashTypeSet(o
,c
->argv
[2],c
->argv
[3]);
7107 addReply(c
, update
? shared
.czero
: shared
.cone
);
7111 static void hsetnxCommand(redisClient
*c
) {
7113 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7114 hashTypeTryConversion(o
,c
->argv
,2,3);
7116 if (hashTypeExists(o
, c
->argv
[2])) {
7117 addReply(c
, shared
.czero
);
7119 hashTypeTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
7120 hashTypeSet(o
,c
->argv
[2],c
->argv
[3]);
7121 addReply(c
, shared
.cone
);
7126 static void hmsetCommand(redisClient
*c
) {
7130 if ((c
->argc
% 2) == 1) {
7131 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
7135 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7136 hashTypeTryConversion(o
,c
->argv
,2,c
->argc
-1);
7137 for (i
= 2; i
< c
->argc
; i
+= 2) {
7138 hashTypeTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
7139 hashTypeSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
7141 addReply(c
, shared
.ok
);
7145 static void hincrbyCommand(redisClient
*c
) {
7146 long long value
, incr
;
7147 robj
*o
, *current
, *new;
7149 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
7150 if ((o
= hashTypeLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
7151 if ((current
= hashTypeGet(o
,c
->argv
[2])) != NULL
) {
7152 if (getLongLongFromObjectOrReply(c
,current
,&value
,
7153 "hash value is not an integer") != REDIS_OK
) {
7154 decrRefCount(current
);
7157 decrRefCount(current
);
7163 new = createStringObjectFromLongLong(value
);
7164 hashTypeTryObjectEncoding(o
,&c
->argv
[2],NULL
);
7165 hashTypeSet(o
,c
->argv
[2],new);
7167 addReplyLongLong(c
,value
);
7171 static void hgetCommand(redisClient
*c
) {
7173 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
7174 checkType(c
,o
,REDIS_HASH
)) return;
7176 if ((value
= hashTypeGet(o
,c
->argv
[2])) != NULL
) {
7177 addReplyBulk(c
,value
);
7178 decrRefCount(value
);
7180 addReply(c
,shared
.nullbulk
);
7184 static void hmgetCommand(redisClient
*c
) {
7187 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
7188 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
7189 addReply(c
,shared
.wrongtypeerr
);
7192 /* Note the check for o != NULL happens inside the loop. This is
7193 * done because objects that cannot be found are considered to be
7194 * an empty hash. The reply should then be a series of NULLs. */
7195 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
7196 for (i
= 2; i
< c
->argc
; i
++) {
7197 if (o
!= NULL
&& (value
= hashTypeGet(o
,c
->argv
[i
])) != NULL
) {
7198 addReplyBulk(c
,value
);
7199 decrRefCount(value
);
7201 addReply(c
,shared
.nullbulk
);
7206 static void hdelCommand(redisClient
*c
) {
7208 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7209 checkType(c
,o
,REDIS_HASH
)) return;
7211 if (hashTypeDelete(o
,c
->argv
[2])) {
7212 if (hashTypeLength(o
) == 0) dbDelete(c
->db
,c
->argv
[1]);
7213 addReply(c
,shared
.cone
);
7216 addReply(c
,shared
.czero
);
7220 static void hlenCommand(redisClient
*c
) {
7222 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7223 checkType(c
,o
,REDIS_HASH
)) return;
7225 addReplyUlong(c
,hashTypeLength(o
));
7228 static void genericHgetallCommand(redisClient
*c
, int flags
) {
7229 robj
*o
, *lenobj
, *obj
;
7230 unsigned long count
= 0;
7231 hashTypeIterator
*hi
;
7233 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
7234 || checkType(c
,o
,REDIS_HASH
)) return;
7236 lenobj
= createObject(REDIS_STRING
,NULL
);
7238 decrRefCount(lenobj
);
7240 hi
= hashTypeInitIterator(o
);
7241 while (hashTypeNext(hi
) != REDIS_ERR
) {
7242 if (flags
& REDIS_HASH_KEY
) {
7243 obj
= hashTypeCurrent(hi
,REDIS_HASH_KEY
);
7244 addReplyBulk(c
,obj
);
7248 if (flags
& REDIS_HASH_VALUE
) {
7249 obj
= hashTypeCurrent(hi
,REDIS_HASH_VALUE
);
7250 addReplyBulk(c
,obj
);
7255 hashTypeReleaseIterator(hi
);
7257 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
7260 static void hkeysCommand(redisClient
*c
) {
7261 genericHgetallCommand(c
,REDIS_HASH_KEY
);
7264 static void hvalsCommand(redisClient
*c
) {
7265 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
7268 static void hgetallCommand(redisClient
*c
) {
7269 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
7272 static void hexistsCommand(redisClient
*c
) {
7274 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
7275 checkType(c
,o
,REDIS_HASH
)) return;
7277 addReply(c
, hashTypeExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
7280 static void convertToRealHash(robj
*o
) {
7281 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
7282 unsigned int klen
, vlen
;
7283 dict
*dict
= dictCreate(&hashDictType
,NULL
);
7285 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
7286 p
= zipmapRewind(zm
);
7287 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
7288 robj
*keyobj
, *valobj
;
7290 keyobj
= createStringObject((char*)key
,klen
);
7291 valobj
= createStringObject((char*)val
,vlen
);
7292 keyobj
= tryObjectEncoding(keyobj
);
7293 valobj
= tryObjectEncoding(valobj
);
7294 dictAdd(dict
,keyobj
,valobj
);
7296 o
->encoding
= REDIS_ENCODING_HT
;
7301 /* ========================= Non type-specific commands ==================== */
7303 static void flushdbCommand(redisClient
*c
) {
7304 server
.dirty
+= dictSize(c
->db
->dict
);
7305 touchWatchedKeysOnFlush(c
->db
->id
);
7306 dictEmpty(c
->db
->dict
);
7307 dictEmpty(c
->db
->expires
);
7308 addReply(c
,shared
.ok
);
7311 static void flushallCommand(redisClient
*c
) {
7312 touchWatchedKeysOnFlush(-1);
7313 server
.dirty
+= emptyDb();
7314 addReply(c
,shared
.ok
);
7315 if (server
.bgsavechildpid
!= -1) {
7316 kill(server
.bgsavechildpid
,SIGKILL
);
7317 rdbRemoveTempFile(server
.bgsavechildpid
);
7319 rdbSave(server
.dbfilename
);
7323 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
7324 redisSortOperation
*so
= zmalloc(sizeof(*so
));
7326 so
->pattern
= pattern
;
7330 /* Return the value associated to the key with a name obtained
7331 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7332 * The returned object will always have its refcount increased by 1
7333 * when it is non-NULL. */
7334 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
7337 robj keyobj
, fieldobj
, *o
;
7338 int prefixlen
, sublen
, postfixlen
, fieldlen
;
7339 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7343 char buf
[REDIS_SORTKEY_MAX
+1];
7344 } keyname
, fieldname
;
7346 /* If the pattern is "#" return the substitution object itself in order
7347 * to implement the "SORT ... GET #" feature. */
7348 spat
= pattern
->ptr
;
7349 if (spat
[0] == '#' && spat
[1] == '\0') {
7350 incrRefCount(subst
);
7354 /* The substitution object may be specially encoded. If so we create
7355 * a decoded object on the fly. Otherwise getDecodedObject will just
7356 * increment the ref count, that we'll decrement later. */
7357 subst
= getDecodedObject(subst
);
7360 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
7361 p
= strchr(spat
,'*');
7363 decrRefCount(subst
);
7367 /* Find out if we're dealing with a hash dereference. */
7368 if ((f
= strstr(p
+1, "->")) != NULL
) {
7369 fieldlen
= sdslen(spat
)-(f
-spat
);
7370 /* this also copies \0 character */
7371 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
7372 fieldname
.len
= fieldlen
-2;
7378 sublen
= sdslen(ssub
);
7379 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
7380 memcpy(keyname
.buf
,spat
,prefixlen
);
7381 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
7382 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
7383 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
7384 keyname
.len
= prefixlen
+sublen
+postfixlen
;
7385 decrRefCount(subst
);
7387 /* Lookup substituted key */
7388 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
7389 o
= lookupKeyRead(db
,&keyobj
);
7390 if (o
== NULL
) return NULL
;
7393 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
7395 /* Retrieve value from hash by the field name. This operation
7396 * already increases the refcount of the returned object. */
7397 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
7398 o
= hashTypeGet(o
, &fieldobj
);
7400 if (o
->type
!= REDIS_STRING
) return NULL
;
7402 /* Every object that this function returns needs to have its refcount
7403 * increased. sortCommand decreases it again. */
7410 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7411 * the additional parameter is not standard but a BSD-specific we have to
7412 * pass sorting parameters via the global 'server' structure */
7413 static int sortCompare(const void *s1
, const void *s2
) {
7414 const redisSortObject
*so1
= s1
, *so2
= s2
;
7417 if (!server
.sort_alpha
) {
7418 /* Numeric sorting. Here it's trivial as we precomputed scores */
7419 if (so1
->u
.score
> so2
->u
.score
) {
7421 } else if (so1
->u
.score
< so2
->u
.score
) {
7427 /* Alphanumeric sorting */
7428 if (server
.sort_bypattern
) {
7429 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
7430 /* At least one compare object is NULL */
7431 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
7433 else if (so1
->u
.cmpobj
== NULL
)
7438 /* We have both the objects, use strcoll */
7439 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
7442 /* Compare elements directly. */
7443 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
7446 return server
.sort_desc
? -cmp
: cmp
;
7449 /* The SORT command is the most complex command in Redis. Warning: this code
7450 * is optimized for speed and a bit less for readability */
7451 static void sortCommand(redisClient
*c
) {
7453 unsigned int outputlen
= 0;
7454 int desc
= 0, alpha
= 0;
7455 int limit_start
= 0, limit_count
= -1, start
, end
;
7456 int j
, dontsort
= 0, vectorlen
;
7457 int getop
= 0; /* GET operation counter */
7458 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
7459 redisSortObject
*vector
; /* Resulting vector to sort */
7461 /* Lookup the key to sort. It must be of the right types */
7462 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
7463 if (sortval
== NULL
) {
7464 addReply(c
,shared
.emptymultibulk
);
7467 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
7468 sortval
->type
!= REDIS_ZSET
)
7470 addReply(c
,shared
.wrongtypeerr
);
7474 /* Create a list of operations to perform for every sorted element.
7475 * Operations can be GET/DEL/INCR/DECR */
7476 operations
= listCreate();
7477 listSetFreeMethod(operations
,zfree
);
7480 /* Now we need to protect sortval incrementing its count, in the future
7481 * SORT may have options able to overwrite/delete keys during the sorting
7482 * and the sorted key itself may get destroied */
7483 incrRefCount(sortval
);
7485 /* The SORT command has an SQL-alike syntax, parse it */
7486 while(j
< c
->argc
) {
7487 int leftargs
= c
->argc
-j
-1;
7488 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
7490 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
7492 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
7494 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
7495 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
7496 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
7498 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
7499 storekey
= c
->argv
[j
+1];
7501 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
7502 sortby
= c
->argv
[j
+1];
7503 /* If the BY pattern does not contain '*', i.e. it is constant,
7504 * we don't need to sort nor to lookup the weight keys. */
7505 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
7507 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
7508 listAddNodeTail(operations
,createSortOperation(
7509 REDIS_SORT_GET
,c
->argv
[j
+1]));
7513 decrRefCount(sortval
);
7514 listRelease(operations
);
7515 addReply(c
,shared
.syntaxerr
);
7521 /* Load the sorting vector with all the objects to sort */
7522 switch(sortval
->type
) {
7523 case REDIS_LIST
: vectorlen
= listTypeLength(sortval
); break;
7524 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
7525 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
7526 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7528 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
7531 if (sortval
->type
== REDIS_LIST
) {
7532 listTypeIterator
*li
= listTypeInitIterator(sortval
,0,REDIS_TAIL
);
7533 listTypeEntry entry
;
7534 while(listTypeNext(li
,&entry
)) {
7535 vector
[j
].obj
= listTypeGet(&entry
);
7536 vector
[j
].u
.score
= 0;
7537 vector
[j
].u
.cmpobj
= NULL
;
7540 listTypeReleaseIterator(li
);
7546 if (sortval
->type
== REDIS_SET
) {
7549 zset
*zs
= sortval
->ptr
;
7553 di
= dictGetIterator(set
);
7554 while((setele
= dictNext(di
)) != NULL
) {
7555 vector
[j
].obj
= dictGetEntryKey(setele
);
7556 vector
[j
].u
.score
= 0;
7557 vector
[j
].u
.cmpobj
= NULL
;
7560 dictReleaseIterator(di
);
7562 redisAssert(j
== vectorlen
);
7564 /* Now it's time to load the right scores in the sorting vector */
7565 if (dontsort
== 0) {
7566 for (j
= 0; j
< vectorlen
; j
++) {
7569 /* lookup value to sort by */
7570 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7571 if (!byval
) continue;
7573 /* use object itself to sort by */
7574 byval
= vector
[j
].obj
;
7578 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7580 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7581 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7582 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7583 /* Don't need to decode the object if it's
7584 * integer-encoded (the only encoding supported) so
7585 * far. We can just cast it */
7586 vector
[j
].u
.score
= (long)byval
->ptr
;
7588 redisAssert(1 != 1);
7592 /* when the object was retrieved using lookupKeyByPattern,
7593 * its refcount needs to be decreased. */
7595 decrRefCount(byval
);
7600 /* We are ready to sort the vector... perform a bit of sanity check
7601 * on the LIMIT option too. We'll use a partial version of quicksort. */
7602 start
= (limit_start
< 0) ? 0 : limit_start
;
7603 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7604 if (start
>= vectorlen
) {
7605 start
= vectorlen
-1;
7608 if (end
>= vectorlen
) end
= vectorlen
-1;
7610 if (dontsort
== 0) {
7611 server
.sort_desc
= desc
;
7612 server
.sort_alpha
= alpha
;
7613 server
.sort_bypattern
= sortby
? 1 : 0;
7614 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7615 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7617 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7620 /* Send command output to the output buffer, performing the specified
7621 * GET/DEL/INCR/DECR operations if any. */
7622 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7623 if (storekey
== NULL
) {
7624 /* STORE option not specified, sent the sorting result to client */
7625 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7626 for (j
= start
; j
<= end
; j
++) {
7630 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7631 listRewind(operations
,&li
);
7632 while((ln
= listNext(&li
))) {
7633 redisSortOperation
*sop
= ln
->value
;
7634 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7637 if (sop
->type
== REDIS_SORT_GET
) {
7639 addReply(c
,shared
.nullbulk
);
7641 addReplyBulk(c
,val
);
7645 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7650 robj
*sobj
= createZiplistObject();
7652 /* STORE option specified, set the sorting result as a List object */
7653 for (j
= start
; j
<= end
; j
++) {
7658 listTypePush(sobj
,vector
[j
].obj
,REDIS_TAIL
);
7660 listRewind(operations
,&li
);
7661 while((ln
= listNext(&li
))) {
7662 redisSortOperation
*sop
= ln
->value
;
7663 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7666 if (sop
->type
== REDIS_SORT_GET
) {
7667 if (!val
) val
= createStringObject("",0);
7669 /* listTypePush does an incrRefCount, so we should take care
7670 * care of the incremented refcount caused by either
7671 * lookupKeyByPattern or createStringObject("",0) */
7672 listTypePush(sobj
,val
,REDIS_TAIL
);
7676 redisAssert(sop
->type
== REDIS_SORT_GET
);
7681 dbReplace(c
->db
,storekey
,sobj
);
7682 /* Note: we add 1 because the DB is dirty anyway since even if the
7683 * SORT result is empty a new key is set and maybe the old content
7685 server
.dirty
+= 1+outputlen
;
7686 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7690 if (sortval
->type
== REDIS_LIST
)
7691 for (j
= 0; j
< vectorlen
; j
++)
7692 decrRefCount(vector
[j
].obj
);
7693 decrRefCount(sortval
);
7694 listRelease(operations
);
7695 for (j
= 0; j
< vectorlen
; j
++) {
7696 if (alpha
&& vector
[j
].u
.cmpobj
)
7697 decrRefCount(vector
[j
].u
.cmpobj
);
7702 /* Convert an amount of bytes into a human readable string in the form
7703 * of 100B, 2G, 100M, 4K, and so forth. */
7704 static void bytesToHuman(char *s
, unsigned long long n
) {
7709 sprintf(s
,"%lluB",n
);
7711 } else if (n
< (1024*1024)) {
7712 d
= (double)n
/(1024);
7713 sprintf(s
,"%.2fK",d
);
7714 } else if (n
< (1024LL*1024*1024)) {
7715 d
= (double)n
/(1024*1024);
7716 sprintf(s
,"%.2fM",d
);
7717 } else if (n
< (1024LL*1024*1024*1024)) {
7718 d
= (double)n
/(1024LL*1024*1024);
7719 sprintf(s
,"%.2fG",d
);
7723 /* Create the string returned by the INFO command. This is decoupled
7724 * by the INFO command itself as we need to report the same information
7725 * on memory corruption problems. */
7726 static sds
genRedisInfoString(void) {
7728 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7732 bytesToHuman(hmem
,zmalloc_used_memory());
7733 info
= sdscatprintf(sdsempty(),
7734 "redis_version:%s\r\n"
7735 "redis_git_sha1:%s\r\n"
7736 "redis_git_dirty:%d\r\n"
7738 "multiplexing_api:%s\r\n"
7739 "process_id:%ld\r\n"
7740 "uptime_in_seconds:%ld\r\n"
7741 "uptime_in_days:%ld\r\n"
7742 "connected_clients:%d\r\n"
7743 "connected_slaves:%d\r\n"
7744 "blocked_clients:%d\r\n"
7745 "used_memory:%zu\r\n"
7746 "used_memory_human:%s\r\n"
7747 "changes_since_last_save:%lld\r\n"
7748 "bgsave_in_progress:%d\r\n"
7749 "last_save_time:%ld\r\n"
7750 "bgrewriteaof_in_progress:%d\r\n"
7751 "total_connections_received:%lld\r\n"
7752 "total_commands_processed:%lld\r\n"
7753 "expired_keys:%lld\r\n"
7754 "hash_max_zipmap_entries:%zu\r\n"
7755 "hash_max_zipmap_value:%zu\r\n"
7756 "pubsub_channels:%ld\r\n"
7757 "pubsub_patterns:%u\r\n"
7762 strtol(REDIS_GIT_DIRTY
,NULL
,10) > 0,
7763 (sizeof(long) == 8) ? "64" : "32",
7768 listLength(server
.clients
)-listLength(server
.slaves
),
7769 listLength(server
.slaves
),
7770 server
.blpop_blocked_clients
,
7771 zmalloc_used_memory(),
7774 server
.bgsavechildpid
!= -1,
7776 server
.bgrewritechildpid
!= -1,
7777 server
.stat_numconnections
,
7778 server
.stat_numcommands
,
7779 server
.stat_expiredkeys
,
7780 server
.hash_max_zipmap_entries
,
7781 server
.hash_max_zipmap_value
,
7782 dictSize(server
.pubsub_channels
),
7783 listLength(server
.pubsub_patterns
),
7784 server
.vm_enabled
!= 0,
7785 server
.masterhost
== NULL
? "master" : "slave"
7787 if (server
.masterhost
) {
7788 info
= sdscatprintf(info
,
7789 "master_host:%s\r\n"
7790 "master_port:%d\r\n"
7791 "master_link_status:%s\r\n"
7792 "master_last_io_seconds_ago:%d\r\n"
7795 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7797 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7800 if (server
.vm_enabled
) {
7802 info
= sdscatprintf(info
,
7803 "vm_conf_max_memory:%llu\r\n"
7804 "vm_conf_page_size:%llu\r\n"
7805 "vm_conf_pages:%llu\r\n"
7806 "vm_stats_used_pages:%llu\r\n"
7807 "vm_stats_swapped_objects:%llu\r\n"
7808 "vm_stats_swappin_count:%llu\r\n"
7809 "vm_stats_swappout_count:%llu\r\n"
7810 "vm_stats_io_newjobs_len:%lu\r\n"
7811 "vm_stats_io_processing_len:%lu\r\n"
7812 "vm_stats_io_processed_len:%lu\r\n"
7813 "vm_stats_io_active_threads:%lu\r\n"
7814 "vm_stats_blocked_clients:%lu\r\n"
7815 ,(unsigned long long) server
.vm_max_memory
,
7816 (unsigned long long) server
.vm_page_size
,
7817 (unsigned long long) server
.vm_pages
,
7818 (unsigned long long) server
.vm_stats_used_pages
,
7819 (unsigned long long) server
.vm_stats_swapped_objects
,
7820 (unsigned long long) server
.vm_stats_swapins
,
7821 (unsigned long long) server
.vm_stats_swapouts
,
7822 (unsigned long) listLength(server
.io_newjobs
),
7823 (unsigned long) listLength(server
.io_processing
),
7824 (unsigned long) listLength(server
.io_processed
),
7825 (unsigned long) server
.io_active_threads
,
7826 (unsigned long) server
.vm_blocked_clients
7830 for (j
= 0; j
< server
.dbnum
; j
++) {
7831 long long keys
, vkeys
;
7833 keys
= dictSize(server
.db
[j
].dict
);
7834 vkeys
= dictSize(server
.db
[j
].expires
);
7835 if (keys
|| vkeys
) {
7836 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7843 static void infoCommand(redisClient
*c
) {
7844 sds info
= genRedisInfoString();
7845 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7846 (unsigned long)sdslen(info
)));
7847 addReplySds(c
,info
);
7848 addReply(c
,shared
.crlf
);
7851 static void monitorCommand(redisClient
*c
) {
7852 /* ignore MONITOR if aleady slave or in monitor mode */
7853 if (c
->flags
& REDIS_SLAVE
) return;
7855 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7857 listAddNodeTail(server
.monitors
,c
);
7858 addReply(c
,shared
.ok
);
7861 /* ================================= Expire ================================= */
7862 static int removeExpire(redisDb
*db
, robj
*key
) {
7863 if (dictDelete(db
->expires
,key
->ptr
) == DICT_OK
) {
7870 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7871 sds copy
= sdsdup(key
->ptr
);
7872 if (dictAdd(db
->expires
,copy
,(void*)when
) == DICT_ERR
) {
7880 /* Return the expire time of the specified key, or -1 if no expire
7881 * is associated with this key (i.e. the key is non volatile) */
7882 static time_t getExpire(redisDb
*db
, robj
*key
) {
7885 /* No expire? return ASAP */
7886 if (dictSize(db
->expires
) == 0 ||
7887 (de
= dictFind(db
->expires
,key
->ptr
)) == NULL
) return -1;
7889 return (time_t) dictGetEntryVal(de
);
7892 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7896 /* No expire? return ASAP */
7897 if (dictSize(db
->expires
) == 0 ||
7898 (de
= dictFind(db
->expires
,key
->ptr
)) == NULL
) return 0;
7900 /* Lookup the expire */
7901 when
= (time_t) dictGetEntryVal(de
);
7902 if (time(NULL
) <= when
) return 0;
7904 /* Delete the key */
7906 server
.stat_expiredkeys
++;
7910 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7913 /* No expire? return ASAP */
7914 if (dictSize(db
->expires
) == 0 ||
7915 (de
= dictFind(db
->expires
,key
->ptr
)) == NULL
) return 0;
7917 /* Delete the key */
7919 server
.stat_expiredkeys
++;
7920 dictDelete(db
->expires
,key
->ptr
);
7921 return dictDelete(db
->dict
,key
->ptr
) == DICT_OK
;
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
);
8031 addReply(c
,shared
.ok
);
8034 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
8035 * implememntation for more information. */
8036 static void execCommandReplicateMulti(redisClient
*c
) {
8037 struct redisCommand
*cmd
;
8038 robj
*multistring
= createStringObject("MULTI",5);
8040 cmd
= lookupCommand("multi");
8041 if (server
.appendonly
)
8042 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
8043 if (listLength(server
.slaves
))
8044 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
8045 decrRefCount(multistring
);
8048 static void execCommand(redisClient
*c
) {
8053 if (!(c
->flags
& REDIS_MULTI
)) {
8054 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
8058 /* Check if we need to abort the EXEC if some WATCHed key was touched.
8059 * A failed EXEC will return a multi bulk nil object. */
8060 if (c
->flags
& REDIS_DIRTY_CAS
) {
8061 freeClientMultiState(c
);
8062 initClientMultiState(c
);
8063 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
8065 addReply(c
,shared
.nullmultibulk
);
8069 /* Replicate a MULTI request now that we are sure the block is executed.
8070 * This way we'll deliver the MULTI/..../EXEC block as a whole and
8071 * both the AOF and the replication link will have the same consistency
8072 * and atomicity guarantees. */
8073 execCommandReplicateMulti(c
);
8075 /* Exec all the queued commands */
8076 unwatchAllKeys(c
); /* Unwatch ASAP otherwise we'll waste CPU cycles */
8077 orig_argv
= c
->argv
;
8078 orig_argc
= c
->argc
;
8079 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
8080 for (j
= 0; j
< c
->mstate
.count
; j
++) {
8081 c
->argc
= c
->mstate
.commands
[j
].argc
;
8082 c
->argv
= c
->mstate
.commands
[j
].argv
;
8083 call(c
,c
->mstate
.commands
[j
].cmd
);
8085 c
->argv
= orig_argv
;
8086 c
->argc
= orig_argc
;
8087 freeClientMultiState(c
);
8088 initClientMultiState(c
);
8089 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
8090 /* Make sure the EXEC command is always replicated / AOF, since we
8091 * always send the MULTI command (we can't know beforehand if the
8092 * next operations will contain at least a modification to the DB). */
8096 /* =========================== Blocking Operations ========================= */
8098 /* Currently Redis blocking operations support is limited to list POP ops,
8099 * so the current implementation is not fully generic, but it is also not
8100 * completely specific so it will not require a rewrite to support new
8101 * kind of blocking operations in the future.
8103 * Still it's important to note that list blocking operations can be already
8104 * used as a notification mechanism in order to implement other blocking
8105 * operations at application level, so there must be a very strong evidence
8106 * of usefulness and generality before new blocking operations are implemented.
8108 * This is how the current blocking POP works, we use BLPOP as example:
8109 * - If the user calls BLPOP and the key exists and contains a non empty list
8110 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
8111 * if there is not to block.
8112 * - If instead BLPOP is called and the key does not exists or the list is
8113 * empty we need to block. In order to do so we remove the notification for
8114 * new data to read in the client socket (so that we'll not serve new
8115 * requests if the blocking request is not served). Also we put the client
8116 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
8117 * blocking for this keys.
8118 * - If a PUSH operation against a key with blocked clients waiting is
8119 * performed, we serve the first in the list: basically instead to push
8120 * the new element inside the list we return it to the (first / oldest)
8121 * blocking client, unblock the client, and remove it form the list.
8123 * The above comment and the source code should be enough in order to understand
8124 * the implementation and modify / fix it later.
8127 /* Set a client in blocking mode for the specified key, with the specified
8129 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
8134 c
->blocking_keys
= zmalloc(sizeof(robj
*)*numkeys
);
8135 c
->blocking_keys_num
= numkeys
;
8136 c
->blockingto
= timeout
;
8137 for (j
= 0; j
< numkeys
; j
++) {
8138 /* Add the key in the client structure, to map clients -> keys */
8139 c
->blocking_keys
[j
] = keys
[j
];
8140 incrRefCount(keys
[j
]);
8142 /* And in the other "side", to map keys -> clients */
8143 de
= dictFind(c
->db
->blocking_keys
,keys
[j
]);
8147 /* For every key we take a list of clients blocked for it */
8149 retval
= dictAdd(c
->db
->blocking_keys
,keys
[j
],l
);
8150 incrRefCount(keys
[j
]);
8151 assert(retval
== DICT_OK
);
8153 l
= dictGetEntryVal(de
);
8155 listAddNodeTail(l
,c
);
8157 /* Mark the client as a blocked client */
8158 c
->flags
|= REDIS_BLOCKED
;
8159 server
.blpop_blocked_clients
++;
8162 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
8163 static void unblockClientWaitingData(redisClient
*c
) {
8168 assert(c
->blocking_keys
!= NULL
);
8169 /* The client may wait for multiple keys, so unblock it for every key. */
8170 for (j
= 0; j
< c
->blocking_keys_num
; j
++) {
8171 /* Remove this client from the list of clients waiting for this key. */
8172 de
= dictFind(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
8174 l
= dictGetEntryVal(de
);
8175 listDelNode(l
,listSearchKey(l
,c
));
8176 /* If the list is empty we need to remove it to avoid wasting memory */
8177 if (listLength(l
) == 0)
8178 dictDelete(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
8179 decrRefCount(c
->blocking_keys
[j
]);
8181 /* Cleanup the client structure */
8182 zfree(c
->blocking_keys
);
8183 c
->blocking_keys
= NULL
;
8184 c
->flags
&= (~REDIS_BLOCKED
);
8185 server
.blpop_blocked_clients
--;
8186 /* We want to process data if there is some command waiting
8187 * in the input buffer. Note that this is safe even if
8188 * unblockClientWaitingData() gets called from freeClient() because
8189 * freeClient() will be smart enough to call this function
8190 * *after* c->querybuf was set to NULL. */
8191 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
8194 /* This should be called from any function PUSHing into lists.
8195 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
8196 * 'ele' is the element pushed.
8198 * If the function returns 0 there was no client waiting for a list push
8201 * If the function returns 1 there was a client waiting for a list push
8202 * against this key, the element was passed to this client thus it's not
8203 * needed to actually add it to the list and the caller should return asap. */
8204 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
8205 struct dictEntry
*de
;
8206 redisClient
*receiver
;
8210 de
= dictFind(c
->db
->blocking_keys
,key
);
8211 if (de
== NULL
) return 0;
8212 l
= dictGetEntryVal(de
);
8215 receiver
= ln
->value
;
8217 addReplySds(receiver
,sdsnew("*2\r\n"));
8218 addReplyBulk(receiver
,key
);
8219 addReplyBulk(receiver
,ele
);
8220 unblockClientWaitingData(receiver
);
8224 /* Blocking RPOP/LPOP */
8225 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
8230 for (j
= 1; j
< c
->argc
-1; j
++) {
8231 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
8233 if (o
->type
!= REDIS_LIST
) {
8234 addReply(c
,shared
.wrongtypeerr
);
8237 list
*list
= o
->ptr
;
8238 if (listLength(list
) != 0) {
8239 /* If the list contains elements fall back to the usual
8240 * non-blocking POP operation */
8241 robj
*argv
[2], **orig_argv
;
8244 /* We need to alter the command arguments before to call
8245 * popGenericCommand() as the command takes a single key. */
8246 orig_argv
= c
->argv
;
8247 orig_argc
= c
->argc
;
8248 argv
[1] = c
->argv
[j
];
8252 /* Also the return value is different, we need to output
8253 * the multi bulk reply header and the key name. The
8254 * "real" command will add the last element (the value)
8255 * for us. If this souds like an hack to you it's just
8256 * because it is... */
8257 addReplySds(c
,sdsnew("*2\r\n"));
8258 addReplyBulk(c
,argv
[1]);
8259 popGenericCommand(c
,where
);
8261 /* Fix the client structure with the original stuff */
8262 c
->argv
= orig_argv
;
8263 c
->argc
= orig_argc
;
8269 /* If the list is empty or the key does not exists we must block */
8270 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
8271 if (timeout
> 0) timeout
+= time(NULL
);
8272 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
8275 static void blpopCommand(redisClient
*c
) {
8276 blockingPopGenericCommand(c
,REDIS_HEAD
);
8279 static void brpopCommand(redisClient
*c
) {
8280 blockingPopGenericCommand(c
,REDIS_TAIL
);
8283 /* =============================== Replication ============================= */
8285 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8286 ssize_t nwritten
, ret
= size
;
8287 time_t start
= time(NULL
);
8291 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
8292 nwritten
= write(fd
,ptr
,size
);
8293 if (nwritten
== -1) return -1;
8297 if ((time(NULL
)-start
) > timeout
) {
8305 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8306 ssize_t nread
, totread
= 0;
8307 time_t start
= time(NULL
);
8311 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
8312 nread
= read(fd
,ptr
,size
);
8313 if (nread
== -1) return -1;
8318 if ((time(NULL
)-start
) > timeout
) {
8326 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8333 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
8336 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
8347 static void syncCommand(redisClient
*c
) {
8348 /* ignore SYNC if aleady slave or in monitor mode */
8349 if (c
->flags
& REDIS_SLAVE
) return;
8351 /* SYNC can't be issued when the server has pending data to send to
8352 * the client about already issued commands. We need a fresh reply
8353 * buffer registering the differences between the BGSAVE and the current
8354 * dataset, so that we can copy to other slaves if needed. */
8355 if (listLength(c
->reply
) != 0) {
8356 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8360 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
8361 /* Here we need to check if there is a background saving operation
8362 * in progress, or if it is required to start one */
8363 if (server
.bgsavechildpid
!= -1) {
8364 /* Ok a background save is in progress. Let's check if it is a good
8365 * one for replication, i.e. if there is another slave that is
8366 * registering differences since the server forked to save */
8371 listRewind(server
.slaves
,&li
);
8372 while((ln
= listNext(&li
))) {
8374 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
8377 /* Perfect, the server is already registering differences for
8378 * another slave. Set the right state, and copy the buffer. */
8379 listRelease(c
->reply
);
8380 c
->reply
= listDup(slave
->reply
);
8381 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8382 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
8384 /* No way, we need to wait for the next BGSAVE in order to
8385 * register differences */
8386 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8387 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
8390 /* Ok we don't have a BGSAVE in progress, let's start one */
8391 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
8392 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8393 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
8394 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
8397 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8400 c
->flags
|= REDIS_SLAVE
;
8402 listAddNodeTail(server
.slaves
,c
);
8406 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
8407 redisClient
*slave
= privdata
;
8409 REDIS_NOTUSED(mask
);
8410 char buf
[REDIS_IOBUF_LEN
];
8411 ssize_t nwritten
, buflen
;
8413 if (slave
->repldboff
== 0) {
8414 /* Write the bulk write count before to transfer the DB. In theory here
8415 * we don't know how much room there is in the output buffer of the
8416 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8417 * operations) will never be smaller than the few bytes we need. */
8420 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8422 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
8430 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
8431 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
8433 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
8434 (buflen
== 0) ? "premature EOF" : strerror(errno
));
8438 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
8439 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
8444 slave
->repldboff
+= nwritten
;
8445 if (slave
->repldboff
== slave
->repldbsize
) {
8446 close(slave
->repldbfd
);
8447 slave
->repldbfd
= -1;
8448 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8449 slave
->replstate
= REDIS_REPL_ONLINE
;
8450 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
8451 sendReplyToClient
, slave
) == AE_ERR
) {
8455 addReplySds(slave
,sdsempty());
8456 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
8460 /* This function is called at the end of every backgrond saving.
8461 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8462 * otherwise REDIS_ERR is passed to the function.
8464 * The goal of this function is to handle slaves waiting for a successful
8465 * background saving in order to perform non-blocking synchronization. */
8466 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
8468 int startbgsave
= 0;
8471 listRewind(server
.slaves
,&li
);
8472 while((ln
= listNext(&li
))) {
8473 redisClient
*slave
= ln
->value
;
8475 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
8477 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8478 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
8479 struct redis_stat buf
;
8481 if (bgsaveerr
!= REDIS_OK
) {
8483 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
8486 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
8487 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
8489 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
8492 slave
->repldboff
= 0;
8493 slave
->repldbsize
= buf
.st_size
;
8494 slave
->replstate
= REDIS_REPL_SEND_BULK
;
8495 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8496 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
8503 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8506 listRewind(server
.slaves
,&li
);
8507 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
8508 while((ln
= listNext(&li
))) {
8509 redisClient
*slave
= ln
->value
;
8511 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
8518 static int syncWithMaster(void) {
8519 char buf
[1024], tmpfile
[256], authcmd
[1024];
8521 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
8522 int dfd
, maxtries
= 5;
8525 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
8530 /* AUTH with the master if required. */
8531 if(server
.masterauth
) {
8532 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
8533 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
8535 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
8539 /* Read the AUTH result. */
8540 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8542 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
8546 if (buf
[0] != '+') {
8548 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
8553 /* Issue the SYNC command */
8554 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
8556 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
8560 /* Read the bulk write count */
8561 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8563 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
8567 if (buf
[0] != '$') {
8569 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8572 dumpsize
= strtol(buf
+1,NULL
,10);
8573 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8574 /* Read the bulk write data on a temp file */
8576 snprintf(tmpfile
,256,
8577 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8578 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8579 if (dfd
!= -1) break;
8584 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8588 int nread
, nwritten
;
8590 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8592 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8598 nwritten
= write(dfd
,buf
,nread
);
8599 if (nwritten
== -1) {
8600 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8608 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8609 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8615 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8616 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8620 server
.master
= createClient(fd
);
8621 server
.master
->flags
|= REDIS_MASTER
;
8622 server
.master
->authenticated
= 1;
8623 server
.replstate
= REDIS_REPL_CONNECTED
;
8627 static void slaveofCommand(redisClient
*c
) {
8628 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8629 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8630 if (server
.masterhost
) {
8631 sdsfree(server
.masterhost
);
8632 server
.masterhost
= NULL
;
8633 if (server
.master
) freeClient(server
.master
);
8634 server
.replstate
= REDIS_REPL_NONE
;
8635 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8638 sdsfree(server
.masterhost
);
8639 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8640 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8641 if (server
.master
) freeClient(server
.master
);
8642 server
.replstate
= REDIS_REPL_CONNECT
;
8643 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8644 server
.masterhost
, server
.masterport
);
8646 addReply(c
,shared
.ok
);
8649 /* ============================ Maxmemory directive ======================== */
8651 /* Try to free one object form the pre-allocated objects free list.
8652 * This is useful under low mem conditions as by default we take 1 million
8653 * free objects allocated. On success REDIS_OK is returned, otherwise
8655 static int tryFreeOneObjectFromFreelist(void) {
8658 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8659 if (listLength(server
.objfreelist
)) {
8660 listNode
*head
= listFirst(server
.objfreelist
);
8661 o
= listNodeValue(head
);
8662 listDelNode(server
.objfreelist
,head
);
8663 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8667 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8672 /* This function gets called when 'maxmemory' is set on the config file to limit
8673 * the max memory used by the server, and we are out of memory.
8674 * This function will try to, in order:
8676 * - Free objects from the free list
8677 * - Try to remove keys with an EXPIRE set
8679 * It is not possible to free enough memory to reach used-memory < maxmemory
8680 * the server will start refusing commands that will enlarge even more the
8683 static void freeMemoryIfNeeded(void) {
8684 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8685 int j
, k
, freed
= 0;
8687 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8688 for (j
= 0; j
< server
.dbnum
; j
++) {
8690 robj
*minkey
= NULL
;
8691 struct dictEntry
*de
;
8693 if (dictSize(server
.db
[j
].expires
)) {
8695 /* From a sample of three keys drop the one nearest to
8696 * the natural expire */
8697 for (k
= 0; k
< 3; k
++) {
8700 de
= dictGetRandomKey(server
.db
[j
].expires
);
8701 t
= (time_t) dictGetEntryVal(de
);
8702 if (minttl
== -1 || t
< minttl
) {
8703 minkey
= dictGetEntryKey(de
);
8707 dbDelete(server
.db
+j
,minkey
);
8710 if (!freed
) return; /* nothing to free... */
8714 /* ============================== Append Only file ========================== */
8716 /* Called when the user switches from "appendonly yes" to "appendonly no"
8717 * at runtime using the CONFIG command. */
8718 static void stopAppendOnly(void) {
8719 flushAppendOnlyFile();
8720 aof_fsync(server
.appendfd
);
8721 close(server
.appendfd
);
8723 server
.appendfd
= -1;
8724 server
.appendseldb
= -1;
8725 server
.appendonly
= 0;
8726 /* rewrite operation in progress? kill it, wait child exit */
8727 if (server
.bgsavechildpid
!= -1) {
8730 if (kill(server
.bgsavechildpid
,SIGKILL
) != -1)
8731 wait3(&statloc
,0,NULL
);
8732 /* reset the buffer accumulating changes while the child saves */
8733 sdsfree(server
.bgrewritebuf
);
8734 server
.bgrewritebuf
= sdsempty();
8735 server
.bgsavechildpid
= -1;
8739 /* Called when the user switches from "appendonly no" to "appendonly yes"
8740 * at runtime using the CONFIG command. */
8741 static int startAppendOnly(void) {
8742 server
.appendonly
= 1;
8743 server
.lastfsync
= time(NULL
);
8744 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
8745 if (server
.appendfd
== -1) {
8746 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno
));
8749 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
8750 server
.appendonly
= 0;
8751 close(server
.appendfd
);
8752 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
));
8758 /* Write the append only file buffer on disk.
8760 * Since we are required to write the AOF before replying to the client,
8761 * and the only way the client socket can get a write is entering when the
8762 * the event loop, we accumulate all the AOF writes in a memory
8763 * buffer and write it on disk using this function just before entering
8764 * the event loop again. */
8765 static void flushAppendOnlyFile(void) {
8769 if (sdslen(server
.aofbuf
) == 0) return;
8771 /* We want to perform a single write. This should be guaranteed atomic
8772 * at least if the filesystem we are writing is a real physical one.
8773 * While this will save us against the server being killed I don't think
8774 * there is much to do about the whole server stopping for power problems
8776 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8777 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8778 /* Ooops, we are in troubles. The best thing to do for now is
8779 * aborting instead of giving the illusion that everything is
8780 * working as expected. */
8781 if (nwritten
== -1) {
8782 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8784 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8788 sdsfree(server
.aofbuf
);
8789 server
.aofbuf
= sdsempty();
8791 /* Don't Fsync if no-appendfsync-on-rewrite is set to yes and we have
8792 * childs performing heavy I/O on disk. */
8793 if (server
.no_appendfsync_on_rewrite
&&
8794 (server
.bgrewritechildpid
!= -1 || server
.bgsavechildpid
!= -1))
8796 /* Fsync if needed */
8798 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8799 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8800 now
-server
.lastfsync
> 1))
8802 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8803 * flushing metadata. */
8804 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8805 server
.lastfsync
= now
;
8809 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8811 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8812 for (j
= 0; j
< argc
; j
++) {
8813 robj
*o
= getDecodedObject(argv
[j
]);
8814 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8815 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8816 buf
= sdscatlen(buf
,"\r\n",2);
8822 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8827 /* Make sure we can use strtol */
8828 seconds
= getDecodedObject(seconds
);
8829 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8830 decrRefCount(seconds
);
8832 argv
[0] = createStringObject("EXPIREAT",8);
8834 argv
[2] = createObject(REDIS_STRING
,
8835 sdscatprintf(sdsempty(),"%ld",when
));
8836 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8837 decrRefCount(argv
[0]);
8838 decrRefCount(argv
[2]);
8842 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8843 sds buf
= sdsempty();
8846 /* The DB this command was targetting is not the same as the last command
8847 * we appendend. To issue a SELECT command is needed. */
8848 if (dictid
!= server
.appendseldb
) {
8851 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8852 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8853 (unsigned long)strlen(seldb
),seldb
);
8854 server
.appendseldb
= dictid
;
8857 if (cmd
->proc
== expireCommand
) {
8858 /* Translate EXPIRE into EXPIREAT */
8859 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8860 } else if (cmd
->proc
== setexCommand
) {
8861 /* Translate SETEX to SET and EXPIREAT */
8862 tmpargv
[0] = createStringObject("SET",3);
8863 tmpargv
[1] = argv
[1];
8864 tmpargv
[2] = argv
[3];
8865 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8866 decrRefCount(tmpargv
[0]);
8867 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8869 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8872 /* Append to the AOF buffer. This will be flushed on disk just before
8873 * of re-entering the event loop, so before the client will get a
8874 * positive reply about the operation performed. */
8875 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8877 /* If a background append only file rewriting is in progress we want to
8878 * accumulate the differences between the child DB and the current one
8879 * in a buffer, so that when the child process will do its work we
8880 * can append the differences to the new append only file. */
8881 if (server
.bgrewritechildpid
!= -1)
8882 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8887 /* In Redis commands are always executed in the context of a client, so in
8888 * order to load the append only file we need to create a fake client. */
8889 static struct redisClient
*createFakeClient(void) {
8890 struct redisClient
*c
= zmalloc(sizeof(*c
));
8894 c
->querybuf
= sdsempty();
8898 /* We set the fake client as a slave waiting for the synchronization
8899 * so that Redis will not try to send replies to this client. */
8900 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8901 c
->reply
= listCreate();
8902 listSetFreeMethod(c
->reply
,decrRefCount
);
8903 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8904 initClientMultiState(c
);
8908 static void freeFakeClient(struct redisClient
*c
) {
8909 sdsfree(c
->querybuf
);
8910 listRelease(c
->reply
);
8911 freeClientMultiState(c
);
8915 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8916 * error (the append only file is zero-length) REDIS_ERR is returned. On
8917 * fatal error an error message is logged and the program exists. */
8918 int loadAppendOnlyFile(char *filename
) {
8919 struct redisClient
*fakeClient
;
8920 FILE *fp
= fopen(filename
,"r");
8921 struct redis_stat sb
;
8922 int appendonly
= server
.appendonly
;
8924 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8928 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8932 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8933 * to the same file we're about to read. */
8934 server
.appendonly
= 0;
8936 fakeClient
= createFakeClient();
8943 struct redisCommand
*cmd
;
8946 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8952 if (buf
[0] != '*') goto fmterr
;
8954 argv
= zmalloc(sizeof(robj
*)*argc
);
8955 for (j
= 0; j
< argc
; j
++) {
8956 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8957 if (buf
[0] != '$') goto fmterr
;
8958 len
= strtol(buf
+1,NULL
,10);
8959 argsds
= sdsnewlen(NULL
,len
);
8960 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8961 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8962 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8965 /* Command lookup */
8966 cmd
= lookupCommand(argv
[0]->ptr
);
8968 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8971 /* Try object encoding */
8972 if (cmd
->flags
& REDIS_CMD_BULK
)
8973 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8974 /* Run the command in the context of a fake client */
8975 fakeClient
->argc
= argc
;
8976 fakeClient
->argv
= argv
;
8977 cmd
->proc(fakeClient
);
8978 /* Discard the reply objects list from the fake client */
8979 while(listLength(fakeClient
->reply
))
8980 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8981 /* Clean up, ready for the next command */
8982 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8984 /* Handle swapping while loading big datasets when VM is on */
8986 if ((zmalloc_used_memory() - server
.vm_max_memory
) > 1024*1024*32)
8989 if (server
.vm_enabled
&& force_swapout
) {
8990 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8991 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8996 /* This point can only be reached when EOF is reached without errors.
8997 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8998 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
9001 freeFakeClient(fakeClient
);
9002 server
.appendonly
= appendonly
;
9007 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
9009 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
9013 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
9017 /* Write binary-safe string into a file in the bulkformat
9018 * $<count>\r\n<payload>\r\n */
9019 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
9023 clen
= 1+ll2string(cbuf
+1,sizeof(cbuf
)-1,len
);
9024 cbuf
[clen
++] = '\r';
9025 cbuf
[clen
++] = '\n';
9026 if (fwrite(cbuf
,clen
,1,fp
) == 0) return 0;
9027 if (len
> 0 && fwrite(s
,len
,1,fp
) == 0) return 0;
9028 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
9032 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
9033 static int fwriteBulkDouble(FILE *fp
, double d
) {
9034 char buf
[128], dbuf
[128];
9036 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
9037 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
9038 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
9039 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
9043 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
9044 static int fwriteBulkLongLong(FILE *fp
, long long l
) {
9045 char bbuf
[128], lbuf
[128];
9046 unsigned int blen
, llen
;
9047 llen
= ll2string(lbuf
,32,l
);
9048 blen
= snprintf(bbuf
,sizeof(bbuf
),"$%u\r\n%s\r\n",llen
,lbuf
);
9049 if (fwrite(bbuf
,blen
,1,fp
) == 0) return 0;
9053 /* Delegate writing an object to writing a bulk string or bulk long long. */
9054 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
9055 /* Avoid using getDecodedObject to help copy-on-write (we are often
9056 * in a child process when this function is called). */
9057 if (obj
->encoding
== REDIS_ENCODING_INT
) {
9058 return fwriteBulkLongLong(fp
,(long)obj
->ptr
);
9059 } else if (obj
->encoding
== REDIS_ENCODING_RAW
) {
9060 return fwriteBulkString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
9062 redisPanic("Unknown string encoding");
9066 /* Write a sequence of commands able to fully rebuild the dataset into
9067 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
9068 static int rewriteAppendOnlyFile(char *filename
) {
9069 dictIterator
*di
= NULL
;
9074 time_t now
= time(NULL
);
9076 /* Note that we have to use a different temp name here compared to the
9077 * one used by rewriteAppendOnlyFileBackground() function. */
9078 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
9079 fp
= fopen(tmpfile
,"w");
9081 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
9084 for (j
= 0; j
< server
.dbnum
; j
++) {
9085 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
9086 redisDb
*db
= server
.db
+j
;
9088 if (dictSize(d
) == 0) continue;
9089 di
= dictGetIterator(d
);
9095 /* SELECT the new DB */
9096 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
9097 if (fwriteBulkLongLong(fp
,j
) == 0) goto werr
;
9099 /* Iterate this DB writing every entry */
9100 while((de
= dictNext(di
)) != NULL
) {
9101 sds keystr
= dictGetEntryKey(de
);
9106 keystr
= dictGetEntryKey(de
);
9107 o
= dictGetEntryVal(de
);
9108 initStaticStringObject(key
,keystr
);
9109 /* If the value for this key is swapped, load a preview in memory.
9110 * We use a "swapped" flag to remember if we need to free the
9111 * value object instead to just increment the ref count anyway
9112 * in order to avoid copy-on-write of pages if we are forked() */
9113 if (!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
||
9114 o
->storage
== REDIS_VM_SWAPPING
) {
9117 o
= vmPreviewObject(o
);
9120 expiretime
= getExpire(db
,&key
);
9122 /* Save the key and associated value */
9123 if (o
->type
== REDIS_STRING
) {
9124 /* Emit a SET command */
9125 char cmd
[]="*3\r\n$3\r\nSET\r\n";
9126 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9128 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9129 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
9130 } else if (o
->type
== REDIS_LIST
) {
9131 /* Emit the RPUSHes needed to rebuild the list */
9132 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
9133 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
9134 unsigned char *zl
= o
->ptr
;
9135 unsigned char *p
= ziplistIndex(zl
,0);
9136 unsigned char *vstr
;
9140 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
9141 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9142 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9144 if (fwriteBulkString(fp
,(char*)vstr
,vlen
) == 0)
9147 if (fwriteBulkLongLong(fp
,vlong
) == 0)
9150 p
= ziplistNext(zl
,p
);
9152 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
9153 list
*list
= o
->ptr
;
9157 listRewind(list
,&li
);
9158 while((ln
= listNext(&li
))) {
9159 robj
*eleobj
= listNodeValue(ln
);
9161 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9162 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9163 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9166 redisPanic("Unknown list encoding");
9168 } else if (o
->type
== REDIS_SET
) {
9169 /* Emit the SADDs needed to rebuild the set */
9171 dictIterator
*di
= dictGetIterator(set
);
9174 while((de
= dictNext(di
)) != NULL
) {
9175 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
9176 robj
*eleobj
= dictGetEntryKey(de
);
9178 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9179 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9180 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9182 dictReleaseIterator(di
);
9183 } else if (o
->type
== REDIS_ZSET
) {
9184 /* Emit the ZADDs needed to rebuild the sorted set */
9186 dictIterator
*di
= dictGetIterator(zs
->dict
);
9189 while((de
= dictNext(di
)) != NULL
) {
9190 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
9191 robj
*eleobj
= dictGetEntryKey(de
);
9192 double *score
= dictGetEntryVal(de
);
9194 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9195 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9196 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
9197 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
9199 dictReleaseIterator(di
);
9200 } else if (o
->type
== REDIS_HASH
) {
9201 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
9203 /* Emit the HSETs needed to rebuild the hash */
9204 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9205 unsigned char *p
= zipmapRewind(o
->ptr
);
9206 unsigned char *field
, *val
;
9207 unsigned int flen
, vlen
;
9209 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
9210 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9211 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9212 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
9214 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
9218 dictIterator
*di
= dictGetIterator(o
->ptr
);
9221 while((de
= dictNext(di
)) != NULL
) {
9222 robj
*field
= dictGetEntryKey(de
);
9223 robj
*val
= dictGetEntryVal(de
);
9225 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9226 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9227 if (fwriteBulkObject(fp
,field
) == -1) return -1;
9228 if (fwriteBulkObject(fp
,val
) == -1) return -1;
9230 dictReleaseIterator(di
);
9233 redisPanic("Unknown object type");
9235 /* Save the expire time */
9236 if (expiretime
!= -1) {
9237 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
9238 /* If this key is already expired skip it */
9239 if (expiretime
< now
) continue;
9240 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
9241 if (fwriteBulkObject(fp
,&key
) == 0) goto werr
;
9242 if (fwriteBulkLongLong(fp
,expiretime
) == 0) goto werr
;
9244 if (swapped
) decrRefCount(o
);
9246 dictReleaseIterator(di
);
9249 /* Make sure data will not remain on the OS's output buffers */
9251 aof_fsync(fileno(fp
));
9254 /* Use RENAME to make sure the DB file is changed atomically only
9255 * if the generate DB file is ok. */
9256 if (rename(tmpfile
,filename
) == -1) {
9257 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
9261 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
9267 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
9268 if (di
) dictReleaseIterator(di
);
9272 /* This is how rewriting of the append only file in background works:
9274 * 1) The user calls BGREWRITEAOF
9275 * 2) Redis calls this function, that forks():
9276 * 2a) the child rewrite the append only file in a temp file.
9277 * 2b) the parent accumulates differences in server.bgrewritebuf.
9278 * 3) When the child finished '2a' exists.
9279 * 4) The parent will trap the exit code, if it's OK, will append the
9280 * data accumulated into server.bgrewritebuf into the temp file, and
9281 * finally will rename(2) the temp file in the actual file name.
9282 * The the new file is reopened as the new append only file. Profit!
9284 static int rewriteAppendOnlyFileBackground(void) {
9287 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
9288 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
9289 if ((childpid
= fork()) == 0) {
9293 if (server
.vm_enabled
) vmReopenSwapFile();
9295 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
9296 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
9303 if (childpid
== -1) {
9304 redisLog(REDIS_WARNING
,
9305 "Can't rewrite append only file in background: fork: %s",
9309 redisLog(REDIS_NOTICE
,
9310 "Background append only file rewriting started by pid %d",childpid
);
9311 server
.bgrewritechildpid
= childpid
;
9312 updateDictResizePolicy();
9313 /* We set appendseldb to -1 in order to force the next call to the
9314 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9315 * accumulated by the parent into server.bgrewritebuf will start
9316 * with a SELECT statement and it will be safe to merge. */
9317 server
.appendseldb
= -1;
9320 return REDIS_OK
; /* unreached */
9323 static void bgrewriteaofCommand(redisClient
*c
) {
9324 if (server
.bgrewritechildpid
!= -1) {
9325 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9328 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
9329 char *status
= "+Background append only file rewriting started\r\n";
9330 addReplySds(c
,sdsnew(status
));
9332 addReply(c
,shared
.err
);
9336 static void aofRemoveTempFile(pid_t childpid
) {
9339 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
9343 /* Virtual Memory is composed mainly of two subsystems:
9344 * - Blocking Virutal Memory
9345 * - Threaded Virtual Memory I/O
9346 * The two parts are not fully decoupled, but functions are split among two
9347 * different sections of the source code (delimited by comments) in order to
9348 * make more clear what functionality is about the blocking VM and what about
9349 * the threaded (not blocking) VM.
9353 * Redis VM is a blocking VM (one that blocks reading swapped values from
9354 * disk into memory when a value swapped out is needed in memory) that is made
9355 * unblocking by trying to examine the command argument vector in order to
9356 * load in background values that will likely be needed in order to exec
9357 * the command. The command is executed only once all the relevant keys
9358 * are loaded into memory.
9360 * This basically is almost as simple of a blocking VM, but almost as parallel
9361 * as a fully non-blocking VM.
9364 /* =================== Virtual Memory - Blocking Side ====================== */
9366 /* Create a VM pointer object. This kind of objects are used in place of
9367 * values in the key -> value hash table, for swapped out objects. */
9368 static vmpointer
*createVmPointer(int vtype
) {
9369 vmpointer
*vp
= zmalloc(sizeof(vmpointer
));
9371 vp
->type
= REDIS_VMPOINTER
;
9372 vp
->storage
= REDIS_VM_SWAPPED
;
9377 static void vmInit(void) {
9383 if (server
.vm_max_threads
!= 0)
9384 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9386 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
9387 /* Try to open the old swap file, otherwise create it */
9388 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
9389 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
9391 if (server
.vm_fp
== NULL
) {
9392 redisLog(REDIS_WARNING
,
9393 "Can't open the swap file: %s. Exiting.",
9397 server
.vm_fd
= fileno(server
.vm_fp
);
9398 /* Lock the swap file for writing, this is useful in order to avoid
9399 * another instance to use the same swap file for a config error. */
9400 fl
.l_type
= F_WRLCK
;
9401 fl
.l_whence
= SEEK_SET
;
9402 fl
.l_start
= fl
.l_len
= 0;
9403 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
9404 redisLog(REDIS_WARNING
,
9405 "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
));
9409 server
.vm_next_page
= 0;
9410 server
.vm_near_pages
= 0;
9411 server
.vm_stats_used_pages
= 0;
9412 server
.vm_stats_swapped_objects
= 0;
9413 server
.vm_stats_swapouts
= 0;
9414 server
.vm_stats_swapins
= 0;
9415 totsize
= server
.vm_pages
*server
.vm_page_size
;
9416 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
9417 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
9418 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
9422 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
9424 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
9425 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
9426 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
9427 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
9429 /* Initialize threaded I/O (used by Virtual Memory) */
9430 server
.io_newjobs
= listCreate();
9431 server
.io_processing
= listCreate();
9432 server
.io_processed
= listCreate();
9433 server
.io_ready_clients
= listCreate();
9434 pthread_mutex_init(&server
.io_mutex
,NULL
);
9435 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
9436 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
9437 server
.io_active_threads
= 0;
9438 if (pipe(pipefds
) == -1) {
9439 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
9443 server
.io_ready_pipe_read
= pipefds
[0];
9444 server
.io_ready_pipe_write
= pipefds
[1];
9445 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
9446 /* LZF requires a lot of stack */
9447 pthread_attr_init(&server
.io_threads_attr
);
9448 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
9449 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
9450 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
9451 /* Listen for events in the threaded I/O pipe */
9452 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
9453 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
9454 oom("creating file event");
9457 /* Mark the page as used */
9458 static void vmMarkPageUsed(off_t page
) {
9459 off_t byte
= page
/8;
9461 redisAssert(vmFreePage(page
) == 1);
9462 server
.vm_bitmap
[byte
] |= 1<<bit
;
9465 /* Mark N contiguous pages as used, with 'page' being the first. */
9466 static void vmMarkPagesUsed(off_t page
, off_t count
) {
9469 for (j
= 0; j
< count
; j
++)
9470 vmMarkPageUsed(page
+j
);
9471 server
.vm_stats_used_pages
+= count
;
9472 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
9473 (long long)count
, (long long)page
);
9476 /* Mark the page as free */
9477 static void vmMarkPageFree(off_t page
) {
9478 off_t byte
= page
/8;
9480 redisAssert(vmFreePage(page
) == 0);
9481 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
9484 /* Mark N contiguous pages as free, with 'page' being the first. */
9485 static void vmMarkPagesFree(off_t page
, off_t count
) {
9488 for (j
= 0; j
< count
; j
++)
9489 vmMarkPageFree(page
+j
);
9490 server
.vm_stats_used_pages
-= count
;
9491 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
9492 (long long)count
, (long long)page
);
9495 /* Test if the page is free */
9496 static int vmFreePage(off_t page
) {
9497 off_t byte
= page
/8;
9499 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
9502 /* Find N contiguous free pages storing the first page of the cluster in *first.
9503 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9504 * REDIS_ERR is returned.
9506 * This function uses a simple algorithm: we try to allocate
9507 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9508 * again from the start of the swap file searching for free spaces.
9510 * If it looks pretty clear that there are no free pages near our offset
9511 * we try to find less populated places doing a forward jump of
9512 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9513 * without hurry, and then we jump again and so forth...
9515 * This function can be improved using a free list to avoid to guess
9516 * too much, since we could collect data about freed pages.
9518 * note: I implemented this function just after watching an episode of
9519 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9521 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
9522 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
9524 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
9525 server
.vm_near_pages
= 0;
9526 server
.vm_next_page
= 0;
9528 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
9529 base
= server
.vm_next_page
;
9531 while(offset
< server
.vm_pages
) {
9532 off_t
this = base
+offset
;
9534 /* If we overflow, restart from page zero */
9535 if (this >= server
.vm_pages
) {
9536 this -= server
.vm_pages
;
9538 /* Just overflowed, what we found on tail is no longer
9539 * interesting, as it's no longer contiguous. */
9543 if (vmFreePage(this)) {
9544 /* This is a free page */
9546 /* Already got N free pages? Return to the caller, with success */
9548 *first
= this-(n
-1);
9549 server
.vm_next_page
= this+1;
9550 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
9554 /* The current one is not a free page */
9558 /* Fast-forward if the current page is not free and we already
9559 * searched enough near this place. */
9561 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
9562 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
9564 /* Note that even if we rewind after the jump, we are don't need
9565 * to make sure numfree is set to zero as we only jump *if* it
9566 * is set to zero. */
9568 /* Otherwise just check the next page */
9575 /* Write the specified object at the specified page of the swap file */
9576 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
9577 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9578 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9579 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9580 redisLog(REDIS_WARNING
,
9581 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9585 rdbSaveObject(server
.vm_fp
,o
);
9586 fflush(server
.vm_fp
);
9587 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9591 /* Transfers the 'val' object to disk. Store all the information
9592 * a 'vmpointer' object containing all the information needed to load the
9593 * object back later is returned.
9595 * If we can't find enough contiguous empty pages to swap the object on disk
9596 * NULL is returned. */
9597 static vmpointer
*vmSwapObjectBlocking(robj
*val
) {
9598 off_t pages
= rdbSavedObjectPages(val
,NULL
);
9602 assert(val
->storage
== REDIS_VM_MEMORY
);
9603 assert(val
->refcount
== 1);
9604 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return NULL
;
9605 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return NULL
;
9607 vp
= createVmPointer(val
->type
);
9609 vp
->usedpages
= pages
;
9610 decrRefCount(val
); /* Deallocate the object from memory. */
9611 vmMarkPagesUsed(page
,pages
);
9612 redisLog(REDIS_DEBUG
,"VM: object %p swapped out at %lld (%lld pages)",
9614 (unsigned long long) page
, (unsigned long long) pages
);
9615 server
.vm_stats_swapped_objects
++;
9616 server
.vm_stats_swapouts
++;
9620 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
9623 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9624 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9625 redisLog(REDIS_WARNING
,
9626 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9630 o
= rdbLoadObject(type
,server
.vm_fp
);
9632 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
9635 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9639 /* Load the specified object from swap to memory.
9640 * The newly allocated object is returned.
9642 * If preview is true the unserialized object is returned to the caller but
9643 * the pages are not marked as freed, nor the vp object is freed. */
9644 static robj
*vmGenericLoadObject(vmpointer
*vp
, int preview
) {
9647 redisAssert(vp
->type
== REDIS_VMPOINTER
&&
9648 (vp
->storage
== REDIS_VM_SWAPPED
|| vp
->storage
== REDIS_VM_LOADING
));
9649 val
= vmReadObjectFromSwap(vp
->page
,vp
->vtype
);
9651 redisLog(REDIS_DEBUG
, "VM: object %p loaded from disk", (void*)vp
);
9652 vmMarkPagesFree(vp
->page
,vp
->usedpages
);
9654 server
.vm_stats_swapped_objects
--;
9656 redisLog(REDIS_DEBUG
, "VM: object %p previewed from disk", (void*)vp
);
9658 server
.vm_stats_swapins
++;
9662 /* Plain object loading, from swap to memory.
9664 * 'o' is actually a redisVmPointer structure that will be freed by the call.
9665 * The return value is the loaded object. */
9666 static robj
*vmLoadObject(robj
*o
) {
9667 /* If we are loading the object in background, stop it, we
9668 * need to load this object synchronously ASAP. */
9669 if (o
->storage
== REDIS_VM_LOADING
)
9670 vmCancelThreadedIOJob(o
);
9671 return vmGenericLoadObject((vmpointer
*)o
,0);
9674 /* Just load the value on disk, without to modify the key.
9675 * This is useful when we want to perform some operation on the value
9676 * without to really bring it from swap to memory, like while saving the
9677 * dataset or rewriting the append only log. */
9678 static robj
*vmPreviewObject(robj
*o
) {
9679 return vmGenericLoadObject((vmpointer
*)o
,1);
9682 /* How a good candidate is this object for swapping?
9683 * The better candidate it is, the greater the returned value.
9685 * Currently we try to perform a fast estimation of the object size in
9686 * memory, and combine it with aging informations.
9688 * Basically swappability = idle-time * log(estimated size)
9690 * Bigger objects are preferred over smaller objects, but not
9691 * proportionally, this is why we use the logarithm. This algorithm is
9692 * just a first try and will probably be tuned later. */
9693 static double computeObjectSwappability(robj
*o
) {
9694 /* actual age can be >= minage, but not < minage. As we use wrapping
9695 * 21 bit clocks with minutes resolution for the LRU. */
9696 time_t minage
= abs(server
.lruclock
- o
->lru
);
9697 long asize
= 0, elesize
;
9702 struct dictEntry
*de
;
9705 if (minage
<= 0) return 0;
9708 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9711 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9715 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
9716 asize
= sizeof(*o
)+ziplistSize(o
->ptr
);
9720 asize
= sizeof(list
);
9723 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9724 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9725 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9731 z
= (o
->type
== REDIS_ZSET
);
9732 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9734 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9735 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9737 de
= dictGetRandomKey(d
);
9738 ele
= dictGetEntryKey(de
);
9739 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9740 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9741 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9742 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9746 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9747 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9748 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9749 unsigned int klen
, vlen
;
9750 unsigned char *key
, *val
;
9752 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9756 asize
= len
*(klen
+vlen
+3);
9757 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9759 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9761 de
= dictGetRandomKey(d
);
9762 ele
= dictGetEntryKey(de
);
9763 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9764 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9765 ele
= dictGetEntryVal(de
);
9766 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9767 (sizeof(*o
)+sdslen(ele
->ptr
)) : sizeof(*o
);
9768 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9773 return (double)minage
*log(1+asize
);
9776 /* Try to swap an object that's a good candidate for swapping.
9777 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9778 * to swap any object at all.
9780 * If 'usethreaded' is true, Redis will try to swap the object in background
9781 * using I/O threads. */
9782 static int vmSwapOneObject(int usethreads
) {
9784 struct dictEntry
*best
= NULL
;
9785 double best_swappability
= 0;
9786 redisDb
*best_db
= NULL
;
9790 for (j
= 0; j
< server
.dbnum
; j
++) {
9791 redisDb
*db
= server
.db
+j
;
9792 /* Why maxtries is set to 100?
9793 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9794 * are swappable objects */
9797 if (dictSize(db
->dict
) == 0) continue;
9798 for (i
= 0; i
< 5; i
++) {
9800 double swappability
;
9802 if (maxtries
) maxtries
--;
9803 de
= dictGetRandomKey(db
->dict
);
9804 val
= dictGetEntryVal(de
);
9805 /* Only swap objects that are currently in memory.
9807 * Also don't swap shared objects: not a good idea in general and
9808 * we need to ensure that the main thread does not touch the
9809 * object while the I/O thread is using it, but we can't
9810 * control other keys without adding additional mutex. */
9811 if (val
->storage
!= REDIS_VM_MEMORY
|| val
->refcount
!= 1) {
9812 if (maxtries
) i
--; /* don't count this try */
9815 swappability
= computeObjectSwappability(val
);
9816 if (!best
|| swappability
> best_swappability
) {
9818 best_swappability
= swappability
;
9823 if (best
== NULL
) return REDIS_ERR
;
9824 key
= dictGetEntryKey(best
);
9825 val
= dictGetEntryVal(best
);
9827 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9828 key
, best_swappability
);
9832 robj
*keyobj
= createStringObject(key
,sdslen(key
));
9833 vmSwapObjectThreaded(keyobj
,val
,best_db
);
9834 decrRefCount(keyobj
);
9839 if ((vp
= vmSwapObjectBlocking(val
)) != NULL
) {
9840 dictGetEntryVal(best
) = vp
;
9848 static int vmSwapOneObjectBlocking() {
9849 return vmSwapOneObject(0);
9852 static int vmSwapOneObjectThreaded() {
9853 return vmSwapOneObject(1);
9856 /* Return true if it's safe to swap out objects in a given moment.
9857 * Basically we don't want to swap objects out while there is a BGSAVE
9858 * or a BGAEOREWRITE running in backgroud. */
9859 static int vmCanSwapOut(void) {
9860 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9863 /* =================== Virtual Memory - Threaded I/O ======================= */
9865 static void freeIOJob(iojob
*j
) {
9866 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9867 j
->type
== REDIS_IOJOB_DO_SWAP
||
9868 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9870 /* we fix the storage type, otherwise decrRefCount() will try to
9871 * kill the I/O thread Job (that does no longer exists). */
9872 if (j
->val
->storage
== REDIS_VM_SWAPPING
)
9873 j
->val
->storage
= REDIS_VM_MEMORY
;
9874 decrRefCount(j
->val
);
9876 decrRefCount(j
->key
);
9880 /* Every time a thread finished a Job, it writes a byte into the write side
9881 * of an unix pipe in order to "awake" the main thread, and this function
9883 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9887 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9889 REDIS_NOTUSED(mask
);
9890 REDIS_NOTUSED(privdata
);
9892 /* For every byte we read in the read side of the pipe, there is one
9893 * I/O job completed to process. */
9894 while((retval
= read(fd
,buf
,1)) == 1) {
9897 struct dictEntry
*de
;
9899 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9901 /* Get the processed element (the oldest one) */
9903 assert(listLength(server
.io_processed
) != 0);
9904 if (toprocess
== -1) {
9905 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9906 if (toprocess
<= 0) toprocess
= 1;
9908 ln
= listFirst(server
.io_processed
);
9910 listDelNode(server
.io_processed
,ln
);
9912 /* If this job is marked as canceled, just ignore it */
9917 /* Post process it in the main thread, as there are things we
9918 * can do just here to avoid race conditions and/or invasive locks */
9919 redisLog(REDIS_DEBUG
,"COMPLETED Job type: %d, ID %p, key: %s", j
->type
, (void*)j
->id
, (unsigned char*)j
->key
->ptr
);
9920 de
= dictFind(j
->db
->dict
,j
->key
->ptr
);
9921 redisAssert(de
!= NULL
);
9922 if (j
->type
== REDIS_IOJOB_LOAD
) {
9924 vmpointer
*vp
= dictGetEntryVal(de
);
9926 /* Key loaded, bring it at home */
9927 vmMarkPagesFree(vp
->page
,vp
->usedpages
);
9928 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9929 (unsigned char*) j
->key
->ptr
);
9930 server
.vm_stats_swapped_objects
--;
9931 server
.vm_stats_swapins
++;
9932 dictGetEntryVal(de
) = j
->val
;
9933 incrRefCount(j
->val
);
9935 /* Handle clients waiting for this key to be loaded. */
9936 handleClientsBlockedOnSwappedKey(db
,j
->key
);
9939 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9940 /* Now we know the amount of pages required to swap this object.
9941 * Let's find some space for it, and queue this task again
9942 * rebranded as REDIS_IOJOB_DO_SWAP. */
9943 if (!vmCanSwapOut() ||
9944 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9946 /* Ooops... no space or we can't swap as there is
9947 * a fork()ed Redis trying to save stuff on disk. */
9948 j
->val
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9951 /* Note that we need to mark this pages as used now,
9952 * if the job will be canceled, we'll mark them as freed
9954 vmMarkPagesUsed(j
->page
,j
->pages
);
9955 j
->type
= REDIS_IOJOB_DO_SWAP
;
9960 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9963 /* Key swapped. We can finally free some memory. */
9964 if (j
->val
->storage
!= REDIS_VM_SWAPPING
) {
9965 vmpointer
*vp
= (vmpointer
*) j
->id
;
9966 printf("storage: %d\n",vp
->storage
);
9967 printf("key->name: %s\n",(char*)j
->key
->ptr
);
9968 printf("val: %p\n",(void*)j
->val
);
9969 printf("val->type: %d\n",j
->val
->type
);
9970 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9972 redisAssert(j
->val
->storage
== REDIS_VM_SWAPPING
);
9973 vp
= createVmPointer(j
->val
->type
);
9975 vp
->usedpages
= j
->pages
;
9976 dictGetEntryVal(de
) = vp
;
9977 /* Fix the storage otherwise decrRefCount will attempt to
9978 * remove the associated I/O job */
9979 j
->val
->storage
= REDIS_VM_MEMORY
;
9980 decrRefCount(j
->val
);
9981 redisLog(REDIS_DEBUG
,
9982 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9983 (unsigned char*) j
->key
->ptr
,
9984 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9985 server
.vm_stats_swapped_objects
++;
9986 server
.vm_stats_swapouts
++;
9988 /* Put a few more swap requests in queue if we are still
9990 if (trytoswap
&& vmCanSwapOut() &&
9991 zmalloc_used_memory() > server
.vm_max_memory
)
9996 more
= listLength(server
.io_newjobs
) <
9997 (unsigned) server
.vm_max_threads
;
9999 /* Don't waste CPU time if swappable objects are rare. */
10000 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
10008 if (processed
== toprocess
) return;
10010 if (retval
< 0 && errno
!= EAGAIN
) {
10011 redisLog(REDIS_WARNING
,
10012 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
10017 static void lockThreadedIO(void) {
10018 pthread_mutex_lock(&server
.io_mutex
);
10021 static void unlockThreadedIO(void) {
10022 pthread_mutex_unlock(&server
.io_mutex
);
10025 /* Remove the specified object from the threaded I/O queue if still not
10026 * processed, otherwise make sure to flag it as canceled. */
10027 static void vmCancelThreadedIOJob(robj
*o
) {
10029 server
.io_newjobs
, /* 0 */
10030 server
.io_processing
, /* 1 */
10031 server
.io_processed
/* 2 */
10035 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
10038 /* Search for a matching object in one of the queues */
10039 for (i
= 0; i
< 3; i
++) {
10043 listRewind(lists
[i
],&li
);
10044 while ((ln
= listNext(&li
)) != NULL
) {
10045 iojob
*job
= ln
->value
;
10047 if (job
->canceled
) continue; /* Skip this, already canceled. */
10048 if (job
->id
== o
) {
10049 redisLog(REDIS_DEBUG
,"*** CANCELED %p (key %s) (type %d) (LIST ID %d)\n",
10050 (void*)job
, (char*)job
->key
->ptr
, job
->type
, i
);
10051 /* Mark the pages as free since the swap didn't happened
10052 * or happened but is now discarded. */
10053 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
10054 vmMarkPagesFree(job
->page
,job
->pages
);
10055 /* Cancel the job. It depends on the list the job is
10058 case 0: /* io_newjobs */
10059 /* If the job was yet not processed the best thing to do
10060 * is to remove it from the queue at all */
10062 listDelNode(lists
[i
],ln
);
10064 case 1: /* io_processing */
10065 /* Oh Shi- the thread is messing with the Job:
10067 * Probably it's accessing the object if this is a
10068 * PREPARE_SWAP or DO_SWAP job.
10069 * If it's a LOAD job it may be reading from disk and
10070 * if we don't wait for the job to terminate before to
10071 * cancel it, maybe in a few microseconds data can be
10072 * corrupted in this pages. So the short story is:
10074 * Better to wait for the job to move into the
10075 * next queue (processed)... */
10077 /* We try again and again until the job is completed. */
10078 unlockThreadedIO();
10079 /* But let's wait some time for the I/O thread
10080 * to finish with this job. After all this condition
10081 * should be very rare. */
10084 case 2: /* io_processed */
10085 /* The job was already processed, that's easy...
10086 * just mark it as canceled so that we'll ignore it
10087 * when processing completed jobs. */
10091 /* Finally we have to adjust the storage type of the object
10092 * in order to "UNDO" the operaiton. */
10093 if (o
->storage
== REDIS_VM_LOADING
)
10094 o
->storage
= REDIS_VM_SWAPPED
;
10095 else if (o
->storage
== REDIS_VM_SWAPPING
)
10096 o
->storage
= REDIS_VM_MEMORY
;
10097 unlockThreadedIO();
10098 redisLog(REDIS_DEBUG
,"*** DONE");
10103 unlockThreadedIO();
10104 printf("Not found: %p\n", (void*)o
);
10105 redisAssert(1 != 1); /* We should never reach this */
10108 static void *IOThreadEntryPoint(void *arg
) {
10111 REDIS_NOTUSED(arg
);
10113 pthread_detach(pthread_self());
10115 /* Get a new job to process */
10117 if (listLength(server
.io_newjobs
) == 0) {
10118 /* No new jobs in queue, exit. */
10119 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
10120 (long) pthread_self());
10121 server
.io_active_threads
--;
10122 unlockThreadedIO();
10125 ln
= listFirst(server
.io_newjobs
);
10127 listDelNode(server
.io_newjobs
,ln
);
10128 /* Add the job in the processing queue */
10129 j
->thread
= pthread_self();
10130 listAddNodeTail(server
.io_processing
,j
);
10131 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
10132 unlockThreadedIO();
10133 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
10134 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
10136 /* Process the Job */
10137 if (j
->type
== REDIS_IOJOB_LOAD
) {
10138 vmpointer
*vp
= (vmpointer
*)j
->id
;
10139 j
->val
= vmReadObjectFromSwap(j
->page
,vp
->vtype
);
10140 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
10141 FILE *fp
= fopen("/dev/null","w+");
10142 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
10144 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
10145 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
10149 /* Done: insert the job into the processed queue */
10150 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
10151 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
10153 listDelNode(server
.io_processing
,ln
);
10154 listAddNodeTail(server
.io_processed
,j
);
10155 unlockThreadedIO();
10157 /* Signal the main thread there is new stuff to process */
10158 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
10160 return NULL
; /* never reached */
10163 static void spawnIOThread(void) {
10165 sigset_t mask
, omask
;
10168 sigemptyset(&mask
);
10169 sigaddset(&mask
,SIGCHLD
);
10170 sigaddset(&mask
,SIGHUP
);
10171 sigaddset(&mask
,SIGPIPE
);
10172 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
10173 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
10174 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
10178 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
10179 server
.io_active_threads
++;
10182 /* We need to wait for the last thread to exit before we are able to
10183 * fork() in order to BGSAVE or BGREWRITEAOF. */
10184 static void waitEmptyIOJobsQueue(void) {
10186 int io_processed_len
;
10189 if (listLength(server
.io_newjobs
) == 0 &&
10190 listLength(server
.io_processing
) == 0 &&
10191 server
.io_active_threads
== 0)
10193 unlockThreadedIO();
10196 /* While waiting for empty jobs queue condition we post-process some
10197 * finshed job, as I/O threads may be hanging trying to write against
10198 * the io_ready_pipe_write FD but there are so much pending jobs that
10199 * it's blocking. */
10200 io_processed_len
= listLength(server
.io_processed
);
10201 unlockThreadedIO();
10202 if (io_processed_len
) {
10203 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
10204 usleep(1000); /* 1 millisecond */
10206 usleep(10000); /* 10 milliseconds */
10211 static void vmReopenSwapFile(void) {
10212 /* Note: we don't close the old one as we are in the child process
10213 * and don't want to mess at all with the original file object. */
10214 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
10215 if (server
.vm_fp
== NULL
) {
10216 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
10217 server
.vm_swap_file
);
10220 server
.vm_fd
= fileno(server
.vm_fp
);
10223 /* This function must be called while with threaded IO locked */
10224 static void queueIOJob(iojob
*j
) {
10225 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
10226 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
10227 listAddNodeTail(server
.io_newjobs
,j
);
10228 if (server
.io_active_threads
< server
.vm_max_threads
)
10232 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
10235 j
= zmalloc(sizeof(*j
));
10236 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
10240 j
->id
= j
->val
= val
;
10243 j
->thread
= (pthread_t
) -1;
10244 val
->storage
= REDIS_VM_SWAPPING
;
10248 unlockThreadedIO();
10252 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
10254 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
10255 * If there is not already a job loading the key, it is craeted.
10256 * The key is added to the io_keys list in the client structure, and also
10257 * in the hash table mapping swapped keys to waiting clients, that is,
10258 * server.io_waited_keys. */
10259 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
10260 struct dictEntry
*de
;
10264 /* If the key does not exist or is already in RAM we don't need to
10265 * block the client at all. */
10266 de
= dictFind(c
->db
->dict
,key
->ptr
);
10267 if (de
== NULL
) return 0;
10268 o
= dictGetEntryVal(de
);
10269 if (o
->storage
== REDIS_VM_MEMORY
) {
10271 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
10272 /* We were swapping the key, undo it! */
10273 vmCancelThreadedIOJob(o
);
10277 /* OK: the key is either swapped, or being loaded just now. */
10279 /* Add the key to the list of keys this client is waiting for.
10280 * This maps clients to keys they are waiting for. */
10281 listAddNodeTail(c
->io_keys
,key
);
10284 /* Add the client to the swapped keys => clients waiting map. */
10285 de
= dictFind(c
->db
->io_keys
,key
);
10289 /* For every key we take a list of clients blocked for it */
10291 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
10293 assert(retval
== DICT_OK
);
10295 l
= dictGetEntryVal(de
);
10297 listAddNodeTail(l
,c
);
10299 /* Are we already loading the key from disk? If not create a job */
10300 if (o
->storage
== REDIS_VM_SWAPPED
) {
10302 vmpointer
*vp
= (vmpointer
*)o
;
10304 o
->storage
= REDIS_VM_LOADING
;
10305 j
= zmalloc(sizeof(*j
));
10306 j
->type
= REDIS_IOJOB_LOAD
;
10311 j
->page
= vp
->page
;
10314 j
->thread
= (pthread_t
) -1;
10317 unlockThreadedIO();
10322 /* Preload keys for any command with first, last and step values for
10323 * the command keys prototype, as defined in the command table. */
10324 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10326 if (cmd
->vm_firstkey
== 0) return;
10327 last
= cmd
->vm_lastkey
;
10328 if (last
< 0) last
= argc
+last
;
10329 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
10330 redisAssert(j
< argc
);
10331 waitForSwappedKey(c
,argv
[j
]);
10335 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10336 * Note that the number of keys to preload is user-defined, so we need to
10337 * apply a sanity check against argc. */
10338 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10340 REDIS_NOTUSED(cmd
);
10342 num
= atoi(argv
[2]->ptr
);
10343 if (num
> (argc
-3)) return;
10344 for (i
= 0; i
< num
; i
++) {
10345 waitForSwappedKey(c
,argv
[3+i
]);
10349 /* Preload keys needed to execute the entire MULTI/EXEC block.
10351 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10352 * and will block the client when any command requires a swapped out value. */
10353 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10355 struct redisCommand
*mcmd
;
10357 REDIS_NOTUSED(cmd
);
10358 REDIS_NOTUSED(argc
);
10359 REDIS_NOTUSED(argv
);
10361 if (!(c
->flags
& REDIS_MULTI
)) return;
10362 for (i
= 0; i
< c
->mstate
.count
; i
++) {
10363 mcmd
= c
->mstate
.commands
[i
].cmd
;
10364 margc
= c
->mstate
.commands
[i
].argc
;
10365 margv
= c
->mstate
.commands
[i
].argv
;
10367 if (mcmd
->vm_preload_proc
!= NULL
) {
10368 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
10370 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
10375 /* Is this client attempting to run a command against swapped keys?
10376 * If so, block it ASAP, load the keys in background, then resume it.
10378 * The important idea about this function is that it can fail! If keys will
10379 * still be swapped when the client is resumed, this key lookups will
10380 * just block loading keys from disk. In practical terms this should only
10381 * happen with SORT BY command or if there is a bug in this function.
10383 * Return 1 if the client is marked as blocked, 0 if the client can
10384 * continue as the keys it is going to access appear to be in memory. */
10385 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
10386 if (cmd
->vm_preload_proc
!= NULL
) {
10387 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
10389 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
10392 /* If the client was blocked for at least one key, mark it as blocked. */
10393 if (listLength(c
->io_keys
)) {
10394 c
->flags
|= REDIS_IO_WAIT
;
10395 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
10396 server
.vm_blocked_clients
++;
10403 /* Remove the 'key' from the list of blocked keys for a given client.
10405 * The function returns 1 when there are no longer blocking keys after
10406 * the current one was removed (and the client can be unblocked). */
10407 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
10411 struct dictEntry
*de
;
10413 /* Remove the key from the list of keys this client is waiting for. */
10414 listRewind(c
->io_keys
,&li
);
10415 while ((ln
= listNext(&li
)) != NULL
) {
10416 if (equalStringObjects(ln
->value
,key
)) {
10417 listDelNode(c
->io_keys
,ln
);
10421 assert(ln
!= NULL
);
10423 /* Remove the client form the key => waiting clients map. */
10424 de
= dictFind(c
->db
->io_keys
,key
);
10425 assert(de
!= NULL
);
10426 l
= dictGetEntryVal(de
);
10427 ln
= listSearchKey(l
,c
);
10428 assert(ln
!= NULL
);
10430 if (listLength(l
) == 0)
10431 dictDelete(c
->db
->io_keys
,key
);
10433 return listLength(c
->io_keys
) == 0;
10436 /* Every time we now a key was loaded back in memory, we handle clients
10437 * waiting for this key if any. */
10438 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
10439 struct dictEntry
*de
;
10444 de
= dictFind(db
->io_keys
,key
);
10447 l
= dictGetEntryVal(de
);
10448 len
= listLength(l
);
10449 /* Note: we can't use something like while(listLength(l)) as the list
10450 * can be freed by the calling function when we remove the last element. */
10453 redisClient
*c
= ln
->value
;
10455 if (dontWaitForSwappedKey(c
,key
)) {
10456 /* Put the client in the list of clients ready to go as we
10457 * loaded all the keys about it. */
10458 listAddNodeTail(server
.io_ready_clients
,c
);
10463 /* =========================== Remote Configuration ========================= */
10465 static void configSetCommand(redisClient
*c
) {
10466 robj
*o
= getDecodedObject(c
->argv
[3]);
10469 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
10470 zfree(server
.dbfilename
);
10471 server
.dbfilename
= zstrdup(o
->ptr
);
10472 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
10473 zfree(server
.requirepass
);
10474 server
.requirepass
= zstrdup(o
->ptr
);
10475 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
10476 zfree(server
.masterauth
);
10477 server
.masterauth
= zstrdup(o
->ptr
);
10478 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
10479 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10480 ll
< 0) goto badfmt
;
10481 server
.maxmemory
= ll
;
10482 } else if (!strcasecmp(c
->argv
[2]->ptr
,"timeout")) {
10483 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10484 ll
< 0 || ll
> LONG_MAX
) goto badfmt
;
10485 server
.maxidletime
= ll
;
10486 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
10487 if (!strcasecmp(o
->ptr
,"no")) {
10488 server
.appendfsync
= APPENDFSYNC_NO
;
10489 } else if (!strcasecmp(o
->ptr
,"everysec")) {
10490 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
10491 } else if (!strcasecmp(o
->ptr
,"always")) {
10492 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
10496 } else if (!strcasecmp(c
->argv
[2]->ptr
,"no-appendfsync-on-rewrite")) {
10497 int yn
= yesnotoi(o
->ptr
);
10499 if (yn
== -1) goto badfmt
;
10500 server
.no_appendfsync_on_rewrite
= yn
;
10501 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendonly")) {
10502 int old
= server
.appendonly
;
10503 int new = yesnotoi(o
->ptr
);
10505 if (new == -1) goto badfmt
;
10510 if (startAppendOnly() == REDIS_ERR
) {
10511 addReplySds(c
,sdscatprintf(sdsempty(),
10512 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10518 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
10520 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
10522 /* Perform sanity check before setting the new config:
10523 * - Even number of args
10524 * - Seconds >= 1, changes >= 0 */
10526 sdsfreesplitres(v
,vlen
);
10529 for (j
= 0; j
< vlen
; j
++) {
10533 val
= strtoll(v
[j
], &eptr
, 10);
10534 if (eptr
[0] != '\0' ||
10535 ((j
& 1) == 0 && val
< 1) ||
10536 ((j
& 1) == 1 && val
< 0)) {
10537 sdsfreesplitres(v
,vlen
);
10541 /* Finally set the new config */
10542 resetServerSaveParams();
10543 for (j
= 0; j
< vlen
; j
+= 2) {
10547 seconds
= strtoll(v
[j
],NULL
,10);
10548 changes
= strtoll(v
[j
+1],NULL
,10);
10549 appendServerSaveParams(seconds
, changes
);
10551 sdsfreesplitres(v
,vlen
);
10553 addReplySds(c
,sdscatprintf(sdsempty(),
10554 "-ERR not supported CONFIG parameter %s\r\n",
10555 (char*)c
->argv
[2]->ptr
));
10560 addReply(c
,shared
.ok
);
10563 badfmt
: /* Bad format errors */
10564 addReplySds(c
,sdscatprintf(sdsempty(),
10565 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10567 (char*)c
->argv
[2]->ptr
));
10571 static void configGetCommand(redisClient
*c
) {
10572 robj
*o
= getDecodedObject(c
->argv
[2]);
10573 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
10574 char *pattern
= o
->ptr
;
10577 addReply(c
,lenobj
);
10578 decrRefCount(lenobj
);
10580 if (stringmatch(pattern
,"dbfilename",0)) {
10581 addReplyBulkCString(c
,"dbfilename");
10582 addReplyBulkCString(c
,server
.dbfilename
);
10585 if (stringmatch(pattern
,"requirepass",0)) {
10586 addReplyBulkCString(c
,"requirepass");
10587 addReplyBulkCString(c
,server
.requirepass
);
10590 if (stringmatch(pattern
,"masterauth",0)) {
10591 addReplyBulkCString(c
,"masterauth");
10592 addReplyBulkCString(c
,server
.masterauth
);
10595 if (stringmatch(pattern
,"maxmemory",0)) {
10598 ll2string(buf
,128,server
.maxmemory
);
10599 addReplyBulkCString(c
,"maxmemory");
10600 addReplyBulkCString(c
,buf
);
10603 if (stringmatch(pattern
,"timeout",0)) {
10606 ll2string(buf
,128,server
.maxidletime
);
10607 addReplyBulkCString(c
,"timeout");
10608 addReplyBulkCString(c
,buf
);
10611 if (stringmatch(pattern
,"appendonly",0)) {
10612 addReplyBulkCString(c
,"appendonly");
10613 addReplyBulkCString(c
,server
.appendonly
? "yes" : "no");
10616 if (stringmatch(pattern
,"no-appendfsync-on-rewrite",0)) {
10617 addReplyBulkCString(c
,"no-appendfsync-on-rewrite");
10618 addReplyBulkCString(c
,server
.no_appendfsync_on_rewrite
? "yes" : "no");
10621 if (stringmatch(pattern
,"appendfsync",0)) {
10624 switch(server
.appendfsync
) {
10625 case APPENDFSYNC_NO
: policy
= "no"; break;
10626 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
10627 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
10628 default: policy
= "unknown"; break; /* too harmless to panic */
10630 addReplyBulkCString(c
,"appendfsync");
10631 addReplyBulkCString(c
,policy
);
10634 if (stringmatch(pattern
,"save",0)) {
10635 sds buf
= sdsempty();
10638 for (j
= 0; j
< server
.saveparamslen
; j
++) {
10639 buf
= sdscatprintf(buf
,"%ld %d",
10640 server
.saveparams
[j
].seconds
,
10641 server
.saveparams
[j
].changes
);
10642 if (j
!= server
.saveparamslen
-1)
10643 buf
= sdscatlen(buf
," ",1);
10645 addReplyBulkCString(c
,"save");
10646 addReplyBulkCString(c
,buf
);
10651 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
10654 static void configCommand(redisClient
*c
) {
10655 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
10656 if (c
->argc
!= 4) goto badarity
;
10657 configSetCommand(c
);
10658 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
10659 if (c
->argc
!= 3) goto badarity
;
10660 configGetCommand(c
);
10661 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
10662 if (c
->argc
!= 2) goto badarity
;
10663 server
.stat_numcommands
= 0;
10664 server
.stat_numconnections
= 0;
10665 server
.stat_expiredkeys
= 0;
10666 server
.stat_starttime
= time(NULL
);
10667 addReply(c
,shared
.ok
);
10669 addReplySds(c
,sdscatprintf(sdsempty(),
10670 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10675 addReplySds(c
,sdscatprintf(sdsempty(),
10676 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10677 (char*) c
->argv
[1]->ptr
));
10680 /* =========================== Pubsub implementation ======================== */
10682 static void freePubsubPattern(void *p
) {
10683 pubsubPattern
*pat
= p
;
10685 decrRefCount(pat
->pattern
);
10689 static int listMatchPubsubPattern(void *a
, void *b
) {
10690 pubsubPattern
*pa
= a
, *pb
= b
;
10692 return (pa
->client
== pb
->client
) &&
10693 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10696 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10697 * 0 if the client was already subscribed to that channel. */
10698 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10699 struct dictEntry
*de
;
10700 list
*clients
= NULL
;
10703 /* Add the channel to the client -> channels hash table */
10704 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10706 incrRefCount(channel
);
10707 /* Add the client to the channel -> list of clients hash table */
10708 de
= dictFind(server
.pubsub_channels
,channel
);
10710 clients
= listCreate();
10711 dictAdd(server
.pubsub_channels
,channel
,clients
);
10712 incrRefCount(channel
);
10714 clients
= dictGetEntryVal(de
);
10716 listAddNodeTail(clients
,c
);
10718 /* Notify the client */
10719 addReply(c
,shared
.mbulk3
);
10720 addReply(c
,shared
.subscribebulk
);
10721 addReplyBulk(c
,channel
);
10722 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10726 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10727 * 0 if the client was not subscribed to the specified channel. */
10728 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10729 struct dictEntry
*de
;
10734 /* Remove the channel from the client -> channels hash table */
10735 incrRefCount(channel
); /* channel may be just a pointer to the same object
10736 we have in the hash tables. Protect it... */
10737 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10739 /* Remove the client from the channel -> clients list hash table */
10740 de
= dictFind(server
.pubsub_channels
,channel
);
10741 assert(de
!= NULL
);
10742 clients
= dictGetEntryVal(de
);
10743 ln
= listSearchKey(clients
,c
);
10744 assert(ln
!= NULL
);
10745 listDelNode(clients
,ln
);
10746 if (listLength(clients
) == 0) {
10747 /* Free the list and associated hash entry at all if this was
10748 * the latest client, so that it will be possible to abuse
10749 * Redis PUBSUB creating millions of channels. */
10750 dictDelete(server
.pubsub_channels
,channel
);
10753 /* Notify the client */
10755 addReply(c
,shared
.mbulk3
);
10756 addReply(c
,shared
.unsubscribebulk
);
10757 addReplyBulk(c
,channel
);
10758 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10759 listLength(c
->pubsub_patterns
));
10762 decrRefCount(channel
); /* it is finally safe to release it */
10766 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10767 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10770 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10772 pubsubPattern
*pat
;
10773 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10774 incrRefCount(pattern
);
10775 pat
= zmalloc(sizeof(*pat
));
10776 pat
->pattern
= getDecodedObject(pattern
);
10778 listAddNodeTail(server
.pubsub_patterns
,pat
);
10780 /* Notify the client */
10781 addReply(c
,shared
.mbulk3
);
10782 addReply(c
,shared
.psubscribebulk
);
10783 addReplyBulk(c
,pattern
);
10784 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10788 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10789 * 0 if the client was not subscribed to the specified channel. */
10790 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10795 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10796 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10798 listDelNode(c
->pubsub_patterns
,ln
);
10800 pat
.pattern
= pattern
;
10801 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10802 listDelNode(server
.pubsub_patterns
,ln
);
10804 /* Notify the client */
10806 addReply(c
,shared
.mbulk3
);
10807 addReply(c
,shared
.punsubscribebulk
);
10808 addReplyBulk(c
,pattern
);
10809 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10810 listLength(c
->pubsub_patterns
));
10812 decrRefCount(pattern
);
10816 /* Unsubscribe from all the channels. Return the number of channels the
10817 * client was subscribed from. */
10818 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10819 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10823 while((de
= dictNext(di
)) != NULL
) {
10824 robj
*channel
= dictGetEntryKey(de
);
10826 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10828 dictReleaseIterator(di
);
10832 /* Unsubscribe from all the patterns. Return the number of patterns the
10833 * client was subscribed from. */
10834 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10839 listRewind(c
->pubsub_patterns
,&li
);
10840 while ((ln
= listNext(&li
)) != NULL
) {
10841 robj
*pattern
= ln
->value
;
10843 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10848 /* Publish a message */
10849 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10851 struct dictEntry
*de
;
10855 /* Send to clients listening for that channel */
10856 de
= dictFind(server
.pubsub_channels
,channel
);
10858 list
*list
= dictGetEntryVal(de
);
10862 listRewind(list
,&li
);
10863 while ((ln
= listNext(&li
)) != NULL
) {
10864 redisClient
*c
= ln
->value
;
10866 addReply(c
,shared
.mbulk3
);
10867 addReply(c
,shared
.messagebulk
);
10868 addReplyBulk(c
,channel
);
10869 addReplyBulk(c
,message
);
10873 /* Send to clients listening to matching channels */
10874 if (listLength(server
.pubsub_patterns
)) {
10875 listRewind(server
.pubsub_patterns
,&li
);
10876 channel
= getDecodedObject(channel
);
10877 while ((ln
= listNext(&li
)) != NULL
) {
10878 pubsubPattern
*pat
= ln
->value
;
10880 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10881 sdslen(pat
->pattern
->ptr
),
10882 (char*)channel
->ptr
,
10883 sdslen(channel
->ptr
),0)) {
10884 addReply(pat
->client
,shared
.mbulk4
);
10885 addReply(pat
->client
,shared
.pmessagebulk
);
10886 addReplyBulk(pat
->client
,pat
->pattern
);
10887 addReplyBulk(pat
->client
,channel
);
10888 addReplyBulk(pat
->client
,message
);
10892 decrRefCount(channel
);
10897 static void subscribeCommand(redisClient
*c
) {
10900 for (j
= 1; j
< c
->argc
; j
++)
10901 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10904 static void unsubscribeCommand(redisClient
*c
) {
10905 if (c
->argc
== 1) {
10906 pubsubUnsubscribeAllChannels(c
,1);
10911 for (j
= 1; j
< c
->argc
; j
++)
10912 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10916 static void psubscribeCommand(redisClient
*c
) {
10919 for (j
= 1; j
< c
->argc
; j
++)
10920 pubsubSubscribePattern(c
,c
->argv
[j
]);
10923 static void punsubscribeCommand(redisClient
*c
) {
10924 if (c
->argc
== 1) {
10925 pubsubUnsubscribeAllPatterns(c
,1);
10930 for (j
= 1; j
< c
->argc
; j
++)
10931 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10935 static void publishCommand(redisClient
*c
) {
10936 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10937 addReplyLongLong(c
,receivers
);
10940 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10942 * The implementation uses a per-DB hash table mapping keys to list of clients
10943 * WATCHing those keys, so that given a key that is going to be modified
10944 * we can mark all the associated clients as dirty.
10946 * Also every client contains a list of WATCHed keys so that's possible to
10947 * un-watch such keys when the client is freed or when UNWATCH is called. */
10949 /* In the client->watched_keys list we need to use watchedKey structures
10950 * as in order to identify a key in Redis we need both the key name and the
10952 typedef struct watchedKey
{
10957 /* Watch for the specified key */
10958 static void watchForKey(redisClient
*c
, robj
*key
) {
10959 list
*clients
= NULL
;
10964 /* Check if we are already watching for this key */
10965 listRewind(c
->watched_keys
,&li
);
10966 while((ln
= listNext(&li
))) {
10967 wk
= listNodeValue(ln
);
10968 if (wk
->db
== c
->db
&& equalStringObjects(key
,wk
->key
))
10969 return; /* Key already watched */
10971 /* This key is not already watched in this DB. Let's add it */
10972 clients
= dictFetchValue(c
->db
->watched_keys
,key
);
10974 clients
= listCreate();
10975 dictAdd(c
->db
->watched_keys
,key
,clients
);
10978 listAddNodeTail(clients
,c
);
10979 /* Add the new key to the lits of keys watched by this client */
10980 wk
= zmalloc(sizeof(*wk
));
10984 listAddNodeTail(c
->watched_keys
,wk
);
10987 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10988 * flag is up to the caller. */
10989 static void unwatchAllKeys(redisClient
*c
) {
10993 if (listLength(c
->watched_keys
) == 0) return;
10994 listRewind(c
->watched_keys
,&li
);
10995 while((ln
= listNext(&li
))) {
10999 /* Lookup the watched key -> clients list and remove the client
11001 wk
= listNodeValue(ln
);
11002 clients
= dictFetchValue(wk
->db
->watched_keys
, wk
->key
);
11003 assert(clients
!= NULL
);
11004 listDelNode(clients
,listSearchKey(clients
,c
));
11005 /* Kill the entry at all if this was the only client */
11006 if (listLength(clients
) == 0)
11007 dictDelete(wk
->db
->watched_keys
, wk
->key
);
11008 /* Remove this watched key from the client->watched list */
11009 listDelNode(c
->watched_keys
,ln
);
11010 decrRefCount(wk
->key
);
11015 /* "Touch" a key, so that if this key is being WATCHed by some client the
11016 * next EXEC will fail. */
11017 static void touchWatchedKey(redisDb
*db
, robj
*key
) {
11022 if (dictSize(db
->watched_keys
) == 0) return;
11023 clients
= dictFetchValue(db
->watched_keys
, key
);
11024 if (!clients
) return;
11026 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
11027 /* Check if we are already watching for this key */
11028 listRewind(clients
,&li
);
11029 while((ln
= listNext(&li
))) {
11030 redisClient
*c
= listNodeValue(ln
);
11032 c
->flags
|= REDIS_DIRTY_CAS
;
11036 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
11037 * flush but will be deleted as effect of the flushing operation should
11038 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
11039 * a FLUSHALL operation (all the DBs flushed). */
11040 static void touchWatchedKeysOnFlush(int dbid
) {
11044 /* For every client, check all the waited keys */
11045 listRewind(server
.clients
,&li1
);
11046 while((ln
= listNext(&li1
))) {
11047 redisClient
*c
= listNodeValue(ln
);
11048 listRewind(c
->watched_keys
,&li2
);
11049 while((ln
= listNext(&li2
))) {
11050 watchedKey
*wk
= listNodeValue(ln
);
11052 /* For every watched key matching the specified DB, if the
11053 * key exists, mark the client as dirty, as the key will be
11055 if (dbid
== -1 || wk
->db
->id
== dbid
) {
11056 if (dictFind(wk
->db
->dict
, wk
->key
->ptr
) != NULL
)
11057 c
->flags
|= REDIS_DIRTY_CAS
;
11063 static void watchCommand(redisClient
*c
) {
11066 if (c
->flags
& REDIS_MULTI
) {
11067 addReplySds(c
,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
11070 for (j
= 1; j
< c
->argc
; j
++)
11071 watchForKey(c
,c
->argv
[j
]);
11072 addReply(c
,shared
.ok
);
11075 static void unwatchCommand(redisClient
*c
) {
11077 c
->flags
&= (~REDIS_DIRTY_CAS
);
11078 addReply(c
,shared
.ok
);
11081 /* ================================= Debugging ============================== */
11083 /* Compute the sha1 of string at 's' with 'len' bytes long.
11084 * The SHA1 is then xored againt the string pointed by digest.
11085 * Since xor is commutative, this operation is used in order to
11086 * "add" digests relative to unordered elements.
11088 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
11089 static void xorDigest(unsigned char *digest
, void *ptr
, size_t len
) {
11091 unsigned char hash
[20], *s
= ptr
;
11095 SHA1Update(&ctx
,s
,len
);
11096 SHA1Final(hash
,&ctx
);
11098 for (j
= 0; j
< 20; j
++)
11099 digest
[j
] ^= hash
[j
];
11102 static void xorObjectDigest(unsigned char *digest
, robj
*o
) {
11103 o
= getDecodedObject(o
);
11104 xorDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
11108 /* This function instead of just computing the SHA1 and xoring it
11109 * against diget, also perform the digest of "digest" itself and
11110 * replace the old value with the new one.
11112 * So the final digest will be:
11114 * digest = SHA1(digest xor SHA1(data))
11116 * This function is used every time we want to preserve the order so
11117 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
11119 * Also note that mixdigest("foo") followed by mixdigest("bar")
11120 * will lead to a different digest compared to "fo", "obar".
11122 static void mixDigest(unsigned char *digest
, void *ptr
, size_t len
) {
11126 xorDigest(digest
,s
,len
);
11128 SHA1Update(&ctx
,digest
,20);
11129 SHA1Final(digest
,&ctx
);
11132 static void mixObjectDigest(unsigned char *digest
, robj
*o
) {
11133 o
= getDecodedObject(o
);
11134 mixDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
11138 /* Compute the dataset digest. Since keys, sets elements, hashes elements
11139 * are not ordered, we use a trick: every aggregate digest is the xor
11140 * of the digests of their elements. This way the order will not change
11141 * the result. For list instead we use a feedback entering the output digest
11142 * as input in order to ensure that a different ordered list will result in
11143 * a different digest. */
11144 static void computeDatasetDigest(unsigned char *final
) {
11145 unsigned char digest
[20];
11147 dictIterator
*di
= NULL
;
11152 memset(final
,0,20); /* Start with a clean result */
11154 for (j
= 0; j
< server
.dbnum
; j
++) {
11155 redisDb
*db
= server
.db
+j
;
11157 if (dictSize(db
->dict
) == 0) continue;
11158 di
= dictGetIterator(db
->dict
);
11160 /* hash the DB id, so the same dataset moved in a different
11161 * DB will lead to a different digest */
11163 mixDigest(final
,&aux
,sizeof(aux
));
11165 /* Iterate this DB writing every entry */
11166 while((de
= dictNext(di
)) != NULL
) {
11171 memset(digest
,0,20); /* This key-val digest */
11172 key
= dictGetEntryKey(de
);
11173 keyobj
= createStringObject(key
,sdslen(key
));
11175 mixDigest(digest
,key
,sdslen(key
));
11177 /* Make sure the key is loaded if VM is active */
11178 o
= lookupKeyRead(db
,keyobj
);
11180 aux
= htonl(o
->type
);
11181 mixDigest(digest
,&aux
,sizeof(aux
));
11182 expiretime
= getExpire(db
,keyobj
);
11184 /* Save the key and associated value */
11185 if (o
->type
== REDIS_STRING
) {
11186 mixObjectDigest(digest
,o
);
11187 } else if (o
->type
== REDIS_LIST
) {
11188 listTypeIterator
*li
= listTypeInitIterator(o
,0,REDIS_TAIL
);
11189 listTypeEntry entry
;
11190 while(listTypeNext(li
,&entry
)) {
11191 robj
*eleobj
= listTypeGet(&entry
);
11192 mixObjectDigest(digest
,eleobj
);
11193 decrRefCount(eleobj
);
11195 listTypeReleaseIterator(li
);
11196 } else if (o
->type
== REDIS_SET
) {
11197 dict
*set
= o
->ptr
;
11198 dictIterator
*di
= dictGetIterator(set
);
11201 while((de
= dictNext(di
)) != NULL
) {
11202 robj
*eleobj
= dictGetEntryKey(de
);
11204 xorObjectDigest(digest
,eleobj
);
11206 dictReleaseIterator(di
);
11207 } else if (o
->type
== REDIS_ZSET
) {
11209 dictIterator
*di
= dictGetIterator(zs
->dict
);
11212 while((de
= dictNext(di
)) != NULL
) {
11213 robj
*eleobj
= dictGetEntryKey(de
);
11214 double *score
= dictGetEntryVal(de
);
11215 unsigned char eledigest
[20];
11217 snprintf(buf
,sizeof(buf
),"%.17g",*score
);
11218 memset(eledigest
,0,20);
11219 mixObjectDigest(eledigest
,eleobj
);
11220 mixDigest(eledigest
,buf
,strlen(buf
));
11221 xorDigest(digest
,eledigest
,20);
11223 dictReleaseIterator(di
);
11224 } else if (o
->type
== REDIS_HASH
) {
11225 hashTypeIterator
*hi
;
11228 hi
= hashTypeInitIterator(o
);
11229 while (hashTypeNext(hi
) != REDIS_ERR
) {
11230 unsigned char eledigest
[20];
11232 memset(eledigest
,0,20);
11233 obj
= hashTypeCurrent(hi
,REDIS_HASH_KEY
);
11234 mixObjectDigest(eledigest
,obj
);
11236 obj
= hashTypeCurrent(hi
,REDIS_HASH_VALUE
);
11237 mixObjectDigest(eledigest
,obj
);
11239 xorDigest(digest
,eledigest
,20);
11241 hashTypeReleaseIterator(hi
);
11243 redisPanic("Unknown object type");
11245 /* If the key has an expire, add it to the mix */
11246 if (expiretime
!= -1) xorDigest(digest
,"!!expire!!",10);
11247 /* We can finally xor the key-val digest to the final digest */
11248 xorDigest(final
,digest
,20);
11249 decrRefCount(keyobj
);
11251 dictReleaseIterator(di
);
11255 static void debugCommand(redisClient
*c
) {
11256 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
11257 *((char*)-1) = 'x';
11258 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
11259 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
11260 addReply(c
,shared
.err
);
11264 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
11265 addReply(c
,shared
.err
);
11268 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
11269 addReply(c
,shared
.ok
);
11270 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
11272 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
11273 addReply(c
,shared
.err
);
11276 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
11277 addReply(c
,shared
.ok
);
11278 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
11279 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]->ptr
);
11283 addReply(c
,shared
.nokeyerr
);
11286 val
= dictGetEntryVal(de
);
11287 if (!server
.vm_enabled
|| (val
->storage
== REDIS_VM_MEMORY
||
11288 val
->storage
== REDIS_VM_SWAPPING
)) {
11292 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
11293 strenc
= strencoding
[val
->encoding
];
11295 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
11298 addReplySds(c
,sdscatprintf(sdsempty(),
11299 "+Value at:%p refcount:%d "
11300 "encoding:%s serializedlength:%lld\r\n",
11301 (void*)val
, val
->refcount
,
11302 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
11304 vmpointer
*vp
= (vmpointer
*) val
;
11305 addReplySds(c
,sdscatprintf(sdsempty(),
11306 "+Value swapped at: page %llu "
11307 "using %llu pages\r\n",
11308 (unsigned long long) vp
->page
,
11309 (unsigned long long) vp
->usedpages
));
11311 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
11312 lookupKeyRead(c
->db
,c
->argv
[2]);
11313 addReply(c
,shared
.ok
);
11314 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
11315 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]->ptr
);
11319 if (!server
.vm_enabled
) {
11320 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11324 addReply(c
,shared
.nokeyerr
);
11327 val
= dictGetEntryVal(de
);
11329 if (val
->storage
!= REDIS_VM_MEMORY
) {
11330 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
11331 } else if (val
->refcount
!= 1) {
11332 addReplySds(c
,sdsnew("-ERR Object is shared\r\n"));
11333 } else if ((vp
= vmSwapObjectBlocking(val
)) != NULL
) {
11334 dictGetEntryVal(de
) = vp
;
11335 addReply(c
,shared
.ok
);
11337 addReply(c
,shared
.err
);
11339 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
11344 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
11346 for (j
= 0; j
< keys
; j
++) {
11347 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
11348 key
= createStringObject(buf
,strlen(buf
));
11349 if (lookupKeyRead(c
->db
,key
) != NULL
) {
11353 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
11354 val
= createStringObject(buf
,strlen(buf
));
11355 dbAdd(c
->db
,key
,val
);
11358 addReply(c
,shared
.ok
);
11359 } else if (!strcasecmp(c
->argv
[1]->ptr
,"digest") && c
->argc
== 2) {
11360 unsigned char digest
[20];
11361 sds d
= sdsnew("+");
11364 computeDatasetDigest(digest
);
11365 for (j
= 0; j
< 20; j
++)
11366 d
= sdscatprintf(d
, "%02x",digest
[j
]);
11368 d
= sdscatlen(d
,"\r\n",2);
11371 addReplySds(c
,sdsnew(
11372 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11376 static void _redisAssert(char *estr
, char *file
, int line
) {
11377 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
11378 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true",file
,line
,estr
);
11379 #ifdef HAVE_BACKTRACE
11380 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11381 *((char*)-1) = 'x';
11385 static void _redisPanic(char *msg
, char *file
, int line
) {
11386 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
11387 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
11388 #ifdef HAVE_BACKTRACE
11389 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11390 *((char*)-1) = 'x';
11394 /* =================================== Main! ================================ */
11397 int linuxOvercommitMemoryValue(void) {
11398 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
11401 if (!fp
) return -1;
11402 if (fgets(buf
,64,fp
) == NULL
) {
11411 void linuxOvercommitMemoryWarning(void) {
11412 if (linuxOvercommitMemoryValue() == 0) {
11413 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.");
11416 #endif /* __linux__ */
11418 static void daemonize(void) {
11422 if (fork() != 0) exit(0); /* parent exits */
11423 setsid(); /* create a new session */
11425 /* Every output goes to /dev/null. If Redis is daemonized but
11426 * the 'logfile' is set to 'stdout' in the configuration file
11427 * it will not log at all. */
11428 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
11429 dup2(fd
, STDIN_FILENO
);
11430 dup2(fd
, STDOUT_FILENO
);
11431 dup2(fd
, STDERR_FILENO
);
11432 if (fd
> STDERR_FILENO
) close(fd
);
11434 /* Try to write the pid file */
11435 fp
= fopen(server
.pidfile
,"w");
11437 fprintf(fp
,"%d\n",getpid());
11442 static void version() {
11443 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
11444 REDIS_GIT_SHA1
, atoi(REDIS_GIT_DIRTY
) > 0);
11448 static void usage() {
11449 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
11450 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
11454 int main(int argc
, char **argv
) {
11457 initServerConfig();
11458 sortCommandTable();
11460 if (strcmp(argv
[1], "-v") == 0 ||
11461 strcmp(argv
[1], "--version") == 0) version();
11462 if (strcmp(argv
[1], "--help") == 0) usage();
11463 resetServerSaveParams();
11464 loadServerConfig(argv
[1]);
11465 } else if ((argc
> 2)) {
11468 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'");
11470 if (server
.daemonize
) daemonize();
11472 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
11474 linuxOvercommitMemoryWarning();
11476 start
= time(NULL
);
11477 if (server
.appendonly
) {
11478 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
11479 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
11481 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
11482 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
11484 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
11485 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
11487 aeDeleteEventLoop(server
.el
);
11491 /* ============================= Backtrace support ========================= */
11493 #ifdef HAVE_BACKTRACE
11494 static char *findFuncName(void *pointer
, unsigned long *offset
);
11496 static void *getMcontextEip(ucontext_t
*uc
) {
11497 #if defined(__FreeBSD__)
11498 return (void*) uc
->uc_mcontext
.mc_eip
;
11499 #elif defined(__dietlibc__)
11500 return (void*) uc
->uc_mcontext
.eip
;
11501 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11503 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11505 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11507 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11508 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11509 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11511 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11513 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11514 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
11515 #elif defined(__ia64__) /* Linux IA64 */
11516 return (void*) uc
->uc_mcontext
.sc_ip
;
11522 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
11524 char **messages
= NULL
;
11525 int i
, trace_size
= 0;
11526 unsigned long offset
=0;
11527 ucontext_t
*uc
= (ucontext_t
*) secret
;
11529 REDIS_NOTUSED(info
);
11531 redisLog(REDIS_WARNING
,
11532 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
11533 infostring
= genRedisInfoString();
11534 redisLog(REDIS_WARNING
, "%s",infostring
);
11535 /* It's not safe to sdsfree() the returned string under memory
11536 * corruption conditions. Let it leak as we are going to abort */
11538 trace_size
= backtrace(trace
, 100);
11539 /* overwrite sigaction with caller's address */
11540 if (getMcontextEip(uc
) != NULL
) {
11541 trace
[1] = getMcontextEip(uc
);
11543 messages
= backtrace_symbols(trace
, trace_size
);
11545 for (i
=1; i
<trace_size
; ++i
) {
11546 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
11548 p
= strchr(messages
[i
],'+');
11549 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
11550 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
11552 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
11555 /* free(messages); Don't call free() with possibly corrupted memory. */
11559 static void sigtermHandler(int sig
) {
11560 REDIS_NOTUSED(sig
);
11562 redisLog(REDIS_WARNING
,"SIGTERM received, scheduling shutting down...");
11563 server
.shutdown_asap
= 1;
11566 static void setupSigSegvAction(void) {
11567 struct sigaction act
;
11569 sigemptyset (&act
.sa_mask
);
11570 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11571 * is used. Otherwise, sa_handler is used */
11572 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
11573 act
.sa_sigaction
= segvHandler
;
11574 sigaction (SIGSEGV
, &act
, NULL
);
11575 sigaction (SIGBUS
, &act
, NULL
);
11576 sigaction (SIGFPE
, &act
, NULL
);
11577 sigaction (SIGILL
, &act
, NULL
);
11578 sigaction (SIGBUS
, &act
, NULL
);
11580 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
11581 act
.sa_handler
= sigtermHandler
;
11582 sigaction (SIGTERM
, &act
, NULL
);
11586 #include "staticsymbols.h"
11587 /* This function try to convert a pointer into a function name. It's used in
11588 * oreder to provide a backtrace under segmentation fault that's able to
11589 * display functions declared as static (otherwise the backtrace is useless). */
11590 static char *findFuncName(void *pointer
, unsigned long *offset
){
11592 unsigned long off
, minoff
= 0;
11594 /* Try to match against the Symbol with the smallest offset */
11595 for (i
=0; symsTable
[i
].pointer
; i
++) {
11596 unsigned long lp
= (unsigned long) pointer
;
11598 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
11599 off
=lp
-symsTable
[i
].pointer
;
11600 if (ret
< 0 || off
< minoff
) {
11606 if (ret
== -1) return NULL
;
11608 return symsTable
[ret
].name
;
11610 #else /* HAVE_BACKTRACE */
11611 static void setupSigSegvAction(void) {
11613 #endif /* HAVE_BACKTRACE */