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.4"
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 4
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 100 /* try to expire 100 keys/second */
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. */
337 /* Global server state structure */
342 dict
*sharingpool
; /* Poll used for object sharing */
343 unsigned int sharingpoolsize
;
344 long long dirty
; /* changes to DB from the last save */
346 list
*slaves
, *monitors
;
347 char neterr
[ANET_ERR_LEN
];
349 int cronloops
; /* number of times the cron function run */
350 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
351 time_t lastsave
; /* Unix time of last save succeeede */
352 /* Fields used only for stats */
353 time_t stat_starttime
; /* server start time */
354 long long stat_numcommands
; /* number of processed commands */
355 long long stat_numconnections
; /* number of connections received */
368 pid_t bgsavechildpid
;
369 pid_t bgrewritechildpid
;
370 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
371 struct saveparam
*saveparams
;
376 char *appendfilename
;
380 /* Replication related */
385 redisClient
*master
; /* client that is master for this slave */
387 unsigned int maxclients
;
388 unsigned long long maxmemory
;
389 unsigned int blpop_blocked_clients
;
390 unsigned int vm_blocked_clients
;
391 /* Sort parameters - qsort_r() is only available under BSD so we
392 * have to take this state global, in order to pass it to sortCompare() */
396 /* Virtual memory configuration */
401 unsigned long long vm_max_memory
;
403 size_t hash_max_zipmap_entries
;
404 size_t hash_max_zipmap_value
;
405 /* Virtual memory state */
408 off_t vm_next_page
; /* Next probably empty page */
409 off_t vm_near_pages
; /* Number of pages allocated sequentially */
410 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
411 time_t unixtime
; /* Unix time sampled every second. */
412 /* Virtual memory I/O threads stuff */
413 /* An I/O thread process an element taken from the io_jobs queue and
414 * put the result of the operation in the io_done list. While the
415 * job is being processed, it's put on io_processing queue. */
416 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
417 list
*io_processing
; /* List of VM I/O jobs being processed */
418 list
*io_processed
; /* List of VM I/O jobs already processed */
419 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
420 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
421 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
422 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
423 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
424 int io_active_threads
; /* Number of running I/O threads */
425 int vm_max_threads
; /* Max number of I/O threads running at the same time */
426 /* Our main thread is blocked on the event loop, locking for sockets ready
427 * to be read or written, so when a threaded I/O operation is ready to be
428 * processed by the main thread, the I/O thread will use a unix pipe to
429 * awake the main thread. The followings are the two pipe FDs. */
430 int io_ready_pipe_read
;
431 int io_ready_pipe_write
;
432 /* Virtual memory stats */
433 unsigned long long vm_stats_used_pages
;
434 unsigned long long vm_stats_swapped_objects
;
435 unsigned long long vm_stats_swapouts
;
436 unsigned long long vm_stats_swapins
;
440 typedef void redisCommandProc(redisClient
*c
);
441 struct redisCommand
{
443 redisCommandProc
*proc
;
446 /* What keys should be loaded in background when calling this command? */
447 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
448 int vm_lastkey
; /* THe last argument that's a key */
449 int vm_keystep
; /* The step between first and last key */
452 struct redisFunctionSym
{
454 unsigned long pointer
;
457 typedef struct _redisSortObject
{
465 typedef struct _redisSortOperation
{
468 } redisSortOperation
;
470 /* ZSETs use a specialized version of Skiplists */
472 typedef struct zskiplistNode
{
473 struct zskiplistNode
**forward
;
474 struct zskiplistNode
*backward
;
480 typedef struct zskiplist
{
481 struct zskiplistNode
*header
, *tail
;
482 unsigned long length
;
486 typedef struct zset
{
491 /* Our shared "common" objects */
493 struct sharedObjectsStruct
{
494 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
495 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
496 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
497 *outofrangeerr
, *plus
,
498 *select0
, *select1
, *select2
, *select3
, *select4
,
499 *select5
, *select6
, *select7
, *select8
, *select9
;
502 /* Global vars that are actally used as constants. The following double
503 * values are used for double on-disk serialization, and are initialized
504 * at runtime to avoid strange compiler optimizations. */
506 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
508 /* VM threaded I/O request message */
509 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
510 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
511 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
512 typedef struct iojob
{
513 int type
; /* Request type, REDIS_IOJOB_* */
514 redisDb
*db
;/* Redis database */
515 robj
*key
; /* This I/O request is about swapping this key */
516 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
517 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
518 off_t page
; /* Swap page where to read/write the object */
519 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
520 int canceled
; /* True if this command was canceled by blocking side of VM */
521 pthread_t thread
; /* ID of the thread processing this entry */
524 /*================================ Prototypes =============================== */
526 static void freeStringObject(robj
*o
);
527 static void freeListObject(robj
*o
);
528 static void freeSetObject(robj
*o
);
529 static void decrRefCount(void *o
);
530 static robj
*createObject(int type
, void *ptr
);
531 static void freeClient(redisClient
*c
);
532 static int rdbLoad(char *filename
);
533 static void addReply(redisClient
*c
, robj
*obj
);
534 static void addReplySds(redisClient
*c
, sds s
);
535 static void incrRefCount(robj
*o
);
536 static int rdbSaveBackground(char *filename
);
537 static robj
*createStringObject(char *ptr
, size_t len
);
538 static robj
*dupStringObject(robj
*o
);
539 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
540 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
541 static int syncWithMaster(void);
542 static robj
*tryObjectSharing(robj
*o
);
543 static int tryObjectEncoding(robj
*o
);
544 static robj
*getDecodedObject(robj
*o
);
545 static int removeExpire(redisDb
*db
, robj
*key
);
546 static int expireIfNeeded(redisDb
*db
, robj
*key
);
547 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
548 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
549 static int deleteKey(redisDb
*db
, robj
*key
);
550 static time_t getExpire(redisDb
*db
, robj
*key
);
551 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
552 static void updateSlavesWaitingBgsave(int bgsaveerr
);
553 static void freeMemoryIfNeeded(void);
554 static int processCommand(redisClient
*c
);
555 static void setupSigSegvAction(void);
556 static void rdbRemoveTempFile(pid_t childpid
);
557 static void aofRemoveTempFile(pid_t childpid
);
558 static size_t stringObjectLen(robj
*o
);
559 static void processInputBuffer(redisClient
*c
);
560 static zskiplist
*zslCreate(void);
561 static void zslFree(zskiplist
*zsl
);
562 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
563 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
564 static void initClientMultiState(redisClient
*c
);
565 static void freeClientMultiState(redisClient
*c
);
566 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
567 static void unblockClientWaitingData(redisClient
*c
);
568 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
569 static void vmInit(void);
570 static void vmMarkPagesFree(off_t page
, off_t count
);
571 static robj
*vmLoadObject(robj
*key
);
572 static robj
*vmPreviewObject(robj
*key
);
573 static int vmSwapOneObjectBlocking(void);
574 static int vmSwapOneObjectThreaded(void);
575 static int vmCanSwapOut(void);
576 static int tryFreeOneObjectFromFreelist(void);
577 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
578 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
579 static void vmCancelThreadedIOJob(robj
*o
);
580 static void lockThreadedIO(void);
581 static void unlockThreadedIO(void);
582 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
583 static void freeIOJob(iojob
*j
);
584 static void queueIOJob(iojob
*j
);
585 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
586 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
587 static void waitEmptyIOJobsQueue(void);
588 static void vmReopenSwapFile(void);
589 static int vmFreePage(off_t page
);
590 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
591 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
592 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
593 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
594 static struct redisCommand
*lookupCommand(char *name
);
595 static void call(redisClient
*c
, struct redisCommand
*cmd
);
596 static void resetClient(redisClient
*c
);
597 static void convertToRealHash(robj
*o
);
599 static void authCommand(redisClient
*c
);
600 static void pingCommand(redisClient
*c
);
601 static void echoCommand(redisClient
*c
);
602 static void setCommand(redisClient
*c
);
603 static void setnxCommand(redisClient
*c
);
604 static void getCommand(redisClient
*c
);
605 static void delCommand(redisClient
*c
);
606 static void existsCommand(redisClient
*c
);
607 static void incrCommand(redisClient
*c
);
608 static void decrCommand(redisClient
*c
);
609 static void incrbyCommand(redisClient
*c
);
610 static void decrbyCommand(redisClient
*c
);
611 static void selectCommand(redisClient
*c
);
612 static void randomkeyCommand(redisClient
*c
);
613 static void keysCommand(redisClient
*c
);
614 static void dbsizeCommand(redisClient
*c
);
615 static void lastsaveCommand(redisClient
*c
);
616 static void saveCommand(redisClient
*c
);
617 static void bgsaveCommand(redisClient
*c
);
618 static void bgrewriteaofCommand(redisClient
*c
);
619 static void shutdownCommand(redisClient
*c
);
620 static void moveCommand(redisClient
*c
);
621 static void renameCommand(redisClient
*c
);
622 static void renamenxCommand(redisClient
*c
);
623 static void lpushCommand(redisClient
*c
);
624 static void rpushCommand(redisClient
*c
);
625 static void lpopCommand(redisClient
*c
);
626 static void rpopCommand(redisClient
*c
);
627 static void llenCommand(redisClient
*c
);
628 static void lindexCommand(redisClient
*c
);
629 static void lrangeCommand(redisClient
*c
);
630 static void ltrimCommand(redisClient
*c
);
631 static void typeCommand(redisClient
*c
);
632 static void lsetCommand(redisClient
*c
);
633 static void saddCommand(redisClient
*c
);
634 static void sremCommand(redisClient
*c
);
635 static void smoveCommand(redisClient
*c
);
636 static void sismemberCommand(redisClient
*c
);
637 static void scardCommand(redisClient
*c
);
638 static void spopCommand(redisClient
*c
);
639 static void srandmemberCommand(redisClient
*c
);
640 static void sinterCommand(redisClient
*c
);
641 static void sinterstoreCommand(redisClient
*c
);
642 static void sunionCommand(redisClient
*c
);
643 static void sunionstoreCommand(redisClient
*c
);
644 static void sdiffCommand(redisClient
*c
);
645 static void sdiffstoreCommand(redisClient
*c
);
646 static void syncCommand(redisClient
*c
);
647 static void flushdbCommand(redisClient
*c
);
648 static void flushallCommand(redisClient
*c
);
649 static void sortCommand(redisClient
*c
);
650 static void lremCommand(redisClient
*c
);
651 static void rpoplpushcommand(redisClient
*c
);
652 static void infoCommand(redisClient
*c
);
653 static void mgetCommand(redisClient
*c
);
654 static void monitorCommand(redisClient
*c
);
655 static void expireCommand(redisClient
*c
);
656 static void expireatCommand(redisClient
*c
);
657 static void getsetCommand(redisClient
*c
);
658 static void ttlCommand(redisClient
*c
);
659 static void slaveofCommand(redisClient
*c
);
660 static void debugCommand(redisClient
*c
);
661 static void msetCommand(redisClient
*c
);
662 static void msetnxCommand(redisClient
*c
);
663 static void zaddCommand(redisClient
*c
);
664 static void zincrbyCommand(redisClient
*c
);
665 static void zrangeCommand(redisClient
*c
);
666 static void zrangebyscoreCommand(redisClient
*c
);
667 static void zcountCommand(redisClient
*c
);
668 static void zrevrangeCommand(redisClient
*c
);
669 static void zcardCommand(redisClient
*c
);
670 static void zremCommand(redisClient
*c
);
671 static void zscoreCommand(redisClient
*c
);
672 static void zremrangebyscoreCommand(redisClient
*c
);
673 static void multiCommand(redisClient
*c
);
674 static void execCommand(redisClient
*c
);
675 static void discardCommand(redisClient
*c
);
676 static void blpopCommand(redisClient
*c
);
677 static void brpopCommand(redisClient
*c
);
678 static void appendCommand(redisClient
*c
);
679 static void substrCommand(redisClient
*c
);
680 static void zrankCommand(redisClient
*c
);
681 static void zrevrankCommand(redisClient
*c
);
682 static void hsetCommand(redisClient
*c
);
683 static void hgetCommand(redisClient
*c
);
684 static void hdelCommand(redisClient
*c
);
685 static void hlenCommand(redisClient
*c
);
686 static void zremrangebyrankCommand(redisClient
*c
);
687 static void zunionCommand(redisClient
*c
);
688 static void zinterCommand(redisClient
*c
);
690 /*================================= Globals ================================= */
693 static struct redisServer server
; /* server global state */
694 static struct redisCommand cmdTable
[] = {
695 {"get",getCommand
,2,REDIS_CMD_INLINE
,1,1,1},
696 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
697 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
698 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
699 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,1,1,1},
700 {"del",delCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
701 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
702 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
703 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
704 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,1,-1,1},
705 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
706 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
707 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
708 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
709 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
710 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
711 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
712 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,1,1,1},
713 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
714 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,1,1,1},
715 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,1,1,1},
716 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,1,1,1},
717 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,2,1},
718 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
719 {"srem",sremCommand
,3,REDIS_CMD_BULK
,1,1,1},
720 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,1,2,1},
721 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,1,1,1},
722 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
723 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
724 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,1,1,1},
725 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
726 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
727 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
728 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
729 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
730 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
731 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,1,1,1},
732 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
733 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
734 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,1,1,1},
735 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,1,1,1},
736 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,1,1,1},
737 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,0,0,0},
738 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,0,0,0},
739 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
740 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
741 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,1,1,1},
742 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
743 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
744 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
745 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,1,1,1},
746 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,1,1,1},
747 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
748 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,1,1,1},
749 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,1,1,1},
750 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
751 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
752 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
753 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
754 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
755 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
756 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,0,0,0},
757 {"select",selectCommand
,2,REDIS_CMD_INLINE
,0,0,0},
758 {"move",moveCommand
,3,REDIS_CMD_INLINE
,1,1,1},
759 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,1,1,1},
760 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,1,1,1},
761 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,0,0,0},
762 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,0,0,0},
763 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,0,0,0},
764 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,0,0,0},
765 {"auth",authCommand
,2,REDIS_CMD_INLINE
,0,0,0},
766 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,0,0,0},
767 {"echo",echoCommand
,2,REDIS_CMD_BULK
,0,0,0},
768 {"save",saveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
769 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
770 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,0,0,0},
771 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,0,0,0},
772 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
773 {"type",typeCommand
,2,REDIS_CMD_INLINE
,1,1,1},
774 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,0,0,0},
775 {"exec",execCommand
,1,REDIS_CMD_INLINE
,0,0,0},
776 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,0,0,0},
777 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,0,0,0},
778 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,0,0,0},
779 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,0,0,0},
780 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
781 {"info",infoCommand
,1,REDIS_CMD_INLINE
,0,0,0},
782 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,0,0,0},
783 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,1,1,1},
784 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,0,0,0},
785 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
786 {NULL
,NULL
,0,0,0,0,0}
789 /*============================ Utility functions ============================ */
791 /* Glob-style pattern matching. */
792 int stringmatchlen(const char *pattern
, int patternLen
,
793 const char *string
, int stringLen
, int nocase
)
798 while (pattern
[1] == '*') {
803 return 1; /* match */
805 if (stringmatchlen(pattern
+1, patternLen
-1,
806 string
, stringLen
, nocase
))
807 return 1; /* match */
811 return 0; /* no match */
815 return 0; /* no match */
825 not = pattern
[0] == '^';
832 if (pattern
[0] == '\\') {
835 if (pattern
[0] == string
[0])
837 } else if (pattern
[0] == ']') {
839 } else if (patternLen
== 0) {
843 } else if (pattern
[1] == '-' && patternLen
>= 3) {
844 int start
= pattern
[0];
845 int end
= pattern
[2];
853 start
= tolower(start
);
859 if (c
>= start
&& c
<= end
)
863 if (pattern
[0] == string
[0])
866 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
876 return 0; /* no match */
882 if (patternLen
>= 2) {
889 if (pattern
[0] != string
[0])
890 return 0; /* no match */
892 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
893 return 0; /* no match */
901 if (stringLen
== 0) {
902 while(*pattern
== '*') {
909 if (patternLen
== 0 && stringLen
== 0)
914 static void redisLog(int level
, const char *fmt
, ...) {
918 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
922 if (level
>= server
.verbosity
) {
928 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
929 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
930 vfprintf(fp
, fmt
, ap
);
936 if (server
.logfile
) fclose(fp
);
939 /*====================== Hash table type implementation ==================== */
941 /* This is an hash table type that uses the SDS dynamic strings libary as
942 * keys and radis objects as values (objects can hold SDS strings,
945 static void dictVanillaFree(void *privdata
, void *val
)
947 DICT_NOTUSED(privdata
);
951 static void dictListDestructor(void *privdata
, void *val
)
953 DICT_NOTUSED(privdata
);
954 listRelease((list
*)val
);
957 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
961 DICT_NOTUSED(privdata
);
963 l1
= sdslen((sds
)key1
);
964 l2
= sdslen((sds
)key2
);
965 if (l1
!= l2
) return 0;
966 return memcmp(key1
, key2
, l1
) == 0;
969 static void dictRedisObjectDestructor(void *privdata
, void *val
)
971 DICT_NOTUSED(privdata
);
973 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
977 static int dictObjKeyCompare(void *privdata
, const void *key1
,
980 const robj
*o1
= key1
, *o2
= key2
;
981 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
984 static unsigned int dictObjHash(const void *key
) {
986 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
989 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
992 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
995 o1
= getDecodedObject(o1
);
996 o2
= getDecodedObject(o2
);
997 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1003 static unsigned int dictEncObjHash(const void *key
) {
1004 robj
*o
= (robj
*) key
;
1006 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1007 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1009 if (o
->encoding
== REDIS_ENCODING_INT
) {
1013 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1014 return dictGenHashFunction((unsigned char*)buf
, len
);
1018 o
= getDecodedObject(o
);
1019 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1026 /* Sets type and expires */
1027 static dictType setDictType
= {
1028 dictEncObjHash
, /* hash function */
1031 dictEncObjKeyCompare
, /* key compare */
1032 dictRedisObjectDestructor
, /* key destructor */
1033 NULL
/* val destructor */
1036 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1037 static dictType zsetDictType
= {
1038 dictEncObjHash
, /* hash function */
1041 dictEncObjKeyCompare
, /* key compare */
1042 dictRedisObjectDestructor
, /* key destructor */
1043 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1047 static dictType dbDictType
= {
1048 dictObjHash
, /* hash function */
1051 dictObjKeyCompare
, /* key compare */
1052 dictRedisObjectDestructor
, /* key destructor */
1053 dictRedisObjectDestructor
/* val destructor */
1057 static dictType keyptrDictType
= {
1058 dictObjHash
, /* hash function */
1061 dictObjKeyCompare
, /* key compare */
1062 dictRedisObjectDestructor
, /* key destructor */
1063 NULL
/* val destructor */
1066 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1067 static dictType hashDictType
= {
1068 dictEncObjHash
, /* hash function */
1071 dictEncObjKeyCompare
, /* key compare */
1072 dictRedisObjectDestructor
, /* key destructor */
1073 dictRedisObjectDestructor
/* val destructor */
1076 /* Keylist hash table type has unencoded redis objects as keys and
1077 * lists as values. It's used for blocking operations (BLPOP) and to
1078 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1079 static dictType keylistDictType
= {
1080 dictObjHash
, /* hash function */
1083 dictObjKeyCompare
, /* key compare */
1084 dictRedisObjectDestructor
, /* key destructor */
1085 dictListDestructor
/* val destructor */
1088 /* ========================= Random utility functions ======================= */
1090 /* Redis generally does not try to recover from out of memory conditions
1091 * when allocating objects or strings, it is not clear if it will be possible
1092 * to report this condition to the client since the networking layer itself
1093 * is based on heap allocation for send buffers, so we simply abort.
1094 * At least the code will be simpler to read... */
1095 static void oom(const char *msg
) {
1096 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1101 /* ====================== Redis server networking stuff ===================== */
1102 static void closeTimedoutClients(void) {
1105 time_t now
= time(NULL
);
1108 listRewind(server
.clients
,&li
);
1109 while ((ln
= listNext(&li
)) != NULL
) {
1110 c
= listNodeValue(ln
);
1111 if (server
.maxidletime
&&
1112 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1113 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1114 (now
- c
->lastinteraction
> server
.maxidletime
))
1116 redisLog(REDIS_VERBOSE
,"Closing idle client");
1118 } else if (c
->flags
& REDIS_BLOCKED
) {
1119 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1120 addReply(c
,shared
.nullmultibulk
);
1121 unblockClientWaitingData(c
);
1127 static int htNeedsResize(dict
*dict
) {
1128 long long size
, used
;
1130 size
= dictSlots(dict
);
1131 used
= dictSize(dict
);
1132 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1133 (used
*100/size
< REDIS_HT_MINFILL
));
1136 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1137 * we resize the hash table to save memory */
1138 static void tryResizeHashTables(void) {
1141 for (j
= 0; j
< server
.dbnum
; j
++) {
1142 if (htNeedsResize(server
.db
[j
].dict
)) {
1143 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1144 dictResize(server
.db
[j
].dict
);
1145 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1147 if (htNeedsResize(server
.db
[j
].expires
))
1148 dictResize(server
.db
[j
].expires
);
1152 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1153 void backgroundSaveDoneHandler(int statloc
) {
1154 int exitcode
= WEXITSTATUS(statloc
);
1155 int bysignal
= WIFSIGNALED(statloc
);
1157 if (!bysignal
&& exitcode
== 0) {
1158 redisLog(REDIS_NOTICE
,
1159 "Background saving terminated with success");
1161 server
.lastsave
= time(NULL
);
1162 } else if (!bysignal
&& exitcode
!= 0) {
1163 redisLog(REDIS_WARNING
, "Background saving error");
1165 redisLog(REDIS_WARNING
,
1166 "Background saving terminated by signal");
1167 rdbRemoveTempFile(server
.bgsavechildpid
);
1169 server
.bgsavechildpid
= -1;
1170 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1171 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1172 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1175 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1177 void backgroundRewriteDoneHandler(int statloc
) {
1178 int exitcode
= WEXITSTATUS(statloc
);
1179 int bysignal
= WIFSIGNALED(statloc
);
1181 if (!bysignal
&& exitcode
== 0) {
1185 redisLog(REDIS_NOTICE
,
1186 "Background append only file rewriting terminated with success");
1187 /* Now it's time to flush the differences accumulated by the parent */
1188 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1189 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1191 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1194 /* Flush our data... */
1195 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1196 (signed) sdslen(server
.bgrewritebuf
)) {
1197 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
));
1201 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1202 /* Now our work is to rename the temp file into the stable file. And
1203 * switch the file descriptor used by the server for append only. */
1204 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1205 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1209 /* Mission completed... almost */
1210 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1211 if (server
.appendfd
!= -1) {
1212 /* If append only is actually enabled... */
1213 close(server
.appendfd
);
1214 server
.appendfd
= fd
;
1216 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1217 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1219 /* If append only is disabled we just generate a dump in this
1220 * format. Why not? */
1223 } else if (!bysignal
&& exitcode
!= 0) {
1224 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1226 redisLog(REDIS_WARNING
,
1227 "Background append only file rewriting terminated by signal");
1230 sdsfree(server
.bgrewritebuf
);
1231 server
.bgrewritebuf
= sdsempty();
1232 aofRemoveTempFile(server
.bgrewritechildpid
);
1233 server
.bgrewritechildpid
= -1;
1236 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1237 int j
, loops
= server
.cronloops
++;
1238 REDIS_NOTUSED(eventLoop
);
1240 REDIS_NOTUSED(clientData
);
1242 /* We take a cached value of the unix time in the global state because
1243 * with virtual memory and aging there is to store the current time
1244 * in objects at every object access, and accuracy is not needed.
1245 * To access a global var is faster than calling time(NULL) */
1246 server
.unixtime
= time(NULL
);
1248 /* Show some info about non-empty databases */
1249 for (j
= 0; j
< server
.dbnum
; j
++) {
1250 long long size
, used
, vkeys
;
1252 size
= dictSlots(server
.db
[j
].dict
);
1253 used
= dictSize(server
.db
[j
].dict
);
1254 vkeys
= dictSize(server
.db
[j
].expires
);
1255 if (!(loops
% 5) && (used
|| vkeys
)) {
1256 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1257 /* dictPrintStats(server.dict); */
1261 /* We don't want to resize the hash tables while a bacground saving
1262 * is in progress: the saving child is created using fork() that is
1263 * implemented with a copy-on-write semantic in most modern systems, so
1264 * if we resize the HT while there is the saving child at work actually
1265 * a lot of memory movements in the parent will cause a lot of pages
1267 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1269 /* Show information about connected clients */
1271 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1272 listLength(server
.clients
)-listLength(server
.slaves
),
1273 listLength(server
.slaves
),
1274 zmalloc_used_memory(),
1275 dictSize(server
.sharingpool
));
1278 /* Close connections of timedout clients */
1279 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1280 closeTimedoutClients();
1282 /* Check if a background saving or AOF rewrite in progress terminated */
1283 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1287 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1288 if (pid
== server
.bgsavechildpid
) {
1289 backgroundSaveDoneHandler(statloc
);
1291 backgroundRewriteDoneHandler(statloc
);
1295 /* If there is not a background saving in progress check if
1296 * we have to save now */
1297 time_t now
= time(NULL
);
1298 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1299 struct saveparam
*sp
= server
.saveparams
+j
;
1301 if (server
.dirty
>= sp
->changes
&&
1302 now
-server
.lastsave
> sp
->seconds
) {
1303 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1304 sp
->changes
, sp
->seconds
);
1305 rdbSaveBackground(server
.dbfilename
);
1311 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1312 * will use few CPU cycles if there are few expiring keys, otherwise
1313 * it will get more aggressive to avoid that too much memory is used by
1314 * keys that can be removed from the keyspace. */
1315 for (j
= 0; j
< server
.dbnum
; j
++) {
1317 redisDb
*db
= server
.db
+j
;
1319 /* Continue to expire if at the end of the cycle more than 25%
1320 * of the keys were expired. */
1322 long num
= dictSize(db
->expires
);
1323 time_t now
= time(NULL
);
1326 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1327 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1332 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1333 t
= (time_t) dictGetEntryVal(de
);
1335 deleteKey(db
,dictGetEntryKey(de
));
1339 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1342 /* Swap a few keys on disk if we are over the memory limit and VM
1343 * is enbled. Try to free objects from the free list first. */
1344 if (vmCanSwapOut()) {
1345 while (server
.vm_enabled
&& zmalloc_used_memory() >
1346 server
.vm_max_memory
)
1350 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1351 retval
= (server
.vm_max_threads
== 0) ?
1352 vmSwapOneObjectBlocking() :
1353 vmSwapOneObjectThreaded();
1354 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1355 zmalloc_used_memory() >
1356 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1358 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1360 /* Note that when using threade I/O we free just one object,
1361 * because anyway when the I/O thread in charge to swap this
1362 * object out will finish, the handler of completed jobs
1363 * will try to swap more objects if we are still out of memory. */
1364 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1368 /* Check if we should connect to a MASTER */
1369 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1370 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1371 if (syncWithMaster() == REDIS_OK
) {
1372 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1378 /* This function gets called every time Redis is entering the
1379 * main loop of the event driven library, that is, before to sleep
1380 * for ready file descriptors. */
1381 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1382 REDIS_NOTUSED(eventLoop
);
1384 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1388 listRewind(server
.io_ready_clients
,&li
);
1389 while((ln
= listNext(&li
))) {
1390 redisClient
*c
= ln
->value
;
1391 struct redisCommand
*cmd
;
1393 /* Resume the client. */
1394 listDelNode(server
.io_ready_clients
,ln
);
1395 c
->flags
&= (~REDIS_IO_WAIT
);
1396 server
.vm_blocked_clients
--;
1397 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1398 readQueryFromClient
, c
);
1399 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1400 assert(cmd
!= NULL
);
1403 /* There may be more data to process in the input buffer. */
1404 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1405 processInputBuffer(c
);
1410 static void createSharedObjects(void) {
1411 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1412 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1413 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1414 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1415 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1416 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1417 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1418 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1419 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1420 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1421 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1422 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1423 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1424 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1425 "-ERR no such key\r\n"));
1426 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1427 "-ERR syntax error\r\n"));
1428 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1429 "-ERR source and destination objects are the same\r\n"));
1430 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1431 "-ERR index out of range\r\n"));
1432 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1433 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1434 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1435 shared
.select0
= createStringObject("select 0\r\n",10);
1436 shared
.select1
= createStringObject("select 1\r\n",10);
1437 shared
.select2
= createStringObject("select 2\r\n",10);
1438 shared
.select3
= createStringObject("select 3\r\n",10);
1439 shared
.select4
= createStringObject("select 4\r\n",10);
1440 shared
.select5
= createStringObject("select 5\r\n",10);
1441 shared
.select6
= createStringObject("select 6\r\n",10);
1442 shared
.select7
= createStringObject("select 7\r\n",10);
1443 shared
.select8
= createStringObject("select 8\r\n",10);
1444 shared
.select9
= createStringObject("select 9\r\n",10);
1447 static void appendServerSaveParams(time_t seconds
, int changes
) {
1448 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1449 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1450 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1451 server
.saveparamslen
++;
1454 static void resetServerSaveParams() {
1455 zfree(server
.saveparams
);
1456 server
.saveparams
= NULL
;
1457 server
.saveparamslen
= 0;
1460 static void initServerConfig() {
1461 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1462 server
.port
= REDIS_SERVERPORT
;
1463 server
.verbosity
= REDIS_VERBOSE
;
1464 server
.maxidletime
= REDIS_MAXIDLETIME
;
1465 server
.saveparams
= NULL
;
1466 server
.logfile
= NULL
; /* NULL = log on standard output */
1467 server
.bindaddr
= NULL
;
1468 server
.glueoutputbuf
= 1;
1469 server
.daemonize
= 0;
1470 server
.appendonly
= 0;
1471 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1472 server
.lastfsync
= time(NULL
);
1473 server
.appendfd
= -1;
1474 server
.appendseldb
= -1; /* Make sure the first time will not match */
1475 server
.pidfile
= "/var/run/redis.pid";
1476 server
.dbfilename
= "dump.rdb";
1477 server
.appendfilename
= "appendonly.aof";
1478 server
.requirepass
= NULL
;
1479 server
.shareobjects
= 0;
1480 server
.rdbcompression
= 1;
1481 server
.sharingpoolsize
= 1024;
1482 server
.maxclients
= 0;
1483 server
.blpop_blocked_clients
= 0;
1484 server
.maxmemory
= 0;
1485 server
.vm_enabled
= 0;
1486 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1487 server
.vm_page_size
= 256; /* 256 bytes per page */
1488 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1489 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1490 server
.vm_max_threads
= 4;
1491 server
.vm_blocked_clients
= 0;
1492 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1493 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1495 resetServerSaveParams();
1497 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1498 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1499 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1500 /* Replication related */
1502 server
.masterauth
= NULL
;
1503 server
.masterhost
= NULL
;
1504 server
.masterport
= 6379;
1505 server
.master
= NULL
;
1506 server
.replstate
= REDIS_REPL_NONE
;
1508 /* Double constants initialization */
1510 R_PosInf
= 1.0/R_Zero
;
1511 R_NegInf
= -1.0/R_Zero
;
1512 R_Nan
= R_Zero
/R_Zero
;
1515 static void initServer() {
1518 signal(SIGHUP
, SIG_IGN
);
1519 signal(SIGPIPE
, SIG_IGN
);
1520 setupSigSegvAction();
1522 server
.devnull
= fopen("/dev/null","w");
1523 if (server
.devnull
== NULL
) {
1524 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1527 server
.clients
= listCreate();
1528 server
.slaves
= listCreate();
1529 server
.monitors
= listCreate();
1530 server
.objfreelist
= listCreate();
1531 createSharedObjects();
1532 server
.el
= aeCreateEventLoop();
1533 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1534 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1535 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1536 if (server
.fd
== -1) {
1537 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1540 for (j
= 0; j
< server
.dbnum
; j
++) {
1541 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1542 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1543 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1544 if (server
.vm_enabled
)
1545 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1546 server
.db
[j
].id
= j
;
1548 server
.cronloops
= 0;
1549 server
.bgsavechildpid
= -1;
1550 server
.bgrewritechildpid
= -1;
1551 server
.bgrewritebuf
= sdsempty();
1552 server
.lastsave
= time(NULL
);
1554 server
.stat_numcommands
= 0;
1555 server
.stat_numconnections
= 0;
1556 server
.stat_starttime
= time(NULL
);
1557 server
.unixtime
= time(NULL
);
1558 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1559 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1560 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1562 if (server
.appendonly
) {
1563 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1564 if (server
.appendfd
== -1) {
1565 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1571 if (server
.vm_enabled
) vmInit();
1574 /* Empty the whole database */
1575 static long long emptyDb() {
1577 long long removed
= 0;
1579 for (j
= 0; j
< server
.dbnum
; j
++) {
1580 removed
+= dictSize(server
.db
[j
].dict
);
1581 dictEmpty(server
.db
[j
].dict
);
1582 dictEmpty(server
.db
[j
].expires
);
1587 static int yesnotoi(char *s
) {
1588 if (!strcasecmp(s
,"yes")) return 1;
1589 else if (!strcasecmp(s
,"no")) return 0;
1593 /* I agree, this is a very rudimental way to load a configuration...
1594 will improve later if the config gets more complex */
1595 static void loadServerConfig(char *filename
) {
1597 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1601 if (filename
[0] == '-' && filename
[1] == '\0')
1604 if ((fp
= fopen(filename
,"r")) == NULL
) {
1605 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1610 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1616 line
= sdstrim(line
," \t\r\n");
1618 /* Skip comments and blank lines*/
1619 if (line
[0] == '#' || line
[0] == '\0') {
1624 /* Split into arguments */
1625 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1626 sdstolower(argv
[0]);
1628 /* Execute config directives */
1629 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1630 server
.maxidletime
= atoi(argv
[1]);
1631 if (server
.maxidletime
< 0) {
1632 err
= "Invalid timeout value"; goto loaderr
;
1634 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1635 server
.port
= atoi(argv
[1]);
1636 if (server
.port
< 1 || server
.port
> 65535) {
1637 err
= "Invalid port"; goto loaderr
;
1639 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1640 server
.bindaddr
= zstrdup(argv
[1]);
1641 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1642 int seconds
= atoi(argv
[1]);
1643 int changes
= atoi(argv
[2]);
1644 if (seconds
< 1 || changes
< 0) {
1645 err
= "Invalid save parameters"; goto loaderr
;
1647 appendServerSaveParams(seconds
,changes
);
1648 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1649 if (chdir(argv
[1]) == -1) {
1650 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1651 argv
[1], strerror(errno
));
1654 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1655 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1656 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1657 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1658 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1660 err
= "Invalid log level. Must be one of debug, notice, warning";
1663 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1666 server
.logfile
= zstrdup(argv
[1]);
1667 if (!strcasecmp(server
.logfile
,"stdout")) {
1668 zfree(server
.logfile
);
1669 server
.logfile
= NULL
;
1671 if (server
.logfile
) {
1672 /* Test if we are able to open the file. The server will not
1673 * be able to abort just for this problem later... */
1674 logfp
= fopen(server
.logfile
,"a");
1675 if (logfp
== NULL
) {
1676 err
= sdscatprintf(sdsempty(),
1677 "Can't open the log file: %s", strerror(errno
));
1682 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1683 server
.dbnum
= atoi(argv
[1]);
1684 if (server
.dbnum
< 1) {
1685 err
= "Invalid number of databases"; goto loaderr
;
1687 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1688 server
.maxclients
= atoi(argv
[1]);
1689 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1690 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1691 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1692 server
.masterhost
= sdsnew(argv
[1]);
1693 server
.masterport
= atoi(argv
[2]);
1694 server
.replstate
= REDIS_REPL_CONNECT
;
1695 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1696 server
.masterauth
= zstrdup(argv
[1]);
1697 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1698 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1699 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1701 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1702 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1703 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1705 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1706 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1707 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1709 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1710 server
.sharingpoolsize
= atoi(argv
[1]);
1711 if (server
.sharingpoolsize
< 1) {
1712 err
= "invalid object sharing pool size"; goto loaderr
;
1714 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1715 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1716 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1718 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1719 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1720 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1722 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1723 if (!strcasecmp(argv
[1],"no")) {
1724 server
.appendfsync
= APPENDFSYNC_NO
;
1725 } else if (!strcasecmp(argv
[1],"always")) {
1726 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1727 } else if (!strcasecmp(argv
[1],"everysec")) {
1728 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1730 err
= "argument must be 'no', 'always' or 'everysec'";
1733 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1734 server
.requirepass
= zstrdup(argv
[1]);
1735 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1736 server
.pidfile
= zstrdup(argv
[1]);
1737 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1738 server
.dbfilename
= zstrdup(argv
[1]);
1739 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1740 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1741 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1743 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1744 zfree(server
.vm_swap_file
);
1745 server
.vm_swap_file
= zstrdup(argv
[1]);
1746 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1747 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1748 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1749 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1750 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1751 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1752 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1753 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1754 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1755 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1756 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1757 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1758 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1759 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1761 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1763 for (j
= 0; j
< argc
; j
++)
1768 if (fp
!= stdin
) fclose(fp
);
1772 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1773 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1774 fprintf(stderr
, ">>> '%s'\n", line
);
1775 fprintf(stderr
, "%s\n", err
);
1779 static void freeClientArgv(redisClient
*c
) {
1782 for (j
= 0; j
< c
->argc
; j
++)
1783 decrRefCount(c
->argv
[j
]);
1784 for (j
= 0; j
< c
->mbargc
; j
++)
1785 decrRefCount(c
->mbargv
[j
]);
1790 static void freeClient(redisClient
*c
) {
1793 /* Note that if the client we are freeing is blocked into a blocking
1794 * call, we have to set querybuf to NULL *before* to call
1795 * unblockClientWaitingData() to avoid processInputBuffer() will get
1796 * called. Also it is important to remove the file events after
1797 * this, because this call adds the READABLE event. */
1798 sdsfree(c
->querybuf
);
1800 if (c
->flags
& REDIS_BLOCKED
)
1801 unblockClientWaitingData(c
);
1803 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1804 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1805 listRelease(c
->reply
);
1808 /* Remove from the list of clients */
1809 ln
= listSearchKey(server
.clients
,c
);
1810 redisAssert(ln
!= NULL
);
1811 listDelNode(server
.clients
,ln
);
1812 /* Remove from the list of clients waiting for swapped keys */
1813 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1814 ln
= listSearchKey(server
.io_ready_clients
,c
);
1816 listDelNode(server
.io_ready_clients
,ln
);
1817 server
.vm_blocked_clients
--;
1820 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1821 ln
= listFirst(c
->io_keys
);
1822 dontWaitForSwappedKey(c
,ln
->value
);
1824 listRelease(c
->io_keys
);
1826 if (c
->flags
& REDIS_SLAVE
) {
1827 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1829 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1830 ln
= listSearchKey(l
,c
);
1831 redisAssert(ln
!= NULL
);
1834 if (c
->flags
& REDIS_MASTER
) {
1835 server
.master
= NULL
;
1836 server
.replstate
= REDIS_REPL_CONNECT
;
1840 freeClientMultiState(c
);
1844 #define GLUEREPLY_UP_TO (1024)
1845 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1847 char buf
[GLUEREPLY_UP_TO
];
1852 listRewind(c
->reply
,&li
);
1853 while((ln
= listNext(&li
))) {
1857 objlen
= sdslen(o
->ptr
);
1858 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1859 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1861 listDelNode(c
->reply
,ln
);
1863 if (copylen
== 0) return;
1867 /* Now the output buffer is empty, add the new single element */
1868 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1869 listAddNodeHead(c
->reply
,o
);
1872 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1873 redisClient
*c
= privdata
;
1874 int nwritten
= 0, totwritten
= 0, objlen
;
1877 REDIS_NOTUSED(mask
);
1879 /* Use writev() if we have enough buffers to send */
1880 if (!server
.glueoutputbuf
&&
1881 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1882 !(c
->flags
& REDIS_MASTER
))
1884 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1888 while(listLength(c
->reply
)) {
1889 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1890 glueReplyBuffersIfNeeded(c
);
1892 o
= listNodeValue(listFirst(c
->reply
));
1893 objlen
= sdslen(o
->ptr
);
1896 listDelNode(c
->reply
,listFirst(c
->reply
));
1900 if (c
->flags
& REDIS_MASTER
) {
1901 /* Don't reply to a master */
1902 nwritten
= objlen
- c
->sentlen
;
1904 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1905 if (nwritten
<= 0) break;
1907 c
->sentlen
+= nwritten
;
1908 totwritten
+= nwritten
;
1909 /* If we fully sent the object on head go to the next one */
1910 if (c
->sentlen
== objlen
) {
1911 listDelNode(c
->reply
,listFirst(c
->reply
));
1914 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1915 * bytes, in a single threaded server it's a good idea to serve
1916 * other clients as well, even if a very large request comes from
1917 * super fast link that is always able to accept data (in real world
1918 * scenario think about 'KEYS *' against the loopback interfae) */
1919 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1921 if (nwritten
== -1) {
1922 if (errno
== EAGAIN
) {
1925 redisLog(REDIS_VERBOSE
,
1926 "Error writing to client: %s", strerror(errno
));
1931 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1932 if (listLength(c
->reply
) == 0) {
1934 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1938 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1940 redisClient
*c
= privdata
;
1941 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1943 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1944 int offset
, ion
= 0;
1946 REDIS_NOTUSED(mask
);
1949 while (listLength(c
->reply
)) {
1950 offset
= c
->sentlen
;
1954 /* fill-in the iov[] array */
1955 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1956 o
= listNodeValue(node
);
1957 objlen
= sdslen(o
->ptr
);
1959 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1962 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1963 break; /* no more iovecs */
1965 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1966 iov
[ion
].iov_len
= objlen
- offset
;
1967 willwrite
+= objlen
- offset
;
1968 offset
= 0; /* just for the first item */
1975 /* write all collected blocks at once */
1976 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1977 if (errno
!= EAGAIN
) {
1978 redisLog(REDIS_VERBOSE
,
1979 "Error writing to client: %s", strerror(errno
));
1986 totwritten
+= nwritten
;
1987 offset
= c
->sentlen
;
1989 /* remove written robjs from c->reply */
1990 while (nwritten
&& listLength(c
->reply
)) {
1991 o
= listNodeValue(listFirst(c
->reply
));
1992 objlen
= sdslen(o
->ptr
);
1994 if(nwritten
>= objlen
- offset
) {
1995 listDelNode(c
->reply
, listFirst(c
->reply
));
1996 nwritten
-= objlen
- offset
;
2000 c
->sentlen
+= nwritten
;
2008 c
->lastinteraction
= time(NULL
);
2010 if (listLength(c
->reply
) == 0) {
2012 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2016 static struct redisCommand
*lookupCommand(char *name
) {
2018 while(cmdTable
[j
].name
!= NULL
) {
2019 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2025 /* resetClient prepare the client to process the next command */
2026 static void resetClient(redisClient
*c
) {
2032 /* Call() is the core of Redis execution of a command */
2033 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2036 dirty
= server
.dirty
;
2038 if (server
.appendonly
&& server
.dirty
-dirty
)
2039 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2040 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
2041 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2042 if (listLength(server
.monitors
))
2043 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2044 server
.stat_numcommands
++;
2047 /* If this function gets called we already read a whole
2048 * command, argments are in the client argv/argc fields.
2049 * processCommand() execute the command or prepare the
2050 * server for a bulk read from the client.
2052 * If 1 is returned the client is still alive and valid and
2053 * and other operations can be performed by the caller. Otherwise
2054 * if 0 is returned the client was destroied (i.e. after QUIT). */
2055 static int processCommand(redisClient
*c
) {
2056 struct redisCommand
*cmd
;
2058 /* Free some memory if needed (maxmemory setting) */
2059 if (server
.maxmemory
) freeMemoryIfNeeded();
2061 /* Handle the multi bulk command type. This is an alternative protocol
2062 * supported by Redis in order to receive commands that are composed of
2063 * multiple binary-safe "bulk" arguments. The latency of processing is
2064 * a bit higher but this allows things like multi-sets, so if this
2065 * protocol is used only for MSET and similar commands this is a big win. */
2066 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2067 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2068 if (c
->multibulk
<= 0) {
2072 decrRefCount(c
->argv
[c
->argc
-1]);
2076 } else if (c
->multibulk
) {
2077 if (c
->bulklen
== -1) {
2078 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2079 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2083 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2084 decrRefCount(c
->argv
[0]);
2085 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2087 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2092 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2096 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2097 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2101 if (c
->multibulk
== 0) {
2105 /* Here we need to swap the multi-bulk argc/argv with the
2106 * normal argc/argv of the client structure. */
2108 c
->argv
= c
->mbargv
;
2109 c
->mbargv
= auxargv
;
2112 c
->argc
= c
->mbargc
;
2113 c
->mbargc
= auxargc
;
2115 /* We need to set bulklen to something different than -1
2116 * in order for the code below to process the command without
2117 * to try to read the last argument of a bulk command as
2118 * a special argument. */
2120 /* continue below and process the command */
2127 /* -- end of multi bulk commands processing -- */
2129 /* The QUIT command is handled as a special case. Normal command
2130 * procs are unable to close the client connection safely */
2131 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2136 /* Now lookup the command and check ASAP about trivial error conditions
2137 * such wrong arity, bad command name and so forth. */
2138 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2141 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2142 (char*)c
->argv
[0]->ptr
));
2145 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2146 (c
->argc
< -cmd
->arity
)) {
2148 sdscatprintf(sdsempty(),
2149 "-ERR wrong number of arguments for '%s' command\r\n",
2153 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2154 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2157 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2158 /* This is a bulk command, we have to read the last argument yet. */
2159 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2161 decrRefCount(c
->argv
[c
->argc
-1]);
2162 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2164 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2169 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2170 /* It is possible that the bulk read is already in the
2171 * buffer. Check this condition and handle it accordingly.
2172 * This is just a fast path, alternative to call processInputBuffer().
2173 * It's a good idea since the code is small and this condition
2174 * happens most of the times. */
2175 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2176 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2178 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2180 /* Otherwise return... there is to read the last argument
2181 * from the socket. */
2185 /* Let's try to share objects on the command arguments vector */
2186 if (server
.shareobjects
) {
2188 for(j
= 1; j
< c
->argc
; j
++)
2189 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2191 /* Let's try to encode the bulk object to save space. */
2192 if (cmd
->flags
& REDIS_CMD_BULK
)
2193 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2195 /* Check if the user is authenticated */
2196 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2197 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2202 /* Exec the command */
2203 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2204 queueMultiCommand(c
,cmd
);
2205 addReply(c
,shared
.queued
);
2207 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2208 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2212 /* Prepare the client for the next command */
2217 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2222 /* (args*2)+1 is enough room for args, spaces, newlines */
2223 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2225 if (argc
<= REDIS_STATIC_ARGS
) {
2228 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2231 for (j
= 0; j
< argc
; j
++) {
2232 if (j
!= 0) outv
[outc
++] = shared
.space
;
2233 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2236 lenobj
= createObject(REDIS_STRING
,
2237 sdscatprintf(sdsempty(),"%lu\r\n",
2238 (unsigned long) stringObjectLen(argv
[j
])));
2239 lenobj
->refcount
= 0;
2240 outv
[outc
++] = lenobj
;
2242 outv
[outc
++] = argv
[j
];
2244 outv
[outc
++] = shared
.crlf
;
2246 /* Increment all the refcounts at start and decrement at end in order to
2247 * be sure to free objects if there is no slave in a replication state
2248 * able to be feed with commands */
2249 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2250 listRewind(slaves
,&li
);
2251 while((ln
= listNext(&li
))) {
2252 redisClient
*slave
= ln
->value
;
2254 /* Don't feed slaves that are still waiting for BGSAVE to start */
2255 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2257 /* Feed all the other slaves, MONITORs and so on */
2258 if (slave
->slaveseldb
!= dictid
) {
2262 case 0: selectcmd
= shared
.select0
; break;
2263 case 1: selectcmd
= shared
.select1
; break;
2264 case 2: selectcmd
= shared
.select2
; break;
2265 case 3: selectcmd
= shared
.select3
; break;
2266 case 4: selectcmd
= shared
.select4
; break;
2267 case 5: selectcmd
= shared
.select5
; break;
2268 case 6: selectcmd
= shared
.select6
; break;
2269 case 7: selectcmd
= shared
.select7
; break;
2270 case 8: selectcmd
= shared
.select8
; break;
2271 case 9: selectcmd
= shared
.select9
; break;
2273 selectcmd
= createObject(REDIS_STRING
,
2274 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2275 selectcmd
->refcount
= 0;
2278 addReply(slave
,selectcmd
);
2279 slave
->slaveseldb
= dictid
;
2281 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2283 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2284 if (outv
!= static_outv
) zfree(outv
);
2287 static void processInputBuffer(redisClient
*c
) {
2289 /* Before to process the input buffer, make sure the client is not
2290 * waitig for a blocking operation such as BLPOP. Note that the first
2291 * iteration the client is never blocked, otherwise the processInputBuffer
2292 * would not be called at all, but after the execution of the first commands
2293 * in the input buffer the client may be blocked, and the "goto again"
2294 * will try to reiterate. The following line will make it return asap. */
2295 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2296 if (c
->bulklen
== -1) {
2297 /* Read the first line of the query */
2298 char *p
= strchr(c
->querybuf
,'\n');
2305 query
= c
->querybuf
;
2306 c
->querybuf
= sdsempty();
2307 querylen
= 1+(p
-(query
));
2308 if (sdslen(query
) > querylen
) {
2309 /* leave data after the first line of the query in the buffer */
2310 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2312 *p
= '\0'; /* remove "\n" */
2313 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2314 sdsupdatelen(query
);
2316 /* Now we can split the query in arguments */
2317 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2320 if (c
->argv
) zfree(c
->argv
);
2321 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2323 for (j
= 0; j
< argc
; j
++) {
2324 if (sdslen(argv
[j
])) {
2325 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2333 /* Execute the command. If the client is still valid
2334 * after processCommand() return and there is something
2335 * on the query buffer try to process the next command. */
2336 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2338 /* Nothing to process, argc == 0. Just process the query
2339 * buffer if it's not empty or return to the caller */
2340 if (sdslen(c
->querybuf
)) goto again
;
2343 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2344 redisLog(REDIS_VERBOSE
, "Client protocol error");
2349 /* Bulk read handling. Note that if we are at this point
2350 the client already sent a command terminated with a newline,
2351 we are reading the bulk data that is actually the last
2352 argument of the command. */
2353 int qbl
= sdslen(c
->querybuf
);
2355 if (c
->bulklen
<= qbl
) {
2356 /* Copy everything but the final CRLF as final argument */
2357 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2359 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2360 /* Process the command. If the client is still valid after
2361 * the processing and there is more data in the buffer
2362 * try to parse it. */
2363 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2369 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2370 redisClient
*c
= (redisClient
*) privdata
;
2371 char buf
[REDIS_IOBUF_LEN
];
2374 REDIS_NOTUSED(mask
);
2376 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2378 if (errno
== EAGAIN
) {
2381 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2385 } else if (nread
== 0) {
2386 redisLog(REDIS_VERBOSE
, "Client closed connection");
2391 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2392 c
->lastinteraction
= time(NULL
);
2396 if (!(c
->flags
& REDIS_BLOCKED
))
2397 processInputBuffer(c
);
2400 static int selectDb(redisClient
*c
, int id
) {
2401 if (id
< 0 || id
>= server
.dbnum
)
2403 c
->db
= &server
.db
[id
];
2407 static void *dupClientReplyValue(void *o
) {
2408 incrRefCount((robj
*)o
);
2412 static redisClient
*createClient(int fd
) {
2413 redisClient
*c
= zmalloc(sizeof(*c
));
2415 anetNonBlock(NULL
,fd
);
2416 anetTcpNoDelay(NULL
,fd
);
2417 if (!c
) return NULL
;
2420 c
->querybuf
= sdsempty();
2429 c
->lastinteraction
= time(NULL
);
2430 c
->authenticated
= 0;
2431 c
->replstate
= REDIS_REPL_NONE
;
2432 c
->reply
= listCreate();
2433 listSetFreeMethod(c
->reply
,decrRefCount
);
2434 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2435 c
->blockingkeys
= NULL
;
2436 c
->blockingkeysnum
= 0;
2437 c
->io_keys
= listCreate();
2438 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2439 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2440 readQueryFromClient
, c
) == AE_ERR
) {
2444 listAddNodeTail(server
.clients
,c
);
2445 initClientMultiState(c
);
2449 static void addReply(redisClient
*c
, robj
*obj
) {
2450 if (listLength(c
->reply
) == 0 &&
2451 (c
->replstate
== REDIS_REPL_NONE
||
2452 c
->replstate
== REDIS_REPL_ONLINE
) &&
2453 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2454 sendReplyToClient
, c
) == AE_ERR
) return;
2456 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2457 obj
= dupStringObject(obj
);
2458 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2460 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2463 static void addReplySds(redisClient
*c
, sds s
) {
2464 robj
*o
= createObject(REDIS_STRING
,s
);
2469 static void addReplyDouble(redisClient
*c
, double d
) {
2472 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2473 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2474 (unsigned long) strlen(buf
),buf
));
2477 static void addReplyLong(redisClient
*c
, long l
) {
2482 addReply(c
,shared
.czero
);
2484 } else if (l
== 1) {
2485 addReply(c
,shared
.cone
);
2488 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2489 addReplySds(c
,sdsnewlen(buf
,len
));
2492 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2497 addReply(c
,shared
.czero
);
2499 } else if (ul
== 1) {
2500 addReply(c
,shared
.cone
);
2503 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2504 addReplySds(c
,sdsnewlen(buf
,len
));
2507 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2510 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2511 len
= sdslen(obj
->ptr
);
2513 long n
= (long)obj
->ptr
;
2515 /* Compute how many bytes will take this integer as a radix 10 string */
2521 while((n
= n
/10) != 0) {
2525 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2528 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2529 addReplyBulkLen(c
,obj
);
2531 addReply(c
,shared
.crlf
);
2534 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2539 REDIS_NOTUSED(mask
);
2540 REDIS_NOTUSED(privdata
);
2542 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2543 if (cfd
== AE_ERR
) {
2544 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2547 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2548 if ((c
= createClient(cfd
)) == NULL
) {
2549 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2550 close(cfd
); /* May be already closed, just ingore errors */
2553 /* If maxclient directive is set and this is one client more... close the
2554 * connection. Note that we create the client instead to check before
2555 * for this condition, since now the socket is already set in nonblocking
2556 * mode and we can send an error for free using the Kernel I/O */
2557 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2558 char *err
= "-ERR max number of clients reached\r\n";
2560 /* That's a best effort error message, don't check write errors */
2561 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2562 /* Nothing to do, Just to avoid the warning... */
2567 server
.stat_numconnections
++;
2570 /* ======================= Redis objects implementation ===================== */
2572 static robj
*createObject(int type
, void *ptr
) {
2575 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2576 if (listLength(server
.objfreelist
)) {
2577 listNode
*head
= listFirst(server
.objfreelist
);
2578 o
= listNodeValue(head
);
2579 listDelNode(server
.objfreelist
,head
);
2580 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2582 if (server
.vm_enabled
) {
2583 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2584 o
= zmalloc(sizeof(*o
));
2586 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2590 o
->encoding
= REDIS_ENCODING_RAW
;
2593 if (server
.vm_enabled
) {
2594 /* Note that this code may run in the context of an I/O thread
2595 * and accessing to server.unixtime in theory is an error
2596 * (no locks). But in practice this is safe, and even if we read
2597 * garbage Redis will not fail, as it's just a statistical info */
2598 o
->vm
.atime
= server
.unixtime
;
2599 o
->storage
= REDIS_VM_MEMORY
;
2604 static robj
*createStringObject(char *ptr
, size_t len
) {
2605 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2608 static robj
*dupStringObject(robj
*o
) {
2609 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2610 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2613 static robj
*createListObject(void) {
2614 list
*l
= listCreate();
2616 listSetFreeMethod(l
,decrRefCount
);
2617 return createObject(REDIS_LIST
,l
);
2620 static robj
*createSetObject(void) {
2621 dict
*d
= dictCreate(&setDictType
,NULL
);
2622 return createObject(REDIS_SET
,d
);
2625 static robj
*createHashObject(void) {
2626 /* All the Hashes start as zipmaps. Will be automatically converted
2627 * into hash tables if there are enough elements or big elements
2629 unsigned char *zm
= zipmapNew();
2630 robj
*o
= createObject(REDIS_HASH
,zm
);
2631 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2635 static robj
*createZsetObject(void) {
2636 zset
*zs
= zmalloc(sizeof(*zs
));
2638 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2639 zs
->zsl
= zslCreate();
2640 return createObject(REDIS_ZSET
,zs
);
2643 static void freeStringObject(robj
*o
) {
2644 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2649 static void freeListObject(robj
*o
) {
2650 listRelease((list
*) o
->ptr
);
2653 static void freeSetObject(robj
*o
) {
2654 dictRelease((dict
*) o
->ptr
);
2657 static void freeZsetObject(robj
*o
) {
2660 dictRelease(zs
->dict
);
2665 static void freeHashObject(robj
*o
) {
2666 switch (o
->encoding
) {
2667 case REDIS_ENCODING_HT
:
2668 dictRelease((dict
*) o
->ptr
);
2670 case REDIS_ENCODING_ZIPMAP
:
2679 static void incrRefCount(robj
*o
) {
2680 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2684 static void decrRefCount(void *obj
) {
2687 /* Object is a key of a swapped out value, or in the process of being
2689 if (server
.vm_enabled
&&
2690 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2692 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2693 redisAssert(o
->refcount
== 1);
2695 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2696 redisAssert(o
->type
== REDIS_STRING
);
2697 freeStringObject(o
);
2698 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2699 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2700 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2701 !listAddNodeHead(server
.objfreelist
,o
))
2703 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2704 server
.vm_stats_swapped_objects
--;
2707 /* Object is in memory, or in the process of being swapped out. */
2708 if (--(o
->refcount
) == 0) {
2709 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2710 vmCancelThreadedIOJob(obj
);
2712 case REDIS_STRING
: freeStringObject(o
); break;
2713 case REDIS_LIST
: freeListObject(o
); break;
2714 case REDIS_SET
: freeSetObject(o
); break;
2715 case REDIS_ZSET
: freeZsetObject(o
); break;
2716 case REDIS_HASH
: freeHashObject(o
); break;
2717 default: redisAssert(0 != 0); break;
2719 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2720 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2721 !listAddNodeHead(server
.objfreelist
,o
))
2723 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2727 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2728 dictEntry
*de
= dictFind(db
->dict
,key
);
2730 robj
*key
= dictGetEntryKey(de
);
2731 robj
*val
= dictGetEntryVal(de
);
2733 if (server
.vm_enabled
) {
2734 if (key
->storage
== REDIS_VM_MEMORY
||
2735 key
->storage
== REDIS_VM_SWAPPING
)
2737 /* If we were swapping the object out, stop it, this key
2739 if (key
->storage
== REDIS_VM_SWAPPING
)
2740 vmCancelThreadedIOJob(key
);
2741 /* Update the access time of the key for the aging algorithm. */
2742 key
->vm
.atime
= server
.unixtime
;
2744 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2746 /* Our value was swapped on disk. Bring it at home. */
2747 redisAssert(val
== NULL
);
2748 val
= vmLoadObject(key
);
2749 dictGetEntryVal(de
) = val
;
2751 /* Clients blocked by the VM subsystem may be waiting for
2753 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2762 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2763 expireIfNeeded(db
,key
);
2764 return lookupKey(db
,key
);
2767 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2768 deleteIfVolatile(db
,key
);
2769 return lookupKey(db
,key
);
2772 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2773 robj
*o
= lookupKeyRead(c
->db
, key
);
2774 if (!o
) addReply(c
,reply
);
2778 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2779 robj
*o
= lookupKeyWrite(c
->db
, key
);
2780 if (!o
) addReply(c
,reply
);
2784 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2785 if (o
->type
!= type
) {
2786 addReply(c
,shared
.wrongtypeerr
);
2792 static int deleteKey(redisDb
*db
, robj
*key
) {
2795 /* We need to protect key from destruction: after the first dictDelete()
2796 * it may happen that 'key' is no longer valid if we don't increment
2797 * it's count. This may happen when we get the object reference directly
2798 * from the hash table with dictRandomKey() or dict iterators */
2800 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2801 retval
= dictDelete(db
->dict
,key
);
2804 return retval
== DICT_OK
;
2807 /* Try to share an object against the shared objects pool */
2808 static robj
*tryObjectSharing(robj
*o
) {
2809 struct dictEntry
*de
;
2812 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2814 redisAssert(o
->type
== REDIS_STRING
);
2815 de
= dictFind(server
.sharingpool
,o
);
2817 robj
*shared
= dictGetEntryKey(de
);
2819 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2820 dictGetEntryVal(de
) = (void*) c
;
2821 incrRefCount(shared
);
2825 /* Here we are using a stream algorihtm: Every time an object is
2826 * shared we increment its count, everytime there is a miss we
2827 * recrement the counter of a random object. If this object reaches
2828 * zero we remove the object and put the current object instead. */
2829 if (dictSize(server
.sharingpool
) >=
2830 server
.sharingpoolsize
) {
2831 de
= dictGetRandomKey(server
.sharingpool
);
2832 redisAssert(de
!= NULL
);
2833 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2834 dictGetEntryVal(de
) = (void*) c
;
2836 dictDelete(server
.sharingpool
,de
->key
);
2839 c
= 0; /* If the pool is empty we want to add this object */
2844 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2845 redisAssert(retval
== DICT_OK
);
2852 /* Check if the nul-terminated string 's' can be represented by a long
2853 * (that is, is a number that fits into long without any other space or
2854 * character before or after the digits).
2856 * If so, the function returns REDIS_OK and *longval is set to the value
2857 * of the number. Otherwise REDIS_ERR is returned */
2858 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2859 char buf
[32], *endptr
;
2863 value
= strtol(s
, &endptr
, 10);
2864 if (endptr
[0] != '\0') return REDIS_ERR
;
2865 slen
= snprintf(buf
,32,"%ld",value
);
2867 /* If the number converted back into a string is not identical
2868 * then it's not possible to encode the string as integer */
2869 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2870 if (longval
) *longval
= value
;
2874 /* Try to encode a string object in order to save space */
2875 static int tryObjectEncoding(robj
*o
) {
2879 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2880 return REDIS_ERR
; /* Already encoded */
2882 /* It's not save to encode shared objects: shared objects can be shared
2883 * everywhere in the "object space" of Redis. Encoded objects can only
2884 * appear as "values" (and not, for instance, as keys) */
2885 if (o
->refcount
> 1) return REDIS_ERR
;
2887 /* Currently we try to encode only strings */
2888 redisAssert(o
->type
== REDIS_STRING
);
2890 /* Check if we can represent this string as a long integer */
2891 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2893 /* Ok, this object can be encoded */
2894 o
->encoding
= REDIS_ENCODING_INT
;
2896 o
->ptr
= (void*) value
;
2900 /* Get a decoded version of an encoded object (returned as a new object).
2901 * If the object is already raw-encoded just increment the ref count. */
2902 static robj
*getDecodedObject(robj
*o
) {
2905 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2909 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2912 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2913 dec
= createStringObject(buf
,strlen(buf
));
2916 redisAssert(1 != 1);
2920 /* Compare two string objects via strcmp() or alike.
2921 * Note that the objects may be integer-encoded. In such a case we
2922 * use snprintf() to get a string representation of the numbers on the stack
2923 * and compare the strings, it's much faster than calling getDecodedObject().
2925 * Important note: if objects are not integer encoded, but binary-safe strings,
2926 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2928 static int compareStringObjects(robj
*a
, robj
*b
) {
2929 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2930 char bufa
[128], bufb
[128], *astr
, *bstr
;
2933 if (a
== b
) return 0;
2934 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2935 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2941 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2942 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2948 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2951 static size_t stringObjectLen(robj
*o
) {
2952 redisAssert(o
->type
== REDIS_STRING
);
2953 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2954 return sdslen(o
->ptr
);
2958 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2962 /*============================ RDB saving/loading =========================== */
2964 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2965 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2969 static int rdbSaveTime(FILE *fp
, time_t t
) {
2970 int32_t t32
= (int32_t) t
;
2971 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2975 /* check rdbLoadLen() comments for more info */
2976 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2977 unsigned char buf
[2];
2980 /* Save a 6 bit len */
2981 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2982 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2983 } else if (len
< (1<<14)) {
2984 /* Save a 14 bit len */
2985 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2987 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2989 /* Save a 32 bit len */
2990 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2991 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2993 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2998 /* String objects in the form "2391" "-100" without any space and with a
2999 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3000 * encoded as integers to save space */
3001 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3003 char *endptr
, buf
[32];
3005 /* Check if it's possible to encode this value as a number */
3006 value
= strtoll(s
, &endptr
, 10);
3007 if (endptr
[0] != '\0') return 0;
3008 snprintf(buf
,32,"%lld",value
);
3010 /* If the number converted back into a string is not identical
3011 * then it's not possible to encode the string as integer */
3012 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3014 /* Finally check if it fits in our ranges */
3015 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3016 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3017 enc
[1] = value
&0xFF;
3019 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3020 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3021 enc
[1] = value
&0xFF;
3022 enc
[2] = (value
>>8)&0xFF;
3024 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3025 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3026 enc
[1] = value
&0xFF;
3027 enc
[2] = (value
>>8)&0xFF;
3028 enc
[3] = (value
>>16)&0xFF;
3029 enc
[4] = (value
>>24)&0xFF;
3036 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3037 size_t comprlen
, outlen
;
3041 /* We require at least four bytes compression for this to be worth it */
3042 if (len
<= 4) return 0;
3044 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3045 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3046 if (comprlen
== 0) {
3050 /* Data compressed! Let's save it on disk */
3051 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3052 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3053 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3054 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3055 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3064 /* Save a string objet as [len][data] on disk. If the object is a string
3065 * representation of an integer value we try to safe it in a special form */
3066 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3069 /* Try integer encoding */
3071 unsigned char buf
[5];
3072 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3073 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3078 /* Try LZF compression - under 20 bytes it's unable to compress even
3079 * aaaaaaaaaaaaaaaaaa so skip it */
3080 if (server
.rdbcompression
&& len
> 20) {
3083 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3084 if (retval
== -1) return -1;
3085 if (retval
> 0) return 0;
3086 /* retval == 0 means data can't be compressed, save the old way */
3089 /* Store verbatim */
3090 if (rdbSaveLen(fp
,len
) == -1) return -1;
3091 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3095 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3096 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3099 /* Avoid incr/decr ref count business when possible.
3100 * This plays well with copy-on-write given that we are probably
3101 * in a child process (BGSAVE). Also this makes sure key objects
3102 * of swapped objects are not incRefCount-ed (an assert does not allow
3103 * this in order to avoid bugs) */
3104 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3105 obj
= getDecodedObject(obj
);
3106 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3109 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3114 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3115 * 8 bit integer specifing the length of the representation.
3116 * This 8 bit integer has special values in order to specify the following
3122 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3123 unsigned char buf
[128];
3129 } else if (!isfinite(val
)) {
3131 buf
[0] = (val
< 0) ? 255 : 254;
3133 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3134 buf
[0] = strlen((char*)buf
+1);
3137 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3141 /* Save a Redis object. */
3142 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3143 if (o
->type
== REDIS_STRING
) {
3144 /* Save a string value */
3145 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3146 } else if (o
->type
== REDIS_LIST
) {
3147 /* Save a list value */
3148 list
*list
= o
->ptr
;
3152 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3153 listRewind(list
,&li
);
3154 while((ln
= listNext(&li
))) {
3155 robj
*eleobj
= listNodeValue(ln
);
3157 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3159 } else if (o
->type
== REDIS_SET
) {
3160 /* Save a set value */
3162 dictIterator
*di
= dictGetIterator(set
);
3165 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3166 while((de
= dictNext(di
)) != NULL
) {
3167 robj
*eleobj
= dictGetEntryKey(de
);
3169 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3171 dictReleaseIterator(di
);
3172 } else if (o
->type
== REDIS_ZSET
) {
3173 /* Save a set value */
3175 dictIterator
*di
= dictGetIterator(zs
->dict
);
3178 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3179 while((de
= dictNext(di
)) != NULL
) {
3180 robj
*eleobj
= dictGetEntryKey(de
);
3181 double *score
= dictGetEntryVal(de
);
3183 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3184 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3186 dictReleaseIterator(di
);
3187 } else if (o
->type
== REDIS_HASH
) {
3188 /* Save a hash value */
3189 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3190 unsigned char *p
= zipmapRewind(o
->ptr
);
3191 unsigned int count
= zipmapLen(o
->ptr
);
3192 unsigned char *key
, *val
;
3193 unsigned int klen
, vlen
;
3195 if (rdbSaveLen(fp
,count
) == -1) return -1;
3196 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3197 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3198 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3201 dictIterator
*di
= dictGetIterator(o
->ptr
);
3204 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3205 while((de
= dictNext(di
)) != NULL
) {
3206 robj
*key
= dictGetEntryKey(de
);
3207 robj
*val
= dictGetEntryVal(de
);
3209 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3210 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3212 dictReleaseIterator(di
);
3215 redisAssert(0 != 0);
3220 /* Return the length the object will have on disk if saved with
3221 * the rdbSaveObject() function. Currently we use a trick to get
3222 * this length with very little changes to the code. In the future
3223 * we could switch to a faster solution. */
3224 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3225 if (fp
== NULL
) fp
= server
.devnull
;
3227 assert(rdbSaveObject(fp
,o
) != 1);
3231 /* Return the number of pages required to save this object in the swap file */
3232 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3233 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3235 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3238 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3239 static int rdbSave(char *filename
) {
3240 dictIterator
*di
= NULL
;
3245 time_t now
= time(NULL
);
3247 /* Wait for I/O therads to terminate, just in case this is a
3248 * foreground-saving, to avoid seeking the swap file descriptor at the
3250 if (server
.vm_enabled
)
3251 waitEmptyIOJobsQueue();
3253 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3254 fp
= fopen(tmpfile
,"w");
3256 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3259 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3260 for (j
= 0; j
< server
.dbnum
; j
++) {
3261 redisDb
*db
= server
.db
+j
;
3263 if (dictSize(d
) == 0) continue;
3264 di
= dictGetIterator(d
);
3270 /* Write the SELECT DB opcode */
3271 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3272 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3274 /* Iterate this DB writing every entry */
3275 while((de
= dictNext(di
)) != NULL
) {
3276 robj
*key
= dictGetEntryKey(de
);
3277 robj
*o
= dictGetEntryVal(de
);
3278 time_t expiretime
= getExpire(db
,key
);
3280 /* Save the expire time */
3281 if (expiretime
!= -1) {
3282 /* If this key is already expired skip it */
3283 if (expiretime
< now
) continue;
3284 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3285 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3287 /* Save the key and associated value. This requires special
3288 * handling if the value is swapped out. */
3289 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3290 key
->storage
== REDIS_VM_SWAPPING
) {
3291 /* Save type, key, value */
3292 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3293 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3294 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3296 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3298 /* Get a preview of the object in memory */
3299 po
= vmPreviewObject(key
);
3300 /* Save type, key, value */
3301 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3302 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3303 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3304 /* Remove the loaded object from memory */
3308 dictReleaseIterator(di
);
3311 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3313 /* Make sure data will not remain on the OS's output buffers */
3318 /* Use RENAME to make sure the DB file is changed atomically only
3319 * if the generate DB file is ok. */
3320 if (rename(tmpfile
,filename
) == -1) {
3321 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3325 redisLog(REDIS_NOTICE
,"DB saved on disk");
3327 server
.lastsave
= time(NULL
);
3333 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3334 if (di
) dictReleaseIterator(di
);
3338 static int rdbSaveBackground(char *filename
) {
3341 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3342 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3343 if ((childpid
= fork()) == 0) {
3345 if (server
.vm_enabled
) vmReopenSwapFile();
3347 if (rdbSave(filename
) == REDIS_OK
) {
3354 if (childpid
== -1) {
3355 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3359 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3360 server
.bgsavechildpid
= childpid
;
3363 return REDIS_OK
; /* unreached */
3366 static void rdbRemoveTempFile(pid_t childpid
) {
3369 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3373 static int rdbLoadType(FILE *fp
) {
3375 if (fread(&type
,1,1,fp
) == 0) return -1;
3379 static time_t rdbLoadTime(FILE *fp
) {
3381 if (fread(&t32
,4,1,fp
) == 0) return -1;
3382 return (time_t) t32
;
3385 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3386 * of this file for a description of how this are stored on disk.
3388 * isencoded is set to 1 if the readed length is not actually a length but
3389 * an "encoding type", check the above comments for more info */
3390 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3391 unsigned char buf
[2];
3395 if (isencoded
) *isencoded
= 0;
3396 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3397 type
= (buf
[0]&0xC0)>>6;
3398 if (type
== REDIS_RDB_6BITLEN
) {
3399 /* Read a 6 bit len */
3401 } else if (type
== REDIS_RDB_ENCVAL
) {
3402 /* Read a 6 bit len encoding type */
3403 if (isencoded
) *isencoded
= 1;
3405 } else if (type
== REDIS_RDB_14BITLEN
) {
3406 /* Read a 14 bit len */
3407 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3408 return ((buf
[0]&0x3F)<<8)|buf
[1];
3410 /* Read a 32 bit len */
3411 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3416 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3417 unsigned char enc
[4];
3420 if (enctype
== REDIS_RDB_ENC_INT8
) {
3421 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3422 val
= (signed char)enc
[0];
3423 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3425 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3426 v
= enc
[0]|(enc
[1]<<8);
3428 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3430 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3431 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3434 val
= 0; /* anti-warning */
3437 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3440 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3441 unsigned int len
, clen
;
3442 unsigned char *c
= NULL
;
3445 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3446 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3447 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3448 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3449 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3450 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3452 return createObject(REDIS_STRING
,val
);
3459 static robj
*rdbLoadStringObject(FILE*fp
) {
3464 len
= rdbLoadLen(fp
,&isencoded
);
3467 case REDIS_RDB_ENC_INT8
:
3468 case REDIS_RDB_ENC_INT16
:
3469 case REDIS_RDB_ENC_INT32
:
3470 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3471 case REDIS_RDB_ENC_LZF
:
3472 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3478 if (len
== REDIS_RDB_LENERR
) return NULL
;
3479 val
= sdsnewlen(NULL
,len
);
3480 if (len
&& fread(val
,len
,1,fp
) == 0) {
3484 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3487 /* For information about double serialization check rdbSaveDoubleValue() */
3488 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3492 if (fread(&len
,1,1,fp
) == 0) return -1;
3494 case 255: *val
= R_NegInf
; return 0;
3495 case 254: *val
= R_PosInf
; return 0;
3496 case 253: *val
= R_Nan
; return 0;
3498 if (fread(buf
,len
,1,fp
) == 0) return -1;
3500 sscanf(buf
, "%lg", val
);
3505 /* Load a Redis object of the specified type from the specified file.
3506 * On success a newly allocated object is returned, otherwise NULL. */
3507 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3510 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3511 if (type
== REDIS_STRING
) {
3512 /* Read string value */
3513 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3514 tryObjectEncoding(o
);
3515 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3516 /* Read list/set value */
3519 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3520 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3521 /* It's faster to expand the dict to the right size asap in order
3522 * to avoid rehashing */
3523 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3524 dictExpand(o
->ptr
,listlen
);
3525 /* Load every single element of the list/set */
3529 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3530 tryObjectEncoding(ele
);
3531 if (type
== REDIS_LIST
) {
3532 listAddNodeTail((list
*)o
->ptr
,ele
);
3534 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3537 } else if (type
== REDIS_ZSET
) {
3538 /* Read list/set value */
3542 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3543 o
= createZsetObject();
3545 /* Load every single element of the list/set */
3548 double *score
= zmalloc(sizeof(double));
3550 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3551 tryObjectEncoding(ele
);
3552 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3553 dictAdd(zs
->dict
,ele
,score
);
3554 zslInsert(zs
->zsl
,*score
,ele
);
3555 incrRefCount(ele
); /* added to skiplist */
3557 } else if (type
== REDIS_HASH
) {
3560 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3561 o
= createHashObject();
3562 /* Too many entries? Use an hash table. */
3563 if (hashlen
> server
.hash_max_zipmap_entries
)
3564 convertToRealHash(o
);
3565 /* Load every key/value, then set it into the zipmap or hash
3566 * table, as needed. */
3570 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3571 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3572 /* If we are using a zipmap and there are too big values
3573 * the object is converted to real hash table encoding. */
3574 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3575 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3576 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3578 convertToRealHash(o
);
3581 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3582 unsigned char *zm
= o
->ptr
;
3584 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3585 val
->ptr
,sdslen(val
->ptr
),NULL
);
3590 tryObjectEncoding(key
);
3591 tryObjectEncoding(val
);
3592 dictAdd((dict
*)o
->ptr
,key
,val
);
3598 redisAssert(0 != 0);
3603 static int rdbLoad(char *filename
) {
3605 robj
*keyobj
= NULL
;
3607 int type
, retval
, rdbver
;
3608 dict
*d
= server
.db
[0].dict
;
3609 redisDb
*db
= server
.db
+0;
3611 time_t expiretime
= -1, now
= time(NULL
);
3612 long long loadedkeys
= 0;
3614 fp
= fopen(filename
,"r");
3615 if (!fp
) return REDIS_ERR
;
3616 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3618 if (memcmp(buf
,"REDIS",5) != 0) {
3620 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3623 rdbver
= atoi(buf
+5);
3626 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3633 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3634 if (type
== REDIS_EXPIRETIME
) {
3635 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3636 /* We read the time so we need to read the object type again */
3637 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3639 if (type
== REDIS_EOF
) break;
3640 /* Handle SELECT DB opcode as a special case */
3641 if (type
== REDIS_SELECTDB
) {
3642 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3644 if (dbid
>= (unsigned)server
.dbnum
) {
3645 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3648 db
= server
.db
+dbid
;
3653 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3655 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3656 /* Add the new object in the hash table */
3657 retval
= dictAdd(d
,keyobj
,o
);
3658 if (retval
== DICT_ERR
) {
3659 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3662 /* Set the expire time if needed */
3663 if (expiretime
!= -1) {
3664 setExpire(db
,keyobj
,expiretime
);
3665 /* Delete this key if already expired */
3666 if (expiretime
< now
) deleteKey(db
,keyobj
);
3670 /* Handle swapping while loading big datasets when VM is on */
3672 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3673 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3674 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3681 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3682 if (keyobj
) decrRefCount(keyobj
);
3683 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3685 return REDIS_ERR
; /* Just to avoid warning */
3688 /*================================== Commands =============================== */
3690 static void authCommand(redisClient
*c
) {
3691 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3692 c
->authenticated
= 1;
3693 addReply(c
,shared
.ok
);
3695 c
->authenticated
= 0;
3696 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3700 static void pingCommand(redisClient
*c
) {
3701 addReply(c
,shared
.pong
);
3704 static void echoCommand(redisClient
*c
) {
3705 addReplyBulk(c
,c
->argv
[1]);
3708 /*=================================== Strings =============================== */
3710 static void setGenericCommand(redisClient
*c
, int nx
) {
3713 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3714 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3715 if (retval
== DICT_ERR
) {
3717 /* If the key is about a swapped value, we want a new key object
3718 * to overwrite the old. So we delete the old key in the database.
3719 * This will also make sure that swap pages about the old object
3720 * will be marked as free. */
3721 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3722 incrRefCount(c
->argv
[1]);
3723 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3724 incrRefCount(c
->argv
[2]);
3726 addReply(c
,shared
.czero
);
3730 incrRefCount(c
->argv
[1]);
3731 incrRefCount(c
->argv
[2]);
3734 removeExpire(c
->db
,c
->argv
[1]);
3735 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3738 static void setCommand(redisClient
*c
) {
3739 setGenericCommand(c
,0);
3742 static void setnxCommand(redisClient
*c
) {
3743 setGenericCommand(c
,1);
3746 static int getGenericCommand(redisClient
*c
) {
3749 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3752 if (o
->type
!= REDIS_STRING
) {
3753 addReply(c
,shared
.wrongtypeerr
);
3761 static void getCommand(redisClient
*c
) {
3762 getGenericCommand(c
);
3765 static void getsetCommand(redisClient
*c
) {
3766 if (getGenericCommand(c
) == REDIS_ERR
) return;
3767 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3768 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3770 incrRefCount(c
->argv
[1]);
3772 incrRefCount(c
->argv
[2]);
3774 removeExpire(c
->db
,c
->argv
[1]);
3777 static void mgetCommand(redisClient
*c
) {
3780 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3781 for (j
= 1; j
< c
->argc
; j
++) {
3782 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3784 addReply(c
,shared
.nullbulk
);
3786 if (o
->type
!= REDIS_STRING
) {
3787 addReply(c
,shared
.nullbulk
);
3795 static void msetGenericCommand(redisClient
*c
, int nx
) {
3796 int j
, busykeys
= 0;
3798 if ((c
->argc
% 2) == 0) {
3799 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3802 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3803 * set nothing at all if at least one already key exists. */
3805 for (j
= 1; j
< c
->argc
; j
+= 2) {
3806 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3812 addReply(c
, shared
.czero
);
3816 for (j
= 1; j
< c
->argc
; j
+= 2) {
3819 tryObjectEncoding(c
->argv
[j
+1]);
3820 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3821 if (retval
== DICT_ERR
) {
3822 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3823 incrRefCount(c
->argv
[j
+1]);
3825 incrRefCount(c
->argv
[j
]);
3826 incrRefCount(c
->argv
[j
+1]);
3828 removeExpire(c
->db
,c
->argv
[j
]);
3830 server
.dirty
+= (c
->argc
-1)/2;
3831 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3834 static void msetCommand(redisClient
*c
) {
3835 msetGenericCommand(c
,0);
3838 static void msetnxCommand(redisClient
*c
) {
3839 msetGenericCommand(c
,1);
3842 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3847 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3851 if (o
->type
!= REDIS_STRING
) {
3856 if (o
->encoding
== REDIS_ENCODING_RAW
)
3857 value
= strtoll(o
->ptr
, &eptr
, 10);
3858 else if (o
->encoding
== REDIS_ENCODING_INT
)
3859 value
= (long)o
->ptr
;
3861 redisAssert(1 != 1);
3866 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3867 tryObjectEncoding(o
);
3868 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3869 if (retval
== DICT_ERR
) {
3870 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3871 removeExpire(c
->db
,c
->argv
[1]);
3873 incrRefCount(c
->argv
[1]);
3876 addReply(c
,shared
.colon
);
3878 addReply(c
,shared
.crlf
);
3881 static void incrCommand(redisClient
*c
) {
3882 incrDecrCommand(c
,1);
3885 static void decrCommand(redisClient
*c
) {
3886 incrDecrCommand(c
,-1);
3889 static void incrbyCommand(redisClient
*c
) {
3890 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3891 incrDecrCommand(c
,incr
);
3894 static void decrbyCommand(redisClient
*c
) {
3895 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3896 incrDecrCommand(c
,-incr
);
3899 static void appendCommand(redisClient
*c
) {
3904 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3906 /* Create the key */
3907 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3908 incrRefCount(c
->argv
[1]);
3909 incrRefCount(c
->argv
[2]);
3910 totlen
= stringObjectLen(c
->argv
[2]);
3914 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3917 o
= dictGetEntryVal(de
);
3918 if (o
->type
!= REDIS_STRING
) {
3919 addReply(c
,shared
.wrongtypeerr
);
3922 /* If the object is specially encoded or shared we have to make
3924 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3925 robj
*decoded
= getDecodedObject(o
);
3927 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3928 decrRefCount(decoded
);
3929 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3932 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3933 o
->ptr
= sdscatlen(o
->ptr
,
3934 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3936 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3937 (unsigned long) c
->argv
[2]->ptr
);
3939 totlen
= sdslen(o
->ptr
);
3942 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3945 static void substrCommand(redisClient
*c
) {
3947 long start
= atoi(c
->argv
[2]->ptr
);
3948 long end
= atoi(c
->argv
[3]->ptr
);
3949 size_t rangelen
, strlen
;
3952 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
3953 checkType(c
,o
,REDIS_STRING
)) return;
3955 o
= getDecodedObject(o
);
3956 strlen
= sdslen(o
->ptr
);
3958 /* convert negative indexes */
3959 if (start
< 0) start
= strlen
+start
;
3960 if (end
< 0) end
= strlen
+end
;
3961 if (start
< 0) start
= 0;
3962 if (end
< 0) end
= 0;
3964 /* indexes sanity checks */
3965 if (start
> end
|| (size_t)start
>= strlen
) {
3966 /* Out of range start or start > end result in null reply */
3967 addReply(c
,shared
.nullbulk
);
3971 if ((size_t)end
>= strlen
) end
= strlen
-1;
3972 rangelen
= (end
-start
)+1;
3974 /* Return the result */
3975 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
3976 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
3977 addReplySds(c
,range
);
3978 addReply(c
,shared
.crlf
);
3982 /* ========================= Type agnostic commands ========================= */
3984 static void delCommand(redisClient
*c
) {
3987 for (j
= 1; j
< c
->argc
; j
++) {
3988 if (deleteKey(c
->db
,c
->argv
[j
])) {
3993 addReplyLong(c
,deleted
);
3996 static void existsCommand(redisClient
*c
) {
3997 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4000 static void selectCommand(redisClient
*c
) {
4001 int id
= atoi(c
->argv
[1]->ptr
);
4003 if (selectDb(c
,id
) == REDIS_ERR
) {
4004 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4006 addReply(c
,shared
.ok
);
4010 static void randomkeyCommand(redisClient
*c
) {
4014 de
= dictGetRandomKey(c
->db
->dict
);
4015 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4018 addReply(c
,shared
.plus
);
4019 addReply(c
,shared
.crlf
);
4021 addReply(c
,shared
.plus
);
4022 addReply(c
,dictGetEntryKey(de
));
4023 addReply(c
,shared
.crlf
);
4027 static void keysCommand(redisClient
*c
) {
4030 sds pattern
= c
->argv
[1]->ptr
;
4031 int plen
= sdslen(pattern
);
4032 unsigned long numkeys
= 0;
4033 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4035 di
= dictGetIterator(c
->db
->dict
);
4037 decrRefCount(lenobj
);
4038 while((de
= dictNext(di
)) != NULL
) {
4039 robj
*keyobj
= dictGetEntryKey(de
);
4041 sds key
= keyobj
->ptr
;
4042 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4043 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4044 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4045 addReplyBulk(c
,keyobj
);
4050 dictReleaseIterator(di
);
4051 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4054 static void dbsizeCommand(redisClient
*c
) {
4056 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4059 static void lastsaveCommand(redisClient
*c
) {
4061 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4064 static void typeCommand(redisClient
*c
) {
4068 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4073 case REDIS_STRING
: type
= "+string"; break;
4074 case REDIS_LIST
: type
= "+list"; break;
4075 case REDIS_SET
: type
= "+set"; break;
4076 case REDIS_ZSET
: type
= "+zset"; break;
4077 case REDIS_HASH
: type
= "+hash"; break;
4078 default: type
= "+unknown"; break;
4081 addReplySds(c
,sdsnew(type
));
4082 addReply(c
,shared
.crlf
);
4085 static void saveCommand(redisClient
*c
) {
4086 if (server
.bgsavechildpid
!= -1) {
4087 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4090 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4091 addReply(c
,shared
.ok
);
4093 addReply(c
,shared
.err
);
4097 static void bgsaveCommand(redisClient
*c
) {
4098 if (server
.bgsavechildpid
!= -1) {
4099 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4102 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4103 char *status
= "+Background saving started\r\n";
4104 addReplySds(c
,sdsnew(status
));
4106 addReply(c
,shared
.err
);
4110 static void shutdownCommand(redisClient
*c
) {
4111 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4112 /* Kill the saving child if there is a background saving in progress.
4113 We want to avoid race conditions, for instance our saving child may
4114 overwrite the synchronous saving did by SHUTDOWN. */
4115 if (server
.bgsavechildpid
!= -1) {
4116 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4117 kill(server
.bgsavechildpid
,SIGKILL
);
4118 rdbRemoveTempFile(server
.bgsavechildpid
);
4120 if (server
.appendonly
) {
4121 /* Append only file: fsync() the AOF and exit */
4122 fsync(server
.appendfd
);
4123 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4126 /* Snapshotting. Perform a SYNC SAVE and exit */
4127 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4128 if (server
.daemonize
)
4129 unlink(server
.pidfile
);
4130 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4131 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4132 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4135 /* Ooops.. error saving! The best we can do is to continue
4136 * operating. Note that if there was a background saving process,
4137 * in the next cron() Redis will be notified that the background
4138 * saving aborted, handling special stuff like slaves pending for
4139 * synchronization... */
4140 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4142 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4147 static void renameGenericCommand(redisClient
*c
, int nx
) {
4150 /* To use the same key as src and dst is probably an error */
4151 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4152 addReply(c
,shared
.sameobjecterr
);
4156 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4160 deleteIfVolatile(c
->db
,c
->argv
[2]);
4161 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4164 addReply(c
,shared
.czero
);
4167 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4169 incrRefCount(c
->argv
[2]);
4171 deleteKey(c
->db
,c
->argv
[1]);
4173 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4176 static void renameCommand(redisClient
*c
) {
4177 renameGenericCommand(c
,0);
4180 static void renamenxCommand(redisClient
*c
) {
4181 renameGenericCommand(c
,1);
4184 static void moveCommand(redisClient
*c
) {
4189 /* Obtain source and target DB pointers */
4192 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4193 addReply(c
,shared
.outofrangeerr
);
4197 selectDb(c
,srcid
); /* Back to the source DB */
4199 /* If the user is moving using as target the same
4200 * DB as the source DB it is probably an error. */
4202 addReply(c
,shared
.sameobjecterr
);
4206 /* Check if the element exists and get a reference */
4207 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4209 addReply(c
,shared
.czero
);
4213 /* Try to add the element to the target DB */
4214 deleteIfVolatile(dst
,c
->argv
[1]);
4215 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4216 addReply(c
,shared
.czero
);
4219 incrRefCount(c
->argv
[1]);
4222 /* OK! key moved, free the entry in the source DB */
4223 deleteKey(src
,c
->argv
[1]);
4225 addReply(c
,shared
.cone
);
4228 /* =================================== Lists ================================ */
4229 static void pushGenericCommand(redisClient
*c
, int where
) {
4233 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4235 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4236 addReply(c
,shared
.cone
);
4239 lobj
= createListObject();
4241 if (where
== REDIS_HEAD
) {
4242 listAddNodeHead(list
,c
->argv
[2]);
4244 listAddNodeTail(list
,c
->argv
[2]);
4246 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4247 incrRefCount(c
->argv
[1]);
4248 incrRefCount(c
->argv
[2]);
4250 if (lobj
->type
!= REDIS_LIST
) {
4251 addReply(c
,shared
.wrongtypeerr
);
4254 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4255 addReply(c
,shared
.cone
);
4259 if (where
== REDIS_HEAD
) {
4260 listAddNodeHead(list
,c
->argv
[2]);
4262 listAddNodeTail(list
,c
->argv
[2]);
4264 incrRefCount(c
->argv
[2]);
4267 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4270 static void lpushCommand(redisClient
*c
) {
4271 pushGenericCommand(c
,REDIS_HEAD
);
4274 static void rpushCommand(redisClient
*c
) {
4275 pushGenericCommand(c
,REDIS_TAIL
);
4278 static void llenCommand(redisClient
*c
) {
4282 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4283 checkType(c
,o
,REDIS_LIST
)) return;
4286 addReplyUlong(c
,listLength(l
));
4289 static void lindexCommand(redisClient
*c
) {
4291 int index
= atoi(c
->argv
[2]->ptr
);
4295 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4296 checkType(c
,o
,REDIS_LIST
)) return;
4299 ln
= listIndex(list
, index
);
4301 addReply(c
,shared
.nullbulk
);
4303 robj
*ele
= listNodeValue(ln
);
4304 addReplyBulk(c
,ele
);
4308 static void lsetCommand(redisClient
*c
) {
4310 int index
= atoi(c
->argv
[2]->ptr
);
4314 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4315 checkType(c
,o
,REDIS_LIST
)) return;
4318 ln
= listIndex(list
, index
);
4320 addReply(c
,shared
.outofrangeerr
);
4322 robj
*ele
= listNodeValue(ln
);
4325 listNodeValue(ln
) = c
->argv
[3];
4326 incrRefCount(c
->argv
[3]);
4327 addReply(c
,shared
.ok
);
4332 static void popGenericCommand(redisClient
*c
, int where
) {
4337 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4338 checkType(c
,o
,REDIS_LIST
)) return;
4341 if (where
== REDIS_HEAD
)
4342 ln
= listFirst(list
);
4344 ln
= listLast(list
);
4347 addReply(c
,shared
.nullbulk
);
4349 robj
*ele
= listNodeValue(ln
);
4350 addReplyBulk(c
,ele
);
4351 listDelNode(list
,ln
);
4356 static void lpopCommand(redisClient
*c
) {
4357 popGenericCommand(c
,REDIS_HEAD
);
4360 static void rpopCommand(redisClient
*c
) {
4361 popGenericCommand(c
,REDIS_TAIL
);
4364 static void lrangeCommand(redisClient
*c
) {
4366 int start
= atoi(c
->argv
[2]->ptr
);
4367 int end
= atoi(c
->argv
[3]->ptr
);
4374 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4375 checkType(c
,o
,REDIS_LIST
)) return;
4377 llen
= listLength(list
);
4379 /* convert negative indexes */
4380 if (start
< 0) start
= llen
+start
;
4381 if (end
< 0) end
= llen
+end
;
4382 if (start
< 0) start
= 0;
4383 if (end
< 0) end
= 0;
4385 /* indexes sanity checks */
4386 if (start
> end
|| start
>= llen
) {
4387 /* Out of range start or start > end result in empty list */
4388 addReply(c
,shared
.emptymultibulk
);
4391 if (end
>= llen
) end
= llen
-1;
4392 rangelen
= (end
-start
)+1;
4394 /* Return the result in form of a multi-bulk reply */
4395 ln
= listIndex(list
, start
);
4396 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4397 for (j
= 0; j
< rangelen
; j
++) {
4398 ele
= listNodeValue(ln
);
4399 addReplyBulk(c
,ele
);
4404 static void ltrimCommand(redisClient
*c
) {
4406 int start
= atoi(c
->argv
[2]->ptr
);
4407 int end
= atoi(c
->argv
[3]->ptr
);
4409 int j
, ltrim
, rtrim
;
4413 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4414 checkType(c
,o
,REDIS_LIST
)) return;
4416 llen
= listLength(list
);
4418 /* convert negative indexes */
4419 if (start
< 0) start
= llen
+start
;
4420 if (end
< 0) end
= llen
+end
;
4421 if (start
< 0) start
= 0;
4422 if (end
< 0) end
= 0;
4424 /* indexes sanity checks */
4425 if (start
> end
|| start
>= llen
) {
4426 /* Out of range start or start > end result in empty list */
4430 if (end
>= llen
) end
= llen
-1;
4435 /* Remove list elements to perform the trim */
4436 for (j
= 0; j
< ltrim
; j
++) {
4437 ln
= listFirst(list
);
4438 listDelNode(list
,ln
);
4440 for (j
= 0; j
< rtrim
; j
++) {
4441 ln
= listLast(list
);
4442 listDelNode(list
,ln
);
4445 addReply(c
,shared
.ok
);
4448 static void lremCommand(redisClient
*c
) {
4451 listNode
*ln
, *next
;
4452 int toremove
= atoi(c
->argv
[2]->ptr
);
4456 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4457 checkType(c
,o
,REDIS_LIST
)) return;
4461 toremove
= -toremove
;
4464 ln
= fromtail
? list
->tail
: list
->head
;
4466 robj
*ele
= listNodeValue(ln
);
4468 next
= fromtail
? ln
->prev
: ln
->next
;
4469 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4470 listDelNode(list
,ln
);
4473 if (toremove
&& removed
== toremove
) break;
4477 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4480 /* This is the semantic of this command:
4481 * RPOPLPUSH srclist dstlist:
4482 * IF LLEN(srclist) > 0
4483 * element = RPOP srclist
4484 * LPUSH dstlist element
4491 * The idea is to be able to get an element from a list in a reliable way
4492 * since the element is not just returned but pushed against another list
4493 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4495 static void rpoplpushcommand(redisClient
*c
) {
4500 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4501 checkType(c
,sobj
,REDIS_LIST
)) return;
4502 srclist
= sobj
->ptr
;
4503 ln
= listLast(srclist
);
4506 addReply(c
,shared
.nullbulk
);
4508 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4509 robj
*ele
= listNodeValue(ln
);
4512 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4513 addReply(c
,shared
.wrongtypeerr
);
4517 /* Add the element to the target list (unless it's directly
4518 * passed to some BLPOP-ing client */
4519 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4521 /* Create the list if the key does not exist */
4522 dobj
= createListObject();
4523 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4524 incrRefCount(c
->argv
[2]);
4526 dstlist
= dobj
->ptr
;
4527 listAddNodeHead(dstlist
,ele
);
4531 /* Send the element to the client as reply as well */
4532 addReplyBulk(c
,ele
);
4534 /* Finally remove the element from the source list */
4535 listDelNode(srclist
,ln
);
4540 /* ==================================== Sets ================================ */
4542 static void saddCommand(redisClient
*c
) {
4545 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4547 set
= createSetObject();
4548 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4549 incrRefCount(c
->argv
[1]);
4551 if (set
->type
!= REDIS_SET
) {
4552 addReply(c
,shared
.wrongtypeerr
);
4556 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4557 incrRefCount(c
->argv
[2]);
4559 addReply(c
,shared
.cone
);
4561 addReply(c
,shared
.czero
);
4565 static void sremCommand(redisClient
*c
) {
4568 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4569 checkType(c
,set
,REDIS_SET
)) return;
4571 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4573 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4574 addReply(c
,shared
.cone
);
4576 addReply(c
,shared
.czero
);
4580 static void smoveCommand(redisClient
*c
) {
4581 robj
*srcset
, *dstset
;
4583 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4584 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4586 /* If the source key does not exist return 0, if it's of the wrong type
4588 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4589 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4592 /* Error if the destination key is not a set as well */
4593 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4594 addReply(c
,shared
.wrongtypeerr
);
4597 /* Remove the element from the source set */
4598 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4599 /* Key not found in the src set! return zero */
4600 addReply(c
,shared
.czero
);
4604 /* Add the element to the destination set */
4606 dstset
= createSetObject();
4607 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4608 incrRefCount(c
->argv
[2]);
4610 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4611 incrRefCount(c
->argv
[3]);
4612 addReply(c
,shared
.cone
);
4615 static void sismemberCommand(redisClient
*c
) {
4618 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4619 checkType(c
,set
,REDIS_SET
)) return;
4621 if (dictFind(set
->ptr
,c
->argv
[2]))
4622 addReply(c
,shared
.cone
);
4624 addReply(c
,shared
.czero
);
4627 static void scardCommand(redisClient
*c
) {
4631 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4632 checkType(c
,o
,REDIS_SET
)) return;
4635 addReplyUlong(c
,dictSize(s
));
4638 static void spopCommand(redisClient
*c
) {
4642 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4643 checkType(c
,set
,REDIS_SET
)) return;
4645 de
= dictGetRandomKey(set
->ptr
);
4647 addReply(c
,shared
.nullbulk
);
4649 robj
*ele
= dictGetEntryKey(de
);
4651 addReplyBulk(c
,ele
);
4652 dictDelete(set
->ptr
,ele
);
4653 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4658 static void srandmemberCommand(redisClient
*c
) {
4662 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4663 checkType(c
,set
,REDIS_SET
)) return;
4665 de
= dictGetRandomKey(set
->ptr
);
4667 addReply(c
,shared
.nullbulk
);
4669 robj
*ele
= dictGetEntryKey(de
);
4671 addReplyBulk(c
,ele
);
4675 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4676 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4678 return dictSize(*d1
)-dictSize(*d2
);
4681 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4682 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4685 robj
*lenobj
= NULL
, *dstset
= NULL
;
4686 unsigned long j
, cardinality
= 0;
4688 for (j
= 0; j
< setsnum
; j
++) {
4692 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4693 lookupKeyRead(c
->db
,setskeys
[j
]);
4697 if (deleteKey(c
->db
,dstkey
))
4699 addReply(c
,shared
.czero
);
4701 addReply(c
,shared
.nullmultibulk
);
4705 if (setobj
->type
!= REDIS_SET
) {
4707 addReply(c
,shared
.wrongtypeerr
);
4710 dv
[j
] = setobj
->ptr
;
4712 /* Sort sets from the smallest to largest, this will improve our
4713 * algorithm's performace */
4714 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4716 /* The first thing we should output is the total number of elements...
4717 * since this is a multi-bulk write, but at this stage we don't know
4718 * the intersection set size, so we use a trick, append an empty object
4719 * to the output list and save the pointer to later modify it with the
4722 lenobj
= createObject(REDIS_STRING
,NULL
);
4724 decrRefCount(lenobj
);
4726 /* If we have a target key where to store the resulting set
4727 * create this key with an empty set inside */
4728 dstset
= createSetObject();
4731 /* Iterate all the elements of the first (smallest) set, and test
4732 * the element against all the other sets, if at least one set does
4733 * not include the element it is discarded */
4734 di
= dictGetIterator(dv
[0]);
4736 while((de
= dictNext(di
)) != NULL
) {
4739 for (j
= 1; j
< setsnum
; j
++)
4740 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4742 continue; /* at least one set does not contain the member */
4743 ele
= dictGetEntryKey(de
);
4745 addReplyBulk(c
,ele
);
4748 dictAdd(dstset
->ptr
,ele
,NULL
);
4752 dictReleaseIterator(di
);
4755 /* Store the resulting set into the target */
4756 deleteKey(c
->db
,dstkey
);
4757 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4758 incrRefCount(dstkey
);
4762 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4764 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4765 dictSize((dict
*)dstset
->ptr
)));
4771 static void sinterCommand(redisClient
*c
) {
4772 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4775 static void sinterstoreCommand(redisClient
*c
) {
4776 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4779 #define REDIS_OP_UNION 0
4780 #define REDIS_OP_DIFF 1
4781 #define REDIS_OP_INTER 2
4783 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4784 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4787 robj
*dstset
= NULL
;
4788 int j
, cardinality
= 0;
4790 for (j
= 0; j
< setsnum
; j
++) {
4794 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4795 lookupKeyRead(c
->db
,setskeys
[j
]);
4800 if (setobj
->type
!= REDIS_SET
) {
4802 addReply(c
,shared
.wrongtypeerr
);
4805 dv
[j
] = setobj
->ptr
;
4808 /* We need a temp set object to store our union. If the dstkey
4809 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4810 * this set object will be the resulting object to set into the target key*/
4811 dstset
= createSetObject();
4813 /* Iterate all the elements of all the sets, add every element a single
4814 * time to the result set */
4815 for (j
= 0; j
< setsnum
; j
++) {
4816 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4817 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4819 di
= dictGetIterator(dv
[j
]);
4821 while((de
= dictNext(di
)) != NULL
) {
4824 /* dictAdd will not add the same element multiple times */
4825 ele
= dictGetEntryKey(de
);
4826 if (op
== REDIS_OP_UNION
|| j
== 0) {
4827 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4831 } else if (op
== REDIS_OP_DIFF
) {
4832 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4837 dictReleaseIterator(di
);
4839 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4842 /* Output the content of the resulting set, if not in STORE mode */
4844 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4845 di
= dictGetIterator(dstset
->ptr
);
4846 while((de
= dictNext(di
)) != NULL
) {
4849 ele
= dictGetEntryKey(de
);
4850 addReplyBulk(c
,ele
);
4852 dictReleaseIterator(di
);
4854 /* If we have a target key where to store the resulting set
4855 * create this key with the result set inside */
4856 deleteKey(c
->db
,dstkey
);
4857 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4858 incrRefCount(dstkey
);
4863 decrRefCount(dstset
);
4865 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4866 dictSize((dict
*)dstset
->ptr
)));
4872 static void sunionCommand(redisClient
*c
) {
4873 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4876 static void sunionstoreCommand(redisClient
*c
) {
4877 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4880 static void sdiffCommand(redisClient
*c
) {
4881 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4884 static void sdiffstoreCommand(redisClient
*c
) {
4885 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4888 /* ==================================== ZSets =============================== */
4890 /* ZSETs are ordered sets using two data structures to hold the same elements
4891 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4894 * The elements are added to an hash table mapping Redis objects to scores.
4895 * At the same time the elements are added to a skip list mapping scores
4896 * to Redis objects (so objects are sorted by scores in this "view"). */
4898 /* This skiplist implementation is almost a C translation of the original
4899 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4900 * Alternative to Balanced Trees", modified in three ways:
4901 * a) this implementation allows for repeated values.
4902 * b) the comparison is not just by key (our 'score') but by satellite data.
4903 * c) there is a back pointer, so it's a doubly linked list with the back
4904 * pointers being only at "level 1". This allows to traverse the list
4905 * from tail to head, useful for ZREVRANGE. */
4907 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4908 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4910 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4912 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4918 static zskiplist
*zslCreate(void) {
4922 zsl
= zmalloc(sizeof(*zsl
));
4925 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4926 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4927 zsl
->header
->forward
[j
] = NULL
;
4929 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4930 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4931 zsl
->header
->span
[j
] = 0;
4933 zsl
->header
->backward
= NULL
;
4938 static void zslFreeNode(zskiplistNode
*node
) {
4939 decrRefCount(node
->obj
);
4940 zfree(node
->forward
);
4945 static void zslFree(zskiplist
*zsl
) {
4946 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4948 zfree(zsl
->header
->forward
);
4949 zfree(zsl
->header
->span
);
4952 next
= node
->forward
[0];
4959 static int zslRandomLevel(void) {
4961 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4966 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4967 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4968 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
4972 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4973 /* store rank that is crossed to reach the insert position */
4974 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
4976 while (x
->forward
[i
] &&
4977 (x
->forward
[i
]->score
< score
||
4978 (x
->forward
[i
]->score
== score
&&
4979 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
4980 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
4985 /* we assume the key is not already inside, since we allow duplicated
4986 * scores, and the re-insertion of score and redis object should never
4987 * happpen since the caller of zslInsert() should test in the hash table
4988 * if the element is already inside or not. */
4989 level
= zslRandomLevel();
4990 if (level
> zsl
->level
) {
4991 for (i
= zsl
->level
; i
< level
; i
++) {
4993 update
[i
] = zsl
->header
;
4994 update
[i
]->span
[i
-1] = zsl
->length
;
4998 x
= zslCreateNode(level
,score
,obj
);
4999 for (i
= 0; i
< level
; i
++) {
5000 x
->forward
[i
] = update
[i
]->forward
[i
];
5001 update
[i
]->forward
[i
] = x
;
5003 /* update span covered by update[i] as x is inserted here */
5005 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5006 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5010 /* increment span for untouched levels */
5011 for (i
= level
; i
< zsl
->level
; i
++) {
5012 update
[i
]->span
[i
-1]++;
5015 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5017 x
->forward
[0]->backward
= x
;
5023 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5024 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5026 for (i
= 0; i
< zsl
->level
; i
++) {
5027 if (update
[i
]->forward
[i
] == x
) {
5029 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5031 update
[i
]->forward
[i
] = x
->forward
[i
];
5033 /* invariant: i > 0, because update[0]->forward[0]
5034 * is always equal to x */
5035 update
[i
]->span
[i
-1] -= 1;
5038 if (x
->forward
[0]) {
5039 x
->forward
[0]->backward
= x
->backward
;
5041 zsl
->tail
= x
->backward
;
5043 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5048 /* Delete an element with matching score/object from the skiplist. */
5049 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5050 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5054 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5055 while (x
->forward
[i
] &&
5056 (x
->forward
[i
]->score
< score
||
5057 (x
->forward
[i
]->score
== score
&&
5058 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5062 /* We may have multiple elements with the same score, what we need
5063 * is to find the element with both the right score and object. */
5065 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5066 zslDeleteNode(zsl
, x
, update
);
5070 return 0; /* not found */
5072 return 0; /* not found */
5075 /* Delete all the elements with score between min and max from the skiplist.
5076 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5077 * Note that this function takes the reference to the hash table view of the
5078 * sorted set, in order to remove the elements from the hash table too. */
5079 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5080 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5081 unsigned long removed
= 0;
5085 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5086 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5090 /* We may have multiple elements with the same score, what we need
5091 * is to find the element with both the right score and object. */
5093 while (x
&& x
->score
<= max
) {
5094 zskiplistNode
*next
= x
->forward
[0];
5095 zslDeleteNode(zsl
, x
, update
);
5096 dictDelete(dict
,x
->obj
);
5101 return removed
; /* not found */
5104 /* Delete all the elements with rank between start and end from the skiplist.
5105 * Start and end are inclusive. Note that start and end need to be 1-based */
5106 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5107 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5108 unsigned long traversed
= 0, removed
= 0;
5112 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5113 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5114 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5122 while (x
&& traversed
<= end
) {
5123 zskiplistNode
*next
= x
->forward
[0];
5124 zslDeleteNode(zsl
, x
, update
);
5125 dictDelete(dict
,x
->obj
);
5134 /* Find the first node having a score equal or greater than the specified one.
5135 * Returns NULL if there is no match. */
5136 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5141 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5142 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5145 /* We may have multiple elements with the same score, what we need
5146 * is to find the element with both the right score and object. */
5147 return x
->forward
[0];
5150 /* Find the rank for an element by both score and key.
5151 * Returns 0 when the element cannot be found, rank otherwise.
5152 * Note that the rank is 1-based due to the span of zsl->header to the
5154 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5156 unsigned long rank
= 0;
5160 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5161 while (x
->forward
[i
] &&
5162 (x
->forward
[i
]->score
< score
||
5163 (x
->forward
[i
]->score
== score
&&
5164 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5165 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5169 /* x might be equal to zsl->header, so test if obj is non-NULL */
5170 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5177 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5178 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5180 unsigned long traversed
= 0;
5184 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5185 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5187 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5190 if (traversed
== rank
) {
5197 /* The actual Z-commands implementations */
5199 /* This generic command implements both ZADD and ZINCRBY.
5200 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5201 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5202 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5207 zsetobj
= lookupKeyWrite(c
->db
,key
);
5208 if (zsetobj
== NULL
) {
5209 zsetobj
= createZsetObject();
5210 dictAdd(c
->db
->dict
,key
,zsetobj
);
5213 if (zsetobj
->type
!= REDIS_ZSET
) {
5214 addReply(c
,shared
.wrongtypeerr
);
5220 /* Ok now since we implement both ZADD and ZINCRBY here the code
5221 * needs to handle the two different conditions. It's all about setting
5222 * '*score', that is, the new score to set, to the right value. */
5223 score
= zmalloc(sizeof(double));
5227 /* Read the old score. If the element was not present starts from 0 */
5228 de
= dictFind(zs
->dict
,ele
);
5230 double *oldscore
= dictGetEntryVal(de
);
5231 *score
= *oldscore
+ scoreval
;
5239 /* What follows is a simple remove and re-insert operation that is common
5240 * to both ZADD and ZINCRBY... */
5241 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5242 /* case 1: New element */
5243 incrRefCount(ele
); /* added to hash */
5244 zslInsert(zs
->zsl
,*score
,ele
);
5245 incrRefCount(ele
); /* added to skiplist */
5248 addReplyDouble(c
,*score
);
5250 addReply(c
,shared
.cone
);
5255 /* case 2: Score update operation */
5256 de
= dictFind(zs
->dict
,ele
);
5257 redisAssert(de
!= NULL
);
5258 oldscore
= dictGetEntryVal(de
);
5259 if (*score
!= *oldscore
) {
5262 /* Remove and insert the element in the skip list with new score */
5263 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5264 redisAssert(deleted
!= 0);
5265 zslInsert(zs
->zsl
,*score
,ele
);
5267 /* Update the score in the hash table */
5268 dictReplace(zs
->dict
,ele
,score
);
5274 addReplyDouble(c
,*score
);
5276 addReply(c
,shared
.czero
);
5280 static void zaddCommand(redisClient
*c
) {
5283 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5284 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5287 static void zincrbyCommand(redisClient
*c
) {
5290 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5291 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5294 static void zremCommand(redisClient
*c
) {
5301 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5302 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5305 de
= dictFind(zs
->dict
,c
->argv
[2]);
5307 addReply(c
,shared
.czero
);
5310 /* Delete from the skiplist */
5311 oldscore
= dictGetEntryVal(de
);
5312 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5313 redisAssert(deleted
!= 0);
5315 /* Delete from the hash table */
5316 dictDelete(zs
->dict
,c
->argv
[2]);
5317 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5319 addReply(c
,shared
.cone
);
5322 static void zremrangebyscoreCommand(redisClient
*c
) {
5323 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5324 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5329 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5330 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5333 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5334 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5335 server
.dirty
+= deleted
;
5336 addReplyLong(c
,deleted
);
5339 static void zremrangebyrankCommand(redisClient
*c
) {
5340 int start
= atoi(c
->argv
[2]->ptr
);
5341 int end
= atoi(c
->argv
[3]->ptr
);
5347 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5348 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5350 llen
= zs
->zsl
->length
;
5352 /* convert negative indexes */
5353 if (start
< 0) start
= llen
+start
;
5354 if (end
< 0) end
= llen
+end
;
5355 if (start
< 0) start
= 0;
5356 if (end
< 0) end
= 0;
5358 /* indexes sanity checks */
5359 if (start
> end
|| start
>= llen
) {
5360 addReply(c
,shared
.czero
);
5363 if (end
>= llen
) end
= llen
-1;
5365 /* increment start and end because zsl*Rank functions
5366 * use 1-based rank */
5367 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5368 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5369 server
.dirty
+= deleted
;
5370 addReplyLong(c
, deleted
);
5378 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5379 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5380 unsigned long size1
, size2
;
5381 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5382 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5383 return size1
- size2
;
5386 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5394 /* expect zsetnum input keys to be given */
5395 zsetnum
= atoi(c
->argv
[2]->ptr
);
5397 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5401 /* test if the expected number of keys would overflow */
5402 if (3+zsetnum
> c
->argc
) {
5403 addReply(c
,shared
.syntaxerr
);
5407 /* read keys to be used for input */
5408 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5409 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5410 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5414 if (zsetobj
->type
!= REDIS_ZSET
) {
5416 addReply(c
,shared
.wrongtypeerr
);
5419 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5422 /* default all weights to 1 */
5423 src
[i
].weight
= 1.0;
5426 /* parse optional extra arguments */
5428 int remaining
= c
->argc
-j
;
5431 if (!strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5433 if (remaining
< zsetnum
) {
5435 addReplySds(c
,sdsnew("-ERR not enough weights for ZUNION/ZINTER\r\n"));
5438 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5439 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5443 addReply(c
,shared
.syntaxerr
);
5449 dstobj
= createZsetObject();
5450 dstzset
= dstobj
->ptr
;
5452 if (op
== REDIS_OP_INTER
) {
5453 /* sort sets from the smallest to largest, this will improve our
5454 * algorithm's performance */
5455 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5457 /* skip going over all entries if the smallest zset is NULL or empty */
5458 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5459 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5460 * from small to large, all src[i > 0].dict are non-empty too */
5461 di
= dictGetIterator(src
[0].dict
);
5462 while((de
= dictNext(di
)) != NULL
) {
5463 double *score
= zmalloc(sizeof(double));
5466 for (j
= 0; j
< zsetnum
; j
++) {
5467 dictEntry
*other
= (j
== 0) ? de
: dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5469 *score
= *score
+ src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5475 /* skip entry when not present in every source dict */
5479 robj
*o
= dictGetEntryKey(de
);
5480 dictAdd(dstzset
->dict
,o
,score
);
5481 incrRefCount(o
); /* added to dictionary */
5482 zslInsert(dstzset
->zsl
,*score
,o
);
5483 incrRefCount(o
); /* added to skiplist */
5486 dictReleaseIterator(di
);
5488 } else if (op
== REDIS_OP_UNION
) {
5489 for (i
= 0; i
< zsetnum
; i
++) {
5490 if (!src
[i
].dict
) continue;
5492 di
= dictGetIterator(src
[i
].dict
);
5493 while((de
= dictNext(di
)) != NULL
) {
5494 /* skip key when already processed */
5495 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5497 double *score
= zmalloc(sizeof(double));
5499 for (j
= 0; j
< zsetnum
; j
++) {
5500 if (!src
[j
].dict
) continue;
5502 dictEntry
*other
= (i
== j
) ? de
: dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5504 *score
= *score
+ src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5508 robj
*o
= dictGetEntryKey(de
);
5509 dictAdd(dstzset
->dict
,o
,score
);
5510 incrRefCount(o
); /* added to dictionary */
5511 zslInsert(dstzset
->zsl
,*score
,o
);
5512 incrRefCount(o
); /* added to skiplist */
5514 dictReleaseIterator(di
);
5517 /* unknown operator */
5518 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5521 deleteKey(c
->db
,dstkey
);
5522 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5523 incrRefCount(dstkey
);
5525 addReplyLong(c
, dstzset
->zsl
->length
);
5530 static void zunionCommand(redisClient
*c
) {
5531 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5534 static void zinterCommand(redisClient
*c
) {
5535 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5538 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5540 int start
= atoi(c
->argv
[2]->ptr
);
5541 int end
= atoi(c
->argv
[3]->ptr
);
5550 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5552 } else if (c
->argc
>= 5) {
5553 addReply(c
,shared
.syntaxerr
);
5557 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5558 checkType(c
,o
,REDIS_ZSET
)) return;
5563 /* convert negative indexes */
5564 if (start
< 0) start
= llen
+start
;
5565 if (end
< 0) end
= llen
+end
;
5566 if (start
< 0) start
= 0;
5567 if (end
< 0) end
= 0;
5569 /* indexes sanity checks */
5570 if (start
> end
|| start
>= llen
) {
5571 /* Out of range start or start > end result in empty list */
5572 addReply(c
,shared
.emptymultibulk
);
5575 if (end
>= llen
) end
= llen
-1;
5576 rangelen
= (end
-start
)+1;
5578 /* check if starting point is trivial, before searching
5579 * the element in log(N) time */
5581 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5584 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5587 /* Return the result in form of a multi-bulk reply */
5588 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5589 withscores
? (rangelen
*2) : rangelen
));
5590 for (j
= 0; j
< rangelen
; j
++) {
5592 addReplyBulk(c
,ele
);
5594 addReplyDouble(c
,ln
->score
);
5595 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5599 static void zrangeCommand(redisClient
*c
) {
5600 zrangeGenericCommand(c
,0);
5603 static void zrevrangeCommand(redisClient
*c
) {
5604 zrangeGenericCommand(c
,1);
5607 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5608 * If justcount is non-zero, just the count is returned. */
5609 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5612 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5613 int offset
= 0, limit
= -1;
5617 /* Parse the min-max interval. If one of the values is prefixed
5618 * by the "(" character, it's considered "open". For instance
5619 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5620 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5621 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5622 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5625 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5627 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5628 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5631 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5634 /* Parse "WITHSCORES": note that if the command was called with
5635 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5636 * enter the following paths to parse WITHSCORES and LIMIT. */
5637 if (c
->argc
== 5 || c
->argc
== 8) {
5638 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5643 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5647 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5652 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5653 addReply(c
,shared
.syntaxerr
);
5655 } else if (c
->argc
== (7 + withscores
)) {
5656 offset
= atoi(c
->argv
[5]->ptr
);
5657 limit
= atoi(c
->argv
[6]->ptr
);
5658 if (offset
< 0) offset
= 0;
5661 /* Ok, lookup the key and get the range */
5662 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5664 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5666 if (o
->type
!= REDIS_ZSET
) {
5667 addReply(c
,shared
.wrongtypeerr
);
5669 zset
*zsetobj
= o
->ptr
;
5670 zskiplist
*zsl
= zsetobj
->zsl
;
5672 robj
*ele
, *lenobj
= NULL
;
5673 unsigned long rangelen
= 0;
5675 /* Get the first node with the score >= min, or with
5676 * score > min if 'minex' is true. */
5677 ln
= zslFirstWithScore(zsl
,min
);
5678 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5681 /* No element matching the speciifed interval */
5682 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5686 /* We don't know in advance how many matching elements there
5687 * are in the list, so we push this object that will represent
5688 * the multi-bulk length in the output buffer, and will "fix"
5691 lenobj
= createObject(REDIS_STRING
,NULL
);
5693 decrRefCount(lenobj
);
5696 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5699 ln
= ln
->forward
[0];
5702 if (limit
== 0) break;
5705 addReplyBulk(c
,ele
);
5707 addReplyDouble(c
,ln
->score
);
5709 ln
= ln
->forward
[0];
5711 if (limit
> 0) limit
--;
5714 addReplyLong(c
,(long)rangelen
);
5716 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5717 withscores
? (rangelen
*2) : rangelen
);
5723 static void zrangebyscoreCommand(redisClient
*c
) {
5724 genericZrangebyscoreCommand(c
,0);
5727 static void zcountCommand(redisClient
*c
) {
5728 genericZrangebyscoreCommand(c
,1);
5731 static void zcardCommand(redisClient
*c
) {
5735 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5736 checkType(c
,o
,REDIS_ZSET
)) return;
5739 addReplyUlong(c
,zs
->zsl
->length
);
5742 static void zscoreCommand(redisClient
*c
) {
5747 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5748 checkType(c
,o
,REDIS_ZSET
)) return;
5751 de
= dictFind(zs
->dict
,c
->argv
[2]);
5753 addReply(c
,shared
.nullbulk
);
5755 double *score
= dictGetEntryVal(de
);
5757 addReplyDouble(c
,*score
);
5761 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5769 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5770 checkType(c
,o
,REDIS_ZSET
)) return;
5774 de
= dictFind(zs
->dict
,c
->argv
[2]);
5776 addReply(c
,shared
.nullbulk
);
5780 score
= dictGetEntryVal(de
);
5781 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5784 addReplyLong(c
, zsl
->length
- rank
);
5786 addReplyLong(c
, rank
-1);
5789 addReply(c
,shared
.nullbulk
);
5793 static void zrankCommand(redisClient
*c
) {
5794 zrankGenericCommand(c
, 0);
5797 static void zrevrankCommand(redisClient
*c
) {
5798 zrankGenericCommand(c
, 1);
5801 /* =================================== Hashes =============================== */
5802 static void hsetCommand(redisClient
*c
) {
5804 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5807 o
= createHashObject();
5808 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5809 incrRefCount(c
->argv
[1]);
5811 if (o
->type
!= REDIS_HASH
) {
5812 addReply(c
,shared
.wrongtypeerr
);
5816 /* We want to convert the zipmap into an hash table right now if the
5817 * entry to be added is too big. Note that we check if the object
5818 * is integer encoded before to try fetching the length in the test below.
5819 * This is because integers are small, but currently stringObjectLen()
5820 * performs a slow conversion: not worth it. */
5821 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5822 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5823 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5824 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5825 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5827 convertToRealHash(o
);
5830 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5831 unsigned char *zm
= o
->ptr
;
5832 robj
*valobj
= getDecodedObject(c
->argv
[3]);
5834 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
5835 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
5836 decrRefCount(valobj
);
5839 /* And here there is the second check for hash conversion...
5840 * we want to do it only if the operation was not just an update as
5841 * zipmapLen() is O(N). */
5842 if (!update
&& zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
5843 convertToRealHash(o
);
5845 tryObjectEncoding(c
->argv
[2]);
5846 /* note that c->argv[3] is already encoded, as the latest arg
5847 * of a bulk command is always integer encoded if possible. */
5848 if (dictAdd(o
->ptr
,c
->argv
[2],c
->argv
[3]) == DICT_OK
) {
5849 incrRefCount(c
->argv
[2]);
5853 incrRefCount(c
->argv
[3]);
5856 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
5859 static void hgetCommand(redisClient
*c
) {
5862 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5863 checkType(c
,o
,REDIS_HASH
)) return;
5865 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5866 unsigned char *zm
= o
->ptr
;
5870 if (zipmapGet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
), &val
,&vlen
)) {
5871 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
5872 addReplySds(c
,sdsnewlen(val
,vlen
));
5873 addReply(c
,shared
.crlf
);
5876 addReply(c
,shared
.nullbulk
);
5880 struct dictEntry
*de
;
5882 de
= dictFind(o
->ptr
,c
->argv
[2]);
5884 addReply(c
,shared
.nullbulk
);
5886 robj
*e
= dictGetEntryVal(de
);
5893 static void hdelCommand(redisClient
*c
) {
5897 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5898 checkType(c
,o
,REDIS_HASH
)) return;
5900 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5901 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
5902 (unsigned char*) c
->argv
[2]->ptr
,
5903 sdslen(c
->argv
[2]->ptr
), &deleted
);
5905 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
5907 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
5910 static void hlenCommand(redisClient
*c
) {
5914 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5915 checkType(c
,o
,REDIS_HASH
)) return;
5917 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
5918 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
5919 addReplyUlong(c
,len
);
5922 static void convertToRealHash(robj
*o
) {
5923 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
5924 unsigned int klen
, vlen
;
5925 dict
*dict
= dictCreate(&hashDictType
,NULL
);
5927 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
5928 p
= zipmapRewind(zm
);
5929 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
5930 robj
*keyobj
, *valobj
;
5932 keyobj
= createStringObject((char*)key
,klen
);
5933 valobj
= createStringObject((char*)val
,vlen
);
5934 tryObjectEncoding(keyobj
);
5935 tryObjectEncoding(valobj
);
5936 dictAdd(dict
,keyobj
,valobj
);
5938 o
->encoding
= REDIS_ENCODING_HT
;
5943 /* ========================= Non type-specific commands ==================== */
5945 static void flushdbCommand(redisClient
*c
) {
5946 server
.dirty
+= dictSize(c
->db
->dict
);
5947 dictEmpty(c
->db
->dict
);
5948 dictEmpty(c
->db
->expires
);
5949 addReply(c
,shared
.ok
);
5952 static void flushallCommand(redisClient
*c
) {
5953 server
.dirty
+= emptyDb();
5954 addReply(c
,shared
.ok
);
5955 rdbSave(server
.dbfilename
);
5959 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5960 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5962 so
->pattern
= pattern
;
5966 /* Return the value associated to the key with a name obtained
5967 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5968 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5972 int prefixlen
, sublen
, postfixlen
;
5973 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5977 char buf
[REDIS_SORTKEY_MAX
+1];
5980 /* If the pattern is "#" return the substitution object itself in order
5981 * to implement the "SORT ... GET #" feature. */
5982 spat
= pattern
->ptr
;
5983 if (spat
[0] == '#' && spat
[1] == '\0') {
5987 /* The substitution object may be specially encoded. If so we create
5988 * a decoded object on the fly. Otherwise getDecodedObject will just
5989 * increment the ref count, that we'll decrement later. */
5990 subst
= getDecodedObject(subst
);
5993 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5994 p
= strchr(spat
,'*');
5996 decrRefCount(subst
);
6001 sublen
= sdslen(ssub
);
6002 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6003 memcpy(keyname
.buf
,spat
,prefixlen
);
6004 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6005 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6006 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6007 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6009 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6010 decrRefCount(subst
);
6012 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6013 return lookupKeyRead(db
,&keyobj
);
6016 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6017 * the additional parameter is not standard but a BSD-specific we have to
6018 * pass sorting parameters via the global 'server' structure */
6019 static int sortCompare(const void *s1
, const void *s2
) {
6020 const redisSortObject
*so1
= s1
, *so2
= s2
;
6023 if (!server
.sort_alpha
) {
6024 /* Numeric sorting. Here it's trivial as we precomputed scores */
6025 if (so1
->u
.score
> so2
->u
.score
) {
6027 } else if (so1
->u
.score
< so2
->u
.score
) {
6033 /* Alphanumeric sorting */
6034 if (server
.sort_bypattern
) {
6035 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6036 /* At least one compare object is NULL */
6037 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6039 else if (so1
->u
.cmpobj
== NULL
)
6044 /* We have both the objects, use strcoll */
6045 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6048 /* Compare elements directly */
6051 dec1
= getDecodedObject(so1
->obj
);
6052 dec2
= getDecodedObject(so2
->obj
);
6053 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6058 return server
.sort_desc
? -cmp
: cmp
;
6061 /* The SORT command is the most complex command in Redis. Warning: this code
6062 * is optimized for speed and a bit less for readability */
6063 static void sortCommand(redisClient
*c
) {
6066 int desc
= 0, alpha
= 0;
6067 int limit_start
= 0, limit_count
= -1, start
, end
;
6068 int j
, dontsort
= 0, vectorlen
;
6069 int getop
= 0; /* GET operation counter */
6070 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6071 redisSortObject
*vector
; /* Resulting vector to sort */
6073 /* Lookup the key to sort. It must be of the right types */
6074 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6075 if (sortval
== NULL
) {
6076 addReply(c
,shared
.nullmultibulk
);
6079 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6080 sortval
->type
!= REDIS_ZSET
)
6082 addReply(c
,shared
.wrongtypeerr
);
6086 /* Create a list of operations to perform for every sorted element.
6087 * Operations can be GET/DEL/INCR/DECR */
6088 operations
= listCreate();
6089 listSetFreeMethod(operations
,zfree
);
6092 /* Now we need to protect sortval incrementing its count, in the future
6093 * SORT may have options able to overwrite/delete keys during the sorting
6094 * and the sorted key itself may get destroied */
6095 incrRefCount(sortval
);
6097 /* The SORT command has an SQL-alike syntax, parse it */
6098 while(j
< c
->argc
) {
6099 int leftargs
= c
->argc
-j
-1;
6100 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6102 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6104 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6106 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6107 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6108 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6110 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6111 storekey
= c
->argv
[j
+1];
6113 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6114 sortby
= c
->argv
[j
+1];
6115 /* If the BY pattern does not contain '*', i.e. it is constant,
6116 * we don't need to sort nor to lookup the weight keys. */
6117 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6119 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6120 listAddNodeTail(operations
,createSortOperation(
6121 REDIS_SORT_GET
,c
->argv
[j
+1]));
6125 decrRefCount(sortval
);
6126 listRelease(operations
);
6127 addReply(c
,shared
.syntaxerr
);
6133 /* Load the sorting vector with all the objects to sort */
6134 switch(sortval
->type
) {
6135 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6136 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6137 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6138 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6140 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6143 if (sortval
->type
== REDIS_LIST
) {
6144 list
*list
= sortval
->ptr
;
6148 listRewind(list
,&li
);
6149 while((ln
= listNext(&li
))) {
6150 robj
*ele
= ln
->value
;
6151 vector
[j
].obj
= ele
;
6152 vector
[j
].u
.score
= 0;
6153 vector
[j
].u
.cmpobj
= NULL
;
6161 if (sortval
->type
== REDIS_SET
) {
6164 zset
*zs
= sortval
->ptr
;
6168 di
= dictGetIterator(set
);
6169 while((setele
= dictNext(di
)) != NULL
) {
6170 vector
[j
].obj
= dictGetEntryKey(setele
);
6171 vector
[j
].u
.score
= 0;
6172 vector
[j
].u
.cmpobj
= NULL
;
6175 dictReleaseIterator(di
);
6177 redisAssert(j
== vectorlen
);
6179 /* Now it's time to load the right scores in the sorting vector */
6180 if (dontsort
== 0) {
6181 for (j
= 0; j
< vectorlen
; j
++) {
6185 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6186 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6188 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6190 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6191 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6193 /* Don't need to decode the object if it's
6194 * integer-encoded (the only encoding supported) so
6195 * far. We can just cast it */
6196 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6197 vector
[j
].u
.score
= (long)byval
->ptr
;
6199 redisAssert(1 != 1);
6204 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6205 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6207 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6208 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6210 redisAssert(1 != 1);
6217 /* We are ready to sort the vector... perform a bit of sanity check
6218 * on the LIMIT option too. We'll use a partial version of quicksort. */
6219 start
= (limit_start
< 0) ? 0 : limit_start
;
6220 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6221 if (start
>= vectorlen
) {
6222 start
= vectorlen
-1;
6225 if (end
>= vectorlen
) end
= vectorlen
-1;
6227 if (dontsort
== 0) {
6228 server
.sort_desc
= desc
;
6229 server
.sort_alpha
= alpha
;
6230 server
.sort_bypattern
= sortby
? 1 : 0;
6231 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6232 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6234 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6237 /* Send command output to the output buffer, performing the specified
6238 * GET/DEL/INCR/DECR operations if any. */
6239 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6240 if (storekey
== NULL
) {
6241 /* STORE option not specified, sent the sorting result to client */
6242 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6243 for (j
= start
; j
<= end
; j
++) {
6247 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6248 listRewind(operations
,&li
);
6249 while((ln
= listNext(&li
))) {
6250 redisSortOperation
*sop
= ln
->value
;
6251 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6254 if (sop
->type
== REDIS_SORT_GET
) {
6255 if (!val
|| val
->type
!= REDIS_STRING
) {
6256 addReply(c
,shared
.nullbulk
);
6258 addReplyBulk(c
,val
);
6261 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6266 robj
*listObject
= createListObject();
6267 list
*listPtr
= (list
*) listObject
->ptr
;
6269 /* STORE option specified, set the sorting result as a List object */
6270 for (j
= start
; j
<= end
; j
++) {
6275 listAddNodeTail(listPtr
,vector
[j
].obj
);
6276 incrRefCount(vector
[j
].obj
);
6278 listRewind(operations
,&li
);
6279 while((ln
= listNext(&li
))) {
6280 redisSortOperation
*sop
= ln
->value
;
6281 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6284 if (sop
->type
== REDIS_SORT_GET
) {
6285 if (!val
|| val
->type
!= REDIS_STRING
) {
6286 listAddNodeTail(listPtr
,createStringObject("",0));
6288 listAddNodeTail(listPtr
,val
);
6292 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6296 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6297 incrRefCount(storekey
);
6299 /* Note: we add 1 because the DB is dirty anyway since even if the
6300 * SORT result is empty a new key is set and maybe the old content
6302 server
.dirty
+= 1+outputlen
;
6303 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6307 decrRefCount(sortval
);
6308 listRelease(operations
);
6309 for (j
= 0; j
< vectorlen
; j
++) {
6310 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6311 decrRefCount(vector
[j
].u
.cmpobj
);
6316 /* Convert an amount of bytes into a human readable string in the form
6317 * of 100B, 2G, 100M, 4K, and so forth. */
6318 static void bytesToHuman(char *s
, unsigned long long n
) {
6323 sprintf(s
,"%lluB",n
);
6325 } else if (n
< (1024*1024)) {
6326 d
= (double)n
/(1024);
6327 sprintf(s
,"%.2fK",d
);
6328 } else if (n
< (1024LL*1024*1024)) {
6329 d
= (double)n
/(1024*1024);
6330 sprintf(s
,"%.2fM",d
);
6331 } else if (n
< (1024LL*1024*1024*1024)) {
6332 d
= (double)n
/(1024LL*1024*1024);
6333 sprintf(s
,"%.2fG",d
);
6337 /* Create the string returned by the INFO command. This is decoupled
6338 * by the INFO command itself as we need to report the same information
6339 * on memory corruption problems. */
6340 static sds
genRedisInfoString(void) {
6342 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6346 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
6347 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
6349 bytesToHuman(hmem
,zmalloc_used_memory());
6350 info
= sdscatprintf(sdsempty(),
6351 "redis_version:%s\r\n"
6353 "multiplexing_api:%s\r\n"
6354 "process_id:%ld\r\n"
6355 "uptime_in_seconds:%ld\r\n"
6356 "uptime_in_days:%ld\r\n"
6357 "connected_clients:%d\r\n"
6358 "connected_slaves:%d\r\n"
6359 "blocked_clients:%d\r\n"
6360 "used_memory:%zu\r\n"
6361 "used_memory_human:%s\r\n"
6362 "changes_since_last_save:%lld\r\n"
6363 "bgsave_in_progress:%d\r\n"
6364 "last_save_time:%ld\r\n"
6365 "bgrewriteaof_in_progress:%d\r\n"
6366 "total_connections_received:%lld\r\n"
6367 "total_commands_processed:%lld\r\n"
6368 "hash_max_zipmap_entries:%ld\r\n"
6369 "hash_max_zipmap_value:%ld\r\n"
6373 (sizeof(long) == 8) ? "64" : "32",
6378 listLength(server
.clients
)-listLength(server
.slaves
),
6379 listLength(server
.slaves
),
6380 server
.blpop_blocked_clients
,
6381 zmalloc_used_memory(),
6384 server
.bgsavechildpid
!= -1,
6386 server
.bgrewritechildpid
!= -1,
6387 server
.stat_numconnections
,
6388 server
.stat_numcommands
,
6389 server
.hash_max_zipmap_entries
,
6390 server
.hash_max_zipmap_value
,
6391 server
.vm_enabled
!= 0,
6392 server
.masterhost
== NULL
? "master" : "slave"
6394 if (server
.masterhost
) {
6395 info
= sdscatprintf(info
,
6396 "master_host:%s\r\n"
6397 "master_port:%d\r\n"
6398 "master_link_status:%s\r\n"
6399 "master_last_io_seconds_ago:%d\r\n"
6402 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6404 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6407 if (server
.vm_enabled
) {
6409 info
= sdscatprintf(info
,
6410 "vm_conf_max_memory:%llu\r\n"
6411 "vm_conf_page_size:%llu\r\n"
6412 "vm_conf_pages:%llu\r\n"
6413 "vm_stats_used_pages:%llu\r\n"
6414 "vm_stats_swapped_objects:%llu\r\n"
6415 "vm_stats_swappin_count:%llu\r\n"
6416 "vm_stats_swappout_count:%llu\r\n"
6417 "vm_stats_io_newjobs_len:%lu\r\n"
6418 "vm_stats_io_processing_len:%lu\r\n"
6419 "vm_stats_io_processed_len:%lu\r\n"
6420 "vm_stats_io_active_threads:%lu\r\n"
6421 "vm_stats_blocked_clients:%lu\r\n"
6422 ,(unsigned long long) server
.vm_max_memory
,
6423 (unsigned long long) server
.vm_page_size
,
6424 (unsigned long long) server
.vm_pages
,
6425 (unsigned long long) server
.vm_stats_used_pages
,
6426 (unsigned long long) server
.vm_stats_swapped_objects
,
6427 (unsigned long long) server
.vm_stats_swapins
,
6428 (unsigned long long) server
.vm_stats_swapouts
,
6429 (unsigned long) listLength(server
.io_newjobs
),
6430 (unsigned long) listLength(server
.io_processing
),
6431 (unsigned long) listLength(server
.io_processed
),
6432 (unsigned long) server
.io_active_threads
,
6433 (unsigned long) server
.vm_blocked_clients
6437 for (j
= 0; j
< server
.dbnum
; j
++) {
6438 long long keys
, vkeys
;
6440 keys
= dictSize(server
.db
[j
].dict
);
6441 vkeys
= dictSize(server
.db
[j
].expires
);
6442 if (keys
|| vkeys
) {
6443 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6450 static void infoCommand(redisClient
*c
) {
6451 sds info
= genRedisInfoString();
6452 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6453 (unsigned long)sdslen(info
)));
6454 addReplySds(c
,info
);
6455 addReply(c
,shared
.crlf
);
6458 static void monitorCommand(redisClient
*c
) {
6459 /* ignore MONITOR if aleady slave or in monitor mode */
6460 if (c
->flags
& REDIS_SLAVE
) return;
6462 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6464 listAddNodeTail(server
.monitors
,c
);
6465 addReply(c
,shared
.ok
);
6468 /* ================================= Expire ================================= */
6469 static int removeExpire(redisDb
*db
, robj
*key
) {
6470 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6477 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6478 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6486 /* Return the expire time of the specified key, or -1 if no expire
6487 * is associated with this key (i.e. the key is non volatile) */
6488 static time_t getExpire(redisDb
*db
, robj
*key
) {
6491 /* No expire? return ASAP */
6492 if (dictSize(db
->expires
) == 0 ||
6493 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6495 return (time_t) dictGetEntryVal(de
);
6498 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6502 /* No expire? return ASAP */
6503 if (dictSize(db
->expires
) == 0 ||
6504 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6506 /* Lookup the expire */
6507 when
= (time_t) dictGetEntryVal(de
);
6508 if (time(NULL
) <= when
) return 0;
6510 /* Delete the key */
6511 dictDelete(db
->expires
,key
);
6512 return dictDelete(db
->dict
,key
) == DICT_OK
;
6515 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6518 /* No expire? return ASAP */
6519 if (dictSize(db
->expires
) == 0 ||
6520 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6522 /* Delete the key */
6524 dictDelete(db
->expires
,key
);
6525 return dictDelete(db
->dict
,key
) == DICT_OK
;
6528 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6531 de
= dictFind(c
->db
->dict
,key
);
6533 addReply(c
,shared
.czero
);
6537 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6538 addReply(c
, shared
.cone
);
6541 time_t when
= time(NULL
)+seconds
;
6542 if (setExpire(c
->db
,key
,when
)) {
6543 addReply(c
,shared
.cone
);
6546 addReply(c
,shared
.czero
);
6552 static void expireCommand(redisClient
*c
) {
6553 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6556 static void expireatCommand(redisClient
*c
) {
6557 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6560 static void ttlCommand(redisClient
*c
) {
6564 expire
= getExpire(c
->db
,c
->argv
[1]);
6566 ttl
= (int) (expire
-time(NULL
));
6567 if (ttl
< 0) ttl
= -1;
6569 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6572 /* ================================ MULTI/EXEC ============================== */
6574 /* Client state initialization for MULTI/EXEC */
6575 static void initClientMultiState(redisClient
*c
) {
6576 c
->mstate
.commands
= NULL
;
6577 c
->mstate
.count
= 0;
6580 /* Release all the resources associated with MULTI/EXEC state */
6581 static void freeClientMultiState(redisClient
*c
) {
6584 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6586 multiCmd
*mc
= c
->mstate
.commands
+j
;
6588 for (i
= 0; i
< mc
->argc
; i
++)
6589 decrRefCount(mc
->argv
[i
]);
6592 zfree(c
->mstate
.commands
);
6595 /* Add a new command into the MULTI commands queue */
6596 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6600 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6601 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6602 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6605 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6606 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6607 for (j
= 0; j
< c
->argc
; j
++)
6608 incrRefCount(mc
->argv
[j
]);
6612 static void multiCommand(redisClient
*c
) {
6613 c
->flags
|= REDIS_MULTI
;
6614 addReply(c
,shared
.ok
);
6617 static void discardCommand(redisClient
*c
) {
6618 if (!(c
->flags
& REDIS_MULTI
)) {
6619 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6623 freeClientMultiState(c
);
6624 initClientMultiState(c
);
6625 c
->flags
&= (~REDIS_MULTI
);
6626 addReply(c
,shared
.ok
);
6629 static void execCommand(redisClient
*c
) {
6634 if (!(c
->flags
& REDIS_MULTI
)) {
6635 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6639 orig_argv
= c
->argv
;
6640 orig_argc
= c
->argc
;
6641 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6642 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6643 c
->argc
= c
->mstate
.commands
[j
].argc
;
6644 c
->argv
= c
->mstate
.commands
[j
].argv
;
6645 call(c
,c
->mstate
.commands
[j
].cmd
);
6647 c
->argv
= orig_argv
;
6648 c
->argc
= orig_argc
;
6649 freeClientMultiState(c
);
6650 initClientMultiState(c
);
6651 c
->flags
&= (~REDIS_MULTI
);
6654 /* =========================== Blocking Operations ========================= */
6656 /* Currently Redis blocking operations support is limited to list POP ops,
6657 * so the current implementation is not fully generic, but it is also not
6658 * completely specific so it will not require a rewrite to support new
6659 * kind of blocking operations in the future.
6661 * Still it's important to note that list blocking operations can be already
6662 * used as a notification mechanism in order to implement other blocking
6663 * operations at application level, so there must be a very strong evidence
6664 * of usefulness and generality before new blocking operations are implemented.
6666 * This is how the current blocking POP works, we use BLPOP as example:
6667 * - If the user calls BLPOP and the key exists and contains a non empty list
6668 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6669 * if there is not to block.
6670 * - If instead BLPOP is called and the key does not exists or the list is
6671 * empty we need to block. In order to do so we remove the notification for
6672 * new data to read in the client socket (so that we'll not serve new
6673 * requests if the blocking request is not served). Also we put the client
6674 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6675 * blocking for this keys.
6676 * - If a PUSH operation against a key with blocked clients waiting is
6677 * performed, we serve the first in the list: basically instead to push
6678 * the new element inside the list we return it to the (first / oldest)
6679 * blocking client, unblock the client, and remove it form the list.
6681 * The above comment and the source code should be enough in order to understand
6682 * the implementation and modify / fix it later.
6685 /* Set a client in blocking mode for the specified key, with the specified
6687 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6692 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6693 c
->blockingkeysnum
= numkeys
;
6694 c
->blockingto
= timeout
;
6695 for (j
= 0; j
< numkeys
; j
++) {
6696 /* Add the key in the client structure, to map clients -> keys */
6697 c
->blockingkeys
[j
] = keys
[j
];
6698 incrRefCount(keys
[j
]);
6700 /* And in the other "side", to map keys -> clients */
6701 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6705 /* For every key we take a list of clients blocked for it */
6707 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6708 incrRefCount(keys
[j
]);
6709 assert(retval
== DICT_OK
);
6711 l
= dictGetEntryVal(de
);
6713 listAddNodeTail(l
,c
);
6715 /* Mark the client as a blocked client */
6716 c
->flags
|= REDIS_BLOCKED
;
6717 server
.blpop_blocked_clients
++;
6720 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6721 static void unblockClientWaitingData(redisClient
*c
) {
6726 assert(c
->blockingkeys
!= NULL
);
6727 /* The client may wait for multiple keys, so unblock it for every key. */
6728 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6729 /* Remove this client from the list of clients waiting for this key. */
6730 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6732 l
= dictGetEntryVal(de
);
6733 listDelNode(l
,listSearchKey(l
,c
));
6734 /* If the list is empty we need to remove it to avoid wasting memory */
6735 if (listLength(l
) == 0)
6736 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6737 decrRefCount(c
->blockingkeys
[j
]);
6739 /* Cleanup the client structure */
6740 zfree(c
->blockingkeys
);
6741 c
->blockingkeys
= NULL
;
6742 c
->flags
&= (~REDIS_BLOCKED
);
6743 server
.blpop_blocked_clients
--;
6744 /* We want to process data if there is some command waiting
6745 * in the input buffer. Note that this is safe even if
6746 * unblockClientWaitingData() gets called from freeClient() because
6747 * freeClient() will be smart enough to call this function
6748 * *after* c->querybuf was set to NULL. */
6749 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6752 /* This should be called from any function PUSHing into lists.
6753 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6754 * 'ele' is the element pushed.
6756 * If the function returns 0 there was no client waiting for a list push
6759 * If the function returns 1 there was a client waiting for a list push
6760 * against this key, the element was passed to this client thus it's not
6761 * needed to actually add it to the list and the caller should return asap. */
6762 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6763 struct dictEntry
*de
;
6764 redisClient
*receiver
;
6768 de
= dictFind(c
->db
->blockingkeys
,key
);
6769 if (de
== NULL
) return 0;
6770 l
= dictGetEntryVal(de
);
6773 receiver
= ln
->value
;
6775 addReplySds(receiver
,sdsnew("*2\r\n"));
6776 addReplyBulk(receiver
,key
);
6777 addReplyBulk(receiver
,ele
);
6778 unblockClientWaitingData(receiver
);
6782 /* Blocking RPOP/LPOP */
6783 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6788 for (j
= 1; j
< c
->argc
-1; j
++) {
6789 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6791 if (o
->type
!= REDIS_LIST
) {
6792 addReply(c
,shared
.wrongtypeerr
);
6795 list
*list
= o
->ptr
;
6796 if (listLength(list
) != 0) {
6797 /* If the list contains elements fall back to the usual
6798 * non-blocking POP operation */
6799 robj
*argv
[2], **orig_argv
;
6802 /* We need to alter the command arguments before to call
6803 * popGenericCommand() as the command takes a single key. */
6804 orig_argv
= c
->argv
;
6805 orig_argc
= c
->argc
;
6806 argv
[1] = c
->argv
[j
];
6810 /* Also the return value is different, we need to output
6811 * the multi bulk reply header and the key name. The
6812 * "real" command will add the last element (the value)
6813 * for us. If this souds like an hack to you it's just
6814 * because it is... */
6815 addReplySds(c
,sdsnew("*2\r\n"));
6816 addReplyBulk(c
,argv
[1]);
6817 popGenericCommand(c
,where
);
6819 /* Fix the client structure with the original stuff */
6820 c
->argv
= orig_argv
;
6821 c
->argc
= orig_argc
;
6827 /* If the list is empty or the key does not exists we must block */
6828 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6829 if (timeout
> 0) timeout
+= time(NULL
);
6830 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6833 static void blpopCommand(redisClient
*c
) {
6834 blockingPopGenericCommand(c
,REDIS_HEAD
);
6837 static void brpopCommand(redisClient
*c
) {
6838 blockingPopGenericCommand(c
,REDIS_TAIL
);
6841 /* =============================== Replication ============================= */
6843 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6844 ssize_t nwritten
, ret
= size
;
6845 time_t start
= time(NULL
);
6849 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6850 nwritten
= write(fd
,ptr
,size
);
6851 if (nwritten
== -1) return -1;
6855 if ((time(NULL
)-start
) > timeout
) {
6863 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6864 ssize_t nread
, totread
= 0;
6865 time_t start
= time(NULL
);
6869 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6870 nread
= read(fd
,ptr
,size
);
6871 if (nread
== -1) return -1;
6876 if ((time(NULL
)-start
) > timeout
) {
6884 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6891 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6894 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6905 static void syncCommand(redisClient
*c
) {
6906 /* ignore SYNC if aleady slave or in monitor mode */
6907 if (c
->flags
& REDIS_SLAVE
) return;
6909 /* SYNC can't be issued when the server has pending data to send to
6910 * the client about already issued commands. We need a fresh reply
6911 * buffer registering the differences between the BGSAVE and the current
6912 * dataset, so that we can copy to other slaves if needed. */
6913 if (listLength(c
->reply
) != 0) {
6914 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6918 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6919 /* Here we need to check if there is a background saving operation
6920 * in progress, or if it is required to start one */
6921 if (server
.bgsavechildpid
!= -1) {
6922 /* Ok a background save is in progress. Let's check if it is a good
6923 * one for replication, i.e. if there is another slave that is
6924 * registering differences since the server forked to save */
6929 listRewind(server
.slaves
,&li
);
6930 while((ln
= listNext(&li
))) {
6932 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6935 /* Perfect, the server is already registering differences for
6936 * another slave. Set the right state, and copy the buffer. */
6937 listRelease(c
->reply
);
6938 c
->reply
= listDup(slave
->reply
);
6939 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6940 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6942 /* No way, we need to wait for the next BGSAVE in order to
6943 * register differences */
6944 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6945 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6948 /* Ok we don't have a BGSAVE in progress, let's start one */
6949 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6950 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6951 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6952 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6955 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6958 c
->flags
|= REDIS_SLAVE
;
6960 listAddNodeTail(server
.slaves
,c
);
6964 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6965 redisClient
*slave
= privdata
;
6967 REDIS_NOTUSED(mask
);
6968 char buf
[REDIS_IOBUF_LEN
];
6969 ssize_t nwritten
, buflen
;
6971 if (slave
->repldboff
== 0) {
6972 /* Write the bulk write count before to transfer the DB. In theory here
6973 * we don't know how much room there is in the output buffer of the
6974 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6975 * operations) will never be smaller than the few bytes we need. */
6978 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6980 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6988 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6989 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6991 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6992 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6996 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6997 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7002 slave
->repldboff
+= nwritten
;
7003 if (slave
->repldboff
== slave
->repldbsize
) {
7004 close(slave
->repldbfd
);
7005 slave
->repldbfd
= -1;
7006 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7007 slave
->replstate
= REDIS_REPL_ONLINE
;
7008 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7009 sendReplyToClient
, slave
) == AE_ERR
) {
7013 addReplySds(slave
,sdsempty());
7014 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7018 /* This function is called at the end of every backgrond saving.
7019 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7020 * otherwise REDIS_ERR is passed to the function.
7022 * The goal of this function is to handle slaves waiting for a successful
7023 * background saving in order to perform non-blocking synchronization. */
7024 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7026 int startbgsave
= 0;
7029 listRewind(server
.slaves
,&li
);
7030 while((ln
= listNext(&li
))) {
7031 redisClient
*slave
= ln
->value
;
7033 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7035 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7036 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7037 struct redis_stat buf
;
7039 if (bgsaveerr
!= REDIS_OK
) {
7041 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7044 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7045 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7047 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7050 slave
->repldboff
= 0;
7051 slave
->repldbsize
= buf
.st_size
;
7052 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7053 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7054 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7061 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7064 listRewind(server
.slaves
,&li
);
7065 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7066 while((ln
= listNext(&li
))) {
7067 redisClient
*slave
= ln
->value
;
7069 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7076 static int syncWithMaster(void) {
7077 char buf
[1024], tmpfile
[256], authcmd
[1024];
7079 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7080 int dfd
, maxtries
= 5;
7083 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7088 /* AUTH with the master if required. */
7089 if(server
.masterauth
) {
7090 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7091 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7093 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7097 /* Read the AUTH result. */
7098 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7100 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7104 if (buf
[0] != '+') {
7106 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7111 /* Issue the SYNC command */
7112 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7114 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7118 /* Read the bulk write count */
7119 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7121 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7125 if (buf
[0] != '$') {
7127 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7130 dumpsize
= strtol(buf
+1,NULL
,10);
7131 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7132 /* Read the bulk write data on a temp file */
7134 snprintf(tmpfile
,256,
7135 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7136 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7137 if (dfd
!= -1) break;
7142 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7146 int nread
, nwritten
;
7148 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7150 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7156 nwritten
= write(dfd
,buf
,nread
);
7157 if (nwritten
== -1) {
7158 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7166 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7167 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7173 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7174 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7178 server
.master
= createClient(fd
);
7179 server
.master
->flags
|= REDIS_MASTER
;
7180 server
.master
->authenticated
= 1;
7181 server
.replstate
= REDIS_REPL_CONNECTED
;
7185 static void slaveofCommand(redisClient
*c
) {
7186 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7187 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7188 if (server
.masterhost
) {
7189 sdsfree(server
.masterhost
);
7190 server
.masterhost
= NULL
;
7191 if (server
.master
) freeClient(server
.master
);
7192 server
.replstate
= REDIS_REPL_NONE
;
7193 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7196 sdsfree(server
.masterhost
);
7197 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7198 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7199 if (server
.master
) freeClient(server
.master
);
7200 server
.replstate
= REDIS_REPL_CONNECT
;
7201 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7202 server
.masterhost
, server
.masterport
);
7204 addReply(c
,shared
.ok
);
7207 /* ============================ Maxmemory directive ======================== */
7209 /* Try to free one object form the pre-allocated objects free list.
7210 * This is useful under low mem conditions as by default we take 1 million
7211 * free objects allocated. On success REDIS_OK is returned, otherwise
7213 static int tryFreeOneObjectFromFreelist(void) {
7216 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7217 if (listLength(server
.objfreelist
)) {
7218 listNode
*head
= listFirst(server
.objfreelist
);
7219 o
= listNodeValue(head
);
7220 listDelNode(server
.objfreelist
,head
);
7221 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7225 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7230 /* This function gets called when 'maxmemory' is set on the config file to limit
7231 * the max memory used by the server, and we are out of memory.
7232 * This function will try to, in order:
7234 * - Free objects from the free list
7235 * - Try to remove keys with an EXPIRE set
7237 * It is not possible to free enough memory to reach used-memory < maxmemory
7238 * the server will start refusing commands that will enlarge even more the
7241 static void freeMemoryIfNeeded(void) {
7242 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7243 int j
, k
, freed
= 0;
7245 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7246 for (j
= 0; j
< server
.dbnum
; j
++) {
7248 robj
*minkey
= NULL
;
7249 struct dictEntry
*de
;
7251 if (dictSize(server
.db
[j
].expires
)) {
7253 /* From a sample of three keys drop the one nearest to
7254 * the natural expire */
7255 for (k
= 0; k
< 3; k
++) {
7258 de
= dictGetRandomKey(server
.db
[j
].expires
);
7259 t
= (time_t) dictGetEntryVal(de
);
7260 if (minttl
== -1 || t
< minttl
) {
7261 minkey
= dictGetEntryKey(de
);
7265 deleteKey(server
.db
+j
,minkey
);
7268 if (!freed
) return; /* nothing to free... */
7272 /* ============================== Append Only file ========================== */
7274 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7275 sds buf
= sdsempty();
7281 /* The DB this command was targetting is not the same as the last command
7282 * we appendend. To issue a SELECT command is needed. */
7283 if (dictid
!= server
.appendseldb
) {
7286 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7287 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7288 (unsigned long)strlen(seldb
),seldb
);
7289 server
.appendseldb
= dictid
;
7292 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7293 * EXPIREs into EXPIREATs calls */
7294 if (cmd
->proc
== expireCommand
) {
7297 tmpargv
[0] = createStringObject("EXPIREAT",8);
7298 tmpargv
[1] = argv
[1];
7299 incrRefCount(argv
[1]);
7300 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7301 tmpargv
[2] = createObject(REDIS_STRING
,
7302 sdscatprintf(sdsempty(),"%ld",when
));
7306 /* Append the actual command */
7307 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7308 for (j
= 0; j
< argc
; j
++) {
7311 o
= getDecodedObject(o
);
7312 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7313 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7314 buf
= sdscatlen(buf
,"\r\n",2);
7318 /* Free the objects from the modified argv for EXPIREAT */
7319 if (cmd
->proc
== expireCommand
) {
7320 for (j
= 0; j
< 3; j
++)
7321 decrRefCount(argv
[j
]);
7324 /* We want to perform a single write. This should be guaranteed atomic
7325 * at least if the filesystem we are writing is a real physical one.
7326 * While this will save us against the server being killed I don't think
7327 * there is much to do about the whole server stopping for power problems
7329 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7330 if (nwritten
!= (signed)sdslen(buf
)) {
7331 /* Ooops, we are in troubles. The best thing to do for now is
7332 * to simply exit instead to give the illusion that everything is
7333 * working as expected. */
7334 if (nwritten
== -1) {
7335 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7337 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7341 /* If a background append only file rewriting is in progress we want to
7342 * accumulate the differences between the child DB and the current one
7343 * in a buffer, so that when the child process will do its work we
7344 * can append the differences to the new append only file. */
7345 if (server
.bgrewritechildpid
!= -1)
7346 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7350 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7351 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7352 now
-server
.lastfsync
> 1))
7354 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7355 server
.lastfsync
= now
;
7359 /* In Redis commands are always executed in the context of a client, so in
7360 * order to load the append only file we need to create a fake client. */
7361 static struct redisClient
*createFakeClient(void) {
7362 struct redisClient
*c
= zmalloc(sizeof(*c
));
7366 c
->querybuf
= sdsempty();
7370 /* We set the fake client as a slave waiting for the synchronization
7371 * so that Redis will not try to send replies to this client. */
7372 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7373 c
->reply
= listCreate();
7374 listSetFreeMethod(c
->reply
,decrRefCount
);
7375 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7379 static void freeFakeClient(struct redisClient
*c
) {
7380 sdsfree(c
->querybuf
);
7381 listRelease(c
->reply
);
7385 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7386 * error (the append only file is zero-length) REDIS_ERR is returned. On
7387 * fatal error an error message is logged and the program exists. */
7388 int loadAppendOnlyFile(char *filename
) {
7389 struct redisClient
*fakeClient
;
7390 FILE *fp
= fopen(filename
,"r");
7391 struct redis_stat sb
;
7392 unsigned long long loadedkeys
= 0;
7394 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7398 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7402 fakeClient
= createFakeClient();
7409 struct redisCommand
*cmd
;
7411 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7417 if (buf
[0] != '*') goto fmterr
;
7419 argv
= zmalloc(sizeof(robj
*)*argc
);
7420 for (j
= 0; j
< argc
; j
++) {
7421 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7422 if (buf
[0] != '$') goto fmterr
;
7423 len
= strtol(buf
+1,NULL
,10);
7424 argsds
= sdsnewlen(NULL
,len
);
7425 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7426 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7427 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7430 /* Command lookup */
7431 cmd
= lookupCommand(argv
[0]->ptr
);
7433 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7436 /* Try object sharing and encoding */
7437 if (server
.shareobjects
) {
7439 for(j
= 1; j
< argc
; j
++)
7440 argv
[j
] = tryObjectSharing(argv
[j
]);
7442 if (cmd
->flags
& REDIS_CMD_BULK
)
7443 tryObjectEncoding(argv
[argc
-1]);
7444 /* Run the command in the context of a fake client */
7445 fakeClient
->argc
= argc
;
7446 fakeClient
->argv
= argv
;
7447 cmd
->proc(fakeClient
);
7448 /* Discard the reply objects list from the fake client */
7449 while(listLength(fakeClient
->reply
))
7450 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7451 /* Clean up, ready for the next command */
7452 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7454 /* Handle swapping while loading big datasets when VM is on */
7456 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7457 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7458 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7463 freeFakeClient(fakeClient
);
7468 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7470 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7474 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7478 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7479 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7483 /* Avoid the incr/decr ref count business if possible to help
7484 * copy-on-write (we are often in a child process when this function
7486 * Also makes sure that key objects don't get incrRefCount-ed when VM
7488 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7489 obj
= getDecodedObject(obj
);
7492 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7493 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7494 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7496 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7497 if (decrrc
) decrRefCount(obj
);
7500 if (decrrc
) decrRefCount(obj
);
7504 /* Write binary-safe string into a file in the bulkformat
7505 * $<count>\r\n<payload>\r\n */
7506 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7509 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7510 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7511 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7512 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7516 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7517 static int fwriteBulkDouble(FILE *fp
, double d
) {
7518 char buf
[128], dbuf
[128];
7520 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7521 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7522 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7523 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7527 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7528 static int fwriteBulkLong(FILE *fp
, long l
) {
7529 char buf
[128], lbuf
[128];
7531 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7532 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7533 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7534 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7538 /* Write a sequence of commands able to fully rebuild the dataset into
7539 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7540 static int rewriteAppendOnlyFile(char *filename
) {
7541 dictIterator
*di
= NULL
;
7546 time_t now
= time(NULL
);
7548 /* Note that we have to use a different temp name here compared to the
7549 * one used by rewriteAppendOnlyFileBackground() function. */
7550 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7551 fp
= fopen(tmpfile
,"w");
7553 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7556 for (j
= 0; j
< server
.dbnum
; j
++) {
7557 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7558 redisDb
*db
= server
.db
+j
;
7560 if (dictSize(d
) == 0) continue;
7561 di
= dictGetIterator(d
);
7567 /* SELECT the new DB */
7568 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7569 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7571 /* Iterate this DB writing every entry */
7572 while((de
= dictNext(di
)) != NULL
) {
7577 key
= dictGetEntryKey(de
);
7578 /* If the value for this key is swapped, load a preview in memory.
7579 * We use a "swapped" flag to remember if we need to free the
7580 * value object instead to just increment the ref count anyway
7581 * in order to avoid copy-on-write of pages if we are forked() */
7582 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7583 key
->storage
== REDIS_VM_SWAPPING
) {
7584 o
= dictGetEntryVal(de
);
7587 o
= vmPreviewObject(key
);
7590 expiretime
= getExpire(db
,key
);
7592 /* Save the key and associated value */
7593 if (o
->type
== REDIS_STRING
) {
7594 /* Emit a SET command */
7595 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7596 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7598 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7599 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7600 } else if (o
->type
== REDIS_LIST
) {
7601 /* Emit the RPUSHes needed to rebuild the list */
7602 list
*list
= o
->ptr
;
7606 listRewind(list
,&li
);
7607 while((ln
= listNext(&li
))) {
7608 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7609 robj
*eleobj
= listNodeValue(ln
);
7611 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7612 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7613 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7615 } else if (o
->type
== REDIS_SET
) {
7616 /* Emit the SADDs needed to rebuild the set */
7618 dictIterator
*di
= dictGetIterator(set
);
7621 while((de
= dictNext(di
)) != NULL
) {
7622 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7623 robj
*eleobj
= dictGetEntryKey(de
);
7625 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7626 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7627 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7629 dictReleaseIterator(di
);
7630 } else if (o
->type
== REDIS_ZSET
) {
7631 /* Emit the ZADDs needed to rebuild the sorted set */
7633 dictIterator
*di
= dictGetIterator(zs
->dict
);
7636 while((de
= dictNext(di
)) != NULL
) {
7637 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7638 robj
*eleobj
= dictGetEntryKey(de
);
7639 double *score
= dictGetEntryVal(de
);
7641 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7642 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7643 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7644 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7646 dictReleaseIterator(di
);
7647 } else if (o
->type
== REDIS_HASH
) {
7648 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7650 /* Emit the HSETs needed to rebuild the hash */
7651 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7652 unsigned char *p
= zipmapRewind(o
->ptr
);
7653 unsigned char *field
, *val
;
7654 unsigned int flen
, vlen
;
7656 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
7657 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7658 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7659 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
7661 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
7665 dictIterator
*di
= dictGetIterator(o
->ptr
);
7668 while((de
= dictNext(di
)) != NULL
) {
7669 robj
*field
= dictGetEntryKey(de
);
7670 robj
*val
= dictGetEntryVal(de
);
7672 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7673 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7674 if (fwriteBulkObject(fp
,field
) == -1) return -1;
7675 if (fwriteBulkObject(fp
,val
) == -1) return -1;
7677 dictReleaseIterator(di
);
7680 redisAssert(0 != 0);
7682 /* Save the expire time */
7683 if (expiretime
!= -1) {
7684 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7685 /* If this key is already expired skip it */
7686 if (expiretime
< now
) continue;
7687 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7688 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7689 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7691 if (swapped
) decrRefCount(o
);
7693 dictReleaseIterator(di
);
7696 /* Make sure data will not remain on the OS's output buffers */
7701 /* Use RENAME to make sure the DB file is changed atomically only
7702 * if the generate DB file is ok. */
7703 if (rename(tmpfile
,filename
) == -1) {
7704 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7708 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7714 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7715 if (di
) dictReleaseIterator(di
);
7719 /* This is how rewriting of the append only file in background works:
7721 * 1) The user calls BGREWRITEAOF
7722 * 2) Redis calls this function, that forks():
7723 * 2a) the child rewrite the append only file in a temp file.
7724 * 2b) the parent accumulates differences in server.bgrewritebuf.
7725 * 3) When the child finished '2a' exists.
7726 * 4) The parent will trap the exit code, if it's OK, will append the
7727 * data accumulated into server.bgrewritebuf into the temp file, and
7728 * finally will rename(2) the temp file in the actual file name.
7729 * The the new file is reopened as the new append only file. Profit!
7731 static int rewriteAppendOnlyFileBackground(void) {
7734 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7735 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7736 if ((childpid
= fork()) == 0) {
7740 if (server
.vm_enabled
) vmReopenSwapFile();
7742 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7743 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7750 if (childpid
== -1) {
7751 redisLog(REDIS_WARNING
,
7752 "Can't rewrite append only file in background: fork: %s",
7756 redisLog(REDIS_NOTICE
,
7757 "Background append only file rewriting started by pid %d",childpid
);
7758 server
.bgrewritechildpid
= childpid
;
7759 /* We set appendseldb to -1 in order to force the next call to the
7760 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7761 * accumulated by the parent into server.bgrewritebuf will start
7762 * with a SELECT statement and it will be safe to merge. */
7763 server
.appendseldb
= -1;
7766 return REDIS_OK
; /* unreached */
7769 static void bgrewriteaofCommand(redisClient
*c
) {
7770 if (server
.bgrewritechildpid
!= -1) {
7771 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7774 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7775 char *status
= "+Background append only file rewriting started\r\n";
7776 addReplySds(c
,sdsnew(status
));
7778 addReply(c
,shared
.err
);
7782 static void aofRemoveTempFile(pid_t childpid
) {
7785 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7789 /* Virtual Memory is composed mainly of two subsystems:
7790 * - Blocking Virutal Memory
7791 * - Threaded Virtual Memory I/O
7792 * The two parts are not fully decoupled, but functions are split among two
7793 * different sections of the source code (delimited by comments) in order to
7794 * make more clear what functionality is about the blocking VM and what about
7795 * the threaded (not blocking) VM.
7799 * Redis VM is a blocking VM (one that blocks reading swapped values from
7800 * disk into memory when a value swapped out is needed in memory) that is made
7801 * unblocking by trying to examine the command argument vector in order to
7802 * load in background values that will likely be needed in order to exec
7803 * the command. The command is executed only once all the relevant keys
7804 * are loaded into memory.
7806 * This basically is almost as simple of a blocking VM, but almost as parallel
7807 * as a fully non-blocking VM.
7810 /* =================== Virtual Memory - Blocking Side ====================== */
7812 /* substitute the first occurrence of '%p' with the process pid in the
7813 * swap file name. */
7814 static void expandVmSwapFilename(void) {
7815 char *p
= strstr(server
.vm_swap_file
,"%p");
7821 new = sdscat(new,server
.vm_swap_file
);
7822 new = sdscatprintf(new,"%ld",(long) getpid());
7823 new = sdscat(new,p
+2);
7824 zfree(server
.vm_swap_file
);
7825 server
.vm_swap_file
= new;
7828 static void vmInit(void) {
7833 if (server
.vm_max_threads
!= 0)
7834 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7836 expandVmSwapFilename();
7837 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7838 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7839 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7841 if (server
.vm_fp
== NULL
) {
7842 redisLog(REDIS_WARNING
,
7843 "Impossible to open the swap file: %s. Exiting.",
7847 server
.vm_fd
= fileno(server
.vm_fp
);
7848 server
.vm_next_page
= 0;
7849 server
.vm_near_pages
= 0;
7850 server
.vm_stats_used_pages
= 0;
7851 server
.vm_stats_swapped_objects
= 0;
7852 server
.vm_stats_swapouts
= 0;
7853 server
.vm_stats_swapins
= 0;
7854 totsize
= server
.vm_pages
*server
.vm_page_size
;
7855 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7856 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7857 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7861 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7863 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7864 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7865 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7866 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7868 /* Initialize threaded I/O (used by Virtual Memory) */
7869 server
.io_newjobs
= listCreate();
7870 server
.io_processing
= listCreate();
7871 server
.io_processed
= listCreate();
7872 server
.io_ready_clients
= listCreate();
7873 pthread_mutex_init(&server
.io_mutex
,NULL
);
7874 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7875 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7876 server
.io_active_threads
= 0;
7877 if (pipe(pipefds
) == -1) {
7878 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7882 server
.io_ready_pipe_read
= pipefds
[0];
7883 server
.io_ready_pipe_write
= pipefds
[1];
7884 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7885 /* LZF requires a lot of stack */
7886 pthread_attr_init(&server
.io_threads_attr
);
7887 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7888 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7889 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7890 /* Listen for events in the threaded I/O pipe */
7891 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7892 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7893 oom("creating file event");
7896 /* Mark the page as used */
7897 static void vmMarkPageUsed(off_t page
) {
7898 off_t byte
= page
/8;
7900 redisAssert(vmFreePage(page
) == 1);
7901 server
.vm_bitmap
[byte
] |= 1<<bit
;
7904 /* Mark N contiguous pages as used, with 'page' being the first. */
7905 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7908 for (j
= 0; j
< count
; j
++)
7909 vmMarkPageUsed(page
+j
);
7910 server
.vm_stats_used_pages
+= count
;
7911 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
7912 (long long)count
, (long long)page
);
7915 /* Mark the page as free */
7916 static void vmMarkPageFree(off_t page
) {
7917 off_t byte
= page
/8;
7919 redisAssert(vmFreePage(page
) == 0);
7920 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7923 /* Mark N contiguous pages as free, with 'page' being the first. */
7924 static void vmMarkPagesFree(off_t page
, off_t count
) {
7927 for (j
= 0; j
< count
; j
++)
7928 vmMarkPageFree(page
+j
);
7929 server
.vm_stats_used_pages
-= count
;
7930 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
7931 (long long)count
, (long long)page
);
7934 /* Test if the page is free */
7935 static int vmFreePage(off_t page
) {
7936 off_t byte
= page
/8;
7938 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7941 /* Find N contiguous free pages storing the first page of the cluster in *first.
7942 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7943 * REDIS_ERR is returned.
7945 * This function uses a simple algorithm: we try to allocate
7946 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7947 * again from the start of the swap file searching for free spaces.
7949 * If it looks pretty clear that there are no free pages near our offset
7950 * we try to find less populated places doing a forward jump of
7951 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7952 * without hurry, and then we jump again and so forth...
7954 * This function can be improved using a free list to avoid to guess
7955 * too much, since we could collect data about freed pages.
7957 * note: I implemented this function just after watching an episode of
7958 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7960 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7961 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7963 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7964 server
.vm_near_pages
= 0;
7965 server
.vm_next_page
= 0;
7967 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7968 base
= server
.vm_next_page
;
7970 while(offset
< server
.vm_pages
) {
7971 off_t
this = base
+offset
;
7973 /* If we overflow, restart from page zero */
7974 if (this >= server
.vm_pages
) {
7975 this -= server
.vm_pages
;
7977 /* Just overflowed, what we found on tail is no longer
7978 * interesting, as it's no longer contiguous. */
7982 if (vmFreePage(this)) {
7983 /* This is a free page */
7985 /* Already got N free pages? Return to the caller, with success */
7987 *first
= this-(n
-1);
7988 server
.vm_next_page
= this+1;
7989 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
7993 /* The current one is not a free page */
7997 /* Fast-forward if the current page is not free and we already
7998 * searched enough near this place. */
8000 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8001 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8003 /* Note that even if we rewind after the jump, we are don't need
8004 * to make sure numfree is set to zero as we only jump *if* it
8005 * is set to zero. */
8007 /* Otherwise just check the next page */
8014 /* Write the specified object at the specified page of the swap file */
8015 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8016 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8017 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8018 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8019 redisLog(REDIS_WARNING
,
8020 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8024 rdbSaveObject(server
.vm_fp
,o
);
8025 fflush(server
.vm_fp
);
8026 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8030 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8031 * needed to later retrieve the object into the key object.
8032 * If we can't find enough contiguous empty pages to swap the object on disk
8033 * REDIS_ERR is returned. */
8034 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8035 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8038 assert(key
->storage
== REDIS_VM_MEMORY
);
8039 assert(key
->refcount
== 1);
8040 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8041 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8042 key
->vm
.page
= page
;
8043 key
->vm
.usedpages
= pages
;
8044 key
->storage
= REDIS_VM_SWAPPED
;
8045 key
->vtype
= val
->type
;
8046 decrRefCount(val
); /* Deallocate the object from memory. */
8047 vmMarkPagesUsed(page
,pages
);
8048 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8049 (unsigned char*) key
->ptr
,
8050 (unsigned long long) page
, (unsigned long long) pages
);
8051 server
.vm_stats_swapped_objects
++;
8052 server
.vm_stats_swapouts
++;
8056 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8059 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8060 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8061 redisLog(REDIS_WARNING
,
8062 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8066 o
= rdbLoadObject(type
,server
.vm_fp
);
8068 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8071 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8075 /* Load the value object relative to the 'key' object from swap to memory.
8076 * The newly allocated object is returned.
8078 * If preview is true the unserialized object is returned to the caller but
8079 * no changes are made to the key object, nor the pages are marked as freed */
8080 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8083 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8084 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8086 key
->storage
= REDIS_VM_MEMORY
;
8087 key
->vm
.atime
= server
.unixtime
;
8088 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8089 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8090 (unsigned char*) key
->ptr
);
8091 server
.vm_stats_swapped_objects
--;
8093 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8094 (unsigned char*) key
->ptr
);
8096 server
.vm_stats_swapins
++;
8100 /* Plain object loading, from swap to memory */
8101 static robj
*vmLoadObject(robj
*key
) {
8102 /* If we are loading the object in background, stop it, we
8103 * need to load this object synchronously ASAP. */
8104 if (key
->storage
== REDIS_VM_LOADING
)
8105 vmCancelThreadedIOJob(key
);
8106 return vmGenericLoadObject(key
,0);
8109 /* Just load the value on disk, without to modify the key.
8110 * This is useful when we want to perform some operation on the value
8111 * without to really bring it from swap to memory, like while saving the
8112 * dataset or rewriting the append only log. */
8113 static robj
*vmPreviewObject(robj
*key
) {
8114 return vmGenericLoadObject(key
,1);
8117 /* How a good candidate is this object for swapping?
8118 * The better candidate it is, the greater the returned value.
8120 * Currently we try to perform a fast estimation of the object size in
8121 * memory, and combine it with aging informations.
8123 * Basically swappability = idle-time * log(estimated size)
8125 * Bigger objects are preferred over smaller objects, but not
8126 * proportionally, this is why we use the logarithm. This algorithm is
8127 * just a first try and will probably be tuned later. */
8128 static double computeObjectSwappability(robj
*o
) {
8129 time_t age
= server
.unixtime
- o
->vm
.atime
;
8133 struct dictEntry
*de
;
8136 if (age
<= 0) return 0;
8139 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8142 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8147 listNode
*ln
= listFirst(l
);
8149 asize
= sizeof(list
);
8151 robj
*ele
= ln
->value
;
8154 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8155 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8157 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8162 z
= (o
->type
== REDIS_ZSET
);
8163 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8165 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8166 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8171 de
= dictGetRandomKey(d
);
8172 ele
= dictGetEntryKey(de
);
8173 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8174 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8176 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8177 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8181 return (double)age
*log(1+asize
);
8184 /* Try to swap an object that's a good candidate for swapping.
8185 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8186 * to swap any object at all.
8188 * If 'usethreaded' is true, Redis will try to swap the object in background
8189 * using I/O threads. */
8190 static int vmSwapOneObject(int usethreads
) {
8192 struct dictEntry
*best
= NULL
;
8193 double best_swappability
= 0;
8194 redisDb
*best_db
= NULL
;
8197 for (j
= 0; j
< server
.dbnum
; j
++) {
8198 redisDb
*db
= server
.db
+j
;
8199 /* Why maxtries is set to 100?
8200 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8201 * are swappable objects */
8204 if (dictSize(db
->dict
) == 0) continue;
8205 for (i
= 0; i
< 5; i
++) {
8207 double swappability
;
8209 if (maxtries
) maxtries
--;
8210 de
= dictGetRandomKey(db
->dict
);
8211 key
= dictGetEntryKey(de
);
8212 val
= dictGetEntryVal(de
);
8213 /* Only swap objects that are currently in memory.
8215 * Also don't swap shared objects if threaded VM is on, as we
8216 * try to ensure that the main thread does not touch the
8217 * object while the I/O thread is using it, but we can't
8218 * control other keys without adding additional mutex. */
8219 if (key
->storage
!= REDIS_VM_MEMORY
||
8220 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8221 if (maxtries
) i
--; /* don't count this try */
8224 swappability
= computeObjectSwappability(val
);
8225 if (!best
|| swappability
> best_swappability
) {
8227 best_swappability
= swappability
;
8232 if (best
== NULL
) return REDIS_ERR
;
8233 key
= dictGetEntryKey(best
);
8234 val
= dictGetEntryVal(best
);
8236 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8237 key
->ptr
, best_swappability
);
8239 /* Unshare the key if needed */
8240 if (key
->refcount
> 1) {
8241 robj
*newkey
= dupStringObject(key
);
8243 key
= dictGetEntryKey(best
) = newkey
;
8247 vmSwapObjectThreaded(key
,val
,best_db
);
8250 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8251 dictGetEntryVal(best
) = NULL
;
8259 static int vmSwapOneObjectBlocking() {
8260 return vmSwapOneObject(0);
8263 static int vmSwapOneObjectThreaded() {
8264 return vmSwapOneObject(1);
8267 /* Return true if it's safe to swap out objects in a given moment.
8268 * Basically we don't want to swap objects out while there is a BGSAVE
8269 * or a BGAEOREWRITE running in backgroud. */
8270 static int vmCanSwapOut(void) {
8271 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8274 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8275 * and was deleted. Otherwise 0 is returned. */
8276 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8280 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8281 foundkey
= dictGetEntryKey(de
);
8282 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8287 /* =================== Virtual Memory - Threaded I/O ======================= */
8289 static void freeIOJob(iojob
*j
) {
8290 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8291 j
->type
== REDIS_IOJOB_DO_SWAP
||
8292 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8293 decrRefCount(j
->val
);
8294 decrRefCount(j
->key
);
8298 /* Every time a thread finished a Job, it writes a byte into the write side
8299 * of an unix pipe in order to "awake" the main thread, and this function
8301 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8305 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8307 REDIS_NOTUSED(mask
);
8308 REDIS_NOTUSED(privdata
);
8310 /* For every byte we read in the read side of the pipe, there is one
8311 * I/O job completed to process. */
8312 while((retval
= read(fd
,buf
,1)) == 1) {
8316 struct dictEntry
*de
;
8318 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8320 /* Get the processed element (the oldest one) */
8322 assert(listLength(server
.io_processed
) != 0);
8323 if (toprocess
== -1) {
8324 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8325 if (toprocess
<= 0) toprocess
= 1;
8327 ln
= listFirst(server
.io_processed
);
8329 listDelNode(server
.io_processed
,ln
);
8331 /* If this job is marked as canceled, just ignore it */
8336 /* Post process it in the main thread, as there are things we
8337 * can do just here to avoid race conditions and/or invasive locks */
8338 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
);
8339 de
= dictFind(j
->db
->dict
,j
->key
);
8341 key
= dictGetEntryKey(de
);
8342 if (j
->type
== REDIS_IOJOB_LOAD
) {
8345 /* Key loaded, bring it at home */
8346 key
->storage
= REDIS_VM_MEMORY
;
8347 key
->vm
.atime
= server
.unixtime
;
8348 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8349 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8350 (unsigned char*) key
->ptr
);
8351 server
.vm_stats_swapped_objects
--;
8352 server
.vm_stats_swapins
++;
8353 dictGetEntryVal(de
) = j
->val
;
8354 incrRefCount(j
->val
);
8357 /* Handle clients waiting for this key to be loaded. */
8358 handleClientsBlockedOnSwappedKey(db
,key
);
8359 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8360 /* Now we know the amount of pages required to swap this object.
8361 * Let's find some space for it, and queue this task again
8362 * rebranded as REDIS_IOJOB_DO_SWAP. */
8363 if (!vmCanSwapOut() ||
8364 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8366 /* Ooops... no space or we can't swap as there is
8367 * a fork()ed Redis trying to save stuff on disk. */
8369 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8371 /* Note that we need to mark this pages as used now,
8372 * if the job will be canceled, we'll mark them as freed
8374 vmMarkPagesUsed(j
->page
,j
->pages
);
8375 j
->type
= REDIS_IOJOB_DO_SWAP
;
8380 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8383 /* Key swapped. We can finally free some memory. */
8384 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8385 printf("key->storage: %d\n",key
->storage
);
8386 printf("key->name: %s\n",(char*)key
->ptr
);
8387 printf("key->refcount: %d\n",key
->refcount
);
8388 printf("val: %p\n",(void*)j
->val
);
8389 printf("val->type: %d\n",j
->val
->type
);
8390 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8392 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8393 val
= dictGetEntryVal(de
);
8394 key
->vm
.page
= j
->page
;
8395 key
->vm
.usedpages
= j
->pages
;
8396 key
->storage
= REDIS_VM_SWAPPED
;
8397 key
->vtype
= j
->val
->type
;
8398 decrRefCount(val
); /* Deallocate the object from memory. */
8399 dictGetEntryVal(de
) = NULL
;
8400 redisLog(REDIS_DEBUG
,
8401 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8402 (unsigned char*) key
->ptr
,
8403 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8404 server
.vm_stats_swapped_objects
++;
8405 server
.vm_stats_swapouts
++;
8407 /* Put a few more swap requests in queue if we are still
8409 if (trytoswap
&& vmCanSwapOut() &&
8410 zmalloc_used_memory() > server
.vm_max_memory
)
8415 more
= listLength(server
.io_newjobs
) <
8416 (unsigned) server
.vm_max_threads
;
8418 /* Don't waste CPU time if swappable objects are rare. */
8419 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8427 if (processed
== toprocess
) return;
8429 if (retval
< 0 && errno
!= EAGAIN
) {
8430 redisLog(REDIS_WARNING
,
8431 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8436 static void lockThreadedIO(void) {
8437 pthread_mutex_lock(&server
.io_mutex
);
8440 static void unlockThreadedIO(void) {
8441 pthread_mutex_unlock(&server
.io_mutex
);
8444 /* Remove the specified object from the threaded I/O queue if still not
8445 * processed, otherwise make sure to flag it as canceled. */
8446 static void vmCancelThreadedIOJob(robj
*o
) {
8448 server
.io_newjobs
, /* 0 */
8449 server
.io_processing
, /* 1 */
8450 server
.io_processed
/* 2 */
8454 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8457 /* Search for a matching key in one of the queues */
8458 for (i
= 0; i
< 3; i
++) {
8462 listRewind(lists
[i
],&li
);
8463 while ((ln
= listNext(&li
)) != NULL
) {
8464 iojob
*job
= ln
->value
;
8466 if (job
->canceled
) continue; /* Skip this, already canceled. */
8467 if (compareStringObjects(job
->key
,o
) == 0) {
8468 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8469 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8470 /* Mark the pages as free since the swap didn't happened
8471 * or happened but is now discarded. */
8472 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8473 vmMarkPagesFree(job
->page
,job
->pages
);
8474 /* Cancel the job. It depends on the list the job is
8477 case 0: /* io_newjobs */
8478 /* If the job was yet not processed the best thing to do
8479 * is to remove it from the queue at all */
8481 listDelNode(lists
[i
],ln
);
8483 case 1: /* io_processing */
8484 /* Oh Shi- the thread is messing with the Job:
8486 * Probably it's accessing the object if this is a
8487 * PREPARE_SWAP or DO_SWAP job.
8488 * If it's a LOAD job it may be reading from disk and
8489 * if we don't wait for the job to terminate before to
8490 * cancel it, maybe in a few microseconds data can be
8491 * corrupted in this pages. So the short story is:
8493 * Better to wait for the job to move into the
8494 * next queue (processed)... */
8496 /* We try again and again until the job is completed. */
8498 /* But let's wait some time for the I/O thread
8499 * to finish with this job. After all this condition
8500 * should be very rare. */
8503 case 2: /* io_processed */
8504 /* The job was already processed, that's easy...
8505 * just mark it as canceled so that we'll ignore it
8506 * when processing completed jobs. */
8510 /* Finally we have to adjust the storage type of the object
8511 * in order to "UNDO" the operaiton. */
8512 if (o
->storage
== REDIS_VM_LOADING
)
8513 o
->storage
= REDIS_VM_SWAPPED
;
8514 else if (o
->storage
== REDIS_VM_SWAPPING
)
8515 o
->storage
= REDIS_VM_MEMORY
;
8522 assert(1 != 1); /* We should never reach this */
8525 static void *IOThreadEntryPoint(void *arg
) {
8530 pthread_detach(pthread_self());
8532 /* Get a new job to process */
8534 if (listLength(server
.io_newjobs
) == 0) {
8535 /* No new jobs in queue, exit. */
8536 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8537 (long) pthread_self());
8538 server
.io_active_threads
--;
8542 ln
= listFirst(server
.io_newjobs
);
8544 listDelNode(server
.io_newjobs
,ln
);
8545 /* Add the job in the processing queue */
8546 j
->thread
= pthread_self();
8547 listAddNodeTail(server
.io_processing
,j
);
8548 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8550 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8551 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8553 /* Process the Job */
8554 if (j
->type
== REDIS_IOJOB_LOAD
) {
8555 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8556 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8557 FILE *fp
= fopen("/dev/null","w+");
8558 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8560 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8561 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8565 /* Done: insert the job into the processed queue */
8566 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8567 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8569 listDelNode(server
.io_processing
,ln
);
8570 listAddNodeTail(server
.io_processed
,j
);
8573 /* Signal the main thread there is new stuff to process */
8574 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8576 return NULL
; /* never reached */
8579 static void spawnIOThread(void) {
8581 sigset_t mask
, omask
;
8584 sigaddset(&mask
,SIGCHLD
);
8585 sigaddset(&mask
,SIGHUP
);
8586 sigaddset(&mask
,SIGPIPE
);
8587 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8588 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
8589 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8590 server
.io_active_threads
++;
8593 /* We need to wait for the last thread to exit before we are able to
8594 * fork() in order to BGSAVE or BGREWRITEAOF. */
8595 static void waitEmptyIOJobsQueue(void) {
8597 int io_processed_len
;
8600 if (listLength(server
.io_newjobs
) == 0 &&
8601 listLength(server
.io_processing
) == 0 &&
8602 server
.io_active_threads
== 0)
8607 /* While waiting for empty jobs queue condition we post-process some
8608 * finshed job, as I/O threads may be hanging trying to write against
8609 * the io_ready_pipe_write FD but there are so much pending jobs that
8611 io_processed_len
= listLength(server
.io_processed
);
8613 if (io_processed_len
) {
8614 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8615 usleep(1000); /* 1 millisecond */
8617 usleep(10000); /* 10 milliseconds */
8622 static void vmReopenSwapFile(void) {
8623 /* Note: we don't close the old one as we are in the child process
8624 * and don't want to mess at all with the original file object. */
8625 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8626 if (server
.vm_fp
== NULL
) {
8627 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8628 server
.vm_swap_file
);
8631 server
.vm_fd
= fileno(server
.vm_fp
);
8634 /* This function must be called while with threaded IO locked */
8635 static void queueIOJob(iojob
*j
) {
8636 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8637 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8638 listAddNodeTail(server
.io_newjobs
,j
);
8639 if (server
.io_active_threads
< server
.vm_max_threads
)
8643 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8646 assert(key
->storage
== REDIS_VM_MEMORY
);
8647 assert(key
->refcount
== 1);
8649 j
= zmalloc(sizeof(*j
));
8650 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8652 j
->key
= dupStringObject(key
);
8656 j
->thread
= (pthread_t
) -1;
8657 key
->storage
= REDIS_VM_SWAPPING
;
8665 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8667 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8668 * If there is not already a job loading the key, it is craeted.
8669 * The key is added to the io_keys list in the client structure, and also
8670 * in the hash table mapping swapped keys to waiting clients, that is,
8671 * server.io_waited_keys. */
8672 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8673 struct dictEntry
*de
;
8677 /* If the key does not exist or is already in RAM we don't need to
8678 * block the client at all. */
8679 de
= dictFind(c
->db
->dict
,key
);
8680 if (de
== NULL
) return 0;
8681 o
= dictGetEntryKey(de
);
8682 if (o
->storage
== REDIS_VM_MEMORY
) {
8684 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8685 /* We were swapping the key, undo it! */
8686 vmCancelThreadedIOJob(o
);
8690 /* OK: the key is either swapped, or being loaded just now. */
8692 /* Add the key to the list of keys this client is waiting for.
8693 * This maps clients to keys they are waiting for. */
8694 listAddNodeTail(c
->io_keys
,key
);
8697 /* Add the client to the swapped keys => clients waiting map. */
8698 de
= dictFind(c
->db
->io_keys
,key
);
8702 /* For every key we take a list of clients blocked for it */
8704 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8706 assert(retval
== DICT_OK
);
8708 l
= dictGetEntryVal(de
);
8710 listAddNodeTail(l
,c
);
8712 /* Are we already loading the key from disk? If not create a job */
8713 if (o
->storage
== REDIS_VM_SWAPPED
) {
8716 o
->storage
= REDIS_VM_LOADING
;
8717 j
= zmalloc(sizeof(*j
));
8718 j
->type
= REDIS_IOJOB_LOAD
;
8720 j
->key
= dupStringObject(key
);
8721 j
->key
->vtype
= o
->vtype
;
8722 j
->page
= o
->vm
.page
;
8725 j
->thread
= (pthread_t
) -1;
8733 /* Is this client attempting to run a command against swapped keys?
8734 * If so, block it ASAP, load the keys in background, then resume it.
8736 * The important idea about this function is that it can fail! If keys will
8737 * still be swapped when the client is resumed, this key lookups will
8738 * just block loading keys from disk. In practical terms this should only
8739 * happen with SORT BY command or if there is a bug in this function.
8741 * Return 1 if the client is marked as blocked, 0 if the client can
8742 * continue as the keys it is going to access appear to be in memory. */
8743 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8746 if (cmd
->vm_firstkey
== 0) return 0;
8747 last
= cmd
->vm_lastkey
;
8748 if (last
< 0) last
= c
->argc
+last
;
8749 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8750 waitForSwappedKey(c
,c
->argv
[j
]);
8751 /* If the client was blocked for at least one key, mark it as blocked. */
8752 if (listLength(c
->io_keys
)) {
8753 c
->flags
|= REDIS_IO_WAIT
;
8754 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8755 server
.vm_blocked_clients
++;
8762 /* Remove the 'key' from the list of blocked keys for a given client.
8764 * The function returns 1 when there are no longer blocking keys after
8765 * the current one was removed (and the client can be unblocked). */
8766 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8770 struct dictEntry
*de
;
8772 /* Remove the key from the list of keys this client is waiting for. */
8773 listRewind(c
->io_keys
,&li
);
8774 while ((ln
= listNext(&li
)) != NULL
) {
8775 if (compareStringObjects(ln
->value
,key
) == 0) {
8776 listDelNode(c
->io_keys
,ln
);
8782 /* Remove the client form the key => waiting clients map. */
8783 de
= dictFind(c
->db
->io_keys
,key
);
8785 l
= dictGetEntryVal(de
);
8786 ln
= listSearchKey(l
,c
);
8789 if (listLength(l
) == 0)
8790 dictDelete(c
->db
->io_keys
,key
);
8792 return listLength(c
->io_keys
) == 0;
8795 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8796 struct dictEntry
*de
;
8801 de
= dictFind(db
->io_keys
,key
);
8804 l
= dictGetEntryVal(de
);
8805 len
= listLength(l
);
8806 /* Note: we can't use something like while(listLength(l)) as the list
8807 * can be freed by the calling function when we remove the last element. */
8810 redisClient
*c
= ln
->value
;
8812 if (dontWaitForSwappedKey(c
,key
)) {
8813 /* Put the client in the list of clients ready to go as we
8814 * loaded all the keys about it. */
8815 listAddNodeTail(server
.io_ready_clients
,c
);
8820 /* ================================= Debugging ============================== */
8822 static void debugCommand(redisClient
*c
) {
8823 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8825 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8826 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8827 addReply(c
,shared
.err
);
8831 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8832 addReply(c
,shared
.err
);
8835 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8836 addReply(c
,shared
.ok
);
8837 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8839 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8840 addReply(c
,shared
.err
);
8843 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8844 addReply(c
,shared
.ok
);
8845 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8846 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8850 addReply(c
,shared
.nokeyerr
);
8853 key
= dictGetEntryKey(de
);
8854 val
= dictGetEntryVal(de
);
8855 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8856 key
->storage
== REDIS_VM_SWAPPING
)) {
8860 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
8861 strenc
= strencoding
[val
->encoding
];
8863 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
8866 addReplySds(c
,sdscatprintf(sdsempty(),
8867 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8868 "encoding:%s serializedlength:%lld\r\n",
8869 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8870 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
8872 addReplySds(c
,sdscatprintf(sdsempty(),
8873 "+Key at:%p refcount:%d, value swapped at: page %llu "
8874 "using %llu pages\r\n",
8875 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8876 (unsigned long long) key
->vm
.usedpages
));
8878 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8879 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8882 if (!server
.vm_enabled
) {
8883 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8887 addReply(c
,shared
.nokeyerr
);
8890 key
= dictGetEntryKey(de
);
8891 val
= dictGetEntryVal(de
);
8892 /* If the key is shared we want to create a copy */
8893 if (key
->refcount
> 1) {
8894 robj
*newkey
= dupStringObject(key
);
8896 key
= dictGetEntryKey(de
) = newkey
;
8899 if (key
->storage
!= REDIS_VM_MEMORY
) {
8900 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8901 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8902 dictGetEntryVal(de
) = NULL
;
8903 addReply(c
,shared
.ok
);
8905 addReply(c
,shared
.err
);
8908 addReplySds(c
,sdsnew(
8909 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8913 static void _redisAssert(char *estr
, char *file
, int line
) {
8914 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8915 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8916 #ifdef HAVE_BACKTRACE
8917 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8922 /* =================================== Main! ================================ */
8925 int linuxOvercommitMemoryValue(void) {
8926 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8930 if (fgets(buf
,64,fp
) == NULL
) {
8939 void linuxOvercommitMemoryWarning(void) {
8940 if (linuxOvercommitMemoryValue() == 0) {
8941 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.");
8944 #endif /* __linux__ */
8946 static void daemonize(void) {
8950 if (fork() != 0) exit(0); /* parent exits */
8951 setsid(); /* create a new session */
8953 /* Every output goes to /dev/null. If Redis is daemonized but
8954 * the 'logfile' is set to 'stdout' in the configuration file
8955 * it will not log at all. */
8956 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8957 dup2(fd
, STDIN_FILENO
);
8958 dup2(fd
, STDOUT_FILENO
);
8959 dup2(fd
, STDERR_FILENO
);
8960 if (fd
> STDERR_FILENO
) close(fd
);
8962 /* Try to write the pid file */
8963 fp
= fopen(server
.pidfile
,"w");
8965 fprintf(fp
,"%d\n",getpid());
8970 int main(int argc
, char **argv
) {
8975 resetServerSaveParams();
8976 loadServerConfig(argv
[1]);
8977 } else if (argc
> 2) {
8978 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8981 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'");
8983 if (server
.daemonize
) daemonize();
8985 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8987 linuxOvercommitMemoryWarning();
8990 if (server
.appendonly
) {
8991 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8992 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8994 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8995 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8997 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8998 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9000 aeDeleteEventLoop(server
.el
);
9004 /* ============================= Backtrace support ========================= */
9006 #ifdef HAVE_BACKTRACE
9007 static char *findFuncName(void *pointer
, unsigned long *offset
);
9009 static void *getMcontextEip(ucontext_t
*uc
) {
9010 #if defined(__FreeBSD__)
9011 return (void*) uc
->uc_mcontext
.mc_eip
;
9012 #elif defined(__dietlibc__)
9013 return (void*) uc
->uc_mcontext
.eip
;
9014 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9016 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9018 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9020 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9021 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9022 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9024 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9026 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9027 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9028 #elif defined(__ia64__) /* Linux IA64 */
9029 return (void*) uc
->uc_mcontext
.sc_ip
;
9035 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9037 char **messages
= NULL
;
9038 int i
, trace_size
= 0;
9039 unsigned long offset
=0;
9040 ucontext_t
*uc
= (ucontext_t
*) secret
;
9042 REDIS_NOTUSED(info
);
9044 redisLog(REDIS_WARNING
,
9045 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9046 infostring
= genRedisInfoString();
9047 redisLog(REDIS_WARNING
, "%s",infostring
);
9048 /* It's not safe to sdsfree() the returned string under memory
9049 * corruption conditions. Let it leak as we are going to abort */
9051 trace_size
= backtrace(trace
, 100);
9052 /* overwrite sigaction with caller's address */
9053 if (getMcontextEip(uc
) != NULL
) {
9054 trace
[1] = getMcontextEip(uc
);
9056 messages
= backtrace_symbols(trace
, trace_size
);
9058 for (i
=1; i
<trace_size
; ++i
) {
9059 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9061 p
= strchr(messages
[i
],'+');
9062 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9063 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9065 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9068 /* free(messages); Don't call free() with possibly corrupted memory. */
9072 static void setupSigSegvAction(void) {
9073 struct sigaction act
;
9075 sigemptyset (&act
.sa_mask
);
9076 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9077 * is used. Otherwise, sa_handler is used */
9078 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9079 act
.sa_sigaction
= segvHandler
;
9080 sigaction (SIGSEGV
, &act
, NULL
);
9081 sigaction (SIGBUS
, &act
, NULL
);
9082 sigaction (SIGFPE
, &act
, NULL
);
9083 sigaction (SIGILL
, &act
, NULL
);
9084 sigaction (SIGBUS
, &act
, NULL
);
9088 #include "staticsymbols.h"
9089 /* This function try to convert a pointer into a function name. It's used in
9090 * oreder to provide a backtrace under segmentation fault that's able to
9091 * display functions declared as static (otherwise the backtrace is useless). */
9092 static char *findFuncName(void *pointer
, unsigned long *offset
){
9094 unsigned long off
, minoff
= 0;
9096 /* Try to match against the Symbol with the smallest offset */
9097 for (i
=0; symsTable
[i
].pointer
; i
++) {
9098 unsigned long lp
= (unsigned long) pointer
;
9100 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9101 off
=lp
-symsTable
[i
].pointer
;
9102 if (ret
< 0 || off
< minoff
) {
9108 if (ret
== -1) return NULL
;
9110 return symsTable
[ret
].name
;
9112 #else /* HAVE_BACKTRACE */
9113 static void setupSigSegvAction(void) {
9115 #endif /* HAVE_BACKTRACE */