2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.8"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* try to expire 10 keys/loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_STRING 0
122 /* Objects encoding. Some kind of objects like Strings and Hashes can be
123 * internally represented in multiple ways. The 'encoding' field of the object
124 * is set to one of this fields for this object. */
125 #define REDIS_ENCODING_RAW 0 /* Raw representation */
126 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
127 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
128 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
130 static char* strencoding
[] = {
131 "raw", "int", "zipmap", "hashtable"
134 /* Object types only used for dumping to disk */
135 #define REDIS_EXPIRETIME 253
136 #define REDIS_SELECTDB 254
137 #define REDIS_EOF 255
139 /* Defines related to the dump file format. To store 32 bits lengths for short
140 * keys requires a lot of space, so we check the most significant 2 bits of
141 * the first byte to interpreter the length:
143 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
144 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
145 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
146 * 11|000000 this means: specially encoded object will follow. The six bits
147 * number specify the kind of object that follows.
148 * See the REDIS_RDB_ENC_* defines.
150 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
151 * values, will fit inside. */
152 #define REDIS_RDB_6BITLEN 0
153 #define REDIS_RDB_14BITLEN 1
154 #define REDIS_RDB_32BITLEN 2
155 #define REDIS_RDB_ENCVAL 3
156 #define REDIS_RDB_LENERR UINT_MAX
158 /* When a length of a string object stored on disk has the first two bits
159 * set, the remaining two bits specify a special encoding for the object
160 * accordingly to the following defines: */
161 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
162 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
163 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
164 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
166 /* Virtual memory object->where field. */
167 #define REDIS_VM_MEMORY 0 /* The object is on memory */
168 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
169 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
170 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
172 /* Virtual memory static configuration stuff.
173 * Check vmFindContiguousPages() to know more about this magic numbers. */
174 #define REDIS_VM_MAX_NEAR_PAGES 65536
175 #define REDIS_VM_MAX_RANDOM_JUMP 4096
176 #define REDIS_VM_MAX_THREADS 32
177 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
178 /* The following is the *percentage* of completed I/O jobs to process when the
179 * handelr is called. While Virtual Memory I/O operations are performed by
180 * threads, this operations must be processed by the main thread when completed
181 * in order to take effect. */
182 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
185 #define REDIS_SLAVE 1 /* This client is a slave server */
186 #define REDIS_MASTER 2 /* This client is a master server */
187 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
188 #define REDIS_MULTI 8 /* This client is in a MULTI context */
189 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
190 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
192 /* Slave replication state - slave side */
193 #define REDIS_REPL_NONE 0 /* No active replication */
194 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
195 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
197 /* Slave replication state - from the point of view of master
198 * Note that in SEND_BULK and ONLINE state the slave receives new updates
199 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
200 * to start the next background saving in order to send updates to it. */
201 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
202 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
203 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
204 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
206 /* List related stuff */
210 /* Sort operations */
211 #define REDIS_SORT_GET 0
212 #define REDIS_SORT_ASC 1
213 #define REDIS_SORT_DESC 2
214 #define REDIS_SORTKEY_MAX 1024
217 #define REDIS_DEBUG 0
218 #define REDIS_VERBOSE 1
219 #define REDIS_NOTICE 2
220 #define REDIS_WARNING 3
222 /* Anti-warning macro... */
223 #define REDIS_NOTUSED(V) ((void) V)
225 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
226 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
228 /* Append only defines */
229 #define APPENDFSYNC_NO 0
230 #define APPENDFSYNC_ALWAYS 1
231 #define APPENDFSYNC_EVERYSEC 2
233 /* Hashes related defaults */
234 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
235 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
237 /* We can print the stacktrace, so our assert is defined this way: */
238 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
239 static void _redisAssert(char *estr
, char *file
, int line
);
241 /*================================= Data types ============================== */
243 /* A redis object, that is a type able to hold a string / list / set */
245 /* The VM object structure */
246 struct redisObjectVM
{
247 off_t page
; /* the page at witch the object is stored on disk */
248 off_t usedpages
; /* number of pages used on disk */
249 time_t atime
; /* Last access time */
252 /* The actual Redis Object */
253 typedef struct redisObject
{
256 unsigned char encoding
;
257 unsigned char storage
; /* If this object is a key, where is the value?
258 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
259 unsigned char vtype
; /* If this object is a key, and value is swapped out,
260 * this is the type of the swapped out object. */
262 /* VM fields, this are only allocated if VM is active, otherwise the
263 * object allocation function will just allocate
264 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
265 * Redis without VM active will not have any overhead. */
266 struct redisObjectVM vm
;
269 /* Macro used to initalize a Redis object allocated on the stack.
270 * Note that this macro is taken near the structure definition to make sure
271 * we'll update it when the structure is changed, to avoid bugs like
272 * bug #85 introduced exactly in this way. */
273 #define initStaticStringObject(_var,_ptr) do { \
275 _var.type = REDIS_STRING; \
276 _var.encoding = REDIS_ENCODING_RAW; \
278 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
281 typedef struct redisDb
{
282 dict
*dict
; /* The keyspace for this DB */
283 dict
*expires
; /* Timeout of keys with a timeout set */
284 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
285 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
289 /* Client MULTI/EXEC state */
290 typedef struct multiCmd
{
293 struct redisCommand
*cmd
;
296 typedef struct multiState
{
297 multiCmd
*commands
; /* Array of MULTI commands */
298 int count
; /* Total number of MULTI commands */
301 /* With multiplexing we need to take per-clinet state.
302 * Clients are taken in a liked list. */
303 typedef struct redisClient
{
308 robj
**argv
, **mbargv
;
310 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
311 int multibulk
; /* multi bulk command format active */
314 time_t lastinteraction
; /* time of the last interaction, used for timeout */
315 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
316 int slaveseldb
; /* slave selected db, if this client is a slave */
317 int authenticated
; /* when requirepass is non-NULL */
318 int replstate
; /* replication state if this is a slave */
319 int repldbfd
; /* replication DB file descriptor */
320 long repldboff
; /* replication DB file offset */
321 off_t repldbsize
; /* replication DB file size */
322 multiState mstate
; /* MULTI/EXEC state */
323 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
324 * operation such as BLPOP. Otherwise NULL. */
325 int blockingkeysnum
; /* Number of blocking keys */
326 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
327 * is >= blockingto then the operation timed out. */
328 list
*io_keys
; /* Keys this client is waiting to be loaded from the
329 * swap file in order to continue. */
330 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
331 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
339 /* Global server state structure */
344 dict
*sharingpool
; /* Poll used for object sharing */
345 unsigned int sharingpoolsize
;
346 long long dirty
; /* changes to DB from the last save */
348 list
*slaves
, *monitors
;
349 char neterr
[ANET_ERR_LEN
];
351 int cronloops
; /* number of times the cron function run */
352 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
353 time_t lastsave
; /* Unix time of last save succeeede */
354 /* Fields used only for stats */
355 time_t stat_starttime
; /* server start time */
356 long long stat_numcommands
; /* number of processed commands */
357 long long stat_numconnections
; /* number of connections received */
358 long long stat_expiredkeys
; /* number of expired keys */
371 pid_t bgsavechildpid
;
372 pid_t bgrewritechildpid
;
373 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
374 struct saveparam
*saveparams
;
379 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 struct sharedObjectsStruct
{
510 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
511 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
512 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
513 *outofrangeerr
, *plus
,
514 *select0
, *select1
, *select2
, *select3
, *select4
,
515 *select5
, *select6
, *select7
, *select8
, *select9
,
516 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
517 *psubscribebulk
, *punsubscribebulk
;
520 /* Global vars that are actally used as constants. The following double
521 * values are used for double on-disk serialization, and are initialized
522 * at runtime to avoid strange compiler optimizations. */
524 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
526 /* VM threaded I/O request message */
527 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
528 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
529 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
530 typedef struct iojob
{
531 int type
; /* Request type, REDIS_IOJOB_* */
532 redisDb
*db
;/* Redis database */
533 robj
*key
; /* This I/O request is about swapping this key */
534 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
535 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
536 off_t page
; /* Swap page where to read/write the object */
537 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
538 int canceled
; /* True if this command was canceled by blocking side of VM */
539 pthread_t thread
; /* ID of the thread processing this entry */
542 /*================================ Prototypes =============================== */
544 static void freeStringObject(robj
*o
);
545 static void freeListObject(robj
*o
);
546 static void freeSetObject(robj
*o
);
547 static void decrRefCount(void *o
);
548 static robj
*createObject(int type
, void *ptr
);
549 static void freeClient(redisClient
*c
);
550 static int rdbLoad(char *filename
);
551 static void addReply(redisClient
*c
, robj
*obj
);
552 static void addReplySds(redisClient
*c
, sds s
);
553 static void incrRefCount(robj
*o
);
554 static int rdbSaveBackground(char *filename
);
555 static robj
*createStringObject(char *ptr
, size_t len
);
556 static robj
*dupStringObject(robj
*o
);
557 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
558 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
559 static int syncWithMaster(void);
560 static robj
*tryObjectSharing(robj
*o
);
561 static int tryObjectEncoding(robj
*o
);
562 static robj
*getDecodedObject(robj
*o
);
563 static int removeExpire(redisDb
*db
, robj
*key
);
564 static int expireIfNeeded(redisDb
*db
, robj
*key
);
565 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
566 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
567 static int deleteKey(redisDb
*db
, robj
*key
);
568 static time_t getExpire(redisDb
*db
, robj
*key
);
569 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
570 static void updateSlavesWaitingBgsave(int bgsaveerr
);
571 static void freeMemoryIfNeeded(void);
572 static int processCommand(redisClient
*c
);
573 static void setupSigSegvAction(void);
574 static void rdbRemoveTempFile(pid_t childpid
);
575 static void aofRemoveTempFile(pid_t childpid
);
576 static size_t stringObjectLen(robj
*o
);
577 static void processInputBuffer(redisClient
*c
);
578 static zskiplist
*zslCreate(void);
579 static void zslFree(zskiplist
*zsl
);
580 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
581 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
582 static void initClientMultiState(redisClient
*c
);
583 static void freeClientMultiState(redisClient
*c
);
584 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
585 static void unblockClientWaitingData(redisClient
*c
);
586 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
587 static void vmInit(void);
588 static void vmMarkPagesFree(off_t page
, off_t count
);
589 static robj
*vmLoadObject(robj
*key
);
590 static robj
*vmPreviewObject(robj
*key
);
591 static int vmSwapOneObjectBlocking(void);
592 static int vmSwapOneObjectThreaded(void);
593 static int vmCanSwapOut(void);
594 static int tryFreeOneObjectFromFreelist(void);
595 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
596 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
597 static void vmCancelThreadedIOJob(robj
*o
);
598 static void lockThreadedIO(void);
599 static void unlockThreadedIO(void);
600 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
601 static void freeIOJob(iojob
*j
);
602 static void queueIOJob(iojob
*j
);
603 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
604 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
605 static void waitEmptyIOJobsQueue(void);
606 static void vmReopenSwapFile(void);
607 static int vmFreePage(off_t page
);
608 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
609 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
610 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
611 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
612 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
613 static struct redisCommand
*lookupCommand(char *name
);
614 static void call(redisClient
*c
, struct redisCommand
*cmd
);
615 static void resetClient(redisClient
*c
);
616 static void convertToRealHash(robj
*o
);
617 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
618 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
619 static void freePubsubPattern(void *p
);
620 static int listMatchPubsubPattern(void *a
, void *b
);
621 static int compareStringObjects(robj
*a
, robj
*b
);
624 static void authCommand(redisClient
*c
);
625 static void pingCommand(redisClient
*c
);
626 static void echoCommand(redisClient
*c
);
627 static void setCommand(redisClient
*c
);
628 static void setnxCommand(redisClient
*c
);
629 static void getCommand(redisClient
*c
);
630 static void delCommand(redisClient
*c
);
631 static void existsCommand(redisClient
*c
);
632 static void incrCommand(redisClient
*c
);
633 static void decrCommand(redisClient
*c
);
634 static void incrbyCommand(redisClient
*c
);
635 static void decrbyCommand(redisClient
*c
);
636 static void selectCommand(redisClient
*c
);
637 static void randomkeyCommand(redisClient
*c
);
638 static void keysCommand(redisClient
*c
);
639 static void dbsizeCommand(redisClient
*c
);
640 static void lastsaveCommand(redisClient
*c
);
641 static void saveCommand(redisClient
*c
);
642 static void bgsaveCommand(redisClient
*c
);
643 static void bgrewriteaofCommand(redisClient
*c
);
644 static void shutdownCommand(redisClient
*c
);
645 static void moveCommand(redisClient
*c
);
646 static void renameCommand(redisClient
*c
);
647 static void renamenxCommand(redisClient
*c
);
648 static void lpushCommand(redisClient
*c
);
649 static void rpushCommand(redisClient
*c
);
650 static void lpopCommand(redisClient
*c
);
651 static void rpopCommand(redisClient
*c
);
652 static void llenCommand(redisClient
*c
);
653 static void lindexCommand(redisClient
*c
);
654 static void lrangeCommand(redisClient
*c
);
655 static void ltrimCommand(redisClient
*c
);
656 static void typeCommand(redisClient
*c
);
657 static void lsetCommand(redisClient
*c
);
658 static void saddCommand(redisClient
*c
);
659 static void sremCommand(redisClient
*c
);
660 static void smoveCommand(redisClient
*c
);
661 static void sismemberCommand(redisClient
*c
);
662 static void scardCommand(redisClient
*c
);
663 static void spopCommand(redisClient
*c
);
664 static void srandmemberCommand(redisClient
*c
);
665 static void sinterCommand(redisClient
*c
);
666 static void sinterstoreCommand(redisClient
*c
);
667 static void sunionCommand(redisClient
*c
);
668 static void sunionstoreCommand(redisClient
*c
);
669 static void sdiffCommand(redisClient
*c
);
670 static void sdiffstoreCommand(redisClient
*c
);
671 static void syncCommand(redisClient
*c
);
672 static void flushdbCommand(redisClient
*c
);
673 static void flushallCommand(redisClient
*c
);
674 static void sortCommand(redisClient
*c
);
675 static void lremCommand(redisClient
*c
);
676 static void rpoplpushcommand(redisClient
*c
);
677 static void infoCommand(redisClient
*c
);
678 static void mgetCommand(redisClient
*c
);
679 static void monitorCommand(redisClient
*c
);
680 static void expireCommand(redisClient
*c
);
681 static void expireatCommand(redisClient
*c
);
682 static void getsetCommand(redisClient
*c
);
683 static void ttlCommand(redisClient
*c
);
684 static void slaveofCommand(redisClient
*c
);
685 static void debugCommand(redisClient
*c
);
686 static void msetCommand(redisClient
*c
);
687 static void msetnxCommand(redisClient
*c
);
688 static void zaddCommand(redisClient
*c
);
689 static void zincrbyCommand(redisClient
*c
);
690 static void zrangeCommand(redisClient
*c
);
691 static void zrangebyscoreCommand(redisClient
*c
);
692 static void zcountCommand(redisClient
*c
);
693 static void zrevrangeCommand(redisClient
*c
);
694 static void zcardCommand(redisClient
*c
);
695 static void zremCommand(redisClient
*c
);
696 static void zscoreCommand(redisClient
*c
);
697 static void zremrangebyscoreCommand(redisClient
*c
);
698 static void multiCommand(redisClient
*c
);
699 static void execCommand(redisClient
*c
);
700 static void discardCommand(redisClient
*c
);
701 static void blpopCommand(redisClient
*c
);
702 static void brpopCommand(redisClient
*c
);
703 static void appendCommand(redisClient
*c
);
704 static void substrCommand(redisClient
*c
);
705 static void zrankCommand(redisClient
*c
);
706 static void zrevrankCommand(redisClient
*c
);
707 static void hsetCommand(redisClient
*c
);
708 static void hgetCommand(redisClient
*c
);
709 static void hdelCommand(redisClient
*c
);
710 static void hlenCommand(redisClient
*c
);
711 static void zremrangebyrankCommand(redisClient
*c
);
712 static void zunionCommand(redisClient
*c
);
713 static void zinterCommand(redisClient
*c
);
714 static void hkeysCommand(redisClient
*c
);
715 static void hvalsCommand(redisClient
*c
);
716 static void hgetallCommand(redisClient
*c
);
717 static void hexistsCommand(redisClient
*c
);
718 static void configCommand(redisClient
*c
);
719 static void hincrbyCommand(redisClient
*c
);
720 static void subscribeCommand(redisClient
*c
);
721 static void unsubscribeCommand(redisClient
*c
);
722 static void psubscribeCommand(redisClient
*c
);
723 static void punsubscribeCommand(redisClient
*c
);
724 static void publishCommand(redisClient
*c
);
726 /*================================= Globals ================================= */
729 static struct redisServer server
; /* server global state */
730 static struct redisCommand cmdTable
[] = {
731 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
732 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
733 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
734 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
735 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
736 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
737 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
738 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
739 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
740 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
741 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
742 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
743 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
744 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
750 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
753 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
754 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
755 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
756 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
757 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
762 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
763 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
764 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
765 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
766 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
767 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
768 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
769 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
770 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
771 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
772 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
774 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
775 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
776 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
780 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
781 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
782 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
783 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
784 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
785 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
786 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
787 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
792 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
793 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
796 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
797 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
798 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
799 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
800 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
801 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
803 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
804 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
805 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
806 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
807 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
808 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
809 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
810 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
815 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
817 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
822 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
825 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
828 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"publish",publishCommand
,3,REDIS_CMD_BULK
,NULL
,0,0,0},
833 {NULL
,NULL
,0,0,NULL
,0,0,0}
836 /*============================ Utility functions ============================ */
838 /* Glob-style pattern matching. */
839 static int stringmatchlen(const char *pattern
, int patternLen
,
840 const char *string
, int stringLen
, int nocase
)
845 while (pattern
[1] == '*') {
850 return 1; /* match */
852 if (stringmatchlen(pattern
+1, patternLen
-1,
853 string
, stringLen
, nocase
))
854 return 1; /* match */
858 return 0; /* no match */
862 return 0; /* no match */
872 not = pattern
[0] == '^';
879 if (pattern
[0] == '\\') {
882 if (pattern
[0] == string
[0])
884 } else if (pattern
[0] == ']') {
886 } else if (patternLen
== 0) {
890 } else if (pattern
[1] == '-' && patternLen
>= 3) {
891 int start
= pattern
[0];
892 int end
= pattern
[2];
900 start
= tolower(start
);
906 if (c
>= start
&& c
<= end
)
910 if (pattern
[0] == string
[0])
913 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
923 return 0; /* no match */
929 if (patternLen
>= 2) {
936 if (pattern
[0] != string
[0])
937 return 0; /* no match */
939 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
940 return 0; /* no match */
948 if (stringLen
== 0) {
949 while(*pattern
== '*') {
956 if (patternLen
== 0 && stringLen
== 0)
961 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
962 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
965 static void redisLog(int level
, const char *fmt
, ...) {
969 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
973 if (level
>= server
.verbosity
) {
979 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
980 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
981 vfprintf(fp
, fmt
, ap
);
987 if (server
.logfile
) fclose(fp
);
990 /*====================== Hash table type implementation ==================== */
992 /* This is an hash table type that uses the SDS dynamic strings libary as
993 * keys and radis objects as values (objects can hold SDS strings,
996 static void dictVanillaFree(void *privdata
, void *val
)
998 DICT_NOTUSED(privdata
);
1002 static void dictListDestructor(void *privdata
, void *val
)
1004 DICT_NOTUSED(privdata
);
1005 listRelease((list
*)val
);
1008 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1012 DICT_NOTUSED(privdata
);
1014 l1
= sdslen((sds
)key1
);
1015 l2
= sdslen((sds
)key2
);
1016 if (l1
!= l2
) return 0;
1017 return memcmp(key1
, key2
, l1
) == 0;
1020 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1022 DICT_NOTUSED(privdata
);
1024 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1028 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1031 const robj
*o1
= key1
, *o2
= key2
;
1032 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1035 static unsigned int dictObjHash(const void *key
) {
1036 const robj
*o
= key
;
1037 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1040 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1043 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1046 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1047 o2
->encoding
== REDIS_ENCODING_INT
&&
1048 o1
->ptr
== o2
->ptr
) return 1;
1050 o1
= getDecodedObject(o1
);
1051 o2
= getDecodedObject(o2
);
1052 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1058 static unsigned int dictEncObjHash(const void *key
) {
1059 robj
*o
= (robj
*) key
;
1061 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1062 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1064 if (o
->encoding
== REDIS_ENCODING_INT
) {
1068 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1069 return dictGenHashFunction((unsigned char*)buf
, len
);
1073 o
= getDecodedObject(o
);
1074 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1081 /* Sets type and expires */
1082 static dictType setDictType
= {
1083 dictEncObjHash
, /* hash function */
1086 dictEncObjKeyCompare
, /* key compare */
1087 dictRedisObjectDestructor
, /* key destructor */
1088 NULL
/* val destructor */
1091 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1092 static dictType zsetDictType
= {
1093 dictEncObjHash
, /* hash function */
1096 dictEncObjKeyCompare
, /* key compare */
1097 dictRedisObjectDestructor
, /* key destructor */
1098 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1102 static dictType dbDictType
= {
1103 dictObjHash
, /* hash function */
1106 dictObjKeyCompare
, /* key compare */
1107 dictRedisObjectDestructor
, /* key destructor */
1108 dictRedisObjectDestructor
/* val destructor */
1112 static dictType keyptrDictType
= {
1113 dictObjHash
, /* hash function */
1116 dictObjKeyCompare
, /* key compare */
1117 dictRedisObjectDestructor
, /* key destructor */
1118 NULL
/* val destructor */
1121 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1122 static dictType hashDictType
= {
1123 dictEncObjHash
, /* hash function */
1126 dictEncObjKeyCompare
, /* key compare */
1127 dictRedisObjectDestructor
, /* key destructor */
1128 dictRedisObjectDestructor
/* val destructor */
1131 /* Keylist hash table type has unencoded redis objects as keys and
1132 * lists as values. It's used for blocking operations (BLPOP) and to
1133 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1134 static dictType keylistDictType
= {
1135 dictObjHash
, /* hash function */
1138 dictObjKeyCompare
, /* key compare */
1139 dictRedisObjectDestructor
, /* key destructor */
1140 dictListDestructor
/* val destructor */
1143 static void version();
1145 /* ========================= Random utility functions ======================= */
1147 /* Redis generally does not try to recover from out of memory conditions
1148 * when allocating objects or strings, it is not clear if it will be possible
1149 * to report this condition to the client since the networking layer itself
1150 * is based on heap allocation for send buffers, so we simply abort.
1151 * At least the code will be simpler to read... */
1152 static void oom(const char *msg
) {
1153 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1158 /* ====================== Redis server networking stuff ===================== */
1159 static void closeTimedoutClients(void) {
1162 time_t now
= time(NULL
);
1165 listRewind(server
.clients
,&li
);
1166 while ((ln
= listNext(&li
)) != NULL
) {
1167 c
= listNodeValue(ln
);
1168 if (server
.maxidletime
&&
1169 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1170 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1171 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1172 listLength(c
->pubsub_patterns
) == 0 &&
1173 (now
- c
->lastinteraction
> server
.maxidletime
))
1175 redisLog(REDIS_VERBOSE
,"Closing idle client");
1177 } else if (c
->flags
& REDIS_BLOCKED
) {
1178 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1179 addReply(c
,shared
.nullmultibulk
);
1180 unblockClientWaitingData(c
);
1186 static int htNeedsResize(dict
*dict
) {
1187 long long size
, used
;
1189 size
= dictSlots(dict
);
1190 used
= dictSize(dict
);
1191 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1192 (used
*100/size
< REDIS_HT_MINFILL
));
1195 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1196 * we resize the hash table to save memory */
1197 static void tryResizeHashTables(void) {
1200 for (j
= 0; j
< server
.dbnum
; j
++) {
1201 if (htNeedsResize(server
.db
[j
].dict
)) {
1202 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1203 dictResize(server
.db
[j
].dict
);
1204 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1206 if (htNeedsResize(server
.db
[j
].expires
))
1207 dictResize(server
.db
[j
].expires
);
1211 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1212 void backgroundSaveDoneHandler(int statloc
) {
1213 int exitcode
= WEXITSTATUS(statloc
);
1214 int bysignal
= WIFSIGNALED(statloc
);
1216 if (!bysignal
&& exitcode
== 0) {
1217 redisLog(REDIS_NOTICE
,
1218 "Background saving terminated with success");
1220 server
.lastsave
= time(NULL
);
1221 } else if (!bysignal
&& exitcode
!= 0) {
1222 redisLog(REDIS_WARNING
, "Background saving error");
1224 redisLog(REDIS_WARNING
,
1225 "Background saving terminated by signal");
1226 rdbRemoveTempFile(server
.bgsavechildpid
);
1228 server
.bgsavechildpid
= -1;
1229 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1230 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1231 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1234 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1236 void backgroundRewriteDoneHandler(int statloc
) {
1237 int exitcode
= WEXITSTATUS(statloc
);
1238 int bysignal
= WIFSIGNALED(statloc
);
1240 if (!bysignal
&& exitcode
== 0) {
1244 redisLog(REDIS_NOTICE
,
1245 "Background append only file rewriting terminated with success");
1246 /* Now it's time to flush the differences accumulated by the parent */
1247 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1248 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1250 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1253 /* Flush our data... */
1254 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1255 (signed) sdslen(server
.bgrewritebuf
)) {
1256 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
));
1260 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1261 /* Now our work is to rename the temp file into the stable file. And
1262 * switch the file descriptor used by the server for append only. */
1263 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1264 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1268 /* Mission completed... almost */
1269 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1270 if (server
.appendfd
!= -1) {
1271 /* If append only is actually enabled... */
1272 close(server
.appendfd
);
1273 server
.appendfd
= fd
;
1275 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1276 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1278 /* If append only is disabled we just generate a dump in this
1279 * format. Why not? */
1282 } else if (!bysignal
&& exitcode
!= 0) {
1283 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1285 redisLog(REDIS_WARNING
,
1286 "Background append only file rewriting terminated by signal");
1289 sdsfree(server
.bgrewritebuf
);
1290 server
.bgrewritebuf
= sdsempty();
1291 aofRemoveTempFile(server
.bgrewritechildpid
);
1292 server
.bgrewritechildpid
= -1;
1295 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1296 int j
, loops
= server
.cronloops
++;
1297 REDIS_NOTUSED(eventLoop
);
1299 REDIS_NOTUSED(clientData
);
1301 /* We take a cached value of the unix time in the global state because
1302 * with virtual memory and aging there is to store the current time
1303 * in objects at every object access, and accuracy is not needed.
1304 * To access a global var is faster than calling time(NULL) */
1305 server
.unixtime
= time(NULL
);
1307 /* Show some info about non-empty databases */
1308 for (j
= 0; j
< server
.dbnum
; j
++) {
1309 long long size
, used
, vkeys
;
1311 size
= dictSlots(server
.db
[j
].dict
);
1312 used
= dictSize(server
.db
[j
].dict
);
1313 vkeys
= dictSize(server
.db
[j
].expires
);
1314 if (!(loops
% 50) && (used
|| vkeys
)) {
1315 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1316 /* dictPrintStats(server.dict); */
1320 /* We don't want to resize the hash tables while a bacground saving
1321 * is in progress: the saving child is created using fork() that is
1322 * implemented with a copy-on-write semantic in most modern systems, so
1323 * if we resize the HT while there is the saving child at work actually
1324 * a lot of memory movements in the parent will cause a lot of pages
1326 if (server
.bgsavechildpid
== -1 && !(loops
% 10)) tryResizeHashTables();
1328 /* Show information about connected clients */
1329 if (!(loops
% 50)) {
1330 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1331 listLength(server
.clients
)-listLength(server
.slaves
),
1332 listLength(server
.slaves
),
1333 zmalloc_used_memory(),
1334 dictSize(server
.sharingpool
));
1337 /* Close connections of timedout clients */
1338 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1339 closeTimedoutClients();
1341 /* Check if a background saving or AOF rewrite in progress terminated */
1342 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1346 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1347 if (pid
== server
.bgsavechildpid
) {
1348 backgroundSaveDoneHandler(statloc
);
1350 backgroundRewriteDoneHandler(statloc
);
1354 /* If there is not a background saving in progress check if
1355 * we have to save now */
1356 time_t now
= time(NULL
);
1357 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1358 struct saveparam
*sp
= server
.saveparams
+j
;
1360 if (server
.dirty
>= sp
->changes
&&
1361 now
-server
.lastsave
> sp
->seconds
) {
1362 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1363 sp
->changes
, sp
->seconds
);
1364 rdbSaveBackground(server
.dbfilename
);
1370 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1371 * will use few CPU cycles if there are few expiring keys, otherwise
1372 * it will get more aggressive to avoid that too much memory is used by
1373 * keys that can be removed from the keyspace. */
1374 for (j
= 0; j
< server
.dbnum
; j
++) {
1376 redisDb
*db
= server
.db
+j
;
1378 /* Continue to expire if at the end of the cycle more than 25%
1379 * of the keys were expired. */
1381 long num
= dictSize(db
->expires
);
1382 time_t now
= time(NULL
);
1385 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1386 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1391 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1392 t
= (time_t) dictGetEntryVal(de
);
1394 deleteKey(db
,dictGetEntryKey(de
));
1396 server
.stat_expiredkeys
++;
1399 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1402 /* Swap a few keys on disk if we are over the memory limit and VM
1403 * is enbled. Try to free objects from the free list first. */
1404 if (vmCanSwapOut()) {
1405 while (server
.vm_enabled
&& zmalloc_used_memory() >
1406 server
.vm_max_memory
)
1410 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1411 retval
= (server
.vm_max_threads
== 0) ?
1412 vmSwapOneObjectBlocking() :
1413 vmSwapOneObjectThreaded();
1414 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1415 zmalloc_used_memory() >
1416 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1418 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1420 /* Note that when using threade I/O we free just one object,
1421 * because anyway when the I/O thread in charge to swap this
1422 * object out will finish, the handler of completed jobs
1423 * will try to swap more objects if we are still out of memory. */
1424 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1428 /* Check if we should connect to a MASTER */
1429 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1430 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1431 if (syncWithMaster() == REDIS_OK
) {
1432 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1438 /* This function gets called every time Redis is entering the
1439 * main loop of the event driven library, that is, before to sleep
1440 * for ready file descriptors. */
1441 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1442 REDIS_NOTUSED(eventLoop
);
1444 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1448 listRewind(server
.io_ready_clients
,&li
);
1449 while((ln
= listNext(&li
))) {
1450 redisClient
*c
= ln
->value
;
1451 struct redisCommand
*cmd
;
1453 /* Resume the client. */
1454 listDelNode(server
.io_ready_clients
,ln
);
1455 c
->flags
&= (~REDIS_IO_WAIT
);
1456 server
.vm_blocked_clients
--;
1457 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1458 readQueryFromClient
, c
);
1459 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1460 assert(cmd
!= NULL
);
1463 /* There may be more data to process in the input buffer. */
1464 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1465 processInputBuffer(c
);
1470 static void createSharedObjects(void) {
1471 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1472 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1473 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1474 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1475 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1476 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1477 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1478 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1479 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1480 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1481 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1482 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1483 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1484 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1485 "-ERR no such key\r\n"));
1486 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1487 "-ERR syntax error\r\n"));
1488 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1489 "-ERR source and destination objects are the same\r\n"));
1490 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1491 "-ERR index out of range\r\n"));
1492 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1493 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1494 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1495 shared
.select0
= createStringObject("select 0\r\n",10);
1496 shared
.select1
= createStringObject("select 1\r\n",10);
1497 shared
.select2
= createStringObject("select 2\r\n",10);
1498 shared
.select3
= createStringObject("select 3\r\n",10);
1499 shared
.select4
= createStringObject("select 4\r\n",10);
1500 shared
.select5
= createStringObject("select 5\r\n",10);
1501 shared
.select6
= createStringObject("select 6\r\n",10);
1502 shared
.select7
= createStringObject("select 7\r\n",10);
1503 shared
.select8
= createStringObject("select 8\r\n",10);
1504 shared
.select9
= createStringObject("select 9\r\n",10);
1505 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1506 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1507 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1508 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1509 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1510 shared
.mbulk3
= createStringObject("*3\r\n",4);
1513 static void appendServerSaveParams(time_t seconds
, int changes
) {
1514 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1515 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1516 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1517 server
.saveparamslen
++;
1520 static void resetServerSaveParams() {
1521 zfree(server
.saveparams
);
1522 server
.saveparams
= NULL
;
1523 server
.saveparamslen
= 0;
1526 static void initServerConfig() {
1527 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1528 server
.port
= REDIS_SERVERPORT
;
1529 server
.verbosity
= REDIS_VERBOSE
;
1530 server
.maxidletime
= REDIS_MAXIDLETIME
;
1531 server
.saveparams
= NULL
;
1532 server
.logfile
= NULL
; /* NULL = log on standard output */
1533 server
.bindaddr
= NULL
;
1534 server
.glueoutputbuf
= 1;
1535 server
.daemonize
= 0;
1536 server
.appendonly
= 0;
1537 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1538 server
.lastfsync
= time(NULL
);
1539 server
.appendfd
= -1;
1540 server
.appendseldb
= -1; /* Make sure the first time will not match */
1541 server
.pidfile
= zstrdup("/var/run/redis.pid");
1542 server
.dbfilename
= zstrdup("dump.rdb");
1543 server
.appendfilename
= zstrdup("appendonly.aof");
1544 server
.requirepass
= NULL
;
1545 server
.shareobjects
= 0;
1546 server
.rdbcompression
= 1;
1547 server
.sharingpoolsize
= 1024;
1548 server
.maxclients
= 0;
1549 server
.blpop_blocked_clients
= 0;
1550 server
.maxmemory
= 0;
1551 server
.vm_enabled
= 0;
1552 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1553 server
.vm_page_size
= 256; /* 256 bytes per page */
1554 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1555 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1556 server
.vm_max_threads
= 4;
1557 server
.vm_blocked_clients
= 0;
1558 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1559 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1561 resetServerSaveParams();
1563 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1564 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1565 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1566 /* Replication related */
1568 server
.masterauth
= NULL
;
1569 server
.masterhost
= NULL
;
1570 server
.masterport
= 6379;
1571 server
.master
= NULL
;
1572 server
.replstate
= REDIS_REPL_NONE
;
1574 /* Double constants initialization */
1576 R_PosInf
= 1.0/R_Zero
;
1577 R_NegInf
= -1.0/R_Zero
;
1578 R_Nan
= R_Zero
/R_Zero
;
1581 static void initServer() {
1584 signal(SIGHUP
, SIG_IGN
);
1585 signal(SIGPIPE
, SIG_IGN
);
1586 setupSigSegvAction();
1588 server
.devnull
= fopen("/dev/null","w");
1589 if (server
.devnull
== NULL
) {
1590 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1593 server
.clients
= listCreate();
1594 server
.slaves
= listCreate();
1595 server
.monitors
= listCreate();
1596 server
.objfreelist
= listCreate();
1597 createSharedObjects();
1598 server
.el
= aeCreateEventLoop();
1599 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1600 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1601 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1602 if (server
.fd
== -1) {
1603 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1606 for (j
= 0; j
< server
.dbnum
; j
++) {
1607 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1608 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1609 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1610 if (server
.vm_enabled
)
1611 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1612 server
.db
[j
].id
= j
;
1614 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1615 server
.pubsub_patterns
= listCreate();
1616 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1617 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1618 server
.cronloops
= 0;
1619 server
.bgsavechildpid
= -1;
1620 server
.bgrewritechildpid
= -1;
1621 server
.bgrewritebuf
= sdsempty();
1622 server
.lastsave
= time(NULL
);
1624 server
.stat_numcommands
= 0;
1625 server
.stat_numconnections
= 0;
1626 server
.stat_expiredkeys
= 0;
1627 server
.stat_starttime
= time(NULL
);
1628 server
.unixtime
= time(NULL
);
1629 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1630 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1631 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1633 if (server
.appendonly
) {
1634 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1635 if (server
.appendfd
== -1) {
1636 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1642 if (server
.vm_enabled
) vmInit();
1645 /* Empty the whole database */
1646 static long long emptyDb() {
1648 long long removed
= 0;
1650 for (j
= 0; j
< server
.dbnum
; j
++) {
1651 removed
+= dictSize(server
.db
[j
].dict
);
1652 dictEmpty(server
.db
[j
].dict
);
1653 dictEmpty(server
.db
[j
].expires
);
1658 static int yesnotoi(char *s
) {
1659 if (!strcasecmp(s
,"yes")) return 1;
1660 else if (!strcasecmp(s
,"no")) return 0;
1664 /* I agree, this is a very rudimental way to load a configuration...
1665 will improve later if the config gets more complex */
1666 static void loadServerConfig(char *filename
) {
1668 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1671 char *errormsg
= "Fatal error, can't open config file '%s'";
1672 char *errorbuf
= zmalloc(sizeof(char)*(strlen(errormsg
)+strlen(filename
)));
1673 sprintf(errorbuf
, errormsg
, filename
);
1675 if (filename
[0] == '-' && filename
[1] == '\0')
1678 if ((fp
= fopen(filename
,"r")) == NULL
) {
1679 redisLog(REDIS_WARNING
, errorbuf
);
1684 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1690 line
= sdstrim(line
," \t\r\n");
1692 /* Skip comments and blank lines*/
1693 if (line
[0] == '#' || line
[0] == '\0') {
1698 /* Split into arguments */
1699 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1700 sdstolower(argv
[0]);
1702 /* Execute config directives */
1703 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1704 server
.maxidletime
= atoi(argv
[1]);
1705 if (server
.maxidletime
< 0) {
1706 err
= "Invalid timeout value"; goto loaderr
;
1708 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1709 server
.port
= atoi(argv
[1]);
1710 if (server
.port
< 1 || server
.port
> 65535) {
1711 err
= "Invalid port"; goto loaderr
;
1713 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1714 server
.bindaddr
= zstrdup(argv
[1]);
1715 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1716 int seconds
= atoi(argv
[1]);
1717 int changes
= atoi(argv
[2]);
1718 if (seconds
< 1 || changes
< 0) {
1719 err
= "Invalid save parameters"; goto loaderr
;
1721 appendServerSaveParams(seconds
,changes
);
1722 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1723 if (chdir(argv
[1]) == -1) {
1724 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1725 argv
[1], strerror(errno
));
1728 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1729 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1730 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1731 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1732 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1734 err
= "Invalid log level. Must be one of debug, notice, warning";
1737 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1740 server
.logfile
= zstrdup(argv
[1]);
1741 if (!strcasecmp(server
.logfile
,"stdout")) {
1742 zfree(server
.logfile
);
1743 server
.logfile
= NULL
;
1745 if (server
.logfile
) {
1746 /* Test if we are able to open the file. The server will not
1747 * be able to abort just for this problem later... */
1748 logfp
= fopen(server
.logfile
,"a");
1749 if (logfp
== NULL
) {
1750 err
= sdscatprintf(sdsempty(),
1751 "Can't open the log file: %s", strerror(errno
));
1756 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1757 server
.dbnum
= atoi(argv
[1]);
1758 if (server
.dbnum
< 1) {
1759 err
= "Invalid number of databases"; goto loaderr
;
1761 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1762 loadServerConfig(argv
[1]);
1763 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1764 server
.maxclients
= atoi(argv
[1]);
1765 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1766 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1767 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1768 server
.masterhost
= sdsnew(argv
[1]);
1769 server
.masterport
= atoi(argv
[2]);
1770 server
.replstate
= REDIS_REPL_CONNECT
;
1771 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1772 server
.masterauth
= zstrdup(argv
[1]);
1773 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1774 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1775 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1777 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1778 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1779 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1781 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1782 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1783 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1785 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1786 server
.sharingpoolsize
= atoi(argv
[1]);
1787 if (server
.sharingpoolsize
< 1) {
1788 err
= "invalid object sharing pool size"; goto loaderr
;
1790 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1791 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1792 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1794 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1795 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1796 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1798 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1799 if (!strcasecmp(argv
[1],"no")) {
1800 server
.appendfsync
= APPENDFSYNC_NO
;
1801 } else if (!strcasecmp(argv
[1],"always")) {
1802 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1803 } else if (!strcasecmp(argv
[1],"everysec")) {
1804 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1806 err
= "argument must be 'no', 'always' or 'everysec'";
1809 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1810 server
.requirepass
= zstrdup(argv
[1]);
1811 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1812 zfree(server
.pidfile
);
1813 server
.pidfile
= zstrdup(argv
[1]);
1814 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1815 zfree(server
.dbfilename
);
1816 server
.dbfilename
= zstrdup(argv
[1]);
1817 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1818 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1819 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1821 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1822 zfree(server
.vm_swap_file
);
1823 server
.vm_swap_file
= zstrdup(argv
[1]);
1824 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1825 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1826 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1827 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1828 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1829 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1830 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1831 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1832 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1833 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1834 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1835 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1836 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1837 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1839 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1841 for (j
= 0; j
< argc
; j
++)
1846 if (fp
!= stdin
) fclose(fp
);
1850 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1851 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1852 fprintf(stderr
, ">>> '%s'\n", line
);
1853 fprintf(stderr
, "%s\n", err
);
1857 static void freeClientArgv(redisClient
*c
) {
1860 for (j
= 0; j
< c
->argc
; j
++)
1861 decrRefCount(c
->argv
[j
]);
1862 for (j
= 0; j
< c
->mbargc
; j
++)
1863 decrRefCount(c
->mbargv
[j
]);
1868 static void freeClient(redisClient
*c
) {
1871 /* Note that if the client we are freeing is blocked into a blocking
1872 * call, we have to set querybuf to NULL *before* to call
1873 * unblockClientWaitingData() to avoid processInputBuffer() will get
1874 * called. Also it is important to remove the file events after
1875 * this, because this call adds the READABLE event. */
1876 sdsfree(c
->querybuf
);
1878 if (c
->flags
& REDIS_BLOCKED
)
1879 unblockClientWaitingData(c
);
1881 /* Unsubscribe from all the pubsub channels */
1882 pubsubUnsubscribeAllChannels(c
,0);
1883 pubsubUnsubscribeAllPatterns(c
,0);
1884 dictRelease(c
->pubsub_channels
);
1885 listRelease(c
->pubsub_patterns
);
1886 /* Obvious cleanup */
1887 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1888 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1889 listRelease(c
->reply
);
1892 /* Remove from the list of clients */
1893 ln
= listSearchKey(server
.clients
,c
);
1894 redisAssert(ln
!= NULL
);
1895 listDelNode(server
.clients
,ln
);
1896 /* Remove from the list of clients waiting for swapped keys */
1897 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1898 ln
= listSearchKey(server
.io_ready_clients
,c
);
1900 listDelNode(server
.io_ready_clients
,ln
);
1901 server
.vm_blocked_clients
--;
1904 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1905 ln
= listFirst(c
->io_keys
);
1906 dontWaitForSwappedKey(c
,ln
->value
);
1908 listRelease(c
->io_keys
);
1909 /* Master/slave cleanup */
1910 if (c
->flags
& REDIS_SLAVE
) {
1911 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1913 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1914 ln
= listSearchKey(l
,c
);
1915 redisAssert(ln
!= NULL
);
1918 if (c
->flags
& REDIS_MASTER
) {
1919 server
.master
= NULL
;
1920 server
.replstate
= REDIS_REPL_CONNECT
;
1922 /* Release memory */
1925 freeClientMultiState(c
);
1929 #define GLUEREPLY_UP_TO (1024)
1930 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1932 char buf
[GLUEREPLY_UP_TO
];
1937 listRewind(c
->reply
,&li
);
1938 while((ln
= listNext(&li
))) {
1942 objlen
= sdslen(o
->ptr
);
1943 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1944 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1946 listDelNode(c
->reply
,ln
);
1948 if (copylen
== 0) return;
1952 /* Now the output buffer is empty, add the new single element */
1953 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1954 listAddNodeHead(c
->reply
,o
);
1957 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1958 redisClient
*c
= privdata
;
1959 int nwritten
= 0, totwritten
= 0, objlen
;
1962 REDIS_NOTUSED(mask
);
1964 /* Use writev() if we have enough buffers to send */
1965 if (!server
.glueoutputbuf
&&
1966 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1967 !(c
->flags
& REDIS_MASTER
))
1969 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1973 while(listLength(c
->reply
)) {
1974 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1975 glueReplyBuffersIfNeeded(c
);
1977 o
= listNodeValue(listFirst(c
->reply
));
1978 objlen
= sdslen(o
->ptr
);
1981 listDelNode(c
->reply
,listFirst(c
->reply
));
1985 if (c
->flags
& REDIS_MASTER
) {
1986 /* Don't reply to a master */
1987 nwritten
= objlen
- c
->sentlen
;
1989 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1990 if (nwritten
<= 0) break;
1992 c
->sentlen
+= nwritten
;
1993 totwritten
+= nwritten
;
1994 /* If we fully sent the object on head go to the next one */
1995 if (c
->sentlen
== objlen
) {
1996 listDelNode(c
->reply
,listFirst(c
->reply
));
1999 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2000 * bytes, in a single threaded server it's a good idea to serve
2001 * other clients as well, even if a very large request comes from
2002 * super fast link that is always able to accept data (in real world
2003 * scenario think about 'KEYS *' against the loopback interfae) */
2004 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2006 if (nwritten
== -1) {
2007 if (errno
== EAGAIN
) {
2010 redisLog(REDIS_VERBOSE
,
2011 "Error writing to client: %s", strerror(errno
));
2016 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2017 if (listLength(c
->reply
) == 0) {
2019 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2023 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2025 redisClient
*c
= privdata
;
2026 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2028 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2029 int offset
, ion
= 0;
2031 REDIS_NOTUSED(mask
);
2034 while (listLength(c
->reply
)) {
2035 offset
= c
->sentlen
;
2039 /* fill-in the iov[] array */
2040 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2041 o
= listNodeValue(node
);
2042 objlen
= sdslen(o
->ptr
);
2044 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2047 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2048 break; /* no more iovecs */
2050 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2051 iov
[ion
].iov_len
= objlen
- offset
;
2052 willwrite
+= objlen
- offset
;
2053 offset
= 0; /* just for the first item */
2060 /* write all collected blocks at once */
2061 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2062 if (errno
!= EAGAIN
) {
2063 redisLog(REDIS_VERBOSE
,
2064 "Error writing to client: %s", strerror(errno
));
2071 totwritten
+= nwritten
;
2072 offset
= c
->sentlen
;
2074 /* remove written robjs from c->reply */
2075 while (nwritten
&& listLength(c
->reply
)) {
2076 o
= listNodeValue(listFirst(c
->reply
));
2077 objlen
= sdslen(o
->ptr
);
2079 if(nwritten
>= objlen
- offset
) {
2080 listDelNode(c
->reply
, listFirst(c
->reply
));
2081 nwritten
-= objlen
- offset
;
2085 c
->sentlen
+= nwritten
;
2093 c
->lastinteraction
= time(NULL
);
2095 if (listLength(c
->reply
) == 0) {
2097 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2101 static struct redisCommand
*lookupCommand(char *name
) {
2103 while(cmdTable
[j
].name
!= NULL
) {
2104 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2110 /* resetClient prepare the client to process the next command */
2111 static void resetClient(redisClient
*c
) {
2117 /* Call() is the core of Redis execution of a command */
2118 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2121 dirty
= server
.dirty
;
2123 if (server
.appendonly
&& server
.dirty
-dirty
)
2124 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2125 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2126 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2127 if (listLength(server
.monitors
))
2128 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2129 server
.stat_numcommands
++;
2132 /* If this function gets called we already read a whole
2133 * command, argments are in the client argv/argc fields.
2134 * processCommand() execute the command or prepare the
2135 * server for a bulk read from the client.
2137 * If 1 is returned the client is still alive and valid and
2138 * and other operations can be performed by the caller. Otherwise
2139 * if 0 is returned the client was destroied (i.e. after QUIT). */
2140 static int processCommand(redisClient
*c
) {
2141 struct redisCommand
*cmd
;
2143 /* Free some memory if needed (maxmemory setting) */
2144 if (server
.maxmemory
) freeMemoryIfNeeded();
2146 /* Handle the multi bulk command type. This is an alternative protocol
2147 * supported by Redis in order to receive commands that are composed of
2148 * multiple binary-safe "bulk" arguments. The latency of processing is
2149 * a bit higher but this allows things like multi-sets, so if this
2150 * protocol is used only for MSET and similar commands this is a big win. */
2151 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2152 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2153 if (c
->multibulk
<= 0) {
2157 decrRefCount(c
->argv
[c
->argc
-1]);
2161 } else if (c
->multibulk
) {
2162 if (c
->bulklen
== -1) {
2163 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2164 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2168 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2169 decrRefCount(c
->argv
[0]);
2170 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2172 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2177 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2181 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2182 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2186 if (c
->multibulk
== 0) {
2190 /* Here we need to swap the multi-bulk argc/argv with the
2191 * normal argc/argv of the client structure. */
2193 c
->argv
= c
->mbargv
;
2194 c
->mbargv
= auxargv
;
2197 c
->argc
= c
->mbargc
;
2198 c
->mbargc
= auxargc
;
2200 /* We need to set bulklen to something different than -1
2201 * in order for the code below to process the command without
2202 * to try to read the last argument of a bulk command as
2203 * a special argument. */
2205 /* continue below and process the command */
2212 /* -- end of multi bulk commands processing -- */
2214 /* The QUIT command is handled as a special case. Normal command
2215 * procs are unable to close the client connection safely */
2216 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2221 /* Now lookup the command and check ASAP about trivial error conditions
2222 * such wrong arity, bad command name and so forth. */
2223 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2226 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2227 (char*)c
->argv
[0]->ptr
));
2230 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2231 (c
->argc
< -cmd
->arity
)) {
2233 sdscatprintf(sdsempty(),
2234 "-ERR wrong number of arguments for '%s' command\r\n",
2238 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2239 /* This is a bulk command, we have to read the last argument yet. */
2240 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2242 decrRefCount(c
->argv
[c
->argc
-1]);
2243 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2245 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2250 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2251 /* It is possible that the bulk read is already in the
2252 * buffer. Check this condition and handle it accordingly.
2253 * This is just a fast path, alternative to call processInputBuffer().
2254 * It's a good idea since the code is small and this condition
2255 * happens most of the times. */
2256 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2257 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2259 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2261 /* Otherwise return... there is to read the last argument
2262 * from the socket. */
2266 /* Let's try to share objects on the command arguments vector */
2267 if (server
.shareobjects
) {
2269 for(j
= 1; j
< c
->argc
; j
++)
2270 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2272 /* Let's try to encode the bulk object to save space. */
2273 if (cmd
->flags
& REDIS_CMD_BULK
)
2274 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2276 /* Check if the user is authenticated */
2277 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2278 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2283 /* Handle the maxmemory directive */
2284 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2285 zmalloc_used_memory() > server
.maxmemory
)
2287 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2292 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2293 if (dictSize(c
->pubsub_channels
) > 0 &&
2294 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2295 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2296 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2301 /* Exec the command */
2302 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2303 queueMultiCommand(c
,cmd
);
2304 addReply(c
,shared
.queued
);
2306 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2307 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2311 /* Prepare the client for the next command */
2316 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2321 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2322 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2323 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2324 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2327 if (argc
<= REDIS_STATIC_ARGS
) {
2330 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2333 lenobj
= createObject(REDIS_STRING
,
2334 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2335 lenobj
->refcount
= 0;
2336 outv
[outc
++] = lenobj
;
2337 for (j
= 0; j
< argc
; j
++) {
2338 lenobj
= createObject(REDIS_STRING
,
2339 sdscatprintf(sdsempty(),"$%lu\r\n",
2340 (unsigned long) stringObjectLen(argv
[j
])));
2341 lenobj
->refcount
= 0;
2342 outv
[outc
++] = lenobj
;
2343 outv
[outc
++] = argv
[j
];
2344 outv
[outc
++] = shared
.crlf
;
2347 /* Increment all the refcounts at start and decrement at end in order to
2348 * be sure to free objects if there is no slave in a replication state
2349 * able to be feed with commands */
2350 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2351 listRewind(slaves
,&li
);
2352 while((ln
= listNext(&li
))) {
2353 redisClient
*slave
= ln
->value
;
2355 /* Don't feed slaves that are still waiting for BGSAVE to start */
2356 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2358 /* Feed all the other slaves, MONITORs and so on */
2359 if (slave
->slaveseldb
!= dictid
) {
2363 case 0: selectcmd
= shared
.select0
; break;
2364 case 1: selectcmd
= shared
.select1
; break;
2365 case 2: selectcmd
= shared
.select2
; break;
2366 case 3: selectcmd
= shared
.select3
; break;
2367 case 4: selectcmd
= shared
.select4
; break;
2368 case 5: selectcmd
= shared
.select5
; break;
2369 case 6: selectcmd
= shared
.select6
; break;
2370 case 7: selectcmd
= shared
.select7
; break;
2371 case 8: selectcmd
= shared
.select8
; break;
2372 case 9: selectcmd
= shared
.select9
; break;
2374 selectcmd
= createObject(REDIS_STRING
,
2375 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2376 selectcmd
->refcount
= 0;
2379 addReply(slave
,selectcmd
);
2380 slave
->slaveseldb
= dictid
;
2382 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2384 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2385 if (outv
!= static_outv
) zfree(outv
);
2388 static void processInputBuffer(redisClient
*c
) {
2390 /* Before to process the input buffer, make sure the client is not
2391 * waitig for a blocking operation such as BLPOP. Note that the first
2392 * iteration the client is never blocked, otherwise the processInputBuffer
2393 * would not be called at all, but after the execution of the first commands
2394 * in the input buffer the client may be blocked, and the "goto again"
2395 * will try to reiterate. The following line will make it return asap. */
2396 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2397 if (c
->bulklen
== -1) {
2398 /* Read the first line of the query */
2399 char *p
= strchr(c
->querybuf
,'\n');
2406 query
= c
->querybuf
;
2407 c
->querybuf
= sdsempty();
2408 querylen
= 1+(p
-(query
));
2409 if (sdslen(query
) > querylen
) {
2410 /* leave data after the first line of the query in the buffer */
2411 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2413 *p
= '\0'; /* remove "\n" */
2414 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2415 sdsupdatelen(query
);
2417 /* Now we can split the query in arguments */
2418 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2421 if (c
->argv
) zfree(c
->argv
);
2422 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2424 for (j
= 0; j
< argc
; j
++) {
2425 if (sdslen(argv
[j
])) {
2426 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2434 /* Execute the command. If the client is still valid
2435 * after processCommand() return and there is something
2436 * on the query buffer try to process the next command. */
2437 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2439 /* Nothing to process, argc == 0. Just process the query
2440 * buffer if it's not empty or return to the caller */
2441 if (sdslen(c
->querybuf
)) goto again
;
2444 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2445 redisLog(REDIS_VERBOSE
, "Client protocol error");
2450 /* Bulk read handling. Note that if we are at this point
2451 the client already sent a command terminated with a newline,
2452 we are reading the bulk data that is actually the last
2453 argument of the command. */
2454 int qbl
= sdslen(c
->querybuf
);
2456 if (c
->bulklen
<= qbl
) {
2457 /* Copy everything but the final CRLF as final argument */
2458 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2460 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2461 /* Process the command. If the client is still valid after
2462 * the processing and there is more data in the buffer
2463 * try to parse it. */
2464 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2470 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2471 redisClient
*c
= (redisClient
*) privdata
;
2472 char buf
[REDIS_IOBUF_LEN
];
2475 REDIS_NOTUSED(mask
);
2477 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2479 if (errno
== EAGAIN
) {
2482 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2486 } else if (nread
== 0) {
2487 redisLog(REDIS_VERBOSE
, "Client closed connection");
2492 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2493 c
->lastinteraction
= time(NULL
);
2497 processInputBuffer(c
);
2500 static int selectDb(redisClient
*c
, int id
) {
2501 if (id
< 0 || id
>= server
.dbnum
)
2503 c
->db
= &server
.db
[id
];
2507 static void *dupClientReplyValue(void *o
) {
2508 incrRefCount((robj
*)o
);
2512 static int listMatchObjects(void *a
, void *b
) {
2513 return compareStringObjects(a
,b
) == 0;
2516 static redisClient
*createClient(int fd
) {
2517 redisClient
*c
= zmalloc(sizeof(*c
));
2519 anetNonBlock(NULL
,fd
);
2520 anetTcpNoDelay(NULL
,fd
);
2521 if (!c
) return NULL
;
2524 c
->querybuf
= sdsempty();
2533 c
->lastinteraction
= time(NULL
);
2534 c
->authenticated
= 0;
2535 c
->replstate
= REDIS_REPL_NONE
;
2536 c
->reply
= listCreate();
2537 listSetFreeMethod(c
->reply
,decrRefCount
);
2538 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2539 c
->blockingkeys
= NULL
;
2540 c
->blockingkeysnum
= 0;
2541 c
->io_keys
= listCreate();
2542 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2543 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2544 c
->pubsub_patterns
= listCreate();
2545 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2546 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2547 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2548 readQueryFromClient
, c
) == AE_ERR
) {
2552 listAddNodeTail(server
.clients
,c
);
2553 initClientMultiState(c
);
2557 static void addReply(redisClient
*c
, robj
*obj
) {
2558 if (listLength(c
->reply
) == 0 &&
2559 (c
->replstate
== REDIS_REPL_NONE
||
2560 c
->replstate
== REDIS_REPL_ONLINE
) &&
2561 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2562 sendReplyToClient
, c
) == AE_ERR
) return;
2564 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2565 obj
= dupStringObject(obj
);
2566 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2568 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2571 static void addReplySds(redisClient
*c
, sds s
) {
2572 robj
*o
= createObject(REDIS_STRING
,s
);
2577 static void addReplyDouble(redisClient
*c
, double d
) {
2580 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2581 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2582 (unsigned long) strlen(buf
),buf
));
2585 static void addReplyLong(redisClient
*c
, long l
) {
2590 addReply(c
,shared
.czero
);
2592 } else if (l
== 1) {
2593 addReply(c
,shared
.cone
);
2596 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2597 addReplySds(c
,sdsnewlen(buf
,len
));
2600 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2605 addReply(c
,shared
.czero
);
2607 } else if (ul
== 1) {
2608 addReply(c
,shared
.cone
);
2611 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2612 addReplySds(c
,sdsnewlen(buf
,len
));
2615 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2618 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2619 len
= sdslen(obj
->ptr
);
2621 long n
= (long)obj
->ptr
;
2623 /* Compute how many bytes will take this integer as a radix 10 string */
2629 while((n
= n
/10) != 0) {
2633 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2636 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2637 addReplyBulkLen(c
,obj
);
2639 addReply(c
,shared
.crlf
);
2642 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2643 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2645 addReply(c
,shared
.nullbulk
);
2647 robj
*o
= createStringObject(s
,strlen(s
));
2653 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2658 REDIS_NOTUSED(mask
);
2659 REDIS_NOTUSED(privdata
);
2661 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2662 if (cfd
== AE_ERR
) {
2663 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2666 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2667 if ((c
= createClient(cfd
)) == NULL
) {
2668 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2669 close(cfd
); /* May be already closed, just ingore errors */
2672 /* If maxclient directive is set and this is one client more... close the
2673 * connection. Note that we create the client instead to check before
2674 * for this condition, since now the socket is already set in nonblocking
2675 * mode and we can send an error for free using the Kernel I/O */
2676 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2677 char *err
= "-ERR max number of clients reached\r\n";
2679 /* That's a best effort error message, don't check write errors */
2680 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2681 /* Nothing to do, Just to avoid the warning... */
2686 server
.stat_numconnections
++;
2689 /* ======================= Redis objects implementation ===================== */
2691 static robj
*createObject(int type
, void *ptr
) {
2694 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2695 if (listLength(server
.objfreelist
)) {
2696 listNode
*head
= listFirst(server
.objfreelist
);
2697 o
= listNodeValue(head
);
2698 listDelNode(server
.objfreelist
,head
);
2699 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2701 if (server
.vm_enabled
) {
2702 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2703 o
= zmalloc(sizeof(*o
));
2705 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2709 o
->encoding
= REDIS_ENCODING_RAW
;
2712 if (server
.vm_enabled
) {
2713 /* Note that this code may run in the context of an I/O thread
2714 * and accessing to server.unixtime in theory is an error
2715 * (no locks). But in practice this is safe, and even if we read
2716 * garbage Redis will not fail, as it's just a statistical info */
2717 o
->vm
.atime
= server
.unixtime
;
2718 o
->storage
= REDIS_VM_MEMORY
;
2723 static robj
*createStringObject(char *ptr
, size_t len
) {
2724 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2727 static robj
*dupStringObject(robj
*o
) {
2728 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2729 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2732 static robj
*createListObject(void) {
2733 list
*l
= listCreate();
2735 listSetFreeMethod(l
,decrRefCount
);
2736 return createObject(REDIS_LIST
,l
);
2739 static robj
*createSetObject(void) {
2740 dict
*d
= dictCreate(&setDictType
,NULL
);
2741 return createObject(REDIS_SET
,d
);
2744 static robj
*createHashObject(void) {
2745 /* All the Hashes start as zipmaps. Will be automatically converted
2746 * into hash tables if there are enough elements or big elements
2748 unsigned char *zm
= zipmapNew();
2749 robj
*o
= createObject(REDIS_HASH
,zm
);
2750 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2754 static robj
*createZsetObject(void) {
2755 zset
*zs
= zmalloc(sizeof(*zs
));
2757 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2758 zs
->zsl
= zslCreate();
2759 return createObject(REDIS_ZSET
,zs
);
2762 static void freeStringObject(robj
*o
) {
2763 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2768 static void freeListObject(robj
*o
) {
2769 listRelease((list
*) o
->ptr
);
2772 static void freeSetObject(robj
*o
) {
2773 dictRelease((dict
*) o
->ptr
);
2776 static void freeZsetObject(robj
*o
) {
2779 dictRelease(zs
->dict
);
2784 static void freeHashObject(robj
*o
) {
2785 switch (o
->encoding
) {
2786 case REDIS_ENCODING_HT
:
2787 dictRelease((dict
*) o
->ptr
);
2789 case REDIS_ENCODING_ZIPMAP
:
2798 static void incrRefCount(robj
*o
) {
2799 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2803 static void decrRefCount(void *obj
) {
2806 /* Object is a key of a swapped out value, or in the process of being
2808 if (server
.vm_enabled
&&
2809 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2811 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2812 redisAssert(o
->refcount
== 1);
2814 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2815 redisAssert(o
->type
== REDIS_STRING
);
2816 freeStringObject(o
);
2817 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2818 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2819 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2820 !listAddNodeHead(server
.objfreelist
,o
))
2822 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2823 server
.vm_stats_swapped_objects
--;
2826 /* Object is in memory, or in the process of being swapped out. */
2827 if (--(o
->refcount
) == 0) {
2828 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2829 vmCancelThreadedIOJob(obj
);
2831 case REDIS_STRING
: freeStringObject(o
); break;
2832 case REDIS_LIST
: freeListObject(o
); break;
2833 case REDIS_SET
: freeSetObject(o
); break;
2834 case REDIS_ZSET
: freeZsetObject(o
); break;
2835 case REDIS_HASH
: freeHashObject(o
); break;
2836 default: redisAssert(0); break;
2838 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2839 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2840 !listAddNodeHead(server
.objfreelist
,o
))
2842 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2846 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2847 dictEntry
*de
= dictFind(db
->dict
,key
);
2849 robj
*key
= dictGetEntryKey(de
);
2850 robj
*val
= dictGetEntryVal(de
);
2852 if (server
.vm_enabled
) {
2853 if (key
->storage
== REDIS_VM_MEMORY
||
2854 key
->storage
== REDIS_VM_SWAPPING
)
2856 /* If we were swapping the object out, stop it, this key
2858 if (key
->storage
== REDIS_VM_SWAPPING
)
2859 vmCancelThreadedIOJob(key
);
2860 /* Update the access time of the key for the aging algorithm. */
2861 key
->vm
.atime
= server
.unixtime
;
2863 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2865 /* Our value was swapped on disk. Bring it at home. */
2866 redisAssert(val
== NULL
);
2867 val
= vmLoadObject(key
);
2868 dictGetEntryVal(de
) = val
;
2870 /* Clients blocked by the VM subsystem may be waiting for
2872 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2881 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2882 expireIfNeeded(db
,key
);
2883 return lookupKey(db
,key
);
2886 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2887 deleteIfVolatile(db
,key
);
2888 return lookupKey(db
,key
);
2891 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2892 robj
*o
= lookupKeyRead(c
->db
, key
);
2893 if (!o
) addReply(c
,reply
);
2897 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2898 robj
*o
= lookupKeyWrite(c
->db
, key
);
2899 if (!o
) addReply(c
,reply
);
2903 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2904 if (o
->type
!= type
) {
2905 addReply(c
,shared
.wrongtypeerr
);
2911 static int deleteKey(redisDb
*db
, robj
*key
) {
2914 /* We need to protect key from destruction: after the first dictDelete()
2915 * it may happen that 'key' is no longer valid if we don't increment
2916 * it's count. This may happen when we get the object reference directly
2917 * from the hash table with dictRandomKey() or dict iterators */
2919 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2920 retval
= dictDelete(db
->dict
,key
);
2923 return retval
== DICT_OK
;
2926 /* Try to share an object against the shared objects pool */
2927 static robj
*tryObjectSharing(robj
*o
) {
2928 struct dictEntry
*de
;
2931 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2933 redisAssert(o
->type
== REDIS_STRING
);
2934 de
= dictFind(server
.sharingpool
,o
);
2936 robj
*shared
= dictGetEntryKey(de
);
2938 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2939 dictGetEntryVal(de
) = (void*) c
;
2940 incrRefCount(shared
);
2944 /* Here we are using a stream algorihtm: Every time an object is
2945 * shared we increment its count, everytime there is a miss we
2946 * recrement the counter of a random object. If this object reaches
2947 * zero we remove the object and put the current object instead. */
2948 if (dictSize(server
.sharingpool
) >=
2949 server
.sharingpoolsize
) {
2950 de
= dictGetRandomKey(server
.sharingpool
);
2951 redisAssert(de
!= NULL
);
2952 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2953 dictGetEntryVal(de
) = (void*) c
;
2955 dictDelete(server
.sharingpool
,de
->key
);
2958 c
= 0; /* If the pool is empty we want to add this object */
2963 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2964 redisAssert(retval
== DICT_OK
);
2971 /* Check if the nul-terminated string 's' can be represented by a long
2972 * (that is, is a number that fits into long without any other space or
2973 * character before or after the digits).
2975 * If so, the function returns REDIS_OK and *longval is set to the value
2976 * of the number. Otherwise REDIS_ERR is returned */
2977 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2978 char buf
[32], *endptr
;
2982 value
= strtol(s
, &endptr
, 10);
2983 if (endptr
[0] != '\0') return REDIS_ERR
;
2984 slen
= snprintf(buf
,32,"%ld",value
);
2986 /* If the number converted back into a string is not identical
2987 * then it's not possible to encode the string as integer */
2988 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2989 if (longval
) *longval
= value
;
2993 /* Try to encode a string object in order to save space */
2994 static int tryObjectEncoding(robj
*o
) {
2998 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2999 return REDIS_ERR
; /* Already encoded */
3001 /* It's not save to encode shared objects: shared objects can be shared
3002 * everywhere in the "object space" of Redis. Encoded objects can only
3003 * appear as "values" (and not, for instance, as keys) */
3004 if (o
->refcount
> 1) return REDIS_ERR
;
3006 /* Currently we try to encode only strings */
3007 redisAssert(o
->type
== REDIS_STRING
);
3009 /* Check if we can represent this string as a long integer */
3010 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
3012 /* Ok, this object can be encoded */
3013 o
->encoding
= REDIS_ENCODING_INT
;
3015 o
->ptr
= (void*) value
;
3019 /* Get a decoded version of an encoded object (returned as a new object).
3020 * If the object is already raw-encoded just increment the ref count. */
3021 static robj
*getDecodedObject(robj
*o
) {
3024 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3028 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3031 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3032 dec
= createStringObject(buf
,strlen(buf
));
3035 redisAssert(1 != 1);
3039 /* Compare two string objects via strcmp() or alike.
3040 * Note that the objects may be integer-encoded. In such a case we
3041 * use snprintf() to get a string representation of the numbers on the stack
3042 * and compare the strings, it's much faster than calling getDecodedObject().
3044 * Important note: if objects are not integer encoded, but binary-safe strings,
3045 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3047 static int compareStringObjects(robj
*a
, robj
*b
) {
3048 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3049 char bufa
[128], bufb
[128], *astr
, *bstr
;
3052 if (a
== b
) return 0;
3053 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3054 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3060 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3061 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3067 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3070 static size_t stringObjectLen(robj
*o
) {
3071 redisAssert(o
->type
== REDIS_STRING
);
3072 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3073 return sdslen(o
->ptr
);
3077 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3081 /*============================ RDB saving/loading =========================== */
3083 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3084 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3088 static int rdbSaveTime(FILE *fp
, time_t t
) {
3089 int32_t t32
= (int32_t) t
;
3090 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3094 /* check rdbLoadLen() comments for more info */
3095 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3096 unsigned char buf
[2];
3099 /* Save a 6 bit len */
3100 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3101 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3102 } else if (len
< (1<<14)) {
3103 /* Save a 14 bit len */
3104 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3106 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3108 /* Save a 32 bit len */
3109 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3110 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3112 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3117 /* String objects in the form "2391" "-100" without any space and with a
3118 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3119 * encoded as integers to save space */
3120 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3122 char *endptr
, buf
[32];
3124 /* Check if it's possible to encode this value as a number */
3125 value
= strtoll(s
, &endptr
, 10);
3126 if (endptr
[0] != '\0') return 0;
3127 snprintf(buf
,32,"%lld",value
);
3129 /* If the number converted back into a string is not identical
3130 * then it's not possible to encode the string as integer */
3131 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3133 /* Finally check if it fits in our ranges */
3134 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3135 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3136 enc
[1] = value
&0xFF;
3138 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3139 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3140 enc
[1] = value
&0xFF;
3141 enc
[2] = (value
>>8)&0xFF;
3143 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3144 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3145 enc
[1] = value
&0xFF;
3146 enc
[2] = (value
>>8)&0xFF;
3147 enc
[3] = (value
>>16)&0xFF;
3148 enc
[4] = (value
>>24)&0xFF;
3155 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3156 size_t comprlen
, outlen
;
3160 /* We require at least four bytes compression for this to be worth it */
3161 if (len
<= 4) return 0;
3163 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3164 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3165 if (comprlen
== 0) {
3169 /* Data compressed! Let's save it on disk */
3170 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3171 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3172 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3173 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3174 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3183 /* Save a string objet as [len][data] on disk. If the object is a string
3184 * representation of an integer value we try to safe it in a special form */
3185 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3188 /* Try integer encoding */
3190 unsigned char buf
[5];
3191 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3192 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3197 /* Try LZF compression - under 20 bytes it's unable to compress even
3198 * aaaaaaaaaaaaaaaaaa so skip it */
3199 if (server
.rdbcompression
&& len
> 20) {
3202 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3203 if (retval
== -1) return -1;
3204 if (retval
> 0) return 0;
3205 /* retval == 0 means data can't be compressed, save the old way */
3208 /* Store verbatim */
3209 if (rdbSaveLen(fp
,len
) == -1) return -1;
3210 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3214 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3215 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3218 /* Avoid incr/decr ref count business when possible.
3219 * This plays well with copy-on-write given that we are probably
3220 * in a child process (BGSAVE). Also this makes sure key objects
3221 * of swapped objects are not incRefCount-ed (an assert does not allow
3222 * this in order to avoid bugs) */
3223 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3224 obj
= getDecodedObject(obj
);
3225 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3228 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3233 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3234 * 8 bit integer specifing the length of the representation.
3235 * This 8 bit integer has special values in order to specify the following
3241 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3242 unsigned char buf
[128];
3248 } else if (!isfinite(val
)) {
3250 buf
[0] = (val
< 0) ? 255 : 254;
3252 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3253 buf
[0] = strlen((char*)buf
+1);
3256 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3260 /* Save a Redis object. */
3261 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3262 if (o
->type
== REDIS_STRING
) {
3263 /* Save a string value */
3264 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3265 } else if (o
->type
== REDIS_LIST
) {
3266 /* Save a list value */
3267 list
*list
= o
->ptr
;
3271 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3272 listRewind(list
,&li
);
3273 while((ln
= listNext(&li
))) {
3274 robj
*eleobj
= listNodeValue(ln
);
3276 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3278 } else if (o
->type
== REDIS_SET
) {
3279 /* Save a set value */
3281 dictIterator
*di
= dictGetIterator(set
);
3284 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3285 while((de
= dictNext(di
)) != NULL
) {
3286 robj
*eleobj
= dictGetEntryKey(de
);
3288 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3290 dictReleaseIterator(di
);
3291 } else if (o
->type
== REDIS_ZSET
) {
3292 /* Save a set value */
3294 dictIterator
*di
= dictGetIterator(zs
->dict
);
3297 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3298 while((de
= dictNext(di
)) != NULL
) {
3299 robj
*eleobj
= dictGetEntryKey(de
);
3300 double *score
= dictGetEntryVal(de
);
3302 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3303 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3305 dictReleaseIterator(di
);
3306 } else if (o
->type
== REDIS_HASH
) {
3307 /* Save a hash value */
3308 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3309 unsigned char *p
= zipmapRewind(o
->ptr
);
3310 unsigned int count
= zipmapLen(o
->ptr
);
3311 unsigned char *key
, *val
;
3312 unsigned int klen
, vlen
;
3314 if (rdbSaveLen(fp
,count
) == -1) return -1;
3315 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3316 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3317 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3320 dictIterator
*di
= dictGetIterator(o
->ptr
);
3323 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3324 while((de
= dictNext(di
)) != NULL
) {
3325 robj
*key
= dictGetEntryKey(de
);
3326 robj
*val
= dictGetEntryVal(de
);
3328 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3329 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3331 dictReleaseIterator(di
);
3339 /* Return the length the object will have on disk if saved with
3340 * the rdbSaveObject() function. Currently we use a trick to get
3341 * this length with very little changes to the code. In the future
3342 * we could switch to a faster solution. */
3343 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3344 if (fp
== NULL
) fp
= server
.devnull
;
3346 assert(rdbSaveObject(fp
,o
) != 1);
3350 /* Return the number of pages required to save this object in the swap file */
3351 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3352 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3354 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3357 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3358 static int rdbSave(char *filename
) {
3359 dictIterator
*di
= NULL
;
3364 time_t now
= time(NULL
);
3366 /* Wait for I/O therads to terminate, just in case this is a
3367 * foreground-saving, to avoid seeking the swap file descriptor at the
3369 if (server
.vm_enabled
)
3370 waitEmptyIOJobsQueue();
3372 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3373 fp
= fopen(tmpfile
,"w");
3375 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3378 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3379 for (j
= 0; j
< server
.dbnum
; j
++) {
3380 redisDb
*db
= server
.db
+j
;
3382 if (dictSize(d
) == 0) continue;
3383 di
= dictGetIterator(d
);
3389 /* Write the SELECT DB opcode */
3390 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3391 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3393 /* Iterate this DB writing every entry */
3394 while((de
= dictNext(di
)) != NULL
) {
3395 robj
*key
= dictGetEntryKey(de
);
3396 robj
*o
= dictGetEntryVal(de
);
3397 time_t expiretime
= getExpire(db
,key
);
3399 /* Save the expire time */
3400 if (expiretime
!= -1) {
3401 /* If this key is already expired skip it */
3402 if (expiretime
< now
) continue;
3403 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3404 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3406 /* Save the key and associated value. This requires special
3407 * handling if the value is swapped out. */
3408 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3409 key
->storage
== REDIS_VM_SWAPPING
) {
3410 /* Save type, key, value */
3411 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3412 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3413 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3415 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3417 /* Get a preview of the object in memory */
3418 po
= vmPreviewObject(key
);
3419 /* Save type, key, value */
3420 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3421 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3422 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3423 /* Remove the loaded object from memory */
3427 dictReleaseIterator(di
);
3430 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3432 /* Make sure data will not remain on the OS's output buffers */
3437 /* Use RENAME to make sure the DB file is changed atomically only
3438 * if the generate DB file is ok. */
3439 if (rename(tmpfile
,filename
) == -1) {
3440 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3444 redisLog(REDIS_NOTICE
,"DB saved on disk");
3446 server
.lastsave
= time(NULL
);
3452 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3453 if (di
) dictReleaseIterator(di
);
3457 static int rdbSaveBackground(char *filename
) {
3460 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3461 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3462 if ((childpid
= fork()) == 0) {
3464 if (server
.vm_enabled
) vmReopenSwapFile();
3466 if (rdbSave(filename
) == REDIS_OK
) {
3473 if (childpid
== -1) {
3474 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3478 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3479 server
.bgsavechildpid
= childpid
;
3482 return REDIS_OK
; /* unreached */
3485 static void rdbRemoveTempFile(pid_t childpid
) {
3488 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3492 static int rdbLoadType(FILE *fp
) {
3494 if (fread(&type
,1,1,fp
) == 0) return -1;
3498 static time_t rdbLoadTime(FILE *fp
) {
3500 if (fread(&t32
,4,1,fp
) == 0) return -1;
3501 return (time_t) t32
;
3504 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3505 * of this file for a description of how this are stored on disk.
3507 * isencoded is set to 1 if the readed length is not actually a length but
3508 * an "encoding type", check the above comments for more info */
3509 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3510 unsigned char buf
[2];
3514 if (isencoded
) *isencoded
= 0;
3515 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3516 type
= (buf
[0]&0xC0)>>6;
3517 if (type
== REDIS_RDB_6BITLEN
) {
3518 /* Read a 6 bit len */
3520 } else if (type
== REDIS_RDB_ENCVAL
) {
3521 /* Read a 6 bit len encoding type */
3522 if (isencoded
) *isencoded
= 1;
3524 } else if (type
== REDIS_RDB_14BITLEN
) {
3525 /* Read a 14 bit len */
3526 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3527 return ((buf
[0]&0x3F)<<8)|buf
[1];
3529 /* Read a 32 bit len */
3530 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3535 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3536 unsigned char enc
[4];
3539 if (enctype
== REDIS_RDB_ENC_INT8
) {
3540 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3541 val
= (signed char)enc
[0];
3542 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3544 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3545 v
= enc
[0]|(enc
[1]<<8);
3547 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3549 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3550 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3553 val
= 0; /* anti-warning */
3556 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3559 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3560 unsigned int len
, clen
;
3561 unsigned char *c
= NULL
;
3564 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3565 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3566 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3567 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3568 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3569 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3571 return createObject(REDIS_STRING
,val
);
3578 static robj
*rdbLoadStringObject(FILE*fp
) {
3583 len
= rdbLoadLen(fp
,&isencoded
);
3586 case REDIS_RDB_ENC_INT8
:
3587 case REDIS_RDB_ENC_INT16
:
3588 case REDIS_RDB_ENC_INT32
:
3589 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3590 case REDIS_RDB_ENC_LZF
:
3591 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3597 if (len
== REDIS_RDB_LENERR
) return NULL
;
3598 val
= sdsnewlen(NULL
,len
);
3599 if (len
&& fread(val
,len
,1,fp
) == 0) {
3603 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3606 /* For information about double serialization check rdbSaveDoubleValue() */
3607 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3611 if (fread(&len
,1,1,fp
) == 0) return -1;
3613 case 255: *val
= R_NegInf
; return 0;
3614 case 254: *val
= R_PosInf
; return 0;
3615 case 253: *val
= R_Nan
; return 0;
3617 if (fread(buf
,len
,1,fp
) == 0) return -1;
3619 sscanf(buf
, "%lg", val
);
3624 /* Load a Redis object of the specified type from the specified file.
3625 * On success a newly allocated object is returned, otherwise NULL. */
3626 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3629 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3630 if (type
== REDIS_STRING
) {
3631 /* Read string value */
3632 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3633 tryObjectEncoding(o
);
3634 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3635 /* Read list/set value */
3638 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3639 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3640 /* It's faster to expand the dict to the right size asap in order
3641 * to avoid rehashing */
3642 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3643 dictExpand(o
->ptr
,listlen
);
3644 /* Load every single element of the list/set */
3648 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3649 tryObjectEncoding(ele
);
3650 if (type
== REDIS_LIST
) {
3651 listAddNodeTail((list
*)o
->ptr
,ele
);
3653 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3656 } else if (type
== REDIS_ZSET
) {
3657 /* Read list/set value */
3661 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3662 o
= createZsetObject();
3664 /* Load every single element of the list/set */
3667 double *score
= zmalloc(sizeof(double));
3669 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3670 tryObjectEncoding(ele
);
3671 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3672 dictAdd(zs
->dict
,ele
,score
);
3673 zslInsert(zs
->zsl
,*score
,ele
);
3674 incrRefCount(ele
); /* added to skiplist */
3676 } else if (type
== REDIS_HASH
) {
3679 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3680 o
= createHashObject();
3681 /* Too many entries? Use an hash table. */
3682 if (hashlen
> server
.hash_max_zipmap_entries
)
3683 convertToRealHash(o
);
3684 /* Load every key/value, then set it into the zipmap or hash
3685 * table, as needed. */
3689 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3690 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3691 /* If we are using a zipmap and there are too big values
3692 * the object is converted to real hash table encoding. */
3693 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3694 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3695 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3697 convertToRealHash(o
);
3700 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3701 unsigned char *zm
= o
->ptr
;
3703 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3704 val
->ptr
,sdslen(val
->ptr
),NULL
);
3709 tryObjectEncoding(key
);
3710 tryObjectEncoding(val
);
3711 dictAdd((dict
*)o
->ptr
,key
,val
);
3720 static int rdbLoad(char *filename
) {
3722 robj
*keyobj
= NULL
;
3724 int type
, retval
, rdbver
;
3725 dict
*d
= server
.db
[0].dict
;
3726 redisDb
*db
= server
.db
+0;
3728 time_t expiretime
= -1, now
= time(NULL
);
3729 long long loadedkeys
= 0;
3731 fp
= fopen(filename
,"r");
3732 if (!fp
) return REDIS_ERR
;
3733 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3735 if (memcmp(buf
,"REDIS",5) != 0) {
3737 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3740 rdbver
= atoi(buf
+5);
3743 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3750 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3751 if (type
== REDIS_EXPIRETIME
) {
3752 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3753 /* We read the time so we need to read the object type again */
3754 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3756 if (type
== REDIS_EOF
) break;
3757 /* Handle SELECT DB opcode as a special case */
3758 if (type
== REDIS_SELECTDB
) {
3759 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3761 if (dbid
>= (unsigned)server
.dbnum
) {
3762 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3765 db
= server
.db
+dbid
;
3770 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3772 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3773 /* Add the new object in the hash table */
3774 retval
= dictAdd(d
,keyobj
,o
);
3775 if (retval
== DICT_ERR
) {
3776 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3779 /* Set the expire time if needed */
3780 if (expiretime
!= -1) {
3781 setExpire(db
,keyobj
,expiretime
);
3782 /* Delete this key if already expired */
3783 if (expiretime
< now
) deleteKey(db
,keyobj
);
3787 /* Handle swapping while loading big datasets when VM is on */
3789 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3790 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3791 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3798 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3799 if (keyobj
) decrRefCount(keyobj
);
3800 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3802 return REDIS_ERR
; /* Just to avoid warning */
3805 /*================================== Commands =============================== */
3807 static void authCommand(redisClient
*c
) {
3808 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3809 c
->authenticated
= 1;
3810 addReply(c
,shared
.ok
);
3812 c
->authenticated
= 0;
3813 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3817 static void pingCommand(redisClient
*c
) {
3818 addReply(c
,shared
.pong
);
3821 static void echoCommand(redisClient
*c
) {
3822 addReplyBulk(c
,c
->argv
[1]);
3825 /*=================================== Strings =============================== */
3827 static void setGenericCommand(redisClient
*c
, int nx
) {
3830 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3831 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3832 if (retval
== DICT_ERR
) {
3834 /* If the key is about a swapped value, we want a new key object
3835 * to overwrite the old. So we delete the old key in the database.
3836 * This will also make sure that swap pages about the old object
3837 * will be marked as free. */
3838 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3839 incrRefCount(c
->argv
[1]);
3840 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3841 incrRefCount(c
->argv
[2]);
3843 addReply(c
,shared
.czero
);
3847 incrRefCount(c
->argv
[1]);
3848 incrRefCount(c
->argv
[2]);
3851 removeExpire(c
->db
,c
->argv
[1]);
3852 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3855 static void setCommand(redisClient
*c
) {
3856 setGenericCommand(c
,0);
3859 static void setnxCommand(redisClient
*c
) {
3860 setGenericCommand(c
,1);
3863 static int getGenericCommand(redisClient
*c
) {
3866 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3869 if (o
->type
!= REDIS_STRING
) {
3870 addReply(c
,shared
.wrongtypeerr
);
3878 static void getCommand(redisClient
*c
) {
3879 getGenericCommand(c
);
3882 static void getsetCommand(redisClient
*c
) {
3883 if (getGenericCommand(c
) == REDIS_ERR
) return;
3884 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3885 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3887 incrRefCount(c
->argv
[1]);
3889 incrRefCount(c
->argv
[2]);
3891 removeExpire(c
->db
,c
->argv
[1]);
3894 static void mgetCommand(redisClient
*c
) {
3897 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3898 for (j
= 1; j
< c
->argc
; j
++) {
3899 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3901 addReply(c
,shared
.nullbulk
);
3903 if (o
->type
!= REDIS_STRING
) {
3904 addReply(c
,shared
.nullbulk
);
3912 static void msetGenericCommand(redisClient
*c
, int nx
) {
3913 int j
, busykeys
= 0;
3915 if ((c
->argc
% 2) == 0) {
3916 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3919 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3920 * set nothing at all if at least one already key exists. */
3922 for (j
= 1; j
< c
->argc
; j
+= 2) {
3923 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3929 addReply(c
, shared
.czero
);
3933 for (j
= 1; j
< c
->argc
; j
+= 2) {
3936 tryObjectEncoding(c
->argv
[j
+1]);
3937 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3938 if (retval
== DICT_ERR
) {
3939 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3940 incrRefCount(c
->argv
[j
+1]);
3942 incrRefCount(c
->argv
[j
]);
3943 incrRefCount(c
->argv
[j
+1]);
3945 removeExpire(c
->db
,c
->argv
[j
]);
3947 server
.dirty
+= (c
->argc
-1)/2;
3948 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3951 static void msetCommand(redisClient
*c
) {
3952 msetGenericCommand(c
,0);
3955 static void msetnxCommand(redisClient
*c
) {
3956 msetGenericCommand(c
,1);
3959 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3964 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3968 if (o
->type
!= REDIS_STRING
) {
3973 if (o
->encoding
== REDIS_ENCODING_RAW
)
3974 value
= strtoll(o
->ptr
, &eptr
, 10);
3975 else if (o
->encoding
== REDIS_ENCODING_INT
)
3976 value
= (long)o
->ptr
;
3978 redisAssert(1 != 1);
3983 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3984 tryObjectEncoding(o
);
3985 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3986 if (retval
== DICT_ERR
) {
3987 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3988 removeExpire(c
->db
,c
->argv
[1]);
3990 incrRefCount(c
->argv
[1]);
3993 addReply(c
,shared
.colon
);
3995 addReply(c
,shared
.crlf
);
3998 static void incrCommand(redisClient
*c
) {
3999 incrDecrCommand(c
,1);
4002 static void decrCommand(redisClient
*c
) {
4003 incrDecrCommand(c
,-1);
4006 static void incrbyCommand(redisClient
*c
) {
4007 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4008 incrDecrCommand(c
,incr
);
4011 static void decrbyCommand(redisClient
*c
) {
4012 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4013 incrDecrCommand(c
,-incr
);
4016 static void appendCommand(redisClient
*c
) {
4021 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4023 /* Create the key */
4024 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4025 incrRefCount(c
->argv
[1]);
4026 incrRefCount(c
->argv
[2]);
4027 totlen
= stringObjectLen(c
->argv
[2]);
4031 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4034 o
= dictGetEntryVal(de
);
4035 if (o
->type
!= REDIS_STRING
) {
4036 addReply(c
,shared
.wrongtypeerr
);
4039 /* If the object is specially encoded or shared we have to make
4041 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4042 robj
*decoded
= getDecodedObject(o
);
4044 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4045 decrRefCount(decoded
);
4046 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4049 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4050 o
->ptr
= sdscatlen(o
->ptr
,
4051 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4053 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4054 (unsigned long) c
->argv
[2]->ptr
);
4056 totlen
= sdslen(o
->ptr
);
4059 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4062 static void substrCommand(redisClient
*c
) {
4064 long start
= atoi(c
->argv
[2]->ptr
);
4065 long end
= atoi(c
->argv
[3]->ptr
);
4066 size_t rangelen
, strlen
;
4069 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4070 checkType(c
,o
,REDIS_STRING
)) return;
4072 o
= getDecodedObject(o
);
4073 strlen
= sdslen(o
->ptr
);
4075 /* convert negative indexes */
4076 if (start
< 0) start
= strlen
+start
;
4077 if (end
< 0) end
= strlen
+end
;
4078 if (start
< 0) start
= 0;
4079 if (end
< 0) end
= 0;
4081 /* indexes sanity checks */
4082 if (start
> end
|| (size_t)start
>= strlen
) {
4083 /* Out of range start or start > end result in null reply */
4084 addReply(c
,shared
.nullbulk
);
4088 if ((size_t)end
>= strlen
) end
= strlen
-1;
4089 rangelen
= (end
-start
)+1;
4091 /* Return the result */
4092 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4093 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4094 addReplySds(c
,range
);
4095 addReply(c
,shared
.crlf
);
4099 /* ========================= Type agnostic commands ========================= */
4101 static void delCommand(redisClient
*c
) {
4104 for (j
= 1; j
< c
->argc
; j
++) {
4105 if (deleteKey(c
->db
,c
->argv
[j
])) {
4110 addReplyLong(c
,deleted
);
4113 static void existsCommand(redisClient
*c
) {
4114 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4117 static void selectCommand(redisClient
*c
) {
4118 int id
= atoi(c
->argv
[1]->ptr
);
4120 if (selectDb(c
,id
) == REDIS_ERR
) {
4121 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4123 addReply(c
,shared
.ok
);
4127 static void randomkeyCommand(redisClient
*c
) {
4131 de
= dictGetRandomKey(c
->db
->dict
);
4132 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4135 addReply(c
,shared
.plus
);
4136 addReply(c
,shared
.crlf
);
4138 addReply(c
,shared
.plus
);
4139 addReply(c
,dictGetEntryKey(de
));
4140 addReply(c
,shared
.crlf
);
4144 static void keysCommand(redisClient
*c
) {
4147 sds pattern
= c
->argv
[1]->ptr
;
4148 int plen
= sdslen(pattern
);
4149 unsigned long numkeys
= 0;
4150 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4152 di
= dictGetIterator(c
->db
->dict
);
4154 decrRefCount(lenobj
);
4155 while((de
= dictNext(di
)) != NULL
) {
4156 robj
*keyobj
= dictGetEntryKey(de
);
4158 sds key
= keyobj
->ptr
;
4159 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4160 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4161 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4162 addReplyBulk(c
,keyobj
);
4167 dictReleaseIterator(di
);
4168 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4171 static void dbsizeCommand(redisClient
*c
) {
4173 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4176 static void lastsaveCommand(redisClient
*c
) {
4178 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4181 static void typeCommand(redisClient
*c
) {
4185 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4190 case REDIS_STRING
: type
= "+string"; break;
4191 case REDIS_LIST
: type
= "+list"; break;
4192 case REDIS_SET
: type
= "+set"; break;
4193 case REDIS_ZSET
: type
= "+zset"; break;
4194 case REDIS_HASH
: type
= "+hash"; break;
4195 default: type
= "+unknown"; break;
4198 addReplySds(c
,sdsnew(type
));
4199 addReply(c
,shared
.crlf
);
4202 static void saveCommand(redisClient
*c
) {
4203 if (server
.bgsavechildpid
!= -1) {
4204 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4207 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4208 addReply(c
,shared
.ok
);
4210 addReply(c
,shared
.err
);
4214 static void bgsaveCommand(redisClient
*c
) {
4215 if (server
.bgsavechildpid
!= -1) {
4216 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4219 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4220 char *status
= "+Background saving started\r\n";
4221 addReplySds(c
,sdsnew(status
));
4223 addReply(c
,shared
.err
);
4227 static void shutdownCommand(redisClient
*c
) {
4228 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4229 /* Kill the saving child if there is a background saving in progress.
4230 We want to avoid race conditions, for instance our saving child may
4231 overwrite the synchronous saving did by SHUTDOWN. */
4232 if (server
.bgsavechildpid
!= -1) {
4233 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4234 kill(server
.bgsavechildpid
,SIGKILL
);
4235 rdbRemoveTempFile(server
.bgsavechildpid
);
4237 if (server
.appendonly
) {
4238 /* Append only file: fsync() the AOF and exit */
4239 fsync(server
.appendfd
);
4240 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4243 /* Snapshotting. Perform a SYNC SAVE and exit */
4244 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4245 if (server
.daemonize
)
4246 unlink(server
.pidfile
);
4247 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4248 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4249 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4252 /* Ooops.. error saving! The best we can do is to continue
4253 * operating. Note that if there was a background saving process,
4254 * in the next cron() Redis will be notified that the background
4255 * saving aborted, handling special stuff like slaves pending for
4256 * synchronization... */
4257 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4259 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4264 static void renameGenericCommand(redisClient
*c
, int nx
) {
4267 /* To use the same key as src and dst is probably an error */
4268 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4269 addReply(c
,shared
.sameobjecterr
);
4273 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4277 deleteIfVolatile(c
->db
,c
->argv
[2]);
4278 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4281 addReply(c
,shared
.czero
);
4284 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4286 incrRefCount(c
->argv
[2]);
4288 deleteKey(c
->db
,c
->argv
[1]);
4290 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4293 static void renameCommand(redisClient
*c
) {
4294 renameGenericCommand(c
,0);
4297 static void renamenxCommand(redisClient
*c
) {
4298 renameGenericCommand(c
,1);
4301 static void moveCommand(redisClient
*c
) {
4306 /* Obtain source and target DB pointers */
4309 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4310 addReply(c
,shared
.outofrangeerr
);
4314 selectDb(c
,srcid
); /* Back to the source DB */
4316 /* If the user is moving using as target the same
4317 * DB as the source DB it is probably an error. */
4319 addReply(c
,shared
.sameobjecterr
);
4323 /* Check if the element exists and get a reference */
4324 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4326 addReply(c
,shared
.czero
);
4330 /* Try to add the element to the target DB */
4331 deleteIfVolatile(dst
,c
->argv
[1]);
4332 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4333 addReply(c
,shared
.czero
);
4336 incrRefCount(c
->argv
[1]);
4339 /* OK! key moved, free the entry in the source DB */
4340 deleteKey(src
,c
->argv
[1]);
4342 addReply(c
,shared
.cone
);
4345 /* =================================== Lists ================================ */
4346 static void pushGenericCommand(redisClient
*c
, int where
) {
4350 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4352 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4353 addReply(c
,shared
.cone
);
4356 lobj
= createListObject();
4358 if (where
== REDIS_HEAD
) {
4359 listAddNodeHead(list
,c
->argv
[2]);
4361 listAddNodeTail(list
,c
->argv
[2]);
4363 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4364 incrRefCount(c
->argv
[1]);
4365 incrRefCount(c
->argv
[2]);
4367 if (lobj
->type
!= REDIS_LIST
) {
4368 addReply(c
,shared
.wrongtypeerr
);
4371 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4372 addReply(c
,shared
.cone
);
4376 if (where
== REDIS_HEAD
) {
4377 listAddNodeHead(list
,c
->argv
[2]);
4379 listAddNodeTail(list
,c
->argv
[2]);
4381 incrRefCount(c
->argv
[2]);
4384 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4387 static void lpushCommand(redisClient
*c
) {
4388 pushGenericCommand(c
,REDIS_HEAD
);
4391 static void rpushCommand(redisClient
*c
) {
4392 pushGenericCommand(c
,REDIS_TAIL
);
4395 static void llenCommand(redisClient
*c
) {
4399 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4400 checkType(c
,o
,REDIS_LIST
)) return;
4403 addReplyUlong(c
,listLength(l
));
4406 static void lindexCommand(redisClient
*c
) {
4408 int index
= atoi(c
->argv
[2]->ptr
);
4412 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4413 checkType(c
,o
,REDIS_LIST
)) return;
4416 ln
= listIndex(list
, index
);
4418 addReply(c
,shared
.nullbulk
);
4420 robj
*ele
= listNodeValue(ln
);
4421 addReplyBulk(c
,ele
);
4425 static void lsetCommand(redisClient
*c
) {
4427 int index
= atoi(c
->argv
[2]->ptr
);
4431 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4432 checkType(c
,o
,REDIS_LIST
)) return;
4435 ln
= listIndex(list
, index
);
4437 addReply(c
,shared
.outofrangeerr
);
4439 robj
*ele
= listNodeValue(ln
);
4442 listNodeValue(ln
) = c
->argv
[3];
4443 incrRefCount(c
->argv
[3]);
4444 addReply(c
,shared
.ok
);
4449 static void popGenericCommand(redisClient
*c
, int where
) {
4454 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4455 checkType(c
,o
,REDIS_LIST
)) return;
4458 if (where
== REDIS_HEAD
)
4459 ln
= listFirst(list
);
4461 ln
= listLast(list
);
4464 addReply(c
,shared
.nullbulk
);
4466 robj
*ele
= listNodeValue(ln
);
4467 addReplyBulk(c
,ele
);
4468 listDelNode(list
,ln
);
4469 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4474 static void lpopCommand(redisClient
*c
) {
4475 popGenericCommand(c
,REDIS_HEAD
);
4478 static void rpopCommand(redisClient
*c
) {
4479 popGenericCommand(c
,REDIS_TAIL
);
4482 static void lrangeCommand(redisClient
*c
) {
4484 int start
= atoi(c
->argv
[2]->ptr
);
4485 int end
= atoi(c
->argv
[3]->ptr
);
4492 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4493 checkType(c
,o
,REDIS_LIST
)) return;
4495 llen
= listLength(list
);
4497 /* convert negative indexes */
4498 if (start
< 0) start
= llen
+start
;
4499 if (end
< 0) end
= llen
+end
;
4500 if (start
< 0) start
= 0;
4501 if (end
< 0) end
= 0;
4503 /* indexes sanity checks */
4504 if (start
> end
|| start
>= llen
) {
4505 /* Out of range start or start > end result in empty list */
4506 addReply(c
,shared
.emptymultibulk
);
4509 if (end
>= llen
) end
= llen
-1;
4510 rangelen
= (end
-start
)+1;
4512 /* Return the result in form of a multi-bulk reply */
4513 ln
= listIndex(list
, start
);
4514 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4515 for (j
= 0; j
< rangelen
; j
++) {
4516 ele
= listNodeValue(ln
);
4517 addReplyBulk(c
,ele
);
4522 static void ltrimCommand(redisClient
*c
) {
4524 int start
= atoi(c
->argv
[2]->ptr
);
4525 int end
= atoi(c
->argv
[3]->ptr
);
4527 int j
, ltrim
, rtrim
;
4531 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4532 checkType(c
,o
,REDIS_LIST
)) return;
4534 llen
= listLength(list
);
4536 /* convert negative indexes */
4537 if (start
< 0) start
= llen
+start
;
4538 if (end
< 0) end
= llen
+end
;
4539 if (start
< 0) start
= 0;
4540 if (end
< 0) end
= 0;
4542 /* indexes sanity checks */
4543 if (start
> end
|| start
>= llen
) {
4544 /* Out of range start or start > end result in empty list */
4548 if (end
>= llen
) end
= llen
-1;
4553 /* Remove list elements to perform the trim */
4554 for (j
= 0; j
< ltrim
; j
++) {
4555 ln
= listFirst(list
);
4556 listDelNode(list
,ln
);
4558 for (j
= 0; j
< rtrim
; j
++) {
4559 ln
= listLast(list
);
4560 listDelNode(list
,ln
);
4562 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4564 addReply(c
,shared
.ok
);
4567 static void lremCommand(redisClient
*c
) {
4570 listNode
*ln
, *next
;
4571 int toremove
= atoi(c
->argv
[2]->ptr
);
4575 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4576 checkType(c
,o
,REDIS_LIST
)) return;
4580 toremove
= -toremove
;
4583 ln
= fromtail
? list
->tail
: list
->head
;
4585 robj
*ele
= listNodeValue(ln
);
4587 next
= fromtail
? ln
->prev
: ln
->next
;
4588 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4589 listDelNode(list
,ln
);
4592 if (toremove
&& removed
== toremove
) break;
4596 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4597 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4600 /* This is the semantic of this command:
4601 * RPOPLPUSH srclist dstlist:
4602 * IF LLEN(srclist) > 0
4603 * element = RPOP srclist
4604 * LPUSH dstlist element
4611 * The idea is to be able to get an element from a list in a reliable way
4612 * since the element is not just returned but pushed against another list
4613 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4615 static void rpoplpushcommand(redisClient
*c
) {
4620 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4621 checkType(c
,sobj
,REDIS_LIST
)) return;
4622 srclist
= sobj
->ptr
;
4623 ln
= listLast(srclist
);
4626 addReply(c
,shared
.nullbulk
);
4628 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4629 robj
*ele
= listNodeValue(ln
);
4632 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4633 addReply(c
,shared
.wrongtypeerr
);
4637 /* Add the element to the target list (unless it's directly
4638 * passed to some BLPOP-ing client */
4639 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4641 /* Create the list if the key does not exist */
4642 dobj
= createListObject();
4643 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4644 incrRefCount(c
->argv
[2]);
4646 dstlist
= dobj
->ptr
;
4647 listAddNodeHead(dstlist
,ele
);
4651 /* Send the element to the client as reply as well */
4652 addReplyBulk(c
,ele
);
4654 /* Finally remove the element from the source list */
4655 listDelNode(srclist
,ln
);
4656 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4661 /* ==================================== Sets ================================ */
4663 static void saddCommand(redisClient
*c
) {
4666 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4668 set
= createSetObject();
4669 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4670 incrRefCount(c
->argv
[1]);
4672 if (set
->type
!= REDIS_SET
) {
4673 addReply(c
,shared
.wrongtypeerr
);
4677 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4678 incrRefCount(c
->argv
[2]);
4680 addReply(c
,shared
.cone
);
4682 addReply(c
,shared
.czero
);
4686 static void sremCommand(redisClient
*c
) {
4689 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4690 checkType(c
,set
,REDIS_SET
)) return;
4692 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4694 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4695 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4696 addReply(c
,shared
.cone
);
4698 addReply(c
,shared
.czero
);
4702 static void smoveCommand(redisClient
*c
) {
4703 robj
*srcset
, *dstset
;
4705 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4706 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4708 /* If the source key does not exist return 0, if it's of the wrong type
4710 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4711 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4714 /* Error if the destination key is not a set as well */
4715 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4716 addReply(c
,shared
.wrongtypeerr
);
4719 /* Remove the element from the source set */
4720 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4721 /* Key not found in the src set! return zero */
4722 addReply(c
,shared
.czero
);
4725 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4726 deleteKey(c
->db
,c
->argv
[1]);
4728 /* Add the element to the destination set */
4730 dstset
= createSetObject();
4731 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4732 incrRefCount(c
->argv
[2]);
4734 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4735 incrRefCount(c
->argv
[3]);
4736 addReply(c
,shared
.cone
);
4739 static void sismemberCommand(redisClient
*c
) {
4742 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4743 checkType(c
,set
,REDIS_SET
)) return;
4745 if (dictFind(set
->ptr
,c
->argv
[2]))
4746 addReply(c
,shared
.cone
);
4748 addReply(c
,shared
.czero
);
4751 static void scardCommand(redisClient
*c
) {
4755 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4756 checkType(c
,o
,REDIS_SET
)) return;
4759 addReplyUlong(c
,dictSize(s
));
4762 static void spopCommand(redisClient
*c
) {
4766 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4767 checkType(c
,set
,REDIS_SET
)) return;
4769 de
= dictGetRandomKey(set
->ptr
);
4771 addReply(c
,shared
.nullbulk
);
4773 robj
*ele
= dictGetEntryKey(de
);
4775 addReplyBulk(c
,ele
);
4776 dictDelete(set
->ptr
,ele
);
4777 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4778 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4783 static void srandmemberCommand(redisClient
*c
) {
4787 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4788 checkType(c
,set
,REDIS_SET
)) return;
4790 de
= dictGetRandomKey(set
->ptr
);
4792 addReply(c
,shared
.nullbulk
);
4794 robj
*ele
= dictGetEntryKey(de
);
4796 addReplyBulk(c
,ele
);
4800 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4801 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4803 return dictSize(*d1
)-dictSize(*d2
);
4806 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4807 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4810 robj
*lenobj
= NULL
, *dstset
= NULL
;
4811 unsigned long j
, cardinality
= 0;
4813 for (j
= 0; j
< setsnum
; j
++) {
4817 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4818 lookupKeyRead(c
->db
,setskeys
[j
]);
4822 if (deleteKey(c
->db
,dstkey
))
4824 addReply(c
,shared
.czero
);
4826 addReply(c
,shared
.nullmultibulk
);
4830 if (setobj
->type
!= REDIS_SET
) {
4832 addReply(c
,shared
.wrongtypeerr
);
4835 dv
[j
] = setobj
->ptr
;
4837 /* Sort sets from the smallest to largest, this will improve our
4838 * algorithm's performace */
4839 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4841 /* The first thing we should output is the total number of elements...
4842 * since this is a multi-bulk write, but at this stage we don't know
4843 * the intersection set size, so we use a trick, append an empty object
4844 * to the output list and save the pointer to later modify it with the
4847 lenobj
= createObject(REDIS_STRING
,NULL
);
4849 decrRefCount(lenobj
);
4851 /* If we have a target key where to store the resulting set
4852 * create this key with an empty set inside */
4853 dstset
= createSetObject();
4856 /* Iterate all the elements of the first (smallest) set, and test
4857 * the element against all the other sets, if at least one set does
4858 * not include the element it is discarded */
4859 di
= dictGetIterator(dv
[0]);
4861 while((de
= dictNext(di
)) != NULL
) {
4864 for (j
= 1; j
< setsnum
; j
++)
4865 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4867 continue; /* at least one set does not contain the member */
4868 ele
= dictGetEntryKey(de
);
4870 addReplyBulk(c
,ele
);
4873 dictAdd(dstset
->ptr
,ele
,NULL
);
4877 dictReleaseIterator(di
);
4880 /* Store the resulting set into the target, if the intersection
4881 * is not an empty set. */
4882 deleteKey(c
->db
,dstkey
);
4883 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4884 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4885 incrRefCount(dstkey
);
4886 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4888 decrRefCount(dstset
);
4889 addReply(c
,shared
.czero
);
4893 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4898 static void sinterCommand(redisClient
*c
) {
4899 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4902 static void sinterstoreCommand(redisClient
*c
) {
4903 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4906 #define REDIS_OP_UNION 0
4907 #define REDIS_OP_DIFF 1
4908 #define REDIS_OP_INTER 2
4910 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4911 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4914 robj
*dstset
= NULL
;
4915 int j
, cardinality
= 0;
4917 for (j
= 0; j
< setsnum
; j
++) {
4921 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4922 lookupKeyRead(c
->db
,setskeys
[j
]);
4927 if (setobj
->type
!= REDIS_SET
) {
4929 addReply(c
,shared
.wrongtypeerr
);
4932 dv
[j
] = setobj
->ptr
;
4935 /* We need a temp set object to store our union. If the dstkey
4936 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4937 * this set object will be the resulting object to set into the target key*/
4938 dstset
= createSetObject();
4940 /* Iterate all the elements of all the sets, add every element a single
4941 * time to the result set */
4942 for (j
= 0; j
< setsnum
; j
++) {
4943 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4944 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4946 di
= dictGetIterator(dv
[j
]);
4948 while((de
= dictNext(di
)) != NULL
) {
4951 /* dictAdd will not add the same element multiple times */
4952 ele
= dictGetEntryKey(de
);
4953 if (op
== REDIS_OP_UNION
|| j
== 0) {
4954 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4958 } else if (op
== REDIS_OP_DIFF
) {
4959 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4964 dictReleaseIterator(di
);
4966 /* result set is empty? Exit asap. */
4967 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
4970 /* Output the content of the resulting set, if not in STORE mode */
4972 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4973 di
= dictGetIterator(dstset
->ptr
);
4974 while((de
= dictNext(di
)) != NULL
) {
4977 ele
= dictGetEntryKey(de
);
4978 addReplyBulk(c
,ele
);
4980 dictReleaseIterator(di
);
4981 decrRefCount(dstset
);
4983 /* If we have a target key where to store the resulting set
4984 * create this key with the result set inside */
4985 deleteKey(c
->db
,dstkey
);
4986 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4987 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4988 incrRefCount(dstkey
);
4989 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4991 decrRefCount(dstset
);
4992 addReply(c
,shared
.czero
);
4999 static void sunionCommand(redisClient
*c
) {
5000 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5003 static void sunionstoreCommand(redisClient
*c
) {
5004 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5007 static void sdiffCommand(redisClient
*c
) {
5008 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5011 static void sdiffstoreCommand(redisClient
*c
) {
5012 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5015 /* ==================================== ZSets =============================== */
5017 /* ZSETs are ordered sets using two data structures to hold the same elements
5018 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5021 * The elements are added to an hash table mapping Redis objects to scores.
5022 * At the same time the elements are added to a skip list mapping scores
5023 * to Redis objects (so objects are sorted by scores in this "view"). */
5025 /* This skiplist implementation is almost a C translation of the original
5026 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5027 * Alternative to Balanced Trees", modified in three ways:
5028 * a) this implementation allows for repeated values.
5029 * b) the comparison is not just by key (our 'score') but by satellite data.
5030 * c) there is a back pointer, so it's a doubly linked list with the back
5031 * pointers being only at "level 1". This allows to traverse the list
5032 * from tail to head, useful for ZREVRANGE. */
5034 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5035 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5037 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5039 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5045 static zskiplist
*zslCreate(void) {
5049 zsl
= zmalloc(sizeof(*zsl
));
5052 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5053 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5054 zsl
->header
->forward
[j
] = NULL
;
5056 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5057 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5058 zsl
->header
->span
[j
] = 0;
5060 zsl
->header
->backward
= NULL
;
5065 static void zslFreeNode(zskiplistNode
*node
) {
5066 decrRefCount(node
->obj
);
5067 zfree(node
->forward
);
5072 static void zslFree(zskiplist
*zsl
) {
5073 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5075 zfree(zsl
->header
->forward
);
5076 zfree(zsl
->header
->span
);
5079 next
= node
->forward
[0];
5086 static int zslRandomLevel(void) {
5088 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5093 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5094 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5095 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5099 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5100 /* store rank that is crossed to reach the insert position */
5101 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5103 while (x
->forward
[i
] &&
5104 (x
->forward
[i
]->score
< score
||
5105 (x
->forward
[i
]->score
== score
&&
5106 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5107 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5112 /* we assume the key is not already inside, since we allow duplicated
5113 * scores, and the re-insertion of score and redis object should never
5114 * happpen since the caller of zslInsert() should test in the hash table
5115 * if the element is already inside or not. */
5116 level
= zslRandomLevel();
5117 if (level
> zsl
->level
) {
5118 for (i
= zsl
->level
; i
< level
; i
++) {
5120 update
[i
] = zsl
->header
;
5121 update
[i
]->span
[i
-1] = zsl
->length
;
5125 x
= zslCreateNode(level
,score
,obj
);
5126 for (i
= 0; i
< level
; i
++) {
5127 x
->forward
[i
] = update
[i
]->forward
[i
];
5128 update
[i
]->forward
[i
] = x
;
5130 /* update span covered by update[i] as x is inserted here */
5132 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5133 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5137 /* increment span for untouched levels */
5138 for (i
= level
; i
< zsl
->level
; i
++) {
5139 update
[i
]->span
[i
-1]++;
5142 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5144 x
->forward
[0]->backward
= x
;
5150 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5151 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5153 for (i
= 0; i
< zsl
->level
; i
++) {
5154 if (update
[i
]->forward
[i
] == x
) {
5156 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5158 update
[i
]->forward
[i
] = x
->forward
[i
];
5160 /* invariant: i > 0, because update[0]->forward[0]
5161 * is always equal to x */
5162 update
[i
]->span
[i
-1] -= 1;
5165 if (x
->forward
[0]) {
5166 x
->forward
[0]->backward
= x
->backward
;
5168 zsl
->tail
= x
->backward
;
5170 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5175 /* Delete an element with matching score/object from the skiplist. */
5176 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5177 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5181 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5182 while (x
->forward
[i
] &&
5183 (x
->forward
[i
]->score
< score
||
5184 (x
->forward
[i
]->score
== score
&&
5185 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5189 /* We may have multiple elements with the same score, what we need
5190 * is to find the element with both the right score and object. */
5192 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5193 zslDeleteNode(zsl
, x
, update
);
5197 return 0; /* not found */
5199 return 0; /* not found */
5202 /* Delete all the elements with score between min and max from the skiplist.
5203 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5204 * Note that this function takes the reference to the hash table view of the
5205 * sorted set, in order to remove the elements from the hash table too. */
5206 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5207 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5208 unsigned long removed
= 0;
5212 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5213 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5217 /* We may have multiple elements with the same score, what we need
5218 * is to find the element with both the right score and object. */
5220 while (x
&& x
->score
<= max
) {
5221 zskiplistNode
*next
= x
->forward
[0];
5222 zslDeleteNode(zsl
, x
, update
);
5223 dictDelete(dict
,x
->obj
);
5228 return removed
; /* not found */
5231 /* Delete all the elements with rank between start and end from the skiplist.
5232 * Start and end are inclusive. Note that start and end need to be 1-based */
5233 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5234 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5235 unsigned long traversed
= 0, removed
= 0;
5239 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5240 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5241 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5249 while (x
&& traversed
<= end
) {
5250 zskiplistNode
*next
= x
->forward
[0];
5251 zslDeleteNode(zsl
, x
, update
);
5252 dictDelete(dict
,x
->obj
);
5261 /* Find the first node having a score equal or greater than the specified one.
5262 * Returns NULL if there is no match. */
5263 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5268 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5269 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5272 /* We may have multiple elements with the same score, what we need
5273 * is to find the element with both the right score and object. */
5274 return x
->forward
[0];
5277 /* Find the rank for an element by both score and key.
5278 * Returns 0 when the element cannot be found, rank otherwise.
5279 * Note that the rank is 1-based due to the span of zsl->header to the
5281 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5283 unsigned long rank
= 0;
5287 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5288 while (x
->forward
[i
] &&
5289 (x
->forward
[i
]->score
< score
||
5290 (x
->forward
[i
]->score
== score
&&
5291 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5292 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5296 /* x might be equal to zsl->header, so test if obj is non-NULL */
5297 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5304 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5305 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5307 unsigned long traversed
= 0;
5311 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5312 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5314 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5317 if (traversed
== rank
) {
5324 /* The actual Z-commands implementations */
5326 /* This generic command implements both ZADD and ZINCRBY.
5327 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5328 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5329 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5334 zsetobj
= lookupKeyWrite(c
->db
,key
);
5335 if (zsetobj
== NULL
) {
5336 zsetobj
= createZsetObject();
5337 dictAdd(c
->db
->dict
,key
,zsetobj
);
5340 if (zsetobj
->type
!= REDIS_ZSET
) {
5341 addReply(c
,shared
.wrongtypeerr
);
5347 /* Ok now since we implement both ZADD and ZINCRBY here the code
5348 * needs to handle the two different conditions. It's all about setting
5349 * '*score', that is, the new score to set, to the right value. */
5350 score
= zmalloc(sizeof(double));
5354 /* Read the old score. If the element was not present starts from 0 */
5355 de
= dictFind(zs
->dict
,ele
);
5357 double *oldscore
= dictGetEntryVal(de
);
5358 *score
= *oldscore
+ scoreval
;
5366 /* What follows is a simple remove and re-insert operation that is common
5367 * to both ZADD and ZINCRBY... */
5368 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5369 /* case 1: New element */
5370 incrRefCount(ele
); /* added to hash */
5371 zslInsert(zs
->zsl
,*score
,ele
);
5372 incrRefCount(ele
); /* added to skiplist */
5375 addReplyDouble(c
,*score
);
5377 addReply(c
,shared
.cone
);
5382 /* case 2: Score update operation */
5383 de
= dictFind(zs
->dict
,ele
);
5384 redisAssert(de
!= NULL
);
5385 oldscore
= dictGetEntryVal(de
);
5386 if (*score
!= *oldscore
) {
5389 /* Remove and insert the element in the skip list with new score */
5390 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5391 redisAssert(deleted
!= 0);
5392 zslInsert(zs
->zsl
,*score
,ele
);
5394 /* Update the score in the hash table */
5395 dictReplace(zs
->dict
,ele
,score
);
5401 addReplyDouble(c
,*score
);
5403 addReply(c
,shared
.czero
);
5407 static void zaddCommand(redisClient
*c
) {
5410 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5411 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5414 static void zincrbyCommand(redisClient
*c
) {
5417 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5418 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5421 static void zremCommand(redisClient
*c
) {
5428 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5429 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5432 de
= dictFind(zs
->dict
,c
->argv
[2]);
5434 addReply(c
,shared
.czero
);
5437 /* Delete from the skiplist */
5438 oldscore
= dictGetEntryVal(de
);
5439 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5440 redisAssert(deleted
!= 0);
5442 /* Delete from the hash table */
5443 dictDelete(zs
->dict
,c
->argv
[2]);
5444 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5445 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5447 addReply(c
,shared
.cone
);
5450 static void zremrangebyscoreCommand(redisClient
*c
) {
5451 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5452 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5457 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5458 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5461 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5462 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5463 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5464 server
.dirty
+= deleted
;
5465 addReplyLong(c
,deleted
);
5468 static void zremrangebyrankCommand(redisClient
*c
) {
5469 int start
= atoi(c
->argv
[2]->ptr
);
5470 int end
= atoi(c
->argv
[3]->ptr
);
5476 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5477 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5479 llen
= zs
->zsl
->length
;
5481 /* convert negative indexes */
5482 if (start
< 0) start
= llen
+start
;
5483 if (end
< 0) end
= llen
+end
;
5484 if (start
< 0) start
= 0;
5485 if (end
< 0) end
= 0;
5487 /* indexes sanity checks */
5488 if (start
> end
|| start
>= llen
) {
5489 addReply(c
,shared
.czero
);
5492 if (end
>= llen
) end
= llen
-1;
5494 /* increment start and end because zsl*Rank functions
5495 * use 1-based rank */
5496 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5497 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5498 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5499 server
.dirty
+= deleted
;
5500 addReplyLong(c
, deleted
);
5508 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5509 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5510 unsigned long size1
, size2
;
5511 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5512 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5513 return size1
- size2
;
5516 #define REDIS_AGGR_SUM 1
5517 #define REDIS_AGGR_MIN 2
5518 #define REDIS_AGGR_MAX 3
5520 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5521 if (aggregate
== REDIS_AGGR_SUM
) {
5522 *target
= *target
+ val
;
5523 } else if (aggregate
== REDIS_AGGR_MIN
) {
5524 *target
= val
< *target
? val
: *target
;
5525 } else if (aggregate
== REDIS_AGGR_MAX
) {
5526 *target
= val
> *target
? val
: *target
;
5529 redisAssert(0 != 0);
5533 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5535 int aggregate
= REDIS_AGGR_SUM
;
5542 /* expect zsetnum input keys to be given */
5543 zsetnum
= atoi(c
->argv
[2]->ptr
);
5545 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5549 /* test if the expected number of keys would overflow */
5550 if (3+zsetnum
> c
->argc
) {
5551 addReply(c
,shared
.syntaxerr
);
5555 /* read keys to be used for input */
5556 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5557 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5558 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5562 if (zsetobj
->type
!= REDIS_ZSET
) {
5564 addReply(c
,shared
.wrongtypeerr
);
5567 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5570 /* default all weights to 1 */
5571 src
[i
].weight
= 1.0;
5574 /* parse optional extra arguments */
5576 int remaining
= c
->argc
- j
;
5579 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5581 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5582 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5584 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5586 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5587 aggregate
= REDIS_AGGR_SUM
;
5588 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5589 aggregate
= REDIS_AGGR_MIN
;
5590 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5591 aggregate
= REDIS_AGGR_MAX
;
5594 addReply(c
,shared
.syntaxerr
);
5600 addReply(c
,shared
.syntaxerr
);
5606 /* sort sets from the smallest to largest, this will improve our
5607 * algorithm's performance */
5608 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5610 dstobj
= createZsetObject();
5611 dstzset
= dstobj
->ptr
;
5613 if (op
== REDIS_OP_INTER
) {
5614 /* skip going over all entries if the smallest zset is NULL or empty */
5615 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5616 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5617 * from small to large, all src[i > 0].dict are non-empty too */
5618 di
= dictGetIterator(src
[0].dict
);
5619 while((de
= dictNext(di
)) != NULL
) {
5620 double *score
= zmalloc(sizeof(double)), value
;
5621 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5623 for (j
= 1; j
< zsetnum
; j
++) {
5624 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5626 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5627 zunionInterAggregate(score
, value
, aggregate
);
5633 /* skip entry when not present in every source dict */
5637 robj
*o
= dictGetEntryKey(de
);
5638 dictAdd(dstzset
->dict
,o
,score
);
5639 incrRefCount(o
); /* added to dictionary */
5640 zslInsert(dstzset
->zsl
,*score
,o
);
5641 incrRefCount(o
); /* added to skiplist */
5644 dictReleaseIterator(di
);
5646 } else if (op
== REDIS_OP_UNION
) {
5647 for (i
= 0; i
< zsetnum
; i
++) {
5648 if (!src
[i
].dict
) continue;
5650 di
= dictGetIterator(src
[i
].dict
);
5651 while((de
= dictNext(di
)) != NULL
) {
5652 /* skip key when already processed */
5653 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5655 double *score
= zmalloc(sizeof(double)), value
;
5656 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5658 /* because the zsets are sorted by size, its only possible
5659 * for sets at larger indices to hold this entry */
5660 for (j
= (i
+1); j
< zsetnum
; j
++) {
5661 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5663 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5664 zunionInterAggregate(score
, value
, aggregate
);
5668 robj
*o
= dictGetEntryKey(de
);
5669 dictAdd(dstzset
->dict
,o
,score
);
5670 incrRefCount(o
); /* added to dictionary */
5671 zslInsert(dstzset
->zsl
,*score
,o
);
5672 incrRefCount(o
); /* added to skiplist */
5674 dictReleaseIterator(di
);
5677 /* unknown operator */
5678 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5681 deleteKey(c
->db
,dstkey
);
5682 if (dstzset
->zsl
->length
) {
5683 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5684 incrRefCount(dstkey
);
5685 addReplyLong(c
, dstzset
->zsl
->length
);
5688 decrRefCount(dstobj
);
5689 addReply(c
, shared
.czero
);
5694 static void zunionCommand(redisClient
*c
) {
5695 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5698 static void zinterCommand(redisClient
*c
) {
5699 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5702 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5704 int start
= atoi(c
->argv
[2]->ptr
);
5705 int end
= atoi(c
->argv
[3]->ptr
);
5714 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5716 } else if (c
->argc
>= 5) {
5717 addReply(c
,shared
.syntaxerr
);
5721 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5722 checkType(c
,o
,REDIS_ZSET
)) return;
5727 /* convert negative indexes */
5728 if (start
< 0) start
= llen
+start
;
5729 if (end
< 0) end
= llen
+end
;
5730 if (start
< 0) start
= 0;
5731 if (end
< 0) end
= 0;
5733 /* indexes sanity checks */
5734 if (start
> end
|| start
>= llen
) {
5735 /* Out of range start or start > end result in empty list */
5736 addReply(c
,shared
.emptymultibulk
);
5739 if (end
>= llen
) end
= llen
-1;
5740 rangelen
= (end
-start
)+1;
5742 /* check if starting point is trivial, before searching
5743 * the element in log(N) time */
5745 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5748 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5751 /* Return the result in form of a multi-bulk reply */
5752 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5753 withscores
? (rangelen
*2) : rangelen
));
5754 for (j
= 0; j
< rangelen
; j
++) {
5756 addReplyBulk(c
,ele
);
5758 addReplyDouble(c
,ln
->score
);
5759 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5763 static void zrangeCommand(redisClient
*c
) {
5764 zrangeGenericCommand(c
,0);
5767 static void zrevrangeCommand(redisClient
*c
) {
5768 zrangeGenericCommand(c
,1);
5771 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5772 * If justcount is non-zero, just the count is returned. */
5773 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5776 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5777 int offset
= 0, limit
= -1;
5781 /* Parse the min-max interval. If one of the values is prefixed
5782 * by the "(" character, it's considered "open". For instance
5783 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5784 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5785 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5786 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5789 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5791 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5792 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5795 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5798 /* Parse "WITHSCORES": note that if the command was called with
5799 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5800 * enter the following paths to parse WITHSCORES and LIMIT. */
5801 if (c
->argc
== 5 || c
->argc
== 8) {
5802 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5807 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5811 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5816 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5817 addReply(c
,shared
.syntaxerr
);
5819 } else if (c
->argc
== (7 + withscores
)) {
5820 offset
= atoi(c
->argv
[5]->ptr
);
5821 limit
= atoi(c
->argv
[6]->ptr
);
5822 if (offset
< 0) offset
= 0;
5825 /* Ok, lookup the key and get the range */
5826 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5828 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5830 if (o
->type
!= REDIS_ZSET
) {
5831 addReply(c
,shared
.wrongtypeerr
);
5833 zset
*zsetobj
= o
->ptr
;
5834 zskiplist
*zsl
= zsetobj
->zsl
;
5836 robj
*ele
, *lenobj
= NULL
;
5837 unsigned long rangelen
= 0;
5839 /* Get the first node with the score >= min, or with
5840 * score > min if 'minex' is true. */
5841 ln
= zslFirstWithScore(zsl
,min
);
5842 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5845 /* No element matching the speciifed interval */
5846 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5850 /* We don't know in advance how many matching elements there
5851 * are in the list, so we push this object that will represent
5852 * the multi-bulk length in the output buffer, and will "fix"
5855 lenobj
= createObject(REDIS_STRING
,NULL
);
5857 decrRefCount(lenobj
);
5860 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5863 ln
= ln
->forward
[0];
5866 if (limit
== 0) break;
5869 addReplyBulk(c
,ele
);
5871 addReplyDouble(c
,ln
->score
);
5873 ln
= ln
->forward
[0];
5875 if (limit
> 0) limit
--;
5878 addReplyLong(c
,(long)rangelen
);
5880 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5881 withscores
? (rangelen
*2) : rangelen
);
5887 static void zrangebyscoreCommand(redisClient
*c
) {
5888 genericZrangebyscoreCommand(c
,0);
5891 static void zcountCommand(redisClient
*c
) {
5892 genericZrangebyscoreCommand(c
,1);
5895 static void zcardCommand(redisClient
*c
) {
5899 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5900 checkType(c
,o
,REDIS_ZSET
)) return;
5903 addReplyUlong(c
,zs
->zsl
->length
);
5906 static void zscoreCommand(redisClient
*c
) {
5911 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5912 checkType(c
,o
,REDIS_ZSET
)) return;
5915 de
= dictFind(zs
->dict
,c
->argv
[2]);
5917 addReply(c
,shared
.nullbulk
);
5919 double *score
= dictGetEntryVal(de
);
5921 addReplyDouble(c
,*score
);
5925 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5933 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5934 checkType(c
,o
,REDIS_ZSET
)) return;
5938 de
= dictFind(zs
->dict
,c
->argv
[2]);
5940 addReply(c
,shared
.nullbulk
);
5944 score
= dictGetEntryVal(de
);
5945 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5948 addReplyLong(c
, zsl
->length
- rank
);
5950 addReplyLong(c
, rank
-1);
5953 addReply(c
,shared
.nullbulk
);
5957 static void zrankCommand(redisClient
*c
) {
5958 zrankGenericCommand(c
, 0);
5961 static void zrevrankCommand(redisClient
*c
) {
5962 zrankGenericCommand(c
, 1);
5965 /* =================================== Hashes =============================== */
5966 static void hsetCommand(redisClient
*c
) {
5968 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5971 o
= createHashObject();
5972 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5973 incrRefCount(c
->argv
[1]);
5975 if (o
->type
!= REDIS_HASH
) {
5976 addReply(c
,shared
.wrongtypeerr
);
5980 /* We want to convert the zipmap into an hash table right now if the
5981 * entry to be added is too big. Note that we check if the object
5982 * is integer encoded before to try fetching the length in the test below.
5983 * This is because integers are small, but currently stringObjectLen()
5984 * performs a slow conversion: not worth it. */
5985 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5986 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5987 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5988 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5989 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5991 convertToRealHash(o
);
5994 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5995 unsigned char *zm
= o
->ptr
;
5996 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5998 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5999 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
6000 decrRefCount(valobj
);
6003 /* And here there is the second check for hash conversion. */
6004 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6005 convertToRealHash(o
);
6007 tryObjectEncoding(c
->argv
[2]);
6008 /* note that c->argv[3] is already encoded, as the latest arg
6009 * of a bulk command is always integer encoded if possible. */
6010 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
6011 incrRefCount(c
->argv
[2]);
6015 incrRefCount(c
->argv
[3]);
6018 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
6021 static void hincrbyCommand(redisClient
*c
) {
6022 long long value
= 0, incr
= 0;
6023 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
6026 o
= createHashObject();
6027 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
6028 incrRefCount(c
->argv
[1]);
6030 if (o
->type
!= REDIS_HASH
) {
6031 addReply(c
,shared
.wrongtypeerr
);
6036 robj
*o_incr
= getDecodedObject(c
->argv
[3]);
6037 incr
= strtoll(o_incr
->ptr
, NULL
, 10);
6038 decrRefCount(o_incr
);
6040 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6041 unsigned char *zm
= o
->ptr
;
6042 unsigned char *zval
;
6045 /* Find value if already present in hash */
6046 if (zipmapGet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6048 /* strtoll needs the char* to have a trailing \0, but
6049 * the zipmap doesn't include them. */
6050 sds szval
= sdsnewlen(zval
, zvlen
);
6051 value
= strtoll(szval
,NULL
,10);
6056 sds svalue
= sdscatprintf(sdsempty(),"%lld",value
);
6057 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6058 (unsigned char*)svalue
,sdslen(svalue
),NULL
);
6062 /* Check if the zipmap needs to be converted. */
6063 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6064 convertToRealHash(o
);
6069 /* Find value if already present in hash */
6070 de
= dictFind(o
->ptr
,c
->argv
[2]);
6072 hval
= dictGetEntryVal(de
);
6073 if (hval
->encoding
== REDIS_ENCODING_RAW
)
6074 value
= strtoll(hval
->ptr
,NULL
,10);
6075 else if (hval
->encoding
== REDIS_ENCODING_INT
)
6076 value
= (long)hval
->ptr
;
6078 redisAssert(1 != 1);
6082 hval
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
6083 tryObjectEncoding(hval
);
6084 if (dictReplace(o
->ptr
,c
->argv
[2],hval
)) {
6085 incrRefCount(c
->argv
[2]);
6090 addReplyLong(c
, value
);
6093 static void hgetCommand(redisClient
*c
) {
6096 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6097 checkType(c
,o
,REDIS_HASH
)) return;
6099 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6100 unsigned char *zm
= o
->ptr
;
6105 field
= getDecodedObject(c
->argv
[2]);
6106 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
6107 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
6108 addReplySds(c
,sdsnewlen(val
,vlen
));
6109 addReply(c
,shared
.crlf
);
6110 decrRefCount(field
);
6113 addReply(c
,shared
.nullbulk
);
6114 decrRefCount(field
);
6118 struct dictEntry
*de
;
6120 de
= dictFind(o
->ptr
,c
->argv
[2]);
6122 addReply(c
,shared
.nullbulk
);
6124 robj
*e
= dictGetEntryVal(de
);
6131 static void hdelCommand(redisClient
*c
) {
6135 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6136 checkType(c
,o
,REDIS_HASH
)) return;
6138 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6139 robj
*field
= getDecodedObject(c
->argv
[2]);
6141 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
6142 (unsigned char*) field
->ptr
,
6143 sdslen(field
->ptr
), &deleted
);
6144 decrRefCount(field
);
6145 if (zipmapLen((unsigned char*) o
->ptr
) == 0)
6146 deleteKey(c
->db
,c
->argv
[1]);
6148 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
6149 if (htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6150 if (dictSize((dict
*)o
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6152 if (deleted
) server
.dirty
++;
6153 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
6156 static void hlenCommand(redisClient
*c
) {
6160 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6161 checkType(c
,o
,REDIS_HASH
)) return;
6163 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6164 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6165 addReplyUlong(c
,len
);
6168 #define REDIS_GETALL_KEYS 1
6169 #define REDIS_GETALL_VALS 2
6170 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6172 unsigned long count
= 0;
6174 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
6175 || checkType(c
,o
,REDIS_HASH
)) return;
6177 lenobj
= createObject(REDIS_STRING
,NULL
);
6179 decrRefCount(lenobj
);
6181 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6182 unsigned char *p
= zipmapRewind(o
->ptr
);
6183 unsigned char *field
, *val
;
6184 unsigned int flen
, vlen
;
6186 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
6189 if (flags
& REDIS_GETALL_KEYS
) {
6190 aux
= createStringObject((char*)field
,flen
);
6191 addReplyBulk(c
,aux
);
6195 if (flags
& REDIS_GETALL_VALS
) {
6196 aux
= createStringObject((char*)val
,vlen
);
6197 addReplyBulk(c
,aux
);
6203 dictIterator
*di
= dictGetIterator(o
->ptr
);
6206 while((de
= dictNext(di
)) != NULL
) {
6207 robj
*fieldobj
= dictGetEntryKey(de
);
6208 robj
*valobj
= dictGetEntryVal(de
);
6210 if (flags
& REDIS_GETALL_KEYS
) {
6211 addReplyBulk(c
,fieldobj
);
6214 if (flags
& REDIS_GETALL_VALS
) {
6215 addReplyBulk(c
,valobj
);
6219 dictReleaseIterator(di
);
6221 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6224 static void hkeysCommand(redisClient
*c
) {
6225 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6228 static void hvalsCommand(redisClient
*c
) {
6229 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6232 static void hgetallCommand(redisClient
*c
) {
6233 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6236 static void hexistsCommand(redisClient
*c
) {
6240 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6241 checkType(c
,o
,REDIS_HASH
)) return;
6243 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6245 unsigned char *zm
= o
->ptr
;
6247 field
= getDecodedObject(c
->argv
[2]);
6248 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6249 decrRefCount(field
);
6251 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6253 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6256 static void convertToRealHash(robj
*o
) {
6257 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6258 unsigned int klen
, vlen
;
6259 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6261 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6262 p
= zipmapRewind(zm
);
6263 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6264 robj
*keyobj
, *valobj
;
6266 keyobj
= createStringObject((char*)key
,klen
);
6267 valobj
= createStringObject((char*)val
,vlen
);
6268 tryObjectEncoding(keyobj
);
6269 tryObjectEncoding(valobj
);
6270 dictAdd(dict
,keyobj
,valobj
);
6272 o
->encoding
= REDIS_ENCODING_HT
;
6277 /* ========================= Non type-specific commands ==================== */
6279 static void flushdbCommand(redisClient
*c
) {
6280 server
.dirty
+= dictSize(c
->db
->dict
);
6281 dictEmpty(c
->db
->dict
);
6282 dictEmpty(c
->db
->expires
);
6283 addReply(c
,shared
.ok
);
6286 static void flushallCommand(redisClient
*c
) {
6287 server
.dirty
+= emptyDb();
6288 addReply(c
,shared
.ok
);
6289 if (server
.bgsavechildpid
!= -1) {
6290 kill(server
.bgsavechildpid
,SIGKILL
);
6291 rdbRemoveTempFile(server
.bgsavechildpid
);
6293 rdbSave(server
.dbfilename
);
6297 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6298 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6300 so
->pattern
= pattern
;
6304 /* Return the value associated to the key with a name obtained
6305 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6306 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6310 int prefixlen
, sublen
, postfixlen
;
6311 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6315 char buf
[REDIS_SORTKEY_MAX
+1];
6318 /* If the pattern is "#" return the substitution object itself in order
6319 * to implement the "SORT ... GET #" feature. */
6320 spat
= pattern
->ptr
;
6321 if (spat
[0] == '#' && spat
[1] == '\0') {
6325 /* The substitution object may be specially encoded. If so we create
6326 * a decoded object on the fly. Otherwise getDecodedObject will just
6327 * increment the ref count, that we'll decrement later. */
6328 subst
= getDecodedObject(subst
);
6331 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6332 p
= strchr(spat
,'*');
6334 decrRefCount(subst
);
6339 sublen
= sdslen(ssub
);
6340 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6341 memcpy(keyname
.buf
,spat
,prefixlen
);
6342 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6343 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6344 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6345 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6347 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6348 decrRefCount(subst
);
6350 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6351 return lookupKeyRead(db
,&keyobj
);
6354 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6355 * the additional parameter is not standard but a BSD-specific we have to
6356 * pass sorting parameters via the global 'server' structure */
6357 static int sortCompare(const void *s1
, const void *s2
) {
6358 const redisSortObject
*so1
= s1
, *so2
= s2
;
6361 if (!server
.sort_alpha
) {
6362 /* Numeric sorting. Here it's trivial as we precomputed scores */
6363 if (so1
->u
.score
> so2
->u
.score
) {
6365 } else if (so1
->u
.score
< so2
->u
.score
) {
6371 /* Alphanumeric sorting */
6372 if (server
.sort_bypattern
) {
6373 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6374 /* At least one compare object is NULL */
6375 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6377 else if (so1
->u
.cmpobj
== NULL
)
6382 /* We have both the objects, use strcoll */
6383 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6386 /* Compare elements directly */
6389 dec1
= getDecodedObject(so1
->obj
);
6390 dec2
= getDecodedObject(so2
->obj
);
6391 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6396 return server
.sort_desc
? -cmp
: cmp
;
6399 /* The SORT command is the most complex command in Redis. Warning: this code
6400 * is optimized for speed and a bit less for readability */
6401 static void sortCommand(redisClient
*c
) {
6404 int desc
= 0, alpha
= 0;
6405 int limit_start
= 0, limit_count
= -1, start
, end
;
6406 int j
, dontsort
= 0, vectorlen
;
6407 int getop
= 0; /* GET operation counter */
6408 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6409 redisSortObject
*vector
; /* Resulting vector to sort */
6411 /* Lookup the key to sort. It must be of the right types */
6412 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6413 if (sortval
== NULL
) {
6414 addReply(c
,shared
.nullmultibulk
);
6417 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6418 sortval
->type
!= REDIS_ZSET
)
6420 addReply(c
,shared
.wrongtypeerr
);
6424 /* Create a list of operations to perform for every sorted element.
6425 * Operations can be GET/DEL/INCR/DECR */
6426 operations
= listCreate();
6427 listSetFreeMethod(operations
,zfree
);
6430 /* Now we need to protect sortval incrementing its count, in the future
6431 * SORT may have options able to overwrite/delete keys during the sorting
6432 * and the sorted key itself may get destroied */
6433 incrRefCount(sortval
);
6435 /* The SORT command has an SQL-alike syntax, parse it */
6436 while(j
< c
->argc
) {
6437 int leftargs
= c
->argc
-j
-1;
6438 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6440 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6442 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6444 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6445 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6446 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6448 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6449 storekey
= c
->argv
[j
+1];
6451 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6452 sortby
= c
->argv
[j
+1];
6453 /* If the BY pattern does not contain '*', i.e. it is constant,
6454 * we don't need to sort nor to lookup the weight keys. */
6455 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6457 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6458 listAddNodeTail(operations
,createSortOperation(
6459 REDIS_SORT_GET
,c
->argv
[j
+1]));
6463 decrRefCount(sortval
);
6464 listRelease(operations
);
6465 addReply(c
,shared
.syntaxerr
);
6471 /* Load the sorting vector with all the objects to sort */
6472 switch(sortval
->type
) {
6473 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6474 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6475 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6476 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6478 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6481 if (sortval
->type
== REDIS_LIST
) {
6482 list
*list
= sortval
->ptr
;
6486 listRewind(list
,&li
);
6487 while((ln
= listNext(&li
))) {
6488 robj
*ele
= ln
->value
;
6489 vector
[j
].obj
= ele
;
6490 vector
[j
].u
.score
= 0;
6491 vector
[j
].u
.cmpobj
= NULL
;
6499 if (sortval
->type
== REDIS_SET
) {
6502 zset
*zs
= sortval
->ptr
;
6506 di
= dictGetIterator(set
);
6507 while((setele
= dictNext(di
)) != NULL
) {
6508 vector
[j
].obj
= dictGetEntryKey(setele
);
6509 vector
[j
].u
.score
= 0;
6510 vector
[j
].u
.cmpobj
= NULL
;
6513 dictReleaseIterator(di
);
6515 redisAssert(j
== vectorlen
);
6517 /* Now it's time to load the right scores in the sorting vector */
6518 if (dontsort
== 0) {
6519 for (j
= 0; j
< vectorlen
; j
++) {
6523 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6524 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6526 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6528 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6529 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6531 /* Don't need to decode the object if it's
6532 * integer-encoded (the only encoding supported) so
6533 * far. We can just cast it */
6534 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6535 vector
[j
].u
.score
= (long)byval
->ptr
;
6537 redisAssert(1 != 1);
6542 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6543 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6545 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6546 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6548 redisAssert(1 != 1);
6555 /* We are ready to sort the vector... perform a bit of sanity check
6556 * on the LIMIT option too. We'll use a partial version of quicksort. */
6557 start
= (limit_start
< 0) ? 0 : limit_start
;
6558 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6559 if (start
>= vectorlen
) {
6560 start
= vectorlen
-1;
6563 if (end
>= vectorlen
) end
= vectorlen
-1;
6565 if (dontsort
== 0) {
6566 server
.sort_desc
= desc
;
6567 server
.sort_alpha
= alpha
;
6568 server
.sort_bypattern
= sortby
? 1 : 0;
6569 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6570 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6572 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6575 /* Send command output to the output buffer, performing the specified
6576 * GET/DEL/INCR/DECR operations if any. */
6577 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6578 if (storekey
== NULL
) {
6579 /* STORE option not specified, sent the sorting result to client */
6580 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6581 for (j
= start
; j
<= end
; j
++) {
6585 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6586 listRewind(operations
,&li
);
6587 while((ln
= listNext(&li
))) {
6588 redisSortOperation
*sop
= ln
->value
;
6589 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6592 if (sop
->type
== REDIS_SORT_GET
) {
6593 if (!val
|| val
->type
!= REDIS_STRING
) {
6594 addReply(c
,shared
.nullbulk
);
6596 addReplyBulk(c
,val
);
6599 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6604 robj
*listObject
= createListObject();
6605 list
*listPtr
= (list
*) listObject
->ptr
;
6607 /* STORE option specified, set the sorting result as a List object */
6608 for (j
= start
; j
<= end
; j
++) {
6613 listAddNodeTail(listPtr
,vector
[j
].obj
);
6614 incrRefCount(vector
[j
].obj
);
6616 listRewind(operations
,&li
);
6617 while((ln
= listNext(&li
))) {
6618 redisSortOperation
*sop
= ln
->value
;
6619 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6622 if (sop
->type
== REDIS_SORT_GET
) {
6623 if (!val
|| val
->type
!= REDIS_STRING
) {
6624 listAddNodeTail(listPtr
,createStringObject("",0));
6626 listAddNodeTail(listPtr
,val
);
6630 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6634 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6635 incrRefCount(storekey
);
6637 /* Note: we add 1 because the DB is dirty anyway since even if the
6638 * SORT result is empty a new key is set and maybe the old content
6640 server
.dirty
+= 1+outputlen
;
6641 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6645 decrRefCount(sortval
);
6646 listRelease(operations
);
6647 for (j
= 0; j
< vectorlen
; j
++) {
6648 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6649 decrRefCount(vector
[j
].u
.cmpobj
);
6654 /* Convert an amount of bytes into a human readable string in the form
6655 * of 100B, 2G, 100M, 4K, and so forth. */
6656 static void bytesToHuman(char *s
, unsigned long long n
) {
6661 sprintf(s
,"%lluB",n
);
6663 } else if (n
< (1024*1024)) {
6664 d
= (double)n
/(1024);
6665 sprintf(s
,"%.2fK",d
);
6666 } else if (n
< (1024LL*1024*1024)) {
6667 d
= (double)n
/(1024*1024);
6668 sprintf(s
,"%.2fM",d
);
6669 } else if (n
< (1024LL*1024*1024*1024)) {
6670 d
= (double)n
/(1024LL*1024*1024);
6671 sprintf(s
,"%.2fG",d
);
6675 /* Create the string returned by the INFO command. This is decoupled
6676 * by the INFO command itself as we need to report the same information
6677 * on memory corruption problems. */
6678 static sds
genRedisInfoString(void) {
6680 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6684 bytesToHuman(hmem
,zmalloc_used_memory());
6685 info
= sdscatprintf(sdsempty(),
6686 "redis_version:%s\r\n"
6688 "multiplexing_api:%s\r\n"
6689 "process_id:%ld\r\n"
6690 "uptime_in_seconds:%ld\r\n"
6691 "uptime_in_days:%ld\r\n"
6692 "connected_clients:%d\r\n"
6693 "connected_slaves:%d\r\n"
6694 "blocked_clients:%d\r\n"
6695 "used_memory:%zu\r\n"
6696 "used_memory_human:%s\r\n"
6697 "changes_since_last_save:%lld\r\n"
6698 "bgsave_in_progress:%d\r\n"
6699 "last_save_time:%ld\r\n"
6700 "bgrewriteaof_in_progress:%d\r\n"
6701 "total_connections_received:%lld\r\n"
6702 "total_commands_processed:%lld\r\n"
6703 "expired_keys:%lld\r\n"
6704 "hash_max_zipmap_entries:%ld\r\n"
6705 "hash_max_zipmap_value:%ld\r\n"
6706 "pubsub_channels:%ld\r\n"
6707 "pubsub_patterns:%u\r\n"
6711 (sizeof(long) == 8) ? "64" : "32",
6716 listLength(server
.clients
)-listLength(server
.slaves
),
6717 listLength(server
.slaves
),
6718 server
.blpop_blocked_clients
,
6719 zmalloc_used_memory(),
6722 server
.bgsavechildpid
!= -1,
6724 server
.bgrewritechildpid
!= -1,
6725 server
.stat_numconnections
,
6726 server
.stat_numcommands
,
6727 server
.stat_expiredkeys
,
6728 server
.hash_max_zipmap_entries
,
6729 server
.hash_max_zipmap_value
,
6730 dictSize(server
.pubsub_channels
),
6731 listLength(server
.pubsub_patterns
),
6732 server
.vm_enabled
!= 0,
6733 server
.masterhost
== NULL
? "master" : "slave"
6735 if (server
.masterhost
) {
6736 info
= sdscatprintf(info
,
6737 "master_host:%s\r\n"
6738 "master_port:%d\r\n"
6739 "master_link_status:%s\r\n"
6740 "master_last_io_seconds_ago:%d\r\n"
6743 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6745 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6748 if (server
.vm_enabled
) {
6750 info
= sdscatprintf(info
,
6751 "vm_conf_max_memory:%llu\r\n"
6752 "vm_conf_page_size:%llu\r\n"
6753 "vm_conf_pages:%llu\r\n"
6754 "vm_stats_used_pages:%llu\r\n"
6755 "vm_stats_swapped_objects:%llu\r\n"
6756 "vm_stats_swappin_count:%llu\r\n"
6757 "vm_stats_swappout_count:%llu\r\n"
6758 "vm_stats_io_newjobs_len:%lu\r\n"
6759 "vm_stats_io_processing_len:%lu\r\n"
6760 "vm_stats_io_processed_len:%lu\r\n"
6761 "vm_stats_io_active_threads:%lu\r\n"
6762 "vm_stats_blocked_clients:%lu\r\n"
6763 ,(unsigned long long) server
.vm_max_memory
,
6764 (unsigned long long) server
.vm_page_size
,
6765 (unsigned long long) server
.vm_pages
,
6766 (unsigned long long) server
.vm_stats_used_pages
,
6767 (unsigned long long) server
.vm_stats_swapped_objects
,
6768 (unsigned long long) server
.vm_stats_swapins
,
6769 (unsigned long long) server
.vm_stats_swapouts
,
6770 (unsigned long) listLength(server
.io_newjobs
),
6771 (unsigned long) listLength(server
.io_processing
),
6772 (unsigned long) listLength(server
.io_processed
),
6773 (unsigned long) server
.io_active_threads
,
6774 (unsigned long) server
.vm_blocked_clients
6778 for (j
= 0; j
< server
.dbnum
; j
++) {
6779 long long keys
, vkeys
;
6781 keys
= dictSize(server
.db
[j
].dict
);
6782 vkeys
= dictSize(server
.db
[j
].expires
);
6783 if (keys
|| vkeys
) {
6784 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6791 static void infoCommand(redisClient
*c
) {
6792 sds info
= genRedisInfoString();
6793 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6794 (unsigned long)sdslen(info
)));
6795 addReplySds(c
,info
);
6796 addReply(c
,shared
.crlf
);
6799 static void monitorCommand(redisClient
*c
) {
6800 /* ignore MONITOR if aleady slave or in monitor mode */
6801 if (c
->flags
& REDIS_SLAVE
) return;
6803 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6805 listAddNodeTail(server
.monitors
,c
);
6806 addReply(c
,shared
.ok
);
6809 /* ================================= Expire ================================= */
6810 static int removeExpire(redisDb
*db
, robj
*key
) {
6811 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6818 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6819 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6827 /* Return the expire time of the specified key, or -1 if no expire
6828 * is associated with this key (i.e. the key is non volatile) */
6829 static time_t getExpire(redisDb
*db
, robj
*key
) {
6832 /* No expire? return ASAP */
6833 if (dictSize(db
->expires
) == 0 ||
6834 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6836 return (time_t) dictGetEntryVal(de
);
6839 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6843 /* No expire? return ASAP */
6844 if (dictSize(db
->expires
) == 0 ||
6845 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6847 /* Lookup the expire */
6848 when
= (time_t) dictGetEntryVal(de
);
6849 if (time(NULL
) <= when
) return 0;
6851 /* Delete the key */
6852 dictDelete(db
->expires
,key
);
6853 server
.stat_expiredkeys
++;
6854 return dictDelete(db
->dict
,key
) == DICT_OK
;
6857 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6860 /* No expire? return ASAP */
6861 if (dictSize(db
->expires
) == 0 ||
6862 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6864 /* Delete the key */
6866 server
.stat_expiredkeys
++;
6867 dictDelete(db
->expires
,key
);
6868 return dictDelete(db
->dict
,key
) == DICT_OK
;
6871 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6874 de
= dictFind(c
->db
->dict
,key
);
6876 addReply(c
,shared
.czero
);
6880 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6881 addReply(c
, shared
.cone
);
6884 time_t when
= time(NULL
)+seconds
;
6885 if (setExpire(c
->db
,key
,when
)) {
6886 addReply(c
,shared
.cone
);
6889 addReply(c
,shared
.czero
);
6895 static void expireCommand(redisClient
*c
) {
6896 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6899 static void expireatCommand(redisClient
*c
) {
6900 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6903 static void ttlCommand(redisClient
*c
) {
6907 expire
= getExpire(c
->db
,c
->argv
[1]);
6909 ttl
= (int) (expire
-time(NULL
));
6910 if (ttl
< 0) ttl
= -1;
6912 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6915 /* ================================ MULTI/EXEC ============================== */
6917 /* Client state initialization for MULTI/EXEC */
6918 static void initClientMultiState(redisClient
*c
) {
6919 c
->mstate
.commands
= NULL
;
6920 c
->mstate
.count
= 0;
6923 /* Release all the resources associated with MULTI/EXEC state */
6924 static void freeClientMultiState(redisClient
*c
) {
6927 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6929 multiCmd
*mc
= c
->mstate
.commands
+j
;
6931 for (i
= 0; i
< mc
->argc
; i
++)
6932 decrRefCount(mc
->argv
[i
]);
6935 zfree(c
->mstate
.commands
);
6938 /* Add a new command into the MULTI commands queue */
6939 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6943 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6944 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6945 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6948 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6949 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6950 for (j
= 0; j
< c
->argc
; j
++)
6951 incrRefCount(mc
->argv
[j
]);
6955 static void multiCommand(redisClient
*c
) {
6956 c
->flags
|= REDIS_MULTI
;
6957 addReply(c
,shared
.ok
);
6960 static void discardCommand(redisClient
*c
) {
6961 if (!(c
->flags
& REDIS_MULTI
)) {
6962 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6966 freeClientMultiState(c
);
6967 initClientMultiState(c
);
6968 c
->flags
&= (~REDIS_MULTI
);
6969 addReply(c
,shared
.ok
);
6972 static void execCommand(redisClient
*c
) {
6977 if (!(c
->flags
& REDIS_MULTI
)) {
6978 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6982 orig_argv
= c
->argv
;
6983 orig_argc
= c
->argc
;
6984 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6985 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6986 c
->argc
= c
->mstate
.commands
[j
].argc
;
6987 c
->argv
= c
->mstate
.commands
[j
].argv
;
6988 call(c
,c
->mstate
.commands
[j
].cmd
);
6990 c
->argv
= orig_argv
;
6991 c
->argc
= orig_argc
;
6992 freeClientMultiState(c
);
6993 initClientMultiState(c
);
6994 c
->flags
&= (~REDIS_MULTI
);
6997 /* =========================== Blocking Operations ========================= */
6999 /* Currently Redis blocking operations support is limited to list POP ops,
7000 * so the current implementation is not fully generic, but it is also not
7001 * completely specific so it will not require a rewrite to support new
7002 * kind of blocking operations in the future.
7004 * Still it's important to note that list blocking operations can be already
7005 * used as a notification mechanism in order to implement other blocking
7006 * operations at application level, so there must be a very strong evidence
7007 * of usefulness and generality before new blocking operations are implemented.
7009 * This is how the current blocking POP works, we use BLPOP as example:
7010 * - If the user calls BLPOP and the key exists and contains a non empty list
7011 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7012 * if there is not to block.
7013 * - If instead BLPOP is called and the key does not exists or the list is
7014 * empty we need to block. In order to do so we remove the notification for
7015 * new data to read in the client socket (so that we'll not serve new
7016 * requests if the blocking request is not served). Also we put the client
7017 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7018 * blocking for this keys.
7019 * - If a PUSH operation against a key with blocked clients waiting is
7020 * performed, we serve the first in the list: basically instead to push
7021 * the new element inside the list we return it to the (first / oldest)
7022 * blocking client, unblock the client, and remove it form the list.
7024 * The above comment and the source code should be enough in order to understand
7025 * the implementation and modify / fix it later.
7028 /* Set a client in blocking mode for the specified key, with the specified
7030 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7035 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7036 c
->blockingkeysnum
= numkeys
;
7037 c
->blockingto
= timeout
;
7038 for (j
= 0; j
< numkeys
; j
++) {
7039 /* Add the key in the client structure, to map clients -> keys */
7040 c
->blockingkeys
[j
] = keys
[j
];
7041 incrRefCount(keys
[j
]);
7043 /* And in the other "side", to map keys -> clients */
7044 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7048 /* For every key we take a list of clients blocked for it */
7050 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7051 incrRefCount(keys
[j
]);
7052 assert(retval
== DICT_OK
);
7054 l
= dictGetEntryVal(de
);
7056 listAddNodeTail(l
,c
);
7058 /* Mark the client as a blocked client */
7059 c
->flags
|= REDIS_BLOCKED
;
7060 server
.blpop_blocked_clients
++;
7063 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7064 static void unblockClientWaitingData(redisClient
*c
) {
7069 assert(c
->blockingkeys
!= NULL
);
7070 /* The client may wait for multiple keys, so unblock it for every key. */
7071 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7072 /* Remove this client from the list of clients waiting for this key. */
7073 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7075 l
= dictGetEntryVal(de
);
7076 listDelNode(l
,listSearchKey(l
,c
));
7077 /* If the list is empty we need to remove it to avoid wasting memory */
7078 if (listLength(l
) == 0)
7079 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7080 decrRefCount(c
->blockingkeys
[j
]);
7082 /* Cleanup the client structure */
7083 zfree(c
->blockingkeys
);
7084 c
->blockingkeys
= NULL
;
7085 c
->flags
&= (~REDIS_BLOCKED
);
7086 server
.blpop_blocked_clients
--;
7087 /* We want to process data if there is some command waiting
7088 * in the input buffer. Note that this is safe even if
7089 * unblockClientWaitingData() gets called from freeClient() because
7090 * freeClient() will be smart enough to call this function
7091 * *after* c->querybuf was set to NULL. */
7092 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7095 /* This should be called from any function PUSHing into lists.
7096 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7097 * 'ele' is the element pushed.
7099 * If the function returns 0 there was no client waiting for a list push
7102 * If the function returns 1 there was a client waiting for a list push
7103 * against this key, the element was passed to this client thus it's not
7104 * needed to actually add it to the list and the caller should return asap. */
7105 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7106 struct dictEntry
*de
;
7107 redisClient
*receiver
;
7111 de
= dictFind(c
->db
->blockingkeys
,key
);
7112 if (de
== NULL
) return 0;
7113 l
= dictGetEntryVal(de
);
7116 receiver
= ln
->value
;
7118 addReplySds(receiver
,sdsnew("*2\r\n"));
7119 addReplyBulk(receiver
,key
);
7120 addReplyBulk(receiver
,ele
);
7121 unblockClientWaitingData(receiver
);
7125 /* Blocking RPOP/LPOP */
7126 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7131 for (j
= 1; j
< c
->argc
-1; j
++) {
7132 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7134 if (o
->type
!= REDIS_LIST
) {
7135 addReply(c
,shared
.wrongtypeerr
);
7138 list
*list
= o
->ptr
;
7139 if (listLength(list
) != 0) {
7140 /* If the list contains elements fall back to the usual
7141 * non-blocking POP operation */
7142 robj
*argv
[2], **orig_argv
;
7145 /* We need to alter the command arguments before to call
7146 * popGenericCommand() as the command takes a single key. */
7147 orig_argv
= c
->argv
;
7148 orig_argc
= c
->argc
;
7149 argv
[1] = c
->argv
[j
];
7153 /* Also the return value is different, we need to output
7154 * the multi bulk reply header and the key name. The
7155 * "real" command will add the last element (the value)
7156 * for us. If this souds like an hack to you it's just
7157 * because it is... */
7158 addReplySds(c
,sdsnew("*2\r\n"));
7159 addReplyBulk(c
,argv
[1]);
7160 popGenericCommand(c
,where
);
7162 /* Fix the client structure with the original stuff */
7163 c
->argv
= orig_argv
;
7164 c
->argc
= orig_argc
;
7170 /* If the list is empty or the key does not exists we must block */
7171 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7172 if (timeout
> 0) timeout
+= time(NULL
);
7173 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7176 static void blpopCommand(redisClient
*c
) {
7177 blockingPopGenericCommand(c
,REDIS_HEAD
);
7180 static void brpopCommand(redisClient
*c
) {
7181 blockingPopGenericCommand(c
,REDIS_TAIL
);
7184 /* =============================== Replication ============================= */
7186 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7187 ssize_t nwritten
, ret
= size
;
7188 time_t start
= time(NULL
);
7192 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7193 nwritten
= write(fd
,ptr
,size
);
7194 if (nwritten
== -1) return -1;
7198 if ((time(NULL
)-start
) > timeout
) {
7206 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7207 ssize_t nread
, totread
= 0;
7208 time_t start
= time(NULL
);
7212 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7213 nread
= read(fd
,ptr
,size
);
7214 if (nread
== -1) return -1;
7219 if ((time(NULL
)-start
) > timeout
) {
7227 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7234 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7237 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7248 static void syncCommand(redisClient
*c
) {
7249 /* ignore SYNC if aleady slave or in monitor mode */
7250 if (c
->flags
& REDIS_SLAVE
) return;
7252 /* SYNC can't be issued when the server has pending data to send to
7253 * the client about already issued commands. We need a fresh reply
7254 * buffer registering the differences between the BGSAVE and the current
7255 * dataset, so that we can copy to other slaves if needed. */
7256 if (listLength(c
->reply
) != 0) {
7257 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7261 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7262 /* Here we need to check if there is a background saving operation
7263 * in progress, or if it is required to start one */
7264 if (server
.bgsavechildpid
!= -1) {
7265 /* Ok a background save is in progress. Let's check if it is a good
7266 * one for replication, i.e. if there is another slave that is
7267 * registering differences since the server forked to save */
7272 listRewind(server
.slaves
,&li
);
7273 while((ln
= listNext(&li
))) {
7275 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7278 /* Perfect, the server is already registering differences for
7279 * another slave. Set the right state, and copy the buffer. */
7280 listRelease(c
->reply
);
7281 c
->reply
= listDup(slave
->reply
);
7282 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7283 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7285 /* No way, we need to wait for the next BGSAVE in order to
7286 * register differences */
7287 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7288 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7291 /* Ok we don't have a BGSAVE in progress, let's start one */
7292 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7293 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7294 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7295 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7298 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7301 c
->flags
|= REDIS_SLAVE
;
7303 listAddNodeTail(server
.slaves
,c
);
7307 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7308 redisClient
*slave
= privdata
;
7310 REDIS_NOTUSED(mask
);
7311 char buf
[REDIS_IOBUF_LEN
];
7312 ssize_t nwritten
, buflen
;
7314 if (slave
->repldboff
== 0) {
7315 /* Write the bulk write count before to transfer the DB. In theory here
7316 * we don't know how much room there is in the output buffer of the
7317 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7318 * operations) will never be smaller than the few bytes we need. */
7321 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7323 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7331 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7332 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7334 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7335 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7339 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7340 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7345 slave
->repldboff
+= nwritten
;
7346 if (slave
->repldboff
== slave
->repldbsize
) {
7347 close(slave
->repldbfd
);
7348 slave
->repldbfd
= -1;
7349 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7350 slave
->replstate
= REDIS_REPL_ONLINE
;
7351 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7352 sendReplyToClient
, slave
) == AE_ERR
) {
7356 addReplySds(slave
,sdsempty());
7357 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7361 /* This function is called at the end of every backgrond saving.
7362 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7363 * otherwise REDIS_ERR is passed to the function.
7365 * The goal of this function is to handle slaves waiting for a successful
7366 * background saving in order to perform non-blocking synchronization. */
7367 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7369 int startbgsave
= 0;
7372 listRewind(server
.slaves
,&li
);
7373 while((ln
= listNext(&li
))) {
7374 redisClient
*slave
= ln
->value
;
7376 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7378 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7379 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7380 struct redis_stat buf
;
7382 if (bgsaveerr
!= REDIS_OK
) {
7384 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7387 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7388 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7390 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7393 slave
->repldboff
= 0;
7394 slave
->repldbsize
= buf
.st_size
;
7395 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7396 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7397 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7404 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7407 listRewind(server
.slaves
,&li
);
7408 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7409 while((ln
= listNext(&li
))) {
7410 redisClient
*slave
= ln
->value
;
7412 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7419 static int syncWithMaster(void) {
7420 char buf
[1024], tmpfile
[256], authcmd
[1024];
7422 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7423 int dfd
, maxtries
= 5;
7426 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7431 /* AUTH with the master if required. */
7432 if(server
.masterauth
) {
7433 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7434 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7436 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7440 /* Read the AUTH result. */
7441 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7443 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7447 if (buf
[0] != '+') {
7449 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7454 /* Issue the SYNC command */
7455 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7457 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7461 /* Read the bulk write count */
7462 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7464 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7468 if (buf
[0] != '$') {
7470 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7473 dumpsize
= strtol(buf
+1,NULL
,10);
7474 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7475 /* Read the bulk write data on a temp file */
7477 snprintf(tmpfile
,256,
7478 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7479 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7480 if (dfd
!= -1) break;
7485 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7489 int nread
, nwritten
;
7491 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7493 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7499 nwritten
= write(dfd
,buf
,nread
);
7500 if (nwritten
== -1) {
7501 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7509 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7510 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7516 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7517 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7521 server
.master
= createClient(fd
);
7522 server
.master
->flags
|= REDIS_MASTER
;
7523 server
.master
->authenticated
= 1;
7524 server
.replstate
= REDIS_REPL_CONNECTED
;
7528 static void slaveofCommand(redisClient
*c
) {
7529 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7530 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7531 if (server
.masterhost
) {
7532 sdsfree(server
.masterhost
);
7533 server
.masterhost
= NULL
;
7534 if (server
.master
) freeClient(server
.master
);
7535 server
.replstate
= REDIS_REPL_NONE
;
7536 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7539 sdsfree(server
.masterhost
);
7540 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7541 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7542 if (server
.master
) freeClient(server
.master
);
7543 server
.replstate
= REDIS_REPL_CONNECT
;
7544 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7545 server
.masterhost
, server
.masterport
);
7547 addReply(c
,shared
.ok
);
7550 /* ============================ Maxmemory directive ======================== */
7552 /* Try to free one object form the pre-allocated objects free list.
7553 * This is useful under low mem conditions as by default we take 1 million
7554 * free objects allocated. On success REDIS_OK is returned, otherwise
7556 static int tryFreeOneObjectFromFreelist(void) {
7559 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7560 if (listLength(server
.objfreelist
)) {
7561 listNode
*head
= listFirst(server
.objfreelist
);
7562 o
= listNodeValue(head
);
7563 listDelNode(server
.objfreelist
,head
);
7564 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7568 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7573 /* This function gets called when 'maxmemory' is set on the config file to limit
7574 * the max memory used by the server, and we are out of memory.
7575 * This function will try to, in order:
7577 * - Free objects from the free list
7578 * - Try to remove keys with an EXPIRE set
7580 * It is not possible to free enough memory to reach used-memory < maxmemory
7581 * the server will start refusing commands that will enlarge even more the
7584 static void freeMemoryIfNeeded(void) {
7585 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7586 int j
, k
, freed
= 0;
7588 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7589 for (j
= 0; j
< server
.dbnum
; j
++) {
7591 robj
*minkey
= NULL
;
7592 struct dictEntry
*de
;
7594 if (dictSize(server
.db
[j
].expires
)) {
7596 /* From a sample of three keys drop the one nearest to
7597 * the natural expire */
7598 for (k
= 0; k
< 3; k
++) {
7601 de
= dictGetRandomKey(server
.db
[j
].expires
);
7602 t
= (time_t) dictGetEntryVal(de
);
7603 if (minttl
== -1 || t
< minttl
) {
7604 minkey
= dictGetEntryKey(de
);
7608 deleteKey(server
.db
+j
,minkey
);
7611 if (!freed
) return; /* nothing to free... */
7615 /* ============================== Append Only file ========================== */
7617 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7618 sds buf
= sdsempty();
7624 /* The DB this command was targetting is not the same as the last command
7625 * we appendend. To issue a SELECT command is needed. */
7626 if (dictid
!= server
.appendseldb
) {
7629 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7630 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7631 (unsigned long)strlen(seldb
),seldb
);
7632 server
.appendseldb
= dictid
;
7635 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7636 * EXPIREs into EXPIREATs calls */
7637 if (cmd
->proc
== expireCommand
) {
7640 tmpargv
[0] = createStringObject("EXPIREAT",8);
7641 tmpargv
[1] = argv
[1];
7642 incrRefCount(argv
[1]);
7643 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7644 tmpargv
[2] = createObject(REDIS_STRING
,
7645 sdscatprintf(sdsempty(),"%ld",when
));
7649 /* Append the actual command */
7650 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7651 for (j
= 0; j
< argc
; j
++) {
7654 o
= getDecodedObject(o
);
7655 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7656 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7657 buf
= sdscatlen(buf
,"\r\n",2);
7661 /* Free the objects from the modified argv for EXPIREAT */
7662 if (cmd
->proc
== expireCommand
) {
7663 for (j
= 0; j
< 3; j
++)
7664 decrRefCount(argv
[j
]);
7667 /* We want to perform a single write. This should be guaranteed atomic
7668 * at least if the filesystem we are writing is a real physical one.
7669 * While this will save us against the server being killed I don't think
7670 * there is much to do about the whole server stopping for power problems
7672 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7673 if (nwritten
!= (signed)sdslen(buf
)) {
7674 /* Ooops, we are in troubles. The best thing to do for now is
7675 * to simply exit instead to give the illusion that everything is
7676 * working as expected. */
7677 if (nwritten
== -1) {
7678 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7680 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7684 /* If a background append only file rewriting is in progress we want to
7685 * accumulate the differences between the child DB and the current one
7686 * in a buffer, so that when the child process will do its work we
7687 * can append the differences to the new append only file. */
7688 if (server
.bgrewritechildpid
!= -1)
7689 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7693 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7694 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7695 now
-server
.lastfsync
> 1))
7697 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7698 server
.lastfsync
= now
;
7702 /* In Redis commands are always executed in the context of a client, so in
7703 * order to load the append only file we need to create a fake client. */
7704 static struct redisClient
*createFakeClient(void) {
7705 struct redisClient
*c
= zmalloc(sizeof(*c
));
7709 c
->querybuf
= sdsempty();
7713 /* We set the fake client as a slave waiting for the synchronization
7714 * so that Redis will not try to send replies to this client. */
7715 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7716 c
->reply
= listCreate();
7717 listSetFreeMethod(c
->reply
,decrRefCount
);
7718 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7722 static void freeFakeClient(struct redisClient
*c
) {
7723 sdsfree(c
->querybuf
);
7724 listRelease(c
->reply
);
7728 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7729 * error (the append only file is zero-length) REDIS_ERR is returned. On
7730 * fatal error an error message is logged and the program exists. */
7731 int loadAppendOnlyFile(char *filename
) {
7732 struct redisClient
*fakeClient
;
7733 FILE *fp
= fopen(filename
,"r");
7734 struct redis_stat sb
;
7735 unsigned long long loadedkeys
= 0;
7737 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7741 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7745 fakeClient
= createFakeClient();
7752 struct redisCommand
*cmd
;
7754 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7760 if (buf
[0] != '*') goto fmterr
;
7762 argv
= zmalloc(sizeof(robj
*)*argc
);
7763 for (j
= 0; j
< argc
; j
++) {
7764 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7765 if (buf
[0] != '$') goto fmterr
;
7766 len
= strtol(buf
+1,NULL
,10);
7767 argsds
= sdsnewlen(NULL
,len
);
7768 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7769 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7770 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7773 /* Command lookup */
7774 cmd
= lookupCommand(argv
[0]->ptr
);
7776 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7779 /* Try object sharing and encoding */
7780 if (server
.shareobjects
) {
7782 for(j
= 1; j
< argc
; j
++)
7783 argv
[j
] = tryObjectSharing(argv
[j
]);
7785 if (cmd
->flags
& REDIS_CMD_BULK
)
7786 tryObjectEncoding(argv
[argc
-1]);
7787 /* Run the command in the context of a fake client */
7788 fakeClient
->argc
= argc
;
7789 fakeClient
->argv
= argv
;
7790 cmd
->proc(fakeClient
);
7791 /* Discard the reply objects list from the fake client */
7792 while(listLength(fakeClient
->reply
))
7793 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7794 /* Clean up, ready for the next command */
7795 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7797 /* Handle swapping while loading big datasets when VM is on */
7799 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7800 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7801 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7806 freeFakeClient(fakeClient
);
7811 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7813 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7817 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7821 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7822 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7826 /* Avoid the incr/decr ref count business if possible to help
7827 * copy-on-write (we are often in a child process when this function
7829 * Also makes sure that key objects don't get incrRefCount-ed when VM
7831 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7832 obj
= getDecodedObject(obj
);
7835 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7836 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7837 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7839 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7840 if (decrrc
) decrRefCount(obj
);
7843 if (decrrc
) decrRefCount(obj
);
7847 /* Write binary-safe string into a file in the bulkformat
7848 * $<count>\r\n<payload>\r\n */
7849 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7852 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7853 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7854 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7855 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7859 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7860 static int fwriteBulkDouble(FILE *fp
, double d
) {
7861 char buf
[128], dbuf
[128];
7863 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7864 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7865 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7866 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7870 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7871 static int fwriteBulkLong(FILE *fp
, long l
) {
7872 char buf
[128], lbuf
[128];
7874 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7875 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7876 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7877 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7881 /* Write a sequence of commands able to fully rebuild the dataset into
7882 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7883 static int rewriteAppendOnlyFile(char *filename
) {
7884 dictIterator
*di
= NULL
;
7889 time_t now
= time(NULL
);
7891 /* Note that we have to use a different temp name here compared to the
7892 * one used by rewriteAppendOnlyFileBackground() function. */
7893 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7894 fp
= fopen(tmpfile
,"w");
7896 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7899 for (j
= 0; j
< server
.dbnum
; j
++) {
7900 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7901 redisDb
*db
= server
.db
+j
;
7903 if (dictSize(d
) == 0) continue;
7904 di
= dictGetIterator(d
);
7910 /* SELECT the new DB */
7911 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7912 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7914 /* Iterate this DB writing every entry */
7915 while((de
= dictNext(di
)) != NULL
) {
7920 key
= dictGetEntryKey(de
);
7921 /* If the value for this key is swapped, load a preview in memory.
7922 * We use a "swapped" flag to remember if we need to free the
7923 * value object instead to just increment the ref count anyway
7924 * in order to avoid copy-on-write of pages if we are forked() */
7925 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7926 key
->storage
== REDIS_VM_SWAPPING
) {
7927 o
= dictGetEntryVal(de
);
7930 o
= vmPreviewObject(key
);
7933 expiretime
= getExpire(db
,key
);
7935 /* Save the key and associated value */
7936 if (o
->type
== REDIS_STRING
) {
7937 /* Emit a SET command */
7938 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7939 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7941 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7942 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7943 } else if (o
->type
== REDIS_LIST
) {
7944 /* Emit the RPUSHes needed to rebuild the list */
7945 list
*list
= o
->ptr
;
7949 listRewind(list
,&li
);
7950 while((ln
= listNext(&li
))) {
7951 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7952 robj
*eleobj
= listNodeValue(ln
);
7954 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7955 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7956 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7958 } else if (o
->type
== REDIS_SET
) {
7959 /* Emit the SADDs needed to rebuild the set */
7961 dictIterator
*di
= dictGetIterator(set
);
7964 while((de
= dictNext(di
)) != NULL
) {
7965 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7966 robj
*eleobj
= dictGetEntryKey(de
);
7968 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7969 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7970 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7972 dictReleaseIterator(di
);
7973 } else if (o
->type
== REDIS_ZSET
) {
7974 /* Emit the ZADDs needed to rebuild the sorted set */
7976 dictIterator
*di
= dictGetIterator(zs
->dict
);
7979 while((de
= dictNext(di
)) != NULL
) {
7980 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7981 robj
*eleobj
= dictGetEntryKey(de
);
7982 double *score
= dictGetEntryVal(de
);
7984 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7985 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7986 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7987 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7989 dictReleaseIterator(di
);
7990 } else if (o
->type
== REDIS_HASH
) {
7991 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7993 /* Emit the HSETs needed to rebuild the hash */
7994 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7995 unsigned char *p
= zipmapRewind(o
->ptr
);
7996 unsigned char *field
, *val
;
7997 unsigned int flen
, vlen
;
7999 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8000 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8001 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8002 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8004 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8008 dictIterator
*di
= dictGetIterator(o
->ptr
);
8011 while((de
= dictNext(di
)) != NULL
) {
8012 robj
*field
= dictGetEntryKey(de
);
8013 robj
*val
= dictGetEntryVal(de
);
8015 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8016 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8017 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8018 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8020 dictReleaseIterator(di
);
8025 /* Save the expire time */
8026 if (expiretime
!= -1) {
8027 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8028 /* If this key is already expired skip it */
8029 if (expiretime
< now
) continue;
8030 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8031 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8032 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8034 if (swapped
) decrRefCount(o
);
8036 dictReleaseIterator(di
);
8039 /* Make sure data will not remain on the OS's output buffers */
8044 /* Use RENAME to make sure the DB file is changed atomically only
8045 * if the generate DB file is ok. */
8046 if (rename(tmpfile
,filename
) == -1) {
8047 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8051 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8057 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8058 if (di
) dictReleaseIterator(di
);
8062 /* This is how rewriting of the append only file in background works:
8064 * 1) The user calls BGREWRITEAOF
8065 * 2) Redis calls this function, that forks():
8066 * 2a) the child rewrite the append only file in a temp file.
8067 * 2b) the parent accumulates differences in server.bgrewritebuf.
8068 * 3) When the child finished '2a' exists.
8069 * 4) The parent will trap the exit code, if it's OK, will append the
8070 * data accumulated into server.bgrewritebuf into the temp file, and
8071 * finally will rename(2) the temp file in the actual file name.
8072 * The the new file is reopened as the new append only file. Profit!
8074 static int rewriteAppendOnlyFileBackground(void) {
8077 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8078 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8079 if ((childpid
= fork()) == 0) {
8083 if (server
.vm_enabled
) vmReopenSwapFile();
8085 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8086 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8093 if (childpid
== -1) {
8094 redisLog(REDIS_WARNING
,
8095 "Can't rewrite append only file in background: fork: %s",
8099 redisLog(REDIS_NOTICE
,
8100 "Background append only file rewriting started by pid %d",childpid
);
8101 server
.bgrewritechildpid
= childpid
;
8102 /* We set appendseldb to -1 in order to force the next call to the
8103 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8104 * accumulated by the parent into server.bgrewritebuf will start
8105 * with a SELECT statement and it will be safe to merge. */
8106 server
.appendseldb
= -1;
8109 return REDIS_OK
; /* unreached */
8112 static void bgrewriteaofCommand(redisClient
*c
) {
8113 if (server
.bgrewritechildpid
!= -1) {
8114 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8117 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8118 char *status
= "+Background append only file rewriting started\r\n";
8119 addReplySds(c
,sdsnew(status
));
8121 addReply(c
,shared
.err
);
8125 static void aofRemoveTempFile(pid_t childpid
) {
8128 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8132 /* Virtual Memory is composed mainly of two subsystems:
8133 * - Blocking Virutal Memory
8134 * - Threaded Virtual Memory I/O
8135 * The two parts are not fully decoupled, but functions are split among two
8136 * different sections of the source code (delimited by comments) in order to
8137 * make more clear what functionality is about the blocking VM and what about
8138 * the threaded (not blocking) VM.
8142 * Redis VM is a blocking VM (one that blocks reading swapped values from
8143 * disk into memory when a value swapped out is needed in memory) that is made
8144 * unblocking by trying to examine the command argument vector in order to
8145 * load in background values that will likely be needed in order to exec
8146 * the command. The command is executed only once all the relevant keys
8147 * are loaded into memory.
8149 * This basically is almost as simple of a blocking VM, but almost as parallel
8150 * as a fully non-blocking VM.
8153 /* =================== Virtual Memory - Blocking Side ====================== */
8155 /* substitute the first occurrence of '%p' with the process pid in the
8156 * swap file name. */
8157 static void expandVmSwapFilename(void) {
8158 char *p
= strstr(server
.vm_swap_file
,"%p");
8164 new = sdscat(new,server
.vm_swap_file
);
8165 new = sdscatprintf(new,"%ld",(long) getpid());
8166 new = sdscat(new,p
+2);
8167 zfree(server
.vm_swap_file
);
8168 server
.vm_swap_file
= new;
8171 static void vmInit(void) {
8176 if (server
.vm_max_threads
!= 0)
8177 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8179 expandVmSwapFilename();
8180 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8181 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8182 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8184 if (server
.vm_fp
== NULL
) {
8185 redisLog(REDIS_WARNING
,
8186 "Impossible to open the swap file: %s. Exiting.",
8190 server
.vm_fd
= fileno(server
.vm_fp
);
8191 server
.vm_next_page
= 0;
8192 server
.vm_near_pages
= 0;
8193 server
.vm_stats_used_pages
= 0;
8194 server
.vm_stats_swapped_objects
= 0;
8195 server
.vm_stats_swapouts
= 0;
8196 server
.vm_stats_swapins
= 0;
8197 totsize
= server
.vm_pages
*server
.vm_page_size
;
8198 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8199 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8200 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8204 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8206 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8207 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8208 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8209 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8211 /* Initialize threaded I/O (used by Virtual Memory) */
8212 server
.io_newjobs
= listCreate();
8213 server
.io_processing
= listCreate();
8214 server
.io_processed
= listCreate();
8215 server
.io_ready_clients
= listCreate();
8216 pthread_mutex_init(&server
.io_mutex
,NULL
);
8217 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8218 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8219 server
.io_active_threads
= 0;
8220 if (pipe(pipefds
) == -1) {
8221 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8225 server
.io_ready_pipe_read
= pipefds
[0];
8226 server
.io_ready_pipe_write
= pipefds
[1];
8227 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8228 /* LZF requires a lot of stack */
8229 pthread_attr_init(&server
.io_threads_attr
);
8230 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8231 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8232 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8233 /* Listen for events in the threaded I/O pipe */
8234 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8235 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8236 oom("creating file event");
8239 /* Mark the page as used */
8240 static void vmMarkPageUsed(off_t page
) {
8241 off_t byte
= page
/8;
8243 redisAssert(vmFreePage(page
) == 1);
8244 server
.vm_bitmap
[byte
] |= 1<<bit
;
8247 /* Mark N contiguous pages as used, with 'page' being the first. */
8248 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8251 for (j
= 0; j
< count
; j
++)
8252 vmMarkPageUsed(page
+j
);
8253 server
.vm_stats_used_pages
+= count
;
8254 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8255 (long long)count
, (long long)page
);
8258 /* Mark the page as free */
8259 static void vmMarkPageFree(off_t page
) {
8260 off_t byte
= page
/8;
8262 redisAssert(vmFreePage(page
) == 0);
8263 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8266 /* Mark N contiguous pages as free, with 'page' being the first. */
8267 static void vmMarkPagesFree(off_t page
, off_t count
) {
8270 for (j
= 0; j
< count
; j
++)
8271 vmMarkPageFree(page
+j
);
8272 server
.vm_stats_used_pages
-= count
;
8273 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8274 (long long)count
, (long long)page
);
8277 /* Test if the page is free */
8278 static int vmFreePage(off_t page
) {
8279 off_t byte
= page
/8;
8281 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8284 /* Find N contiguous free pages storing the first page of the cluster in *first.
8285 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8286 * REDIS_ERR is returned.
8288 * This function uses a simple algorithm: we try to allocate
8289 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8290 * again from the start of the swap file searching for free spaces.
8292 * If it looks pretty clear that there are no free pages near our offset
8293 * we try to find less populated places doing a forward jump of
8294 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8295 * without hurry, and then we jump again and so forth...
8297 * This function can be improved using a free list to avoid to guess
8298 * too much, since we could collect data about freed pages.
8300 * note: I implemented this function just after watching an episode of
8301 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8303 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8304 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8306 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8307 server
.vm_near_pages
= 0;
8308 server
.vm_next_page
= 0;
8310 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8311 base
= server
.vm_next_page
;
8313 while(offset
< server
.vm_pages
) {
8314 off_t
this = base
+offset
;
8316 /* If we overflow, restart from page zero */
8317 if (this >= server
.vm_pages
) {
8318 this -= server
.vm_pages
;
8320 /* Just overflowed, what we found on tail is no longer
8321 * interesting, as it's no longer contiguous. */
8325 if (vmFreePage(this)) {
8326 /* This is a free page */
8328 /* Already got N free pages? Return to the caller, with success */
8330 *first
= this-(n
-1);
8331 server
.vm_next_page
= this+1;
8332 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8336 /* The current one is not a free page */
8340 /* Fast-forward if the current page is not free and we already
8341 * searched enough near this place. */
8343 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8344 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8346 /* Note that even if we rewind after the jump, we are don't need
8347 * to make sure numfree is set to zero as we only jump *if* it
8348 * is set to zero. */
8350 /* Otherwise just check the next page */
8357 /* Write the specified object at the specified page of the swap file */
8358 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8359 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8360 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8361 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8362 redisLog(REDIS_WARNING
,
8363 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8367 rdbSaveObject(server
.vm_fp
,o
);
8368 fflush(server
.vm_fp
);
8369 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8373 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8374 * needed to later retrieve the object into the key object.
8375 * If we can't find enough contiguous empty pages to swap the object on disk
8376 * REDIS_ERR is returned. */
8377 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8378 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8381 assert(key
->storage
== REDIS_VM_MEMORY
);
8382 assert(key
->refcount
== 1);
8383 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8384 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8385 key
->vm
.page
= page
;
8386 key
->vm
.usedpages
= pages
;
8387 key
->storage
= REDIS_VM_SWAPPED
;
8388 key
->vtype
= val
->type
;
8389 decrRefCount(val
); /* Deallocate the object from memory. */
8390 vmMarkPagesUsed(page
,pages
);
8391 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8392 (unsigned char*) key
->ptr
,
8393 (unsigned long long) page
, (unsigned long long) pages
);
8394 server
.vm_stats_swapped_objects
++;
8395 server
.vm_stats_swapouts
++;
8399 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8402 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8403 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8404 redisLog(REDIS_WARNING
,
8405 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8409 o
= rdbLoadObject(type
,server
.vm_fp
);
8411 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8414 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8418 /* Load the value object relative to the 'key' object from swap to memory.
8419 * The newly allocated object is returned.
8421 * If preview is true the unserialized object is returned to the caller but
8422 * no changes are made to the key object, nor the pages are marked as freed */
8423 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8426 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8427 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8429 key
->storage
= REDIS_VM_MEMORY
;
8430 key
->vm
.atime
= server
.unixtime
;
8431 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8432 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8433 (unsigned char*) key
->ptr
);
8434 server
.vm_stats_swapped_objects
--;
8436 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8437 (unsigned char*) key
->ptr
);
8439 server
.vm_stats_swapins
++;
8443 /* Plain object loading, from swap to memory */
8444 static robj
*vmLoadObject(robj
*key
) {
8445 /* If we are loading the object in background, stop it, we
8446 * need to load this object synchronously ASAP. */
8447 if (key
->storage
== REDIS_VM_LOADING
)
8448 vmCancelThreadedIOJob(key
);
8449 return vmGenericLoadObject(key
,0);
8452 /* Just load the value on disk, without to modify the key.
8453 * This is useful when we want to perform some operation on the value
8454 * without to really bring it from swap to memory, like while saving the
8455 * dataset or rewriting the append only log. */
8456 static robj
*vmPreviewObject(robj
*key
) {
8457 return vmGenericLoadObject(key
,1);
8460 /* How a good candidate is this object for swapping?
8461 * The better candidate it is, the greater the returned value.
8463 * Currently we try to perform a fast estimation of the object size in
8464 * memory, and combine it with aging informations.
8466 * Basically swappability = idle-time * log(estimated size)
8468 * Bigger objects are preferred over smaller objects, but not
8469 * proportionally, this is why we use the logarithm. This algorithm is
8470 * just a first try and will probably be tuned later. */
8471 static double computeObjectSwappability(robj
*o
) {
8472 time_t age
= server
.unixtime
- o
->vm
.atime
;
8476 struct dictEntry
*de
;
8479 if (age
<= 0) return 0;
8482 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8485 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8490 listNode
*ln
= listFirst(l
);
8492 asize
= sizeof(list
);
8494 robj
*ele
= ln
->value
;
8497 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8498 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8500 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8505 z
= (o
->type
== REDIS_ZSET
);
8506 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8508 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8509 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8514 de
= dictGetRandomKey(d
);
8515 ele
= dictGetEntryKey(de
);
8516 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8517 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8519 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8520 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8524 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8525 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8526 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8527 unsigned int klen
, vlen
;
8528 unsigned char *key
, *val
;
8530 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8534 asize
= len
*(klen
+vlen
+3);
8535 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8537 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8542 de
= dictGetRandomKey(d
);
8543 ele
= dictGetEntryKey(de
);
8544 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8545 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8547 ele
= dictGetEntryVal(de
);
8548 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8549 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8551 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8556 return (double)age
*log(1+asize
);
8559 /* Try to swap an object that's a good candidate for swapping.
8560 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8561 * to swap any object at all.
8563 * If 'usethreaded' is true, Redis will try to swap the object in background
8564 * using I/O threads. */
8565 static int vmSwapOneObject(int usethreads
) {
8567 struct dictEntry
*best
= NULL
;
8568 double best_swappability
= 0;
8569 redisDb
*best_db
= NULL
;
8572 for (j
= 0; j
< server
.dbnum
; j
++) {
8573 redisDb
*db
= server
.db
+j
;
8574 /* Why maxtries is set to 100?
8575 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8576 * are swappable objects */
8579 if (dictSize(db
->dict
) == 0) continue;
8580 for (i
= 0; i
< 5; i
++) {
8582 double swappability
;
8584 if (maxtries
) maxtries
--;
8585 de
= dictGetRandomKey(db
->dict
);
8586 key
= dictGetEntryKey(de
);
8587 val
= dictGetEntryVal(de
);
8588 /* Only swap objects that are currently in memory.
8590 * Also don't swap shared objects if threaded VM is on, as we
8591 * try to ensure that the main thread does not touch the
8592 * object while the I/O thread is using it, but we can't
8593 * control other keys without adding additional mutex. */
8594 if (key
->storage
!= REDIS_VM_MEMORY
||
8595 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8596 if (maxtries
) i
--; /* don't count this try */
8599 swappability
= computeObjectSwappability(val
);
8600 if (!best
|| swappability
> best_swappability
) {
8602 best_swappability
= swappability
;
8607 if (best
== NULL
) return REDIS_ERR
;
8608 key
= dictGetEntryKey(best
);
8609 val
= dictGetEntryVal(best
);
8611 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8612 key
->ptr
, best_swappability
);
8614 /* Unshare the key if needed */
8615 if (key
->refcount
> 1) {
8616 robj
*newkey
= dupStringObject(key
);
8618 key
= dictGetEntryKey(best
) = newkey
;
8622 vmSwapObjectThreaded(key
,val
,best_db
);
8625 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8626 dictGetEntryVal(best
) = NULL
;
8634 static int vmSwapOneObjectBlocking() {
8635 return vmSwapOneObject(0);
8638 static int vmSwapOneObjectThreaded() {
8639 return vmSwapOneObject(1);
8642 /* Return true if it's safe to swap out objects in a given moment.
8643 * Basically we don't want to swap objects out while there is a BGSAVE
8644 * or a BGAEOREWRITE running in backgroud. */
8645 static int vmCanSwapOut(void) {
8646 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8649 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8650 * and was deleted. Otherwise 0 is returned. */
8651 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8655 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8656 foundkey
= dictGetEntryKey(de
);
8657 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8662 /* =================== Virtual Memory - Threaded I/O ======================= */
8664 static void freeIOJob(iojob
*j
) {
8665 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8666 j
->type
== REDIS_IOJOB_DO_SWAP
||
8667 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8668 decrRefCount(j
->val
);
8669 decrRefCount(j
->key
);
8673 /* Every time a thread finished a Job, it writes a byte into the write side
8674 * of an unix pipe in order to "awake" the main thread, and this function
8676 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8680 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8682 REDIS_NOTUSED(mask
);
8683 REDIS_NOTUSED(privdata
);
8685 /* For every byte we read in the read side of the pipe, there is one
8686 * I/O job completed to process. */
8687 while((retval
= read(fd
,buf
,1)) == 1) {
8691 struct dictEntry
*de
;
8693 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8695 /* Get the processed element (the oldest one) */
8697 assert(listLength(server
.io_processed
) != 0);
8698 if (toprocess
== -1) {
8699 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8700 if (toprocess
<= 0) toprocess
= 1;
8702 ln
= listFirst(server
.io_processed
);
8704 listDelNode(server
.io_processed
,ln
);
8706 /* If this job is marked as canceled, just ignore it */
8711 /* Post process it in the main thread, as there are things we
8712 * can do just here to avoid race conditions and/or invasive locks */
8713 redisLog(REDIS_DEBUG
,"Job %p type: %d, key at %p (%s) refcount: %d\n", (void*) j
, j
->type
, (void*)j
->key
, (char*)j
->key
->ptr
, j
->key
->refcount
);
8714 de
= dictFind(j
->db
->dict
,j
->key
);
8716 key
= dictGetEntryKey(de
);
8717 if (j
->type
== REDIS_IOJOB_LOAD
) {
8720 /* Key loaded, bring it at home */
8721 key
->storage
= REDIS_VM_MEMORY
;
8722 key
->vm
.atime
= server
.unixtime
;
8723 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8724 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8725 (unsigned char*) key
->ptr
);
8726 server
.vm_stats_swapped_objects
--;
8727 server
.vm_stats_swapins
++;
8728 dictGetEntryVal(de
) = j
->val
;
8729 incrRefCount(j
->val
);
8732 /* Handle clients waiting for this key to be loaded. */
8733 handleClientsBlockedOnSwappedKey(db
,key
);
8734 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8735 /* Now we know the amount of pages required to swap this object.
8736 * Let's find some space for it, and queue this task again
8737 * rebranded as REDIS_IOJOB_DO_SWAP. */
8738 if (!vmCanSwapOut() ||
8739 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8741 /* Ooops... no space or we can't swap as there is
8742 * a fork()ed Redis trying to save stuff on disk. */
8744 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8746 /* Note that we need to mark this pages as used now,
8747 * if the job will be canceled, we'll mark them as freed
8749 vmMarkPagesUsed(j
->page
,j
->pages
);
8750 j
->type
= REDIS_IOJOB_DO_SWAP
;
8755 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8758 /* Key swapped. We can finally free some memory. */
8759 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8760 printf("key->storage: %d\n",key
->storage
);
8761 printf("key->name: %s\n",(char*)key
->ptr
);
8762 printf("key->refcount: %d\n",key
->refcount
);
8763 printf("val: %p\n",(void*)j
->val
);
8764 printf("val->type: %d\n",j
->val
->type
);
8765 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8767 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8768 val
= dictGetEntryVal(de
);
8769 key
->vm
.page
= j
->page
;
8770 key
->vm
.usedpages
= j
->pages
;
8771 key
->storage
= REDIS_VM_SWAPPED
;
8772 key
->vtype
= j
->val
->type
;
8773 decrRefCount(val
); /* Deallocate the object from memory. */
8774 dictGetEntryVal(de
) = NULL
;
8775 redisLog(REDIS_DEBUG
,
8776 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8777 (unsigned char*) key
->ptr
,
8778 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8779 server
.vm_stats_swapped_objects
++;
8780 server
.vm_stats_swapouts
++;
8782 /* Put a few more swap requests in queue if we are still
8784 if (trytoswap
&& vmCanSwapOut() &&
8785 zmalloc_used_memory() > server
.vm_max_memory
)
8790 more
= listLength(server
.io_newjobs
) <
8791 (unsigned) server
.vm_max_threads
;
8793 /* Don't waste CPU time if swappable objects are rare. */
8794 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8802 if (processed
== toprocess
) return;
8804 if (retval
< 0 && errno
!= EAGAIN
) {
8805 redisLog(REDIS_WARNING
,
8806 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8811 static void lockThreadedIO(void) {
8812 pthread_mutex_lock(&server
.io_mutex
);
8815 static void unlockThreadedIO(void) {
8816 pthread_mutex_unlock(&server
.io_mutex
);
8819 /* Remove the specified object from the threaded I/O queue if still not
8820 * processed, otherwise make sure to flag it as canceled. */
8821 static void vmCancelThreadedIOJob(robj
*o
) {
8823 server
.io_newjobs
, /* 0 */
8824 server
.io_processing
, /* 1 */
8825 server
.io_processed
/* 2 */
8829 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8832 /* Search for a matching key in one of the queues */
8833 for (i
= 0; i
< 3; i
++) {
8837 listRewind(lists
[i
],&li
);
8838 while ((ln
= listNext(&li
)) != NULL
) {
8839 iojob
*job
= ln
->value
;
8841 if (job
->canceled
) continue; /* Skip this, already canceled. */
8842 if (compareStringObjects(job
->key
,o
) == 0) {
8843 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8844 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8845 /* Mark the pages as free since the swap didn't happened
8846 * or happened but is now discarded. */
8847 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8848 vmMarkPagesFree(job
->page
,job
->pages
);
8849 /* Cancel the job. It depends on the list the job is
8852 case 0: /* io_newjobs */
8853 /* If the job was yet not processed the best thing to do
8854 * is to remove it from the queue at all */
8856 listDelNode(lists
[i
],ln
);
8858 case 1: /* io_processing */
8859 /* Oh Shi- the thread is messing with the Job:
8861 * Probably it's accessing the object if this is a
8862 * PREPARE_SWAP or DO_SWAP job.
8863 * If it's a LOAD job it may be reading from disk and
8864 * if we don't wait for the job to terminate before to
8865 * cancel it, maybe in a few microseconds data can be
8866 * corrupted in this pages. So the short story is:
8868 * Better to wait for the job to move into the
8869 * next queue (processed)... */
8871 /* We try again and again until the job is completed. */
8873 /* But let's wait some time for the I/O thread
8874 * to finish with this job. After all this condition
8875 * should be very rare. */
8878 case 2: /* io_processed */
8879 /* The job was already processed, that's easy...
8880 * just mark it as canceled so that we'll ignore it
8881 * when processing completed jobs. */
8885 /* Finally we have to adjust the storage type of the object
8886 * in order to "UNDO" the operaiton. */
8887 if (o
->storage
== REDIS_VM_LOADING
)
8888 o
->storage
= REDIS_VM_SWAPPED
;
8889 else if (o
->storage
== REDIS_VM_SWAPPING
)
8890 o
->storage
= REDIS_VM_MEMORY
;
8897 assert(1 != 1); /* We should never reach this */
8900 static void *IOThreadEntryPoint(void *arg
) {
8905 pthread_detach(pthread_self());
8907 /* Get a new job to process */
8909 if (listLength(server
.io_newjobs
) == 0) {
8910 /* No new jobs in queue, exit. */
8911 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8912 (long) pthread_self());
8913 server
.io_active_threads
--;
8917 ln
= listFirst(server
.io_newjobs
);
8919 listDelNode(server
.io_newjobs
,ln
);
8920 /* Add the job in the processing queue */
8921 j
->thread
= pthread_self();
8922 listAddNodeTail(server
.io_processing
,j
);
8923 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8925 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8926 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8928 /* Process the Job */
8929 if (j
->type
== REDIS_IOJOB_LOAD
) {
8930 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8931 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8932 FILE *fp
= fopen("/dev/null","w+");
8933 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8935 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8936 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8940 /* Done: insert the job into the processed queue */
8941 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8942 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8944 listDelNode(server
.io_processing
,ln
);
8945 listAddNodeTail(server
.io_processed
,j
);
8948 /* Signal the main thread there is new stuff to process */
8949 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8951 return NULL
; /* never reached */
8954 static void spawnIOThread(void) {
8956 sigset_t mask
, omask
;
8960 sigaddset(&mask
,SIGCHLD
);
8961 sigaddset(&mask
,SIGHUP
);
8962 sigaddset(&mask
,SIGPIPE
);
8963 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8964 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
8965 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
8969 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8970 server
.io_active_threads
++;
8973 /* We need to wait for the last thread to exit before we are able to
8974 * fork() in order to BGSAVE or BGREWRITEAOF. */
8975 static void waitEmptyIOJobsQueue(void) {
8977 int io_processed_len
;
8980 if (listLength(server
.io_newjobs
) == 0 &&
8981 listLength(server
.io_processing
) == 0 &&
8982 server
.io_active_threads
== 0)
8987 /* While waiting for empty jobs queue condition we post-process some
8988 * finshed job, as I/O threads may be hanging trying to write against
8989 * the io_ready_pipe_write FD but there are so much pending jobs that
8991 io_processed_len
= listLength(server
.io_processed
);
8993 if (io_processed_len
) {
8994 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8995 usleep(1000); /* 1 millisecond */
8997 usleep(10000); /* 10 milliseconds */
9002 static void vmReopenSwapFile(void) {
9003 /* Note: we don't close the old one as we are in the child process
9004 * and don't want to mess at all with the original file object. */
9005 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9006 if (server
.vm_fp
== NULL
) {
9007 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9008 server
.vm_swap_file
);
9011 server
.vm_fd
= fileno(server
.vm_fp
);
9014 /* This function must be called while with threaded IO locked */
9015 static void queueIOJob(iojob
*j
) {
9016 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9017 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9018 listAddNodeTail(server
.io_newjobs
,j
);
9019 if (server
.io_active_threads
< server
.vm_max_threads
)
9023 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9026 assert(key
->storage
== REDIS_VM_MEMORY
);
9027 assert(key
->refcount
== 1);
9029 j
= zmalloc(sizeof(*j
));
9030 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9032 j
->key
= dupStringObject(key
);
9036 j
->thread
= (pthread_t
) -1;
9037 key
->storage
= REDIS_VM_SWAPPING
;
9045 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9047 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9048 * If there is not already a job loading the key, it is craeted.
9049 * The key is added to the io_keys list in the client structure, and also
9050 * in the hash table mapping swapped keys to waiting clients, that is,
9051 * server.io_waited_keys. */
9052 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9053 struct dictEntry
*de
;
9057 /* If the key does not exist or is already in RAM we don't need to
9058 * block the client at all. */
9059 de
= dictFind(c
->db
->dict
,key
);
9060 if (de
== NULL
) return 0;
9061 o
= dictGetEntryKey(de
);
9062 if (o
->storage
== REDIS_VM_MEMORY
) {
9064 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9065 /* We were swapping the key, undo it! */
9066 vmCancelThreadedIOJob(o
);
9070 /* OK: the key is either swapped, or being loaded just now. */
9072 /* Add the key to the list of keys this client is waiting for.
9073 * This maps clients to keys they are waiting for. */
9074 listAddNodeTail(c
->io_keys
,key
);
9077 /* Add the client to the swapped keys => clients waiting map. */
9078 de
= dictFind(c
->db
->io_keys
,key
);
9082 /* For every key we take a list of clients blocked for it */
9084 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9086 assert(retval
== DICT_OK
);
9088 l
= dictGetEntryVal(de
);
9090 listAddNodeTail(l
,c
);
9092 /* Are we already loading the key from disk? If not create a job */
9093 if (o
->storage
== REDIS_VM_SWAPPED
) {
9096 o
->storage
= REDIS_VM_LOADING
;
9097 j
= zmalloc(sizeof(*j
));
9098 j
->type
= REDIS_IOJOB_LOAD
;
9100 j
->key
= dupStringObject(key
);
9101 j
->key
->vtype
= o
->vtype
;
9102 j
->page
= o
->vm
.page
;
9105 j
->thread
= (pthread_t
) -1;
9113 /* Preload keys needed for the ZUNION and ZINTER commands. */
9114 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9116 num
= atoi(c
->argv
[2]->ptr
);
9117 for (i
= 0; i
< num
; i
++) {
9118 waitForSwappedKey(c
,c
->argv
[3+i
]);
9122 /* Is this client attempting to run a command against swapped keys?
9123 * If so, block it ASAP, load the keys in background, then resume it.
9125 * The important idea about this function is that it can fail! If keys will
9126 * still be swapped when the client is resumed, this key lookups will
9127 * just block loading keys from disk. In practical terms this should only
9128 * happen with SORT BY command or if there is a bug in this function.
9130 * Return 1 if the client is marked as blocked, 0 if the client can
9131 * continue as the keys it is going to access appear to be in memory. */
9132 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9135 if (cmd
->vm_preload_proc
!= NULL
) {
9136 cmd
->vm_preload_proc(c
);
9138 if (cmd
->vm_firstkey
== 0) return 0;
9139 last
= cmd
->vm_lastkey
;
9140 if (last
< 0) last
= c
->argc
+last
;
9141 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9142 waitForSwappedKey(c
,c
->argv
[j
]);
9145 /* If the client was blocked for at least one key, mark it as blocked. */
9146 if (listLength(c
->io_keys
)) {
9147 c
->flags
|= REDIS_IO_WAIT
;
9148 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9149 server
.vm_blocked_clients
++;
9156 /* Remove the 'key' from the list of blocked keys for a given client.
9158 * The function returns 1 when there are no longer blocking keys after
9159 * the current one was removed (and the client can be unblocked). */
9160 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9164 struct dictEntry
*de
;
9166 /* Remove the key from the list of keys this client is waiting for. */
9167 listRewind(c
->io_keys
,&li
);
9168 while ((ln
= listNext(&li
)) != NULL
) {
9169 if (compareStringObjects(ln
->value
,key
) == 0) {
9170 listDelNode(c
->io_keys
,ln
);
9176 /* Remove the client form the key => waiting clients map. */
9177 de
= dictFind(c
->db
->io_keys
,key
);
9179 l
= dictGetEntryVal(de
);
9180 ln
= listSearchKey(l
,c
);
9183 if (listLength(l
) == 0)
9184 dictDelete(c
->db
->io_keys
,key
);
9186 return listLength(c
->io_keys
) == 0;
9189 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9190 struct dictEntry
*de
;
9195 de
= dictFind(db
->io_keys
,key
);
9198 l
= dictGetEntryVal(de
);
9199 len
= listLength(l
);
9200 /* Note: we can't use something like while(listLength(l)) as the list
9201 * can be freed by the calling function when we remove the last element. */
9204 redisClient
*c
= ln
->value
;
9206 if (dontWaitForSwappedKey(c
,key
)) {
9207 /* Put the client in the list of clients ready to go as we
9208 * loaded all the keys about it. */
9209 listAddNodeTail(server
.io_ready_clients
,c
);
9214 /* =========================== Remote Configuration ========================= */
9216 static void configSetCommand(redisClient
*c
) {
9217 robj
*o
= getDecodedObject(c
->argv
[3]);
9218 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9219 zfree(server
.dbfilename
);
9220 server
.dbfilename
= zstrdup(o
->ptr
);
9221 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9222 zfree(server
.requirepass
);
9223 server
.requirepass
= zstrdup(o
->ptr
);
9224 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9225 zfree(server
.masterauth
);
9226 server
.masterauth
= zstrdup(o
->ptr
);
9227 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9228 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9230 addReplySds(c
,sdscatprintf(sdsempty(),
9231 "-ERR not supported CONFIG parameter %s\r\n",
9232 (char*)c
->argv
[2]->ptr
));
9237 addReply(c
,shared
.ok
);
9240 static void configGetCommand(redisClient
*c
) {
9241 robj
*o
= getDecodedObject(c
->argv
[2]);
9242 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9243 char *pattern
= o
->ptr
;
9247 decrRefCount(lenobj
);
9249 if (stringmatch(pattern
,"dbfilename",0)) {
9250 addReplyBulkCString(c
,"dbfilename");
9251 addReplyBulkCString(c
,server
.dbfilename
);
9254 if (stringmatch(pattern
,"requirepass",0)) {
9255 addReplyBulkCString(c
,"requirepass");
9256 addReplyBulkCString(c
,server
.requirepass
);
9259 if (stringmatch(pattern
,"masterauth",0)) {
9260 addReplyBulkCString(c
,"masterauth");
9261 addReplyBulkCString(c
,server
.masterauth
);
9264 if (stringmatch(pattern
,"maxmemory",0)) {
9267 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9268 addReplyBulkCString(c
,"maxmemory");
9269 addReplyBulkCString(c
,buf
);
9273 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9276 static void configCommand(redisClient
*c
) {
9277 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9278 if (c
->argc
!= 4) goto badarity
;
9279 configSetCommand(c
);
9280 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9281 if (c
->argc
!= 3) goto badarity
;
9282 configGetCommand(c
);
9283 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9284 if (c
->argc
!= 2) goto badarity
;
9285 server
.stat_numcommands
= 0;
9286 server
.stat_numconnections
= 0;
9287 server
.stat_expiredkeys
= 0;
9288 server
.stat_starttime
= time(NULL
);
9289 addReply(c
,shared
.ok
);
9291 addReplySds(c
,sdscatprintf(sdsempty(),
9292 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9297 addReplySds(c
,sdscatprintf(sdsempty(),
9298 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9299 (char*) c
->argv
[1]->ptr
));
9302 /* =========================== Pubsub implementation ======================== */
9304 static void freePubsubPattern(void *p
) {
9305 pubsubPattern
*pat
= p
;
9307 decrRefCount(pat
->pattern
);
9311 static int listMatchPubsubPattern(void *a
, void *b
) {
9312 pubsubPattern
*pa
= a
, *pb
= b
;
9314 return (pa
->client
== pb
->client
) &&
9315 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9318 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9319 * 0 if the client was already subscribed to that channel. */
9320 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9321 struct dictEntry
*de
;
9322 list
*clients
= NULL
;
9325 /* Add the channel to the client -> channels hash table */
9326 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9328 incrRefCount(channel
);
9329 /* Add the client to the channel -> list of clients hash table */
9330 de
= dictFind(server
.pubsub_channels
,channel
);
9332 clients
= listCreate();
9333 dictAdd(server
.pubsub_channels
,channel
,clients
);
9334 incrRefCount(channel
);
9336 clients
= dictGetEntryVal(de
);
9338 listAddNodeTail(clients
,c
);
9340 /* Notify the client */
9341 addReply(c
,shared
.mbulk3
);
9342 addReply(c
,shared
.subscribebulk
);
9343 addReplyBulk(c
,channel
);
9344 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9348 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9349 * 0 if the client was not subscribed to the specified channel. */
9350 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9351 struct dictEntry
*de
;
9356 /* Remove the channel from the client -> channels hash table */
9357 incrRefCount(channel
); /* channel may be just a pointer to the same object
9358 we have in the hash tables. Protect it... */
9359 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9361 /* Remove the client from the channel -> clients list hash table */
9362 de
= dictFind(server
.pubsub_channels
,channel
);
9364 clients
= dictGetEntryVal(de
);
9365 ln
= listSearchKey(clients
,c
);
9367 listDelNode(clients
,ln
);
9368 if (listLength(clients
) == 0) {
9369 /* Free the list and associated hash entry at all if this was
9370 * the latest client, so that it will be possible to abuse
9371 * Redis PUBSUB creating millions of channels. */
9372 dictDelete(server
.pubsub_channels
,channel
);
9375 /* Notify the client */
9377 addReply(c
,shared
.mbulk3
);
9378 addReply(c
,shared
.unsubscribebulk
);
9379 addReplyBulk(c
,channel
);
9380 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9381 listLength(c
->pubsub_patterns
));
9384 decrRefCount(channel
); /* it is finally safe to release it */
9388 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9389 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9392 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9395 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9396 incrRefCount(pattern
);
9397 pat
= zmalloc(sizeof(*pat
));
9398 pat
->pattern
= getDecodedObject(pattern
);
9400 listAddNodeTail(server
.pubsub_patterns
,pat
);
9402 /* Notify the client */
9403 addReply(c
,shared
.mbulk3
);
9404 addReply(c
,shared
.psubscribebulk
);
9405 addReplyBulk(c
,pattern
);
9406 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9410 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9411 * 0 if the client was not subscribed to the specified channel. */
9412 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9417 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9418 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9420 listDelNode(c
->pubsub_patterns
,ln
);
9422 pat
.pattern
= pattern
;
9423 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9424 listDelNode(server
.pubsub_patterns
,ln
);
9426 /* Notify the client */
9428 addReply(c
,shared
.mbulk3
);
9429 addReply(c
,shared
.punsubscribebulk
);
9430 addReplyBulk(c
,pattern
);
9431 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9432 listLength(c
->pubsub_patterns
));
9434 decrRefCount(pattern
);
9438 /* Unsubscribe from all the channels. Return the number of channels the
9439 * client was subscribed from. */
9440 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9441 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9445 while((de
= dictNext(di
)) != NULL
) {
9446 robj
*channel
= dictGetEntryKey(de
);
9448 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9450 dictReleaseIterator(di
);
9454 /* Unsubscribe from all the patterns. Return the number of patterns the
9455 * client was subscribed from. */
9456 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9461 listRewind(c
->pubsub_patterns
,&li
);
9462 while ((ln
= listNext(&li
)) != NULL
) {
9463 robj
*pattern
= ln
->value
;
9465 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9470 /* Publish a message */
9471 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9473 struct dictEntry
*de
;
9477 /* Send to clients listening for that channel */
9478 de
= dictFind(server
.pubsub_channels
,channel
);
9480 list
*list
= dictGetEntryVal(de
);
9484 listRewind(list
,&li
);
9485 while ((ln
= listNext(&li
)) != NULL
) {
9486 redisClient
*c
= ln
->value
;
9488 addReply(c
,shared
.mbulk3
);
9489 addReply(c
,shared
.messagebulk
);
9490 addReplyBulk(c
,channel
);
9491 addReplyBulk(c
,message
);
9495 /* Send to clients listening to matching channels */
9496 if (listLength(server
.pubsub_patterns
)) {
9497 listRewind(server
.pubsub_patterns
,&li
);
9498 channel
= getDecodedObject(channel
);
9499 while ((ln
= listNext(&li
)) != NULL
) {
9500 pubsubPattern
*pat
= ln
->value
;
9502 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9503 sdslen(pat
->pattern
->ptr
),
9504 (char*)channel
->ptr
,
9505 sdslen(channel
->ptr
),0)) {
9506 addReply(pat
->client
,shared
.mbulk3
);
9507 addReply(pat
->client
,shared
.messagebulk
);
9508 addReplyBulk(pat
->client
,channel
);
9509 addReplyBulk(pat
->client
,message
);
9513 decrRefCount(channel
);
9518 static void subscribeCommand(redisClient
*c
) {
9521 for (j
= 1; j
< c
->argc
; j
++)
9522 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9525 static void unsubscribeCommand(redisClient
*c
) {
9527 pubsubUnsubscribeAllChannels(c
,1);
9532 for (j
= 1; j
< c
->argc
; j
++)
9533 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9537 static void psubscribeCommand(redisClient
*c
) {
9540 for (j
= 1; j
< c
->argc
; j
++)
9541 pubsubSubscribePattern(c
,c
->argv
[j
]);
9544 static void punsubscribeCommand(redisClient
*c
) {
9546 pubsubUnsubscribeAllPatterns(c
,1);
9551 for (j
= 1; j
< c
->argc
; j
++)
9552 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9556 static void publishCommand(redisClient
*c
) {
9557 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9558 addReplyLong(c
,receivers
);
9561 /* ================================= Debugging ============================== */
9563 static void debugCommand(redisClient
*c
) {
9564 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9566 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9567 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9568 addReply(c
,shared
.err
);
9572 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9573 addReply(c
,shared
.err
);
9576 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9577 addReply(c
,shared
.ok
);
9578 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9580 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9581 addReply(c
,shared
.err
);
9584 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9585 addReply(c
,shared
.ok
);
9586 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9587 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9591 addReply(c
,shared
.nokeyerr
);
9594 key
= dictGetEntryKey(de
);
9595 val
= dictGetEntryVal(de
);
9596 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9597 key
->storage
== REDIS_VM_SWAPPING
)) {
9601 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9602 strenc
= strencoding
[val
->encoding
];
9604 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9607 addReplySds(c
,sdscatprintf(sdsempty(),
9608 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9609 "encoding:%s serializedlength:%lld\r\n",
9610 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9611 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9613 addReplySds(c
,sdscatprintf(sdsempty(),
9614 "+Key at:%p refcount:%d, value swapped at: page %llu "
9615 "using %llu pages\r\n",
9616 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9617 (unsigned long long) key
->vm
.usedpages
));
9619 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9620 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9623 if (!server
.vm_enabled
) {
9624 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9628 addReply(c
,shared
.nokeyerr
);
9631 key
= dictGetEntryKey(de
);
9632 val
= dictGetEntryVal(de
);
9633 /* If the key is shared we want to create a copy */
9634 if (key
->refcount
> 1) {
9635 robj
*newkey
= dupStringObject(key
);
9637 key
= dictGetEntryKey(de
) = newkey
;
9640 if (key
->storage
!= REDIS_VM_MEMORY
) {
9641 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9642 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9643 dictGetEntryVal(de
) = NULL
;
9644 addReply(c
,shared
.ok
);
9646 addReply(c
,shared
.err
);
9649 addReplySds(c
,sdsnew(
9650 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9654 static void _redisAssert(char *estr
, char *file
, int line
) {
9655 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9656 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9657 #ifdef HAVE_BACKTRACE
9658 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9663 /* =================================== Main! ================================ */
9666 int linuxOvercommitMemoryValue(void) {
9667 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9671 if (fgets(buf
,64,fp
) == NULL
) {
9680 void linuxOvercommitMemoryWarning(void) {
9681 if (linuxOvercommitMemoryValue() == 0) {
9682 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low condition memory. 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.");
9685 #endif /* __linux__ */
9687 static void daemonize(void) {
9691 if (fork() != 0) exit(0); /* parent exits */
9692 setsid(); /* create a new session */
9694 /* Every output goes to /dev/null. If Redis is daemonized but
9695 * the 'logfile' is set to 'stdout' in the configuration file
9696 * it will not log at all. */
9697 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9698 dup2(fd
, STDIN_FILENO
);
9699 dup2(fd
, STDOUT_FILENO
);
9700 dup2(fd
, STDERR_FILENO
);
9701 if (fd
> STDERR_FILENO
) close(fd
);
9703 /* Try to write the pid file */
9704 fp
= fopen(server
.pidfile
,"w");
9706 fprintf(fp
,"%d\n",getpid());
9711 static void version() {
9712 printf("Redis server version %s\n", REDIS_VERSION
);
9716 static void usage() {
9717 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9718 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9722 int main(int argc
, char **argv
) {
9727 if (strcmp(argv
[1], "-v") == 0 ||
9728 strcmp(argv
[1], "--version") == 0) version();
9729 if (strcmp(argv
[1], "--help") == 0) usage();
9730 resetServerSaveParams();
9731 loadServerConfig(argv
[1]);
9732 } else if ((argc
> 2)) {
9735 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'");
9737 if (server
.daemonize
) daemonize();
9739 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9741 linuxOvercommitMemoryWarning();
9744 if (server
.appendonly
) {
9745 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9746 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9748 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9749 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9751 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9752 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9754 aeDeleteEventLoop(server
.el
);
9758 /* ============================= Backtrace support ========================= */
9760 #ifdef HAVE_BACKTRACE
9761 static char *findFuncName(void *pointer
, unsigned long *offset
);
9763 static void *getMcontextEip(ucontext_t
*uc
) {
9764 #if defined(__FreeBSD__)
9765 return (void*) uc
->uc_mcontext
.mc_eip
;
9766 #elif defined(__dietlibc__)
9767 return (void*) uc
->uc_mcontext
.eip
;
9768 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9770 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9772 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9774 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9775 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9776 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9778 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9780 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9781 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9782 #elif defined(__ia64__) /* Linux IA64 */
9783 return (void*) uc
->uc_mcontext
.sc_ip
;
9789 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9791 char **messages
= NULL
;
9792 int i
, trace_size
= 0;
9793 unsigned long offset
=0;
9794 ucontext_t
*uc
= (ucontext_t
*) secret
;
9796 REDIS_NOTUSED(info
);
9798 redisLog(REDIS_WARNING
,
9799 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9800 infostring
= genRedisInfoString();
9801 redisLog(REDIS_WARNING
, "%s",infostring
);
9802 /* It's not safe to sdsfree() the returned string under memory
9803 * corruption conditions. Let it leak as we are going to abort */
9805 trace_size
= backtrace(trace
, 100);
9806 /* overwrite sigaction with caller's address */
9807 if (getMcontextEip(uc
) != NULL
) {
9808 trace
[1] = getMcontextEip(uc
);
9810 messages
= backtrace_symbols(trace
, trace_size
);
9812 for (i
=1; i
<trace_size
; ++i
) {
9813 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9815 p
= strchr(messages
[i
],'+');
9816 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9817 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9819 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9822 /* free(messages); Don't call free() with possibly corrupted memory. */
9826 static void setupSigSegvAction(void) {
9827 struct sigaction act
;
9829 sigemptyset (&act
.sa_mask
);
9830 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9831 * is used. Otherwise, sa_handler is used */
9832 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9833 act
.sa_sigaction
= segvHandler
;
9834 sigaction (SIGSEGV
, &act
, NULL
);
9835 sigaction (SIGBUS
, &act
, NULL
);
9836 sigaction (SIGFPE
, &act
, NULL
);
9837 sigaction (SIGILL
, &act
, NULL
);
9838 sigaction (SIGBUS
, &act
, NULL
);
9842 #include "staticsymbols.h"
9843 /* This function try to convert a pointer into a function name. It's used in
9844 * oreder to provide a backtrace under segmentation fault that's able to
9845 * display functions declared as static (otherwise the backtrace is useless). */
9846 static char *findFuncName(void *pointer
, unsigned long *offset
){
9848 unsigned long off
, minoff
= 0;
9850 /* Try to match against the Symbol with the smallest offset */
9851 for (i
=0; symsTable
[i
].pointer
; i
++) {
9852 unsigned long lp
= (unsigned long) pointer
;
9854 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9855 off
=lp
-symsTable
[i
].pointer
;
9856 if (ret
< 0 || off
< minoff
) {
9862 if (ret
== -1) return NULL
;
9864 return symsTable
[ret
].name
;
9866 #else /* HAVE_BACKTRACE */
9867 static void setupSigSegvAction(void) {
9869 #endif /* HAVE_BACKTRACE */