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 */
83 /* Static server configuration */
84 #define REDIS_SERVERPORT 6379 /* TCP port */
85 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
86 #define REDIS_IOBUF_LEN 1024
87 #define REDIS_LOADBUF_LEN 1024
88 #define REDIS_STATIC_ARGS 4
89 #define REDIS_DEFAULT_DBNUM 16
90 #define REDIS_CONFIGLINE_MAX 1024
91 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
92 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
93 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
94 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
95 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
97 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
98 #define REDIS_WRITEV_THRESHOLD 3
99 /* Max number of iovecs used for each writev call */
100 #define REDIS_WRITEV_IOVEC_COUNT 256
102 /* Hash table parameters */
103 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
106 #define REDIS_CMD_BULK 1 /* Bulk write command */
107 #define REDIS_CMD_INLINE 2 /* Inline command */
108 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
109 this flags will return an error when the 'maxmemory' option is set in the
110 config file and the server is using more than maxmemory bytes of memory.
111 In short this commands are denied on low memory conditions. */
112 #define REDIS_CMD_DENYOOM 4
115 #define REDIS_STRING 0
121 /* Objects encoding */
122 #define REDIS_ENCODING_RAW 0 /* Raw representation */
123 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
125 /* Object types only used for dumping to disk */
126 #define REDIS_EXPIRETIME 253
127 #define REDIS_SELECTDB 254
128 #define REDIS_EOF 255
130 /* Defines related to the dump file format. To store 32 bits lengths for short
131 * keys requires a lot of space, so we check the most significant 2 bits of
132 * the first byte to interpreter the length:
134 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
135 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
136 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
137 * 11|000000 this means: specially encoded object will follow. The six bits
138 * number specify the kind of object that follows.
139 * See the REDIS_RDB_ENC_* defines.
141 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
142 * values, will fit inside. */
143 #define REDIS_RDB_6BITLEN 0
144 #define REDIS_RDB_14BITLEN 1
145 #define REDIS_RDB_32BITLEN 2
146 #define REDIS_RDB_ENCVAL 3
147 #define REDIS_RDB_LENERR UINT_MAX
149 /* When a length of a string object stored on disk has the first two bits
150 * set, the remaining two bits specify a special encoding for the object
151 * accordingly to the following defines: */
152 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
153 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
154 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
155 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
157 /* Virtual memory object->where field. */
158 #define REDIS_VM_MEMORY 0 /* The object is on memory */
159 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
160 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
161 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
163 /* Virtual memory static configuration stuff.
164 * Check vmFindContiguousPages() to know more about this magic numbers. */
165 #define REDIS_VM_MAX_NEAR_PAGES 65536
166 #define REDIS_VM_MAX_RANDOM_JUMP 4096
167 #define REDIS_VM_MAX_THREADS 32
168 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
169 /* The following is the *percentage* of completed I/O jobs to process when the
170 * handelr is called. While Virtual Memory I/O operations are performed by
171 * threads, this operations must be processed by the main thread when completed
172 * in order to take effect. */
173 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
176 #define REDIS_SLAVE 1 /* This client is a slave server */
177 #define REDIS_MASTER 2 /* This client is a master server */
178 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
179 #define REDIS_MULTI 8 /* This client is in a MULTI context */
180 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
181 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
183 /* Slave replication state - slave side */
184 #define REDIS_REPL_NONE 0 /* No active replication */
185 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
186 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
188 /* Slave replication state - from the point of view of master
189 * Note that in SEND_BULK and ONLINE state the slave receives new updates
190 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
191 * to start the next background saving in order to send updates to it. */
192 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
193 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
194 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
195 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
197 /* List related stuff */
201 /* Sort operations */
202 #define REDIS_SORT_GET 0
203 #define REDIS_SORT_ASC 1
204 #define REDIS_SORT_DESC 2
205 #define REDIS_SORTKEY_MAX 1024
208 #define REDIS_DEBUG 0
209 #define REDIS_VERBOSE 1
210 #define REDIS_NOTICE 2
211 #define REDIS_WARNING 3
213 /* Anti-warning macro... */
214 #define REDIS_NOTUSED(V) ((void) V)
216 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
217 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
219 /* Append only defines */
220 #define APPENDFSYNC_NO 0
221 #define APPENDFSYNC_ALWAYS 1
222 #define APPENDFSYNC_EVERYSEC 2
224 /* We can print the stacktrace, so our assert is defined this way: */
225 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
226 static void _redisAssert(char *estr
, char *file
, int line
);
228 /*================================= Data types ============================== */
230 /* A redis object, that is a type able to hold a string / list / set */
232 /* The VM object structure */
233 struct redisObjectVM
{
234 off_t page
; /* the page at witch the object is stored on disk */
235 off_t usedpages
; /* number of pages used on disk */
236 time_t atime
; /* Last access time */
239 /* The actual Redis Object */
240 typedef struct redisObject
{
243 unsigned char encoding
;
244 unsigned char storage
; /* If this object is a key, where is the value?
245 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
246 unsigned char vtype
; /* If this object is a key, and value is swapped out,
247 * this is the type of the swapped out object. */
249 /* VM fields, this are only allocated if VM is active, otherwise the
250 * object allocation function will just allocate
251 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
252 * Redis without VM active will not have any overhead. */
253 struct redisObjectVM vm
;
256 /* Macro used to initalize a Redis object allocated on the stack.
257 * Note that this macro is taken near the structure definition to make sure
258 * we'll update it when the structure is changed, to avoid bugs like
259 * bug #85 introduced exactly in this way. */
260 #define initStaticStringObject(_var,_ptr) do { \
262 _var.type = REDIS_STRING; \
263 _var.encoding = REDIS_ENCODING_RAW; \
265 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
268 typedef struct redisDb
{
269 dict
*dict
; /* The keyspace for this DB */
270 dict
*expires
; /* Timeout of keys with a timeout set */
271 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
272 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
276 /* Client MULTI/EXEC state */
277 typedef struct multiCmd
{
280 struct redisCommand
*cmd
;
283 typedef struct multiState
{
284 multiCmd
*commands
; /* Array of MULTI commands */
285 int count
; /* Total number of MULTI commands */
288 /* With multiplexing we need to take per-clinet state.
289 * Clients are taken in a liked list. */
290 typedef struct redisClient
{
295 robj
**argv
, **mbargv
;
297 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
298 int multibulk
; /* multi bulk command format active */
301 time_t lastinteraction
; /* time of the last interaction, used for timeout */
302 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
303 int slaveseldb
; /* slave selected db, if this client is a slave */
304 int authenticated
; /* when requirepass is non-NULL */
305 int replstate
; /* replication state if this is a slave */
306 int repldbfd
; /* replication DB file descriptor */
307 long repldboff
; /* replication DB file offset */
308 off_t repldbsize
; /* replication DB file size */
309 multiState mstate
; /* MULTI/EXEC state */
310 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
311 * operation such as BLPOP. Otherwise NULL. */
312 int blockingkeysnum
; /* Number of blocking keys */
313 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
314 * is >= blockingto then the operation timed out. */
315 list
*io_keys
; /* Keys this client is waiting to be loaded from the
316 * swap file in order to continue. */
324 /* Global server state structure */
329 dict
*sharingpool
; /* Poll used for object sharing */
330 unsigned int sharingpoolsize
;
331 long long dirty
; /* changes to DB from the last save */
333 list
*slaves
, *monitors
;
334 char neterr
[ANET_ERR_LEN
];
336 int cronloops
; /* number of times the cron function run */
337 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
338 time_t lastsave
; /* Unix time of last save succeeede */
339 /* Fields used only for stats */
340 time_t stat_starttime
; /* server start time */
341 long long stat_numcommands
; /* number of processed commands */
342 long long stat_numconnections
; /* number of connections received */
355 pid_t bgsavechildpid
;
356 pid_t bgrewritechildpid
;
357 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
358 struct saveparam
*saveparams
;
363 char *appendfilename
;
367 /* Replication related */
372 redisClient
*master
; /* client that is master for this slave */
374 unsigned int maxclients
;
375 unsigned long long maxmemory
;
376 unsigned int blpop_blocked_clients
;
377 unsigned int vm_blocked_clients
;
378 /* Sort parameters - qsort_r() is only available under BSD so we
379 * have to take this state global, in order to pass it to sortCompare() */
383 /* Virtual memory configuration */
388 unsigned long long vm_max_memory
;
389 /* Virtual memory state */
392 off_t vm_next_page
; /* Next probably empty page */
393 off_t vm_near_pages
; /* Number of pages allocated sequentially */
394 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
395 time_t unixtime
; /* Unix time sampled every second. */
396 /* Virtual memory I/O threads stuff */
397 /* An I/O thread process an element taken from the io_jobs queue and
398 * put the result of the operation in the io_done list. While the
399 * job is being processed, it's put on io_processing queue. */
400 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
401 list
*io_processing
; /* List of VM I/O jobs being processed */
402 list
*io_processed
; /* List of VM I/O jobs already processed */
403 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
404 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
405 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
406 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
407 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
408 int io_active_threads
; /* Number of running I/O threads */
409 int vm_max_threads
; /* Max number of I/O threads running at the same time */
410 /* Our main thread is blocked on the event loop, locking for sockets ready
411 * to be read or written, so when a threaded I/O operation is ready to be
412 * processed by the main thread, the I/O thread will use a unix pipe to
413 * awake the main thread. The followings are the two pipe FDs. */
414 int io_ready_pipe_read
;
415 int io_ready_pipe_write
;
416 /* Virtual memory stats */
417 unsigned long long vm_stats_used_pages
;
418 unsigned long long vm_stats_swapped_objects
;
419 unsigned long long vm_stats_swapouts
;
420 unsigned long long vm_stats_swapins
;
424 typedef void redisCommandProc(redisClient
*c
);
425 struct redisCommand
{
427 redisCommandProc
*proc
;
430 /* What keys should be loaded in background when calling this command? */
431 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
432 int vm_lastkey
; /* THe last argument that's a key */
433 int vm_keystep
; /* The step between first and last key */
436 struct redisFunctionSym
{
438 unsigned long pointer
;
441 typedef struct _redisSortObject
{
449 typedef struct _redisSortOperation
{
452 } redisSortOperation
;
454 /* ZSETs use a specialized version of Skiplists */
456 typedef struct zskiplistNode
{
457 struct zskiplistNode
**forward
;
458 struct zskiplistNode
*backward
;
464 typedef struct zskiplist
{
465 struct zskiplistNode
*header
, *tail
;
466 unsigned long length
;
470 typedef struct zset
{
475 /* Our shared "common" objects */
477 struct sharedObjectsStruct
{
478 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
479 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
480 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
481 *outofrangeerr
, *plus
,
482 *select0
, *select1
, *select2
, *select3
, *select4
,
483 *select5
, *select6
, *select7
, *select8
, *select9
;
486 /* Global vars that are actally used as constants. The following double
487 * values are used for double on-disk serialization, and are initialized
488 * at runtime to avoid strange compiler optimizations. */
490 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
492 /* VM threaded I/O request message */
493 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
494 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
495 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
496 typedef struct iojob
{
497 int type
; /* Request type, REDIS_IOJOB_* */
498 redisDb
*db
;/* Redis database */
499 robj
*key
; /* This I/O request is about swapping this key */
500 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
501 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
502 off_t page
; /* Swap page where to read/write the object */
503 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
504 int canceled
; /* True if this command was canceled by blocking side of VM */
505 pthread_t thread
; /* ID of the thread processing this entry */
508 /*================================ Prototypes =============================== */
510 static void freeStringObject(robj
*o
);
511 static void freeListObject(robj
*o
);
512 static void freeSetObject(robj
*o
);
513 static void decrRefCount(void *o
);
514 static robj
*createObject(int type
, void *ptr
);
515 static void freeClient(redisClient
*c
);
516 static int rdbLoad(char *filename
);
517 static void addReply(redisClient
*c
, robj
*obj
);
518 static void addReplySds(redisClient
*c
, sds s
);
519 static void incrRefCount(robj
*o
);
520 static int rdbSaveBackground(char *filename
);
521 static robj
*createStringObject(char *ptr
, size_t len
);
522 static robj
*dupStringObject(robj
*o
);
523 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
524 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
525 static int syncWithMaster(void);
526 static robj
*tryObjectSharing(robj
*o
);
527 static int tryObjectEncoding(robj
*o
);
528 static robj
*getDecodedObject(robj
*o
);
529 static int removeExpire(redisDb
*db
, robj
*key
);
530 static int expireIfNeeded(redisDb
*db
, robj
*key
);
531 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
532 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
533 static int deleteKey(redisDb
*db
, robj
*key
);
534 static time_t getExpire(redisDb
*db
, robj
*key
);
535 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
536 static void updateSlavesWaitingBgsave(int bgsaveerr
);
537 static void freeMemoryIfNeeded(void);
538 static int processCommand(redisClient
*c
);
539 static void setupSigSegvAction(void);
540 static void rdbRemoveTempFile(pid_t childpid
);
541 static void aofRemoveTempFile(pid_t childpid
);
542 static size_t stringObjectLen(robj
*o
);
543 static void processInputBuffer(redisClient
*c
);
544 static zskiplist
*zslCreate(void);
545 static void zslFree(zskiplist
*zsl
);
546 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
547 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
548 static void initClientMultiState(redisClient
*c
);
549 static void freeClientMultiState(redisClient
*c
);
550 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
551 static void unblockClientWaitingData(redisClient
*c
);
552 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
553 static void vmInit(void);
554 static void vmMarkPagesFree(off_t page
, off_t count
);
555 static robj
*vmLoadObject(robj
*key
);
556 static robj
*vmPreviewObject(robj
*key
);
557 static int vmSwapOneObjectBlocking(void);
558 static int vmSwapOneObjectThreaded(void);
559 static int vmCanSwapOut(void);
560 static int tryFreeOneObjectFromFreelist(void);
561 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
562 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
563 static void vmCancelThreadedIOJob(robj
*o
);
564 static void lockThreadedIO(void);
565 static void unlockThreadedIO(void);
566 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
567 static void freeIOJob(iojob
*j
);
568 static void queueIOJob(iojob
*j
);
569 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
570 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
571 static void waitEmptyIOJobsQueue(void);
572 static void vmReopenSwapFile(void);
573 static int vmFreePage(off_t page
);
574 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
575 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
576 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
577 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
578 static struct redisCommand
*lookupCommand(char *name
);
579 static void call(redisClient
*c
, struct redisCommand
*cmd
);
580 static void resetClient(redisClient
*c
);
582 static void authCommand(redisClient
*c
);
583 static void pingCommand(redisClient
*c
);
584 static void echoCommand(redisClient
*c
);
585 static void setCommand(redisClient
*c
);
586 static void setnxCommand(redisClient
*c
);
587 static void getCommand(redisClient
*c
);
588 static void delCommand(redisClient
*c
);
589 static void existsCommand(redisClient
*c
);
590 static void incrCommand(redisClient
*c
);
591 static void decrCommand(redisClient
*c
);
592 static void incrbyCommand(redisClient
*c
);
593 static void decrbyCommand(redisClient
*c
);
594 static void selectCommand(redisClient
*c
);
595 static void randomkeyCommand(redisClient
*c
);
596 static void keysCommand(redisClient
*c
);
597 static void dbsizeCommand(redisClient
*c
);
598 static void lastsaveCommand(redisClient
*c
);
599 static void saveCommand(redisClient
*c
);
600 static void bgsaveCommand(redisClient
*c
);
601 static void bgrewriteaofCommand(redisClient
*c
);
602 static void shutdownCommand(redisClient
*c
);
603 static void moveCommand(redisClient
*c
);
604 static void renameCommand(redisClient
*c
);
605 static void renamenxCommand(redisClient
*c
);
606 static void lpushCommand(redisClient
*c
);
607 static void rpushCommand(redisClient
*c
);
608 static void lpopCommand(redisClient
*c
);
609 static void rpopCommand(redisClient
*c
);
610 static void llenCommand(redisClient
*c
);
611 static void lindexCommand(redisClient
*c
);
612 static void lrangeCommand(redisClient
*c
);
613 static void ltrimCommand(redisClient
*c
);
614 static void typeCommand(redisClient
*c
);
615 static void lsetCommand(redisClient
*c
);
616 static void saddCommand(redisClient
*c
);
617 static void sremCommand(redisClient
*c
);
618 static void smoveCommand(redisClient
*c
);
619 static void sismemberCommand(redisClient
*c
);
620 static void scardCommand(redisClient
*c
);
621 static void spopCommand(redisClient
*c
);
622 static void srandmemberCommand(redisClient
*c
);
623 static void sinterCommand(redisClient
*c
);
624 static void sinterstoreCommand(redisClient
*c
);
625 static void sunionCommand(redisClient
*c
);
626 static void sunionstoreCommand(redisClient
*c
);
627 static void sdiffCommand(redisClient
*c
);
628 static void sdiffstoreCommand(redisClient
*c
);
629 static void syncCommand(redisClient
*c
);
630 static void flushdbCommand(redisClient
*c
);
631 static void flushallCommand(redisClient
*c
);
632 static void sortCommand(redisClient
*c
);
633 static void lremCommand(redisClient
*c
);
634 static void rpoplpushcommand(redisClient
*c
);
635 static void infoCommand(redisClient
*c
);
636 static void mgetCommand(redisClient
*c
);
637 static void monitorCommand(redisClient
*c
);
638 static void expireCommand(redisClient
*c
);
639 static void expireatCommand(redisClient
*c
);
640 static void getsetCommand(redisClient
*c
);
641 static void ttlCommand(redisClient
*c
);
642 static void slaveofCommand(redisClient
*c
);
643 static void debugCommand(redisClient
*c
);
644 static void msetCommand(redisClient
*c
);
645 static void msetnxCommand(redisClient
*c
);
646 static void zaddCommand(redisClient
*c
);
647 static void zincrbyCommand(redisClient
*c
);
648 static void zrangeCommand(redisClient
*c
);
649 static void zrangebyscoreCommand(redisClient
*c
);
650 static void zcountCommand(redisClient
*c
);
651 static void zrevrangeCommand(redisClient
*c
);
652 static void zcardCommand(redisClient
*c
);
653 static void zremCommand(redisClient
*c
);
654 static void zscoreCommand(redisClient
*c
);
655 static void zremrangebyscoreCommand(redisClient
*c
);
656 static void multiCommand(redisClient
*c
);
657 static void execCommand(redisClient
*c
);
658 static void discardCommand(redisClient
*c
);
659 static void blpopCommand(redisClient
*c
);
660 static void brpopCommand(redisClient
*c
);
661 static void appendCommand(redisClient
*c
);
662 static void substrCommand(redisClient
*c
);
663 static void zrankCommand(redisClient
*c
);
664 static void zremrangebyrankCommand(redisClient
*c
);
666 /*================================= Globals ================================= */
669 static struct redisServer server
; /* server global state */
670 static struct redisCommand cmdTable
[] = {
671 {"get",getCommand
,2,REDIS_CMD_INLINE
,1,1,1},
672 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
673 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
674 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
675 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,1,1,1},
676 {"del",delCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
677 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
678 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
679 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
680 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,1,-1,1},
681 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
682 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
683 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
684 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
685 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
686 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
687 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
688 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,1,1,1},
689 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
690 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,1,1,1},
691 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,1,1,1},
692 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,1,1,1},
693 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,2,1},
694 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
695 {"srem",sremCommand
,3,REDIS_CMD_BULK
,1,1,1},
696 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,1,2,1},
697 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,1,1,1},
698 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
699 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
700 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,1,1,1},
701 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
702 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
703 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
704 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
705 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
706 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
707 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,1,1,1},
708 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
709 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
710 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,1,1,1},
711 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,1,1,1},
712 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,1,1,1},
713 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
714 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
715 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,1,1,1},
716 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
717 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
718 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
719 {"zrank",zrankCommand
,3,REDIS_CMD_INLINE
,1,1,1},
720 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
721 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
722 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
723 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
724 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
725 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,0,0,0},
726 {"select",selectCommand
,2,REDIS_CMD_INLINE
,0,0,0},
727 {"move",moveCommand
,3,REDIS_CMD_INLINE
,1,1,1},
728 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,1,1,1},
729 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,1,1,1},
730 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,0,0,0},
731 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,0,0,0},
732 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,0,0,0},
733 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,0,0,0},
734 {"auth",authCommand
,2,REDIS_CMD_INLINE
,0,0,0},
735 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,0,0,0},
736 {"echo",echoCommand
,2,REDIS_CMD_BULK
,0,0,0},
737 {"save",saveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
738 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
739 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,0,0,0},
740 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,0,0,0},
741 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
742 {"type",typeCommand
,2,REDIS_CMD_INLINE
,1,1,1},
743 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,0,0,0},
744 {"exec",execCommand
,1,REDIS_CMD_INLINE
,0,0,0},
745 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,0,0,0},
746 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,0,0,0},
747 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,0,0,0},
748 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,0,0,0},
749 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
750 {"info",infoCommand
,1,REDIS_CMD_INLINE
,0,0,0},
751 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,0,0,0},
752 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,1,1,1},
753 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,0,0,0},
754 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
755 {NULL
,NULL
,0,0,0,0,0}
758 /*============================ Utility functions ============================ */
760 /* Glob-style pattern matching. */
761 int stringmatchlen(const char *pattern
, int patternLen
,
762 const char *string
, int stringLen
, int nocase
)
767 while (pattern
[1] == '*') {
772 return 1; /* match */
774 if (stringmatchlen(pattern
+1, patternLen
-1,
775 string
, stringLen
, nocase
))
776 return 1; /* match */
780 return 0; /* no match */
784 return 0; /* no match */
794 not = pattern
[0] == '^';
801 if (pattern
[0] == '\\') {
804 if (pattern
[0] == string
[0])
806 } else if (pattern
[0] == ']') {
808 } else if (patternLen
== 0) {
812 } else if (pattern
[1] == '-' && patternLen
>= 3) {
813 int start
= pattern
[0];
814 int end
= pattern
[2];
822 start
= tolower(start
);
828 if (c
>= start
&& c
<= end
)
832 if (pattern
[0] == string
[0])
835 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
845 return 0; /* no match */
851 if (patternLen
>= 2) {
858 if (pattern
[0] != string
[0])
859 return 0; /* no match */
861 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
862 return 0; /* no match */
870 if (stringLen
== 0) {
871 while(*pattern
== '*') {
878 if (patternLen
== 0 && stringLen
== 0)
883 static void redisLog(int level
, const char *fmt
, ...) {
887 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
891 if (level
>= server
.verbosity
) {
897 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
898 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
899 vfprintf(fp
, fmt
, ap
);
905 if (server
.logfile
) fclose(fp
);
908 /*====================== Hash table type implementation ==================== */
910 /* This is an hash table type that uses the SDS dynamic strings libary as
911 * keys and radis objects as values (objects can hold SDS strings,
914 static void dictVanillaFree(void *privdata
, void *val
)
916 DICT_NOTUSED(privdata
);
920 static void dictListDestructor(void *privdata
, void *val
)
922 DICT_NOTUSED(privdata
);
923 listRelease((list
*)val
);
926 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
930 DICT_NOTUSED(privdata
);
932 l1
= sdslen((sds
)key1
);
933 l2
= sdslen((sds
)key2
);
934 if (l1
!= l2
) return 0;
935 return memcmp(key1
, key2
, l1
) == 0;
938 static void dictRedisObjectDestructor(void *privdata
, void *val
)
940 DICT_NOTUSED(privdata
);
942 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
946 static int dictObjKeyCompare(void *privdata
, const void *key1
,
949 const robj
*o1
= key1
, *o2
= key2
;
950 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
953 static unsigned int dictObjHash(const void *key
) {
955 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
958 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
961 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
964 o1
= getDecodedObject(o1
);
965 o2
= getDecodedObject(o2
);
966 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
972 static unsigned int dictEncObjHash(const void *key
) {
973 robj
*o
= (robj
*) key
;
975 if (o
->encoding
== REDIS_ENCODING_RAW
) {
976 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
978 if (o
->encoding
== REDIS_ENCODING_INT
) {
982 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
983 return dictGenHashFunction((unsigned char*)buf
, len
);
987 o
= getDecodedObject(o
);
988 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
995 /* Sets type and expires */
996 static dictType setDictType
= {
997 dictEncObjHash
, /* hash function */
1000 dictEncObjKeyCompare
, /* key compare */
1001 dictRedisObjectDestructor
, /* key destructor */
1002 NULL
/* val destructor */
1005 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1006 static dictType zsetDictType
= {
1007 dictEncObjHash
, /* hash function */
1010 dictEncObjKeyCompare
, /* key compare */
1011 dictRedisObjectDestructor
, /* key destructor */
1012 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1016 static dictType hashDictType
= {
1017 dictObjHash
, /* hash function */
1020 dictObjKeyCompare
, /* key compare */
1021 dictRedisObjectDestructor
, /* key destructor */
1022 dictRedisObjectDestructor
/* val destructor */
1026 static dictType keyptrDictType
= {
1027 dictObjHash
, /* hash function */
1030 dictObjKeyCompare
, /* key compare */
1031 dictRedisObjectDestructor
, /* key destructor */
1032 NULL
/* val destructor */
1035 /* Keylist hash table type has unencoded redis objects as keys and
1036 * lists as values. It's used for blocking operations (BLPOP) and to
1037 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1038 static dictType keylistDictType
= {
1039 dictObjHash
, /* hash function */
1042 dictObjKeyCompare
, /* key compare */
1043 dictRedisObjectDestructor
, /* key destructor */
1044 dictListDestructor
/* val destructor */
1047 /* ========================= Random utility functions ======================= */
1049 /* Redis generally does not try to recover from out of memory conditions
1050 * when allocating objects or strings, it is not clear if it will be possible
1051 * to report this condition to the client since the networking layer itself
1052 * is based on heap allocation for send buffers, so we simply abort.
1053 * At least the code will be simpler to read... */
1054 static void oom(const char *msg
) {
1055 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1060 /* ====================== Redis server networking stuff ===================== */
1061 static void closeTimedoutClients(void) {
1064 time_t now
= time(NULL
);
1067 listRewind(server
.clients
,&li
);
1068 while ((ln
= listNext(&li
)) != NULL
) {
1069 c
= listNodeValue(ln
);
1070 if (server
.maxidletime
&&
1071 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1072 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1073 (now
- c
->lastinteraction
> server
.maxidletime
))
1075 redisLog(REDIS_VERBOSE
,"Closing idle client");
1077 } else if (c
->flags
& REDIS_BLOCKED
) {
1078 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1079 addReply(c
,shared
.nullmultibulk
);
1080 unblockClientWaitingData(c
);
1086 static int htNeedsResize(dict
*dict
) {
1087 long long size
, used
;
1089 size
= dictSlots(dict
);
1090 used
= dictSize(dict
);
1091 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1092 (used
*100/size
< REDIS_HT_MINFILL
));
1095 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1096 * we resize the hash table to save memory */
1097 static void tryResizeHashTables(void) {
1100 for (j
= 0; j
< server
.dbnum
; j
++) {
1101 if (htNeedsResize(server
.db
[j
].dict
)) {
1102 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1103 dictResize(server
.db
[j
].dict
);
1104 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1106 if (htNeedsResize(server
.db
[j
].expires
))
1107 dictResize(server
.db
[j
].expires
);
1111 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1112 void backgroundSaveDoneHandler(int statloc
) {
1113 int exitcode
= WEXITSTATUS(statloc
);
1114 int bysignal
= WIFSIGNALED(statloc
);
1116 if (!bysignal
&& exitcode
== 0) {
1117 redisLog(REDIS_NOTICE
,
1118 "Background saving terminated with success");
1120 server
.lastsave
= time(NULL
);
1121 } else if (!bysignal
&& exitcode
!= 0) {
1122 redisLog(REDIS_WARNING
, "Background saving error");
1124 redisLog(REDIS_WARNING
,
1125 "Background saving terminated by signal");
1126 rdbRemoveTempFile(server
.bgsavechildpid
);
1128 server
.bgsavechildpid
= -1;
1129 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1130 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1131 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1134 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1136 void backgroundRewriteDoneHandler(int statloc
) {
1137 int exitcode
= WEXITSTATUS(statloc
);
1138 int bysignal
= WIFSIGNALED(statloc
);
1140 if (!bysignal
&& exitcode
== 0) {
1144 redisLog(REDIS_NOTICE
,
1145 "Background append only file rewriting terminated with success");
1146 /* Now it's time to flush the differences accumulated by the parent */
1147 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1148 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1150 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1153 /* Flush our data... */
1154 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1155 (signed) sdslen(server
.bgrewritebuf
)) {
1156 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
));
1160 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1161 /* Now our work is to rename the temp file into the stable file. And
1162 * switch the file descriptor used by the server for append only. */
1163 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1164 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1168 /* Mission completed... almost */
1169 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1170 if (server
.appendfd
!= -1) {
1171 /* If append only is actually enabled... */
1172 close(server
.appendfd
);
1173 server
.appendfd
= fd
;
1175 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1176 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1178 /* If append only is disabled we just generate a dump in this
1179 * format. Why not? */
1182 } else if (!bysignal
&& exitcode
!= 0) {
1183 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1185 redisLog(REDIS_WARNING
,
1186 "Background append only file rewriting terminated by signal");
1189 sdsfree(server
.bgrewritebuf
);
1190 server
.bgrewritebuf
= sdsempty();
1191 aofRemoveTempFile(server
.bgrewritechildpid
);
1192 server
.bgrewritechildpid
= -1;
1195 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1196 int j
, loops
= server
.cronloops
++;
1197 REDIS_NOTUSED(eventLoop
);
1199 REDIS_NOTUSED(clientData
);
1201 /* We take a cached value of the unix time in the global state because
1202 * with virtual memory and aging there is to store the current time
1203 * in objects at every object access, and accuracy is not needed.
1204 * To access a global var is faster than calling time(NULL) */
1205 server
.unixtime
= time(NULL
);
1207 /* Show some info about non-empty databases */
1208 for (j
= 0; j
< server
.dbnum
; j
++) {
1209 long long size
, used
, vkeys
;
1211 size
= dictSlots(server
.db
[j
].dict
);
1212 used
= dictSize(server
.db
[j
].dict
);
1213 vkeys
= dictSize(server
.db
[j
].expires
);
1214 if (!(loops
% 5) && (used
|| vkeys
)) {
1215 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1216 /* dictPrintStats(server.dict); */
1220 /* We don't want to resize the hash tables while a bacground saving
1221 * is in progress: the saving child is created using fork() that is
1222 * implemented with a copy-on-write semantic in most modern systems, so
1223 * if we resize the HT while there is the saving child at work actually
1224 * a lot of memory movements in the parent will cause a lot of pages
1226 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1228 /* Show information about connected clients */
1230 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1231 listLength(server
.clients
)-listLength(server
.slaves
),
1232 listLength(server
.slaves
),
1233 zmalloc_used_memory(),
1234 dictSize(server
.sharingpool
));
1237 /* Close connections of timedout clients */
1238 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1239 closeTimedoutClients();
1241 /* Check if a background saving or AOF rewrite in progress terminated */
1242 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1246 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1247 if (pid
== server
.bgsavechildpid
) {
1248 backgroundSaveDoneHandler(statloc
);
1250 backgroundRewriteDoneHandler(statloc
);
1254 /* If there is not a background saving in progress check if
1255 * we have to save now */
1256 time_t now
= time(NULL
);
1257 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1258 struct saveparam
*sp
= server
.saveparams
+j
;
1260 if (server
.dirty
>= sp
->changes
&&
1261 now
-server
.lastsave
> sp
->seconds
) {
1262 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1263 sp
->changes
, sp
->seconds
);
1264 rdbSaveBackground(server
.dbfilename
);
1270 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1271 * will use few CPU cycles if there are few expiring keys, otherwise
1272 * it will get more aggressive to avoid that too much memory is used by
1273 * keys that can be removed from the keyspace. */
1274 for (j
= 0; j
< server
.dbnum
; j
++) {
1276 redisDb
*db
= server
.db
+j
;
1278 /* Continue to expire if at the end of the cycle more than 25%
1279 * of the keys were expired. */
1281 long num
= dictSize(db
->expires
);
1282 time_t now
= time(NULL
);
1285 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1286 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1291 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1292 t
= (time_t) dictGetEntryVal(de
);
1294 deleteKey(db
,dictGetEntryKey(de
));
1298 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1301 /* Swap a few keys on disk if we are over the memory limit and VM
1302 * is enbled. Try to free objects from the free list first. */
1303 if (vmCanSwapOut()) {
1304 while (server
.vm_enabled
&& zmalloc_used_memory() >
1305 server
.vm_max_memory
)
1309 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1310 retval
= (server
.vm_max_threads
== 0) ?
1311 vmSwapOneObjectBlocking() :
1312 vmSwapOneObjectThreaded();
1313 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1314 zmalloc_used_memory() >
1315 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1317 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1319 /* Note that when using threade I/O we free just one object,
1320 * because anyway when the I/O thread in charge to swap this
1321 * object out will finish, the handler of completed jobs
1322 * will try to swap more objects if we are still out of memory. */
1323 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1327 /* Check if we should connect to a MASTER */
1328 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1329 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1330 if (syncWithMaster() == REDIS_OK
) {
1331 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1337 /* This function gets called every time Redis is entering the
1338 * main loop of the event driven library, that is, before to sleep
1339 * for ready file descriptors. */
1340 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1341 REDIS_NOTUSED(eventLoop
);
1343 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1347 listRewind(server
.io_ready_clients
,&li
);
1348 while((ln
= listNext(&li
))) {
1349 redisClient
*c
= ln
->value
;
1350 struct redisCommand
*cmd
;
1352 /* Resume the client. */
1353 listDelNode(server
.io_ready_clients
,ln
);
1354 c
->flags
&= (~REDIS_IO_WAIT
);
1355 server
.vm_blocked_clients
--;
1356 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1357 readQueryFromClient
, c
);
1358 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1359 assert(cmd
!= NULL
);
1362 /* There may be more data to process in the input buffer. */
1363 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1364 processInputBuffer(c
);
1369 static void createSharedObjects(void) {
1370 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1371 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1372 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1373 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1374 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1375 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1376 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1377 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1378 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1379 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1380 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1381 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1382 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1383 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1384 "-ERR no such key\r\n"));
1385 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1386 "-ERR syntax error\r\n"));
1387 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1388 "-ERR source and destination objects are the same\r\n"));
1389 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1390 "-ERR index out of range\r\n"));
1391 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1392 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1393 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1394 shared
.select0
= createStringObject("select 0\r\n",10);
1395 shared
.select1
= createStringObject("select 1\r\n",10);
1396 shared
.select2
= createStringObject("select 2\r\n",10);
1397 shared
.select3
= createStringObject("select 3\r\n",10);
1398 shared
.select4
= createStringObject("select 4\r\n",10);
1399 shared
.select5
= createStringObject("select 5\r\n",10);
1400 shared
.select6
= createStringObject("select 6\r\n",10);
1401 shared
.select7
= createStringObject("select 7\r\n",10);
1402 shared
.select8
= createStringObject("select 8\r\n",10);
1403 shared
.select9
= createStringObject("select 9\r\n",10);
1406 static void appendServerSaveParams(time_t seconds
, int changes
) {
1407 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1408 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1409 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1410 server
.saveparamslen
++;
1413 static void resetServerSaveParams() {
1414 zfree(server
.saveparams
);
1415 server
.saveparams
= NULL
;
1416 server
.saveparamslen
= 0;
1419 static void initServerConfig() {
1420 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1421 server
.port
= REDIS_SERVERPORT
;
1422 server
.verbosity
= REDIS_VERBOSE
;
1423 server
.maxidletime
= REDIS_MAXIDLETIME
;
1424 server
.saveparams
= NULL
;
1425 server
.logfile
= NULL
; /* NULL = log on standard output */
1426 server
.bindaddr
= NULL
;
1427 server
.glueoutputbuf
= 1;
1428 server
.daemonize
= 0;
1429 server
.appendonly
= 0;
1430 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1431 server
.lastfsync
= time(NULL
);
1432 server
.appendfd
= -1;
1433 server
.appendseldb
= -1; /* Make sure the first time will not match */
1434 server
.pidfile
= "/var/run/redis.pid";
1435 server
.dbfilename
= "dump.rdb";
1436 server
.appendfilename
= "appendonly.aof";
1437 server
.requirepass
= NULL
;
1438 server
.shareobjects
= 0;
1439 server
.rdbcompression
= 1;
1440 server
.sharingpoolsize
= 1024;
1441 server
.maxclients
= 0;
1442 server
.blpop_blocked_clients
= 0;
1443 server
.maxmemory
= 0;
1444 server
.vm_enabled
= 0;
1445 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1446 server
.vm_page_size
= 256; /* 256 bytes per page */
1447 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1448 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1449 server
.vm_max_threads
= 4;
1450 server
.vm_blocked_clients
= 0;
1452 resetServerSaveParams();
1454 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1455 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1456 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1457 /* Replication related */
1459 server
.masterauth
= NULL
;
1460 server
.masterhost
= NULL
;
1461 server
.masterport
= 6379;
1462 server
.master
= NULL
;
1463 server
.replstate
= REDIS_REPL_NONE
;
1465 /* Double constants initialization */
1467 R_PosInf
= 1.0/R_Zero
;
1468 R_NegInf
= -1.0/R_Zero
;
1469 R_Nan
= R_Zero
/R_Zero
;
1472 static void initServer() {
1475 signal(SIGHUP
, SIG_IGN
);
1476 signal(SIGPIPE
, SIG_IGN
);
1477 setupSigSegvAction();
1479 server
.devnull
= fopen("/dev/null","w");
1480 if (server
.devnull
== NULL
) {
1481 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1484 server
.clients
= listCreate();
1485 server
.slaves
= listCreate();
1486 server
.monitors
= listCreate();
1487 server
.objfreelist
= listCreate();
1488 createSharedObjects();
1489 server
.el
= aeCreateEventLoop();
1490 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1491 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1492 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1493 if (server
.fd
== -1) {
1494 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1497 for (j
= 0; j
< server
.dbnum
; j
++) {
1498 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1499 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1500 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1501 if (server
.vm_enabled
)
1502 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1503 server
.db
[j
].id
= j
;
1505 server
.cronloops
= 0;
1506 server
.bgsavechildpid
= -1;
1507 server
.bgrewritechildpid
= -1;
1508 server
.bgrewritebuf
= sdsempty();
1509 server
.lastsave
= time(NULL
);
1511 server
.stat_numcommands
= 0;
1512 server
.stat_numconnections
= 0;
1513 server
.stat_starttime
= time(NULL
);
1514 server
.unixtime
= time(NULL
);
1515 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1516 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1517 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1519 if (server
.appendonly
) {
1520 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1521 if (server
.appendfd
== -1) {
1522 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1528 if (server
.vm_enabled
) vmInit();
1531 /* Empty the whole database */
1532 static long long emptyDb() {
1534 long long removed
= 0;
1536 for (j
= 0; j
< server
.dbnum
; j
++) {
1537 removed
+= dictSize(server
.db
[j
].dict
);
1538 dictEmpty(server
.db
[j
].dict
);
1539 dictEmpty(server
.db
[j
].expires
);
1544 static int yesnotoi(char *s
) {
1545 if (!strcasecmp(s
,"yes")) return 1;
1546 else if (!strcasecmp(s
,"no")) return 0;
1550 /* I agree, this is a very rudimental way to load a configuration...
1551 will improve later if the config gets more complex */
1552 static void loadServerConfig(char *filename
) {
1554 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1558 if (filename
[0] == '-' && filename
[1] == '\0')
1561 if ((fp
= fopen(filename
,"r")) == NULL
) {
1562 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1567 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1573 line
= sdstrim(line
," \t\r\n");
1575 /* Skip comments and blank lines*/
1576 if (line
[0] == '#' || line
[0] == '\0') {
1581 /* Split into arguments */
1582 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1583 sdstolower(argv
[0]);
1585 /* Execute config directives */
1586 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1587 server
.maxidletime
= atoi(argv
[1]);
1588 if (server
.maxidletime
< 0) {
1589 err
= "Invalid timeout value"; goto loaderr
;
1591 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1592 server
.port
= atoi(argv
[1]);
1593 if (server
.port
< 1 || server
.port
> 65535) {
1594 err
= "Invalid port"; goto loaderr
;
1596 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1597 server
.bindaddr
= zstrdup(argv
[1]);
1598 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1599 int seconds
= atoi(argv
[1]);
1600 int changes
= atoi(argv
[2]);
1601 if (seconds
< 1 || changes
< 0) {
1602 err
= "Invalid save parameters"; goto loaderr
;
1604 appendServerSaveParams(seconds
,changes
);
1605 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1606 if (chdir(argv
[1]) == -1) {
1607 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1608 argv
[1], strerror(errno
));
1611 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1612 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1613 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1614 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1615 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1617 err
= "Invalid log level. Must be one of debug, notice, warning";
1620 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1623 server
.logfile
= zstrdup(argv
[1]);
1624 if (!strcasecmp(server
.logfile
,"stdout")) {
1625 zfree(server
.logfile
);
1626 server
.logfile
= NULL
;
1628 if (server
.logfile
) {
1629 /* Test if we are able to open the file. The server will not
1630 * be able to abort just for this problem later... */
1631 logfp
= fopen(server
.logfile
,"a");
1632 if (logfp
== NULL
) {
1633 err
= sdscatprintf(sdsempty(),
1634 "Can't open the log file: %s", strerror(errno
));
1639 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1640 server
.dbnum
= atoi(argv
[1]);
1641 if (server
.dbnum
< 1) {
1642 err
= "Invalid number of databases"; goto loaderr
;
1644 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1645 server
.maxclients
= atoi(argv
[1]);
1646 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1647 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1648 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1649 server
.masterhost
= sdsnew(argv
[1]);
1650 server
.masterport
= atoi(argv
[2]);
1651 server
.replstate
= REDIS_REPL_CONNECT
;
1652 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1653 server
.masterauth
= zstrdup(argv
[1]);
1654 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1655 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1656 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1658 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1659 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1660 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1662 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1663 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1664 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1666 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1667 server
.sharingpoolsize
= atoi(argv
[1]);
1668 if (server
.sharingpoolsize
< 1) {
1669 err
= "invalid object sharing pool size"; goto loaderr
;
1671 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1672 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1673 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1675 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1676 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1677 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1679 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1680 if (!strcasecmp(argv
[1],"no")) {
1681 server
.appendfsync
= APPENDFSYNC_NO
;
1682 } else if (!strcasecmp(argv
[1],"always")) {
1683 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1684 } else if (!strcasecmp(argv
[1],"everysec")) {
1685 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1687 err
= "argument must be 'no', 'always' or 'everysec'";
1690 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1691 server
.requirepass
= zstrdup(argv
[1]);
1692 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1693 server
.pidfile
= zstrdup(argv
[1]);
1694 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1695 server
.dbfilename
= zstrdup(argv
[1]);
1696 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1697 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1698 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1700 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1701 zfree(server
.vm_swap_file
);
1702 server
.vm_swap_file
= zstrdup(argv
[1]);
1703 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1704 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1705 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1706 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1707 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1708 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1709 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1710 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1712 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1714 for (j
= 0; j
< argc
; j
++)
1719 if (fp
!= stdin
) fclose(fp
);
1723 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1724 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1725 fprintf(stderr
, ">>> '%s'\n", line
);
1726 fprintf(stderr
, "%s\n", err
);
1730 static void freeClientArgv(redisClient
*c
) {
1733 for (j
= 0; j
< c
->argc
; j
++)
1734 decrRefCount(c
->argv
[j
]);
1735 for (j
= 0; j
< c
->mbargc
; j
++)
1736 decrRefCount(c
->mbargv
[j
]);
1741 static void freeClient(redisClient
*c
) {
1744 /* Note that if the client we are freeing is blocked into a blocking
1745 * call, we have to set querybuf to NULL *before* to call
1746 * unblockClientWaitingData() to avoid processInputBuffer() will get
1747 * called. Also it is important to remove the file events after
1748 * this, because this call adds the READABLE event. */
1749 sdsfree(c
->querybuf
);
1751 if (c
->flags
& REDIS_BLOCKED
)
1752 unblockClientWaitingData(c
);
1754 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1755 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1756 listRelease(c
->reply
);
1759 /* Remove from the list of clients */
1760 ln
= listSearchKey(server
.clients
,c
);
1761 redisAssert(ln
!= NULL
);
1762 listDelNode(server
.clients
,ln
);
1763 /* Remove from the list of clients waiting for swapped keys */
1764 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1765 ln
= listSearchKey(server
.io_ready_clients
,c
);
1767 listDelNode(server
.io_ready_clients
,ln
);
1768 server
.vm_blocked_clients
--;
1771 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1772 ln
= listFirst(c
->io_keys
);
1773 dontWaitForSwappedKey(c
,ln
->value
);
1775 listRelease(c
->io_keys
);
1777 if (c
->flags
& REDIS_SLAVE
) {
1778 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1780 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1781 ln
= listSearchKey(l
,c
);
1782 redisAssert(ln
!= NULL
);
1785 if (c
->flags
& REDIS_MASTER
) {
1786 server
.master
= NULL
;
1787 server
.replstate
= REDIS_REPL_CONNECT
;
1791 freeClientMultiState(c
);
1795 #define GLUEREPLY_UP_TO (1024)
1796 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1798 char buf
[GLUEREPLY_UP_TO
];
1803 listRewind(c
->reply
,&li
);
1804 while((ln
= listNext(&li
))) {
1808 objlen
= sdslen(o
->ptr
);
1809 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1810 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1812 listDelNode(c
->reply
,ln
);
1814 if (copylen
== 0) return;
1818 /* Now the output buffer is empty, add the new single element */
1819 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1820 listAddNodeHead(c
->reply
,o
);
1823 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1824 redisClient
*c
= privdata
;
1825 int nwritten
= 0, totwritten
= 0, objlen
;
1828 REDIS_NOTUSED(mask
);
1830 /* Use writev() if we have enough buffers to send */
1831 if (!server
.glueoutputbuf
&&
1832 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1833 !(c
->flags
& REDIS_MASTER
))
1835 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1839 while(listLength(c
->reply
)) {
1840 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1841 glueReplyBuffersIfNeeded(c
);
1843 o
= listNodeValue(listFirst(c
->reply
));
1844 objlen
= sdslen(o
->ptr
);
1847 listDelNode(c
->reply
,listFirst(c
->reply
));
1851 if (c
->flags
& REDIS_MASTER
) {
1852 /* Don't reply to a master */
1853 nwritten
= objlen
- c
->sentlen
;
1855 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1856 if (nwritten
<= 0) break;
1858 c
->sentlen
+= nwritten
;
1859 totwritten
+= nwritten
;
1860 /* If we fully sent the object on head go to the next one */
1861 if (c
->sentlen
== objlen
) {
1862 listDelNode(c
->reply
,listFirst(c
->reply
));
1865 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1866 * bytes, in a single threaded server it's a good idea to serve
1867 * other clients as well, even if a very large request comes from
1868 * super fast link that is always able to accept data (in real world
1869 * scenario think about 'KEYS *' against the loopback interfae) */
1870 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1872 if (nwritten
== -1) {
1873 if (errno
== EAGAIN
) {
1876 redisLog(REDIS_VERBOSE
,
1877 "Error writing to client: %s", strerror(errno
));
1882 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1883 if (listLength(c
->reply
) == 0) {
1885 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1889 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1891 redisClient
*c
= privdata
;
1892 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1894 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1895 int offset
, ion
= 0;
1897 REDIS_NOTUSED(mask
);
1900 while (listLength(c
->reply
)) {
1901 offset
= c
->sentlen
;
1905 /* fill-in the iov[] array */
1906 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1907 o
= listNodeValue(node
);
1908 objlen
= sdslen(o
->ptr
);
1910 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1913 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1914 break; /* no more iovecs */
1916 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1917 iov
[ion
].iov_len
= objlen
- offset
;
1918 willwrite
+= objlen
- offset
;
1919 offset
= 0; /* just for the first item */
1926 /* write all collected blocks at once */
1927 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1928 if (errno
!= EAGAIN
) {
1929 redisLog(REDIS_VERBOSE
,
1930 "Error writing to client: %s", strerror(errno
));
1937 totwritten
+= nwritten
;
1938 offset
= c
->sentlen
;
1940 /* remove written robjs from c->reply */
1941 while (nwritten
&& listLength(c
->reply
)) {
1942 o
= listNodeValue(listFirst(c
->reply
));
1943 objlen
= sdslen(o
->ptr
);
1945 if(nwritten
>= objlen
- offset
) {
1946 listDelNode(c
->reply
, listFirst(c
->reply
));
1947 nwritten
-= objlen
- offset
;
1951 c
->sentlen
+= nwritten
;
1959 c
->lastinteraction
= time(NULL
);
1961 if (listLength(c
->reply
) == 0) {
1963 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1967 static struct redisCommand
*lookupCommand(char *name
) {
1969 while(cmdTable
[j
].name
!= NULL
) {
1970 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1976 /* resetClient prepare the client to process the next command */
1977 static void resetClient(redisClient
*c
) {
1983 /* Call() is the core of Redis execution of a command */
1984 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1987 dirty
= server
.dirty
;
1989 if (server
.appendonly
&& server
.dirty
-dirty
)
1990 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1991 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1992 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1993 if (listLength(server
.monitors
))
1994 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1995 server
.stat_numcommands
++;
1998 /* If this function gets called we already read a whole
1999 * command, argments are in the client argv/argc fields.
2000 * processCommand() execute the command or prepare the
2001 * server for a bulk read from the client.
2003 * If 1 is returned the client is still alive and valid and
2004 * and other operations can be performed by the caller. Otherwise
2005 * if 0 is returned the client was destroied (i.e. after QUIT). */
2006 static int processCommand(redisClient
*c
) {
2007 struct redisCommand
*cmd
;
2009 /* Free some memory if needed (maxmemory setting) */
2010 if (server
.maxmemory
) freeMemoryIfNeeded();
2012 /* Handle the multi bulk command type. This is an alternative protocol
2013 * supported by Redis in order to receive commands that are composed of
2014 * multiple binary-safe "bulk" arguments. The latency of processing is
2015 * a bit higher but this allows things like multi-sets, so if this
2016 * protocol is used only for MSET and similar commands this is a big win. */
2017 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2018 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2019 if (c
->multibulk
<= 0) {
2023 decrRefCount(c
->argv
[c
->argc
-1]);
2027 } else if (c
->multibulk
) {
2028 if (c
->bulklen
== -1) {
2029 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2030 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2034 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2035 decrRefCount(c
->argv
[0]);
2036 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2038 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2043 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2047 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2048 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2052 if (c
->multibulk
== 0) {
2056 /* Here we need to swap the multi-bulk argc/argv with the
2057 * normal argc/argv of the client structure. */
2059 c
->argv
= c
->mbargv
;
2060 c
->mbargv
= auxargv
;
2063 c
->argc
= c
->mbargc
;
2064 c
->mbargc
= auxargc
;
2066 /* We need to set bulklen to something different than -1
2067 * in order for the code below to process the command without
2068 * to try to read the last argument of a bulk command as
2069 * a special argument. */
2071 /* continue below and process the command */
2078 /* -- end of multi bulk commands processing -- */
2080 /* The QUIT command is handled as a special case. Normal command
2081 * procs are unable to close the client connection safely */
2082 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2087 /* Now lookup the command and check ASAP about trivial error conditions
2088 * such wrong arity, bad command name and so forth. */
2089 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2092 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2093 (char*)c
->argv
[0]->ptr
));
2096 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2097 (c
->argc
< -cmd
->arity
)) {
2099 sdscatprintf(sdsempty(),
2100 "-ERR wrong number of arguments for '%s' command\r\n",
2104 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2105 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2108 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2109 /* This is a bulk command, we have to read the last argument yet. */
2110 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2112 decrRefCount(c
->argv
[c
->argc
-1]);
2113 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2115 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2120 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2121 /* It is possible that the bulk read is already in the
2122 * buffer. Check this condition and handle it accordingly.
2123 * This is just a fast path, alternative to call processInputBuffer().
2124 * It's a good idea since the code is small and this condition
2125 * happens most of the times. */
2126 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2127 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2129 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2131 /* Otherwise return... there is to read the last argument
2132 * from the socket. */
2136 /* Let's try to share objects on the command arguments vector */
2137 if (server
.shareobjects
) {
2139 for(j
= 1; j
< c
->argc
; j
++)
2140 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2142 /* Let's try to encode the bulk object to save space. */
2143 if (cmd
->flags
& REDIS_CMD_BULK
)
2144 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2146 /* Check if the user is authenticated */
2147 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2148 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2153 /* Exec the command */
2154 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2155 queueMultiCommand(c
,cmd
);
2156 addReply(c
,shared
.queued
);
2158 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2159 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2163 /* Prepare the client for the next command */
2168 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2173 /* (args*2)+1 is enough room for args, spaces, newlines */
2174 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2176 if (argc
<= REDIS_STATIC_ARGS
) {
2179 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2182 for (j
= 0; j
< argc
; j
++) {
2183 if (j
!= 0) outv
[outc
++] = shared
.space
;
2184 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2187 lenobj
= createObject(REDIS_STRING
,
2188 sdscatprintf(sdsempty(),"%lu\r\n",
2189 (unsigned long) stringObjectLen(argv
[j
])));
2190 lenobj
->refcount
= 0;
2191 outv
[outc
++] = lenobj
;
2193 outv
[outc
++] = argv
[j
];
2195 outv
[outc
++] = shared
.crlf
;
2197 /* Increment all the refcounts at start and decrement at end in order to
2198 * be sure to free objects if there is no slave in a replication state
2199 * able to be feed with commands */
2200 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2201 listRewind(slaves
,&li
);
2202 while((ln
= listNext(&li
))) {
2203 redisClient
*slave
= ln
->value
;
2205 /* Don't feed slaves that are still waiting for BGSAVE to start */
2206 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2208 /* Feed all the other slaves, MONITORs and so on */
2209 if (slave
->slaveseldb
!= dictid
) {
2213 case 0: selectcmd
= shared
.select0
; break;
2214 case 1: selectcmd
= shared
.select1
; break;
2215 case 2: selectcmd
= shared
.select2
; break;
2216 case 3: selectcmd
= shared
.select3
; break;
2217 case 4: selectcmd
= shared
.select4
; break;
2218 case 5: selectcmd
= shared
.select5
; break;
2219 case 6: selectcmd
= shared
.select6
; break;
2220 case 7: selectcmd
= shared
.select7
; break;
2221 case 8: selectcmd
= shared
.select8
; break;
2222 case 9: selectcmd
= shared
.select9
; break;
2224 selectcmd
= createObject(REDIS_STRING
,
2225 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2226 selectcmd
->refcount
= 0;
2229 addReply(slave
,selectcmd
);
2230 slave
->slaveseldb
= dictid
;
2232 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2234 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2235 if (outv
!= static_outv
) zfree(outv
);
2238 static void processInputBuffer(redisClient
*c
) {
2240 /* Before to process the input buffer, make sure the client is not
2241 * waitig for a blocking operation such as BLPOP. Note that the first
2242 * iteration the client is never blocked, otherwise the processInputBuffer
2243 * would not be called at all, but after the execution of the first commands
2244 * in the input buffer the client may be blocked, and the "goto again"
2245 * will try to reiterate. The following line will make it return asap. */
2246 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2247 if (c
->bulklen
== -1) {
2248 /* Read the first line of the query */
2249 char *p
= strchr(c
->querybuf
,'\n');
2256 query
= c
->querybuf
;
2257 c
->querybuf
= sdsempty();
2258 querylen
= 1+(p
-(query
));
2259 if (sdslen(query
) > querylen
) {
2260 /* leave data after the first line of the query in the buffer */
2261 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2263 *p
= '\0'; /* remove "\n" */
2264 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2265 sdsupdatelen(query
);
2267 /* Now we can split the query in arguments */
2268 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2271 if (c
->argv
) zfree(c
->argv
);
2272 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2274 for (j
= 0; j
< argc
; j
++) {
2275 if (sdslen(argv
[j
])) {
2276 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2284 /* Execute the command. If the client is still valid
2285 * after processCommand() return and there is something
2286 * on the query buffer try to process the next command. */
2287 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2289 /* Nothing to process, argc == 0. Just process the query
2290 * buffer if it's not empty or return to the caller */
2291 if (sdslen(c
->querybuf
)) goto again
;
2294 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2295 redisLog(REDIS_VERBOSE
, "Client protocol error");
2300 /* Bulk read handling. Note that if we are at this point
2301 the client already sent a command terminated with a newline,
2302 we are reading the bulk data that is actually the last
2303 argument of the command. */
2304 int qbl
= sdslen(c
->querybuf
);
2306 if (c
->bulklen
<= qbl
) {
2307 /* Copy everything but the final CRLF as final argument */
2308 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2310 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2311 /* Process the command. If the client is still valid after
2312 * the processing and there is more data in the buffer
2313 * try to parse it. */
2314 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2320 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2321 redisClient
*c
= (redisClient
*) privdata
;
2322 char buf
[REDIS_IOBUF_LEN
];
2325 REDIS_NOTUSED(mask
);
2327 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2329 if (errno
== EAGAIN
) {
2332 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2336 } else if (nread
== 0) {
2337 redisLog(REDIS_VERBOSE
, "Client closed connection");
2342 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2343 c
->lastinteraction
= time(NULL
);
2347 if (!(c
->flags
& REDIS_BLOCKED
))
2348 processInputBuffer(c
);
2351 static int selectDb(redisClient
*c
, int id
) {
2352 if (id
< 0 || id
>= server
.dbnum
)
2354 c
->db
= &server
.db
[id
];
2358 static void *dupClientReplyValue(void *o
) {
2359 incrRefCount((robj
*)o
);
2363 static redisClient
*createClient(int fd
) {
2364 redisClient
*c
= zmalloc(sizeof(*c
));
2366 anetNonBlock(NULL
,fd
);
2367 anetTcpNoDelay(NULL
,fd
);
2368 if (!c
) return NULL
;
2371 c
->querybuf
= sdsempty();
2380 c
->lastinteraction
= time(NULL
);
2381 c
->authenticated
= 0;
2382 c
->replstate
= REDIS_REPL_NONE
;
2383 c
->reply
= listCreate();
2384 listSetFreeMethod(c
->reply
,decrRefCount
);
2385 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2386 c
->blockingkeys
= NULL
;
2387 c
->blockingkeysnum
= 0;
2388 c
->io_keys
= listCreate();
2389 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2390 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2391 readQueryFromClient
, c
) == AE_ERR
) {
2395 listAddNodeTail(server
.clients
,c
);
2396 initClientMultiState(c
);
2400 static void addReply(redisClient
*c
, robj
*obj
) {
2401 if (listLength(c
->reply
) == 0 &&
2402 (c
->replstate
== REDIS_REPL_NONE
||
2403 c
->replstate
== REDIS_REPL_ONLINE
) &&
2404 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2405 sendReplyToClient
, c
) == AE_ERR
) return;
2407 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2408 obj
= dupStringObject(obj
);
2409 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2411 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2414 static void addReplySds(redisClient
*c
, sds s
) {
2415 robj
*o
= createObject(REDIS_STRING
,s
);
2420 static void addReplyDouble(redisClient
*c
, double d
) {
2423 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2424 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2425 (unsigned long) strlen(buf
),buf
));
2428 static void addReplyLong(redisClient
*c
, long l
) {
2432 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2433 addReplySds(c
,sdsnewlen(buf
,len
));
2436 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2439 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2440 len
= sdslen(obj
->ptr
);
2442 long n
= (long)obj
->ptr
;
2444 /* Compute how many bytes will take this integer as a radix 10 string */
2450 while((n
= n
/10) != 0) {
2454 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2457 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2462 REDIS_NOTUSED(mask
);
2463 REDIS_NOTUSED(privdata
);
2465 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2466 if (cfd
== AE_ERR
) {
2467 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2470 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2471 if ((c
= createClient(cfd
)) == NULL
) {
2472 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2473 close(cfd
); /* May be already closed, just ingore errors */
2476 /* If maxclient directive is set and this is one client more... close the
2477 * connection. Note that we create the client instead to check before
2478 * for this condition, since now the socket is already set in nonblocking
2479 * mode and we can send an error for free using the Kernel I/O */
2480 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2481 char *err
= "-ERR max number of clients reached\r\n";
2483 /* That's a best effort error message, don't check write errors */
2484 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2485 /* Nothing to do, Just to avoid the warning... */
2490 server
.stat_numconnections
++;
2493 /* ======================= Redis objects implementation ===================== */
2495 static robj
*createObject(int type
, void *ptr
) {
2498 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2499 if (listLength(server
.objfreelist
)) {
2500 listNode
*head
= listFirst(server
.objfreelist
);
2501 o
= listNodeValue(head
);
2502 listDelNode(server
.objfreelist
,head
);
2503 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2505 if (server
.vm_enabled
) {
2506 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2507 o
= zmalloc(sizeof(*o
));
2509 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2513 o
->encoding
= REDIS_ENCODING_RAW
;
2516 if (server
.vm_enabled
) {
2517 /* Note that this code may run in the context of an I/O thread
2518 * and accessing to server.unixtime in theory is an error
2519 * (no locks). But in practice this is safe, and even if we read
2520 * garbage Redis will not fail, as it's just a statistical info */
2521 o
->vm
.atime
= server
.unixtime
;
2522 o
->storage
= REDIS_VM_MEMORY
;
2527 static robj
*createStringObject(char *ptr
, size_t len
) {
2528 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2531 static robj
*dupStringObject(robj
*o
) {
2532 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2533 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2536 static robj
*createListObject(void) {
2537 list
*l
= listCreate();
2539 listSetFreeMethod(l
,decrRefCount
);
2540 return createObject(REDIS_LIST
,l
);
2543 static robj
*createSetObject(void) {
2544 dict
*d
= dictCreate(&setDictType
,NULL
);
2545 return createObject(REDIS_SET
,d
);
2548 static robj
*createZsetObject(void) {
2549 zset
*zs
= zmalloc(sizeof(*zs
));
2551 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2552 zs
->zsl
= zslCreate();
2553 return createObject(REDIS_ZSET
,zs
);
2556 static void freeStringObject(robj
*o
) {
2557 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2562 static void freeListObject(robj
*o
) {
2563 listRelease((list
*) o
->ptr
);
2566 static void freeSetObject(robj
*o
) {
2567 dictRelease((dict
*) o
->ptr
);
2570 static void freeZsetObject(robj
*o
) {
2573 dictRelease(zs
->dict
);
2578 static void freeHashObject(robj
*o
) {
2579 dictRelease((dict
*) o
->ptr
);
2582 static void incrRefCount(robj
*o
) {
2583 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2587 static void decrRefCount(void *obj
) {
2590 /* Object is a key of a swapped out value, or in the process of being
2592 if (server
.vm_enabled
&&
2593 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2595 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2596 redisAssert(o
->refcount
== 1);
2598 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2599 redisAssert(o
->type
== REDIS_STRING
);
2600 freeStringObject(o
);
2601 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2602 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2603 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2604 !listAddNodeHead(server
.objfreelist
,o
))
2606 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2607 server
.vm_stats_swapped_objects
--;
2610 /* Object is in memory, or in the process of being swapped out. */
2611 if (--(o
->refcount
) == 0) {
2612 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2613 vmCancelThreadedIOJob(obj
);
2615 case REDIS_STRING
: freeStringObject(o
); break;
2616 case REDIS_LIST
: freeListObject(o
); break;
2617 case REDIS_SET
: freeSetObject(o
); break;
2618 case REDIS_ZSET
: freeZsetObject(o
); break;
2619 case REDIS_HASH
: freeHashObject(o
); break;
2620 default: redisAssert(0 != 0); break;
2622 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2623 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2624 !listAddNodeHead(server
.objfreelist
,o
))
2626 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2630 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2631 dictEntry
*de
= dictFind(db
->dict
,key
);
2633 robj
*key
= dictGetEntryKey(de
);
2634 robj
*val
= dictGetEntryVal(de
);
2636 if (server
.vm_enabled
) {
2637 if (key
->storage
== REDIS_VM_MEMORY
||
2638 key
->storage
== REDIS_VM_SWAPPING
)
2640 /* If we were swapping the object out, stop it, this key
2642 if (key
->storage
== REDIS_VM_SWAPPING
)
2643 vmCancelThreadedIOJob(key
);
2644 /* Update the access time of the key for the aging algorithm. */
2645 key
->vm
.atime
= server
.unixtime
;
2647 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2649 /* Our value was swapped on disk. Bring it at home. */
2650 redisAssert(val
== NULL
);
2651 val
= vmLoadObject(key
);
2652 dictGetEntryVal(de
) = val
;
2654 /* Clients blocked by the VM subsystem may be waiting for
2656 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2665 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2666 expireIfNeeded(db
,key
);
2667 return lookupKey(db
,key
);
2670 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2671 deleteIfVolatile(db
,key
);
2672 return lookupKey(db
,key
);
2675 static int deleteKey(redisDb
*db
, robj
*key
) {
2678 /* We need to protect key from destruction: after the first dictDelete()
2679 * it may happen that 'key' is no longer valid if we don't increment
2680 * it's count. This may happen when we get the object reference directly
2681 * from the hash table with dictRandomKey() or dict iterators */
2683 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2684 retval
= dictDelete(db
->dict
,key
);
2687 return retval
== DICT_OK
;
2690 /* Try to share an object against the shared objects pool */
2691 static robj
*tryObjectSharing(robj
*o
) {
2692 struct dictEntry
*de
;
2695 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2697 redisAssert(o
->type
== REDIS_STRING
);
2698 de
= dictFind(server
.sharingpool
,o
);
2700 robj
*shared
= dictGetEntryKey(de
);
2702 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2703 dictGetEntryVal(de
) = (void*) c
;
2704 incrRefCount(shared
);
2708 /* Here we are using a stream algorihtm: Every time an object is
2709 * shared we increment its count, everytime there is a miss we
2710 * recrement the counter of a random object. If this object reaches
2711 * zero we remove the object and put the current object instead. */
2712 if (dictSize(server
.sharingpool
) >=
2713 server
.sharingpoolsize
) {
2714 de
= dictGetRandomKey(server
.sharingpool
);
2715 redisAssert(de
!= NULL
);
2716 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2717 dictGetEntryVal(de
) = (void*) c
;
2719 dictDelete(server
.sharingpool
,de
->key
);
2722 c
= 0; /* If the pool is empty we want to add this object */
2727 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2728 redisAssert(retval
== DICT_OK
);
2735 /* Check if the nul-terminated string 's' can be represented by a long
2736 * (that is, is a number that fits into long without any other space or
2737 * character before or after the digits).
2739 * If so, the function returns REDIS_OK and *longval is set to the value
2740 * of the number. Otherwise REDIS_ERR is returned */
2741 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2742 char buf
[32], *endptr
;
2746 value
= strtol(s
, &endptr
, 10);
2747 if (endptr
[0] != '\0') return REDIS_ERR
;
2748 slen
= snprintf(buf
,32,"%ld",value
);
2750 /* If the number converted back into a string is not identical
2751 * then it's not possible to encode the string as integer */
2752 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2753 if (longval
) *longval
= value
;
2757 /* Try to encode a string object in order to save space */
2758 static int tryObjectEncoding(robj
*o
) {
2762 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2763 return REDIS_ERR
; /* Already encoded */
2765 /* It's not save to encode shared objects: shared objects can be shared
2766 * everywhere in the "object space" of Redis. Encoded objects can only
2767 * appear as "values" (and not, for instance, as keys) */
2768 if (o
->refcount
> 1) return REDIS_ERR
;
2770 /* Currently we try to encode only strings */
2771 redisAssert(o
->type
== REDIS_STRING
);
2773 /* Check if we can represent this string as a long integer */
2774 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2776 /* Ok, this object can be encoded */
2777 o
->encoding
= REDIS_ENCODING_INT
;
2779 o
->ptr
= (void*) value
;
2783 /* Get a decoded version of an encoded object (returned as a new object).
2784 * If the object is already raw-encoded just increment the ref count. */
2785 static robj
*getDecodedObject(robj
*o
) {
2788 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2792 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2795 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2796 dec
= createStringObject(buf
,strlen(buf
));
2799 redisAssert(1 != 1);
2803 /* Compare two string objects via strcmp() or alike.
2804 * Note that the objects may be integer-encoded. In such a case we
2805 * use snprintf() to get a string representation of the numbers on the stack
2806 * and compare the strings, it's much faster than calling getDecodedObject().
2808 * Important note: if objects are not integer encoded, but binary-safe strings,
2809 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2811 static int compareStringObjects(robj
*a
, robj
*b
) {
2812 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2813 char bufa
[128], bufb
[128], *astr
, *bstr
;
2816 if (a
== b
) return 0;
2817 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2818 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2824 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2825 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2831 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2834 static size_t stringObjectLen(robj
*o
) {
2835 redisAssert(o
->type
== REDIS_STRING
);
2836 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2837 return sdslen(o
->ptr
);
2841 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2845 /*============================ RDB saving/loading =========================== */
2847 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2848 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2852 static int rdbSaveTime(FILE *fp
, time_t t
) {
2853 int32_t t32
= (int32_t) t
;
2854 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2858 /* check rdbLoadLen() comments for more info */
2859 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2860 unsigned char buf
[2];
2863 /* Save a 6 bit len */
2864 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2865 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2866 } else if (len
< (1<<14)) {
2867 /* Save a 14 bit len */
2868 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2870 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2872 /* Save a 32 bit len */
2873 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2874 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2876 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2881 /* String objects in the form "2391" "-100" without any space and with a
2882 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2883 * encoded as integers to save space */
2884 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2886 char *endptr
, buf
[32];
2888 /* Check if it's possible to encode this value as a number */
2889 value
= strtoll(s
, &endptr
, 10);
2890 if (endptr
[0] != '\0') return 0;
2891 snprintf(buf
,32,"%lld",value
);
2893 /* If the number converted back into a string is not identical
2894 * then it's not possible to encode the string as integer */
2895 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2897 /* Finally check if it fits in our ranges */
2898 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2899 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2900 enc
[1] = value
&0xFF;
2902 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2903 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2904 enc
[1] = value
&0xFF;
2905 enc
[2] = (value
>>8)&0xFF;
2907 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2908 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2909 enc
[1] = value
&0xFF;
2910 enc
[2] = (value
>>8)&0xFF;
2911 enc
[3] = (value
>>16)&0xFF;
2912 enc
[4] = (value
>>24)&0xFF;
2919 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2920 unsigned int comprlen
, outlen
;
2924 /* We require at least four bytes compression for this to be worth it */
2925 outlen
= sdslen(obj
->ptr
)-4;
2926 if (outlen
<= 0) return 0;
2927 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2928 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2929 if (comprlen
== 0) {
2933 /* Data compressed! Let's save it on disk */
2934 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2935 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2936 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2937 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2938 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2947 /* Save a string objet as [len][data] on disk. If the object is a string
2948 * representation of an integer value we try to safe it in a special form */
2949 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2953 len
= sdslen(obj
->ptr
);
2955 /* Try integer encoding */
2957 unsigned char buf
[5];
2958 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2959 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2964 /* Try LZF compression - under 20 bytes it's unable to compress even
2965 * aaaaaaaaaaaaaaaaaa so skip it */
2966 if (server
.rdbcompression
&& len
> 20) {
2969 retval
= rdbSaveLzfStringObject(fp
,obj
);
2970 if (retval
== -1) return -1;
2971 if (retval
> 0) return 0;
2972 /* retval == 0 means data can't be compressed, save the old way */
2975 /* Store verbatim */
2976 if (rdbSaveLen(fp
,len
) == -1) return -1;
2977 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2981 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2982 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2985 /* Avoid incr/decr ref count business when possible.
2986 * This plays well with copy-on-write given that we are probably
2987 * in a child process (BGSAVE). Also this makes sure key objects
2988 * of swapped objects are not incRefCount-ed (an assert does not allow
2989 * this in order to avoid bugs) */
2990 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2991 obj
= getDecodedObject(obj
);
2992 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2995 retval
= rdbSaveStringObjectRaw(fp
,obj
);
3000 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3001 * 8 bit integer specifing the length of the representation.
3002 * This 8 bit integer has special values in order to specify the following
3008 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3009 unsigned char buf
[128];
3015 } else if (!isfinite(val
)) {
3017 buf
[0] = (val
< 0) ? 255 : 254;
3019 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3020 buf
[0] = strlen((char*)buf
+1);
3023 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3027 /* Save a Redis object. */
3028 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3029 if (o
->type
== REDIS_STRING
) {
3030 /* Save a string value */
3031 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3032 } else if (o
->type
== REDIS_LIST
) {
3033 /* Save a list value */
3034 list
*list
= o
->ptr
;
3038 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3039 listRewind(list
,&li
);
3040 while((ln
= listNext(&li
))) {
3041 robj
*eleobj
= listNodeValue(ln
);
3043 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3045 } else if (o
->type
== REDIS_SET
) {
3046 /* Save a set value */
3048 dictIterator
*di
= dictGetIterator(set
);
3051 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3052 while((de
= dictNext(di
)) != NULL
) {
3053 robj
*eleobj
= dictGetEntryKey(de
);
3055 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3057 dictReleaseIterator(di
);
3058 } else if (o
->type
== REDIS_ZSET
) {
3059 /* Save a set value */
3061 dictIterator
*di
= dictGetIterator(zs
->dict
);
3064 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3065 while((de
= dictNext(di
)) != NULL
) {
3066 robj
*eleobj
= dictGetEntryKey(de
);
3067 double *score
= dictGetEntryVal(de
);
3069 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3070 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3072 dictReleaseIterator(di
);
3074 redisAssert(0 != 0);
3079 /* Return the length the object will have on disk if saved with
3080 * the rdbSaveObject() function. Currently we use a trick to get
3081 * this length with very little changes to the code. In the future
3082 * we could switch to a faster solution. */
3083 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3084 if (fp
== NULL
) fp
= server
.devnull
;
3086 assert(rdbSaveObject(fp
,o
) != 1);
3090 /* Return the number of pages required to save this object in the swap file */
3091 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3092 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3094 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3097 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3098 static int rdbSave(char *filename
) {
3099 dictIterator
*di
= NULL
;
3104 time_t now
= time(NULL
);
3106 /* Wait for I/O therads to terminate, just in case this is a
3107 * foreground-saving, to avoid seeking the swap file descriptor at the
3109 if (server
.vm_enabled
)
3110 waitEmptyIOJobsQueue();
3112 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3113 fp
= fopen(tmpfile
,"w");
3115 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3118 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3119 for (j
= 0; j
< server
.dbnum
; j
++) {
3120 redisDb
*db
= server
.db
+j
;
3122 if (dictSize(d
) == 0) continue;
3123 di
= dictGetIterator(d
);
3129 /* Write the SELECT DB opcode */
3130 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3131 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3133 /* Iterate this DB writing every entry */
3134 while((de
= dictNext(di
)) != NULL
) {
3135 robj
*key
= dictGetEntryKey(de
);
3136 robj
*o
= dictGetEntryVal(de
);
3137 time_t expiretime
= getExpire(db
,key
);
3139 /* Save the expire time */
3140 if (expiretime
!= -1) {
3141 /* If this key is already expired skip it */
3142 if (expiretime
< now
) continue;
3143 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3144 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3146 /* Save the key and associated value. This requires special
3147 * handling if the value is swapped out. */
3148 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3149 key
->storage
== REDIS_VM_SWAPPING
) {
3150 /* Save type, key, value */
3151 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3152 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3153 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3155 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3157 /* Get a preview of the object in memory */
3158 po
= vmPreviewObject(key
);
3159 /* Save type, key, value */
3160 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3161 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3162 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3163 /* Remove the loaded object from memory */
3167 dictReleaseIterator(di
);
3170 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3172 /* Make sure data will not remain on the OS's output buffers */
3177 /* Use RENAME to make sure the DB file is changed atomically only
3178 * if the generate DB file is ok. */
3179 if (rename(tmpfile
,filename
) == -1) {
3180 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3184 redisLog(REDIS_NOTICE
,"DB saved on disk");
3186 server
.lastsave
= time(NULL
);
3192 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3193 if (di
) dictReleaseIterator(di
);
3197 static int rdbSaveBackground(char *filename
) {
3200 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3201 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3202 if ((childpid
= fork()) == 0) {
3204 if (server
.vm_enabled
) vmReopenSwapFile();
3206 if (rdbSave(filename
) == REDIS_OK
) {
3213 if (childpid
== -1) {
3214 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3218 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3219 server
.bgsavechildpid
= childpid
;
3222 return REDIS_OK
; /* unreached */
3225 static void rdbRemoveTempFile(pid_t childpid
) {
3228 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3232 static int rdbLoadType(FILE *fp
) {
3234 if (fread(&type
,1,1,fp
) == 0) return -1;
3238 static time_t rdbLoadTime(FILE *fp
) {
3240 if (fread(&t32
,4,1,fp
) == 0) return -1;
3241 return (time_t) t32
;
3244 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3245 * of this file for a description of how this are stored on disk.
3247 * isencoded is set to 1 if the readed length is not actually a length but
3248 * an "encoding type", check the above comments for more info */
3249 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3250 unsigned char buf
[2];
3254 if (isencoded
) *isencoded
= 0;
3255 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3256 type
= (buf
[0]&0xC0)>>6;
3257 if (type
== REDIS_RDB_6BITLEN
) {
3258 /* Read a 6 bit len */
3260 } else if (type
== REDIS_RDB_ENCVAL
) {
3261 /* Read a 6 bit len encoding type */
3262 if (isencoded
) *isencoded
= 1;
3264 } else if (type
== REDIS_RDB_14BITLEN
) {
3265 /* Read a 14 bit len */
3266 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3267 return ((buf
[0]&0x3F)<<8)|buf
[1];
3269 /* Read a 32 bit len */
3270 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3275 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3276 unsigned char enc
[4];
3279 if (enctype
== REDIS_RDB_ENC_INT8
) {
3280 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3281 val
= (signed char)enc
[0];
3282 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3284 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3285 v
= enc
[0]|(enc
[1]<<8);
3287 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3289 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3290 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3293 val
= 0; /* anti-warning */
3296 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3299 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3300 unsigned int len
, clen
;
3301 unsigned char *c
= NULL
;
3304 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3305 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3306 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3307 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3308 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3309 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3311 return createObject(REDIS_STRING
,val
);
3318 static robj
*rdbLoadStringObject(FILE*fp
) {
3323 len
= rdbLoadLen(fp
,&isencoded
);
3326 case REDIS_RDB_ENC_INT8
:
3327 case REDIS_RDB_ENC_INT16
:
3328 case REDIS_RDB_ENC_INT32
:
3329 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3330 case REDIS_RDB_ENC_LZF
:
3331 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3337 if (len
== REDIS_RDB_LENERR
) return NULL
;
3338 val
= sdsnewlen(NULL
,len
);
3339 if (len
&& fread(val
,len
,1,fp
) == 0) {
3343 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3346 /* For information about double serialization check rdbSaveDoubleValue() */
3347 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3351 if (fread(&len
,1,1,fp
) == 0) return -1;
3353 case 255: *val
= R_NegInf
; return 0;
3354 case 254: *val
= R_PosInf
; return 0;
3355 case 253: *val
= R_Nan
; return 0;
3357 if (fread(buf
,len
,1,fp
) == 0) return -1;
3359 sscanf(buf
, "%lg", val
);
3364 /* Load a Redis object of the specified type from the specified file.
3365 * On success a newly allocated object is returned, otherwise NULL. */
3366 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3369 if (type
== REDIS_STRING
) {
3370 /* Read string value */
3371 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3372 tryObjectEncoding(o
);
3373 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3374 /* Read list/set value */
3377 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3378 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3379 /* It's faster to expand the dict to the right size asap in order
3380 * to avoid rehashing */
3381 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3382 dictExpand(o
->ptr
,listlen
);
3383 /* Load every single element of the list/set */
3387 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3388 tryObjectEncoding(ele
);
3389 if (type
== REDIS_LIST
) {
3390 listAddNodeTail((list
*)o
->ptr
,ele
);
3392 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3395 } else if (type
== REDIS_ZSET
) {
3396 /* Read list/set value */
3400 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3401 o
= createZsetObject();
3403 /* Load every single element of the list/set */
3406 double *score
= zmalloc(sizeof(double));
3408 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3409 tryObjectEncoding(ele
);
3410 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3411 dictAdd(zs
->dict
,ele
,score
);
3412 zslInsert(zs
->zsl
,*score
,ele
);
3413 incrRefCount(ele
); /* added to skiplist */
3416 redisAssert(0 != 0);
3421 static int rdbLoad(char *filename
) {
3423 robj
*keyobj
= NULL
;
3425 int type
, retval
, rdbver
;
3426 dict
*d
= server
.db
[0].dict
;
3427 redisDb
*db
= server
.db
+0;
3429 time_t expiretime
= -1, now
= time(NULL
);
3430 long long loadedkeys
= 0;
3432 fp
= fopen(filename
,"r");
3433 if (!fp
) return REDIS_ERR
;
3434 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3436 if (memcmp(buf
,"REDIS",5) != 0) {
3438 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3441 rdbver
= atoi(buf
+5);
3444 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3451 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3452 if (type
== REDIS_EXPIRETIME
) {
3453 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3454 /* We read the time so we need to read the object type again */
3455 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3457 if (type
== REDIS_EOF
) break;
3458 /* Handle SELECT DB opcode as a special case */
3459 if (type
== REDIS_SELECTDB
) {
3460 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3462 if (dbid
>= (unsigned)server
.dbnum
) {
3463 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3466 db
= server
.db
+dbid
;
3471 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3473 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3474 /* Add the new object in the hash table */
3475 retval
= dictAdd(d
,keyobj
,o
);
3476 if (retval
== DICT_ERR
) {
3477 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3480 /* Set the expire time if needed */
3481 if (expiretime
!= -1) {
3482 setExpire(db
,keyobj
,expiretime
);
3483 /* Delete this key if already expired */
3484 if (expiretime
< now
) deleteKey(db
,keyobj
);
3488 /* Handle swapping while loading big datasets when VM is on */
3490 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3491 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3492 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3499 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3500 if (keyobj
) decrRefCount(keyobj
);
3501 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3503 return REDIS_ERR
; /* Just to avoid warning */
3506 /*================================== Commands =============================== */
3508 static void authCommand(redisClient
*c
) {
3509 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3510 c
->authenticated
= 1;
3511 addReply(c
,shared
.ok
);
3513 c
->authenticated
= 0;
3514 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3518 static void pingCommand(redisClient
*c
) {
3519 addReply(c
,shared
.pong
);
3522 static void echoCommand(redisClient
*c
) {
3523 addReplyBulkLen(c
,c
->argv
[1]);
3524 addReply(c
,c
->argv
[1]);
3525 addReply(c
,shared
.crlf
);
3528 /*=================================== Strings =============================== */
3530 static void setGenericCommand(redisClient
*c
, int nx
) {
3533 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3534 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3535 if (retval
== DICT_ERR
) {
3537 /* If the key is about a swapped value, we want a new key object
3538 * to overwrite the old. So we delete the old key in the database.
3539 * This will also make sure that swap pages about the old object
3540 * will be marked as free. */
3541 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3542 incrRefCount(c
->argv
[1]);
3543 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3544 incrRefCount(c
->argv
[2]);
3546 addReply(c
,shared
.czero
);
3550 incrRefCount(c
->argv
[1]);
3551 incrRefCount(c
->argv
[2]);
3554 removeExpire(c
->db
,c
->argv
[1]);
3555 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3558 static void setCommand(redisClient
*c
) {
3559 setGenericCommand(c
,0);
3562 static void setnxCommand(redisClient
*c
) {
3563 setGenericCommand(c
,1);
3566 static int getGenericCommand(redisClient
*c
) {
3567 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3570 addReply(c
,shared
.nullbulk
);
3573 if (o
->type
!= REDIS_STRING
) {
3574 addReply(c
,shared
.wrongtypeerr
);
3577 addReplyBulkLen(c
,o
);
3579 addReply(c
,shared
.crlf
);
3585 static void getCommand(redisClient
*c
) {
3586 getGenericCommand(c
);
3589 static void getsetCommand(redisClient
*c
) {
3590 if (getGenericCommand(c
) == REDIS_ERR
) return;
3591 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3592 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3594 incrRefCount(c
->argv
[1]);
3596 incrRefCount(c
->argv
[2]);
3598 removeExpire(c
->db
,c
->argv
[1]);
3601 static void mgetCommand(redisClient
*c
) {
3604 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3605 for (j
= 1; j
< c
->argc
; j
++) {
3606 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3608 addReply(c
,shared
.nullbulk
);
3610 if (o
->type
!= REDIS_STRING
) {
3611 addReply(c
,shared
.nullbulk
);
3613 addReplyBulkLen(c
,o
);
3615 addReply(c
,shared
.crlf
);
3621 static void msetGenericCommand(redisClient
*c
, int nx
) {
3622 int j
, busykeys
= 0;
3624 if ((c
->argc
% 2) == 0) {
3625 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3628 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3629 * set nothing at all if at least one already key exists. */
3631 for (j
= 1; j
< c
->argc
; j
+= 2) {
3632 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3638 addReply(c
, shared
.czero
);
3642 for (j
= 1; j
< c
->argc
; j
+= 2) {
3645 tryObjectEncoding(c
->argv
[j
+1]);
3646 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3647 if (retval
== DICT_ERR
) {
3648 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3649 incrRefCount(c
->argv
[j
+1]);
3651 incrRefCount(c
->argv
[j
]);
3652 incrRefCount(c
->argv
[j
+1]);
3654 removeExpire(c
->db
,c
->argv
[j
]);
3656 server
.dirty
+= (c
->argc
-1)/2;
3657 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3660 static void msetCommand(redisClient
*c
) {
3661 msetGenericCommand(c
,0);
3664 static void msetnxCommand(redisClient
*c
) {
3665 msetGenericCommand(c
,1);
3668 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3673 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3677 if (o
->type
!= REDIS_STRING
) {
3682 if (o
->encoding
== REDIS_ENCODING_RAW
)
3683 value
= strtoll(o
->ptr
, &eptr
, 10);
3684 else if (o
->encoding
== REDIS_ENCODING_INT
)
3685 value
= (long)o
->ptr
;
3687 redisAssert(1 != 1);
3692 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3693 tryObjectEncoding(o
);
3694 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3695 if (retval
== DICT_ERR
) {
3696 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3697 removeExpire(c
->db
,c
->argv
[1]);
3699 incrRefCount(c
->argv
[1]);
3702 addReply(c
,shared
.colon
);
3704 addReply(c
,shared
.crlf
);
3707 static void incrCommand(redisClient
*c
) {
3708 incrDecrCommand(c
,1);
3711 static void decrCommand(redisClient
*c
) {
3712 incrDecrCommand(c
,-1);
3715 static void incrbyCommand(redisClient
*c
) {
3716 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3717 incrDecrCommand(c
,incr
);
3720 static void decrbyCommand(redisClient
*c
) {
3721 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3722 incrDecrCommand(c
,-incr
);
3725 static void appendCommand(redisClient
*c
) {
3730 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3732 /* Create the key */
3733 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3734 incrRefCount(c
->argv
[1]);
3735 incrRefCount(c
->argv
[2]);
3736 totlen
= stringObjectLen(c
->argv
[2]);
3740 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3743 o
= dictGetEntryVal(de
);
3744 if (o
->type
!= REDIS_STRING
) {
3745 addReply(c
,shared
.wrongtypeerr
);
3748 /* If the object is specially encoded or shared we have to make
3750 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3751 robj
*decoded
= getDecodedObject(o
);
3753 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3754 decrRefCount(decoded
);
3755 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3758 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3759 o
->ptr
= sdscatlen(o
->ptr
,
3760 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3762 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3763 (unsigned long) c
->argv
[2]->ptr
);
3765 totlen
= sdslen(o
->ptr
);
3768 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3771 static void substrCommand(redisClient
*c
) {
3773 long start
= atoi(c
->argv
[2]->ptr
);
3774 long end
= atoi(c
->argv
[3]->ptr
);
3776 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3778 addReply(c
,shared
.nullbulk
);
3780 if (o
->type
!= REDIS_STRING
) {
3781 addReply(c
,shared
.wrongtypeerr
);
3783 size_t rangelen
, strlen
;
3786 o
= getDecodedObject(o
);
3787 strlen
= sdslen(o
->ptr
);
3789 /* convert negative indexes */
3790 if (start
< 0) start
= strlen
+start
;
3791 if (end
< 0) end
= strlen
+end
;
3792 if (start
< 0) start
= 0;
3793 if (end
< 0) end
= 0;
3795 /* indexes sanity checks */
3796 if (start
> end
|| (size_t)start
>= strlen
) {
3797 /* Out of range start or start > end result in null reply */
3798 addReply(c
,shared
.nullbulk
);
3802 if ((size_t)end
>= strlen
) end
= strlen
-1;
3803 rangelen
= (end
-start
)+1;
3805 /* Return the result */
3806 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",rangelen
));
3807 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
3808 addReplySds(c
,range
);
3809 addReply(c
,shared
.crlf
);
3815 /* ========================= Type agnostic commands ========================= */
3817 static void delCommand(redisClient
*c
) {
3820 for (j
= 1; j
< c
->argc
; j
++) {
3821 if (deleteKey(c
->db
,c
->argv
[j
])) {
3828 addReply(c
,shared
.czero
);
3831 addReply(c
,shared
.cone
);
3834 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3839 static void existsCommand(redisClient
*c
) {
3840 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3843 static void selectCommand(redisClient
*c
) {
3844 int id
= atoi(c
->argv
[1]->ptr
);
3846 if (selectDb(c
,id
) == REDIS_ERR
) {
3847 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3849 addReply(c
,shared
.ok
);
3853 static void randomkeyCommand(redisClient
*c
) {
3857 de
= dictGetRandomKey(c
->db
->dict
);
3858 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3861 addReply(c
,shared
.plus
);
3862 addReply(c
,shared
.crlf
);
3864 addReply(c
,shared
.plus
);
3865 addReply(c
,dictGetEntryKey(de
));
3866 addReply(c
,shared
.crlf
);
3870 static void keysCommand(redisClient
*c
) {
3873 sds pattern
= c
->argv
[1]->ptr
;
3874 int plen
= sdslen(pattern
);
3875 unsigned long numkeys
= 0;
3876 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3878 di
= dictGetIterator(c
->db
->dict
);
3880 decrRefCount(lenobj
);
3881 while((de
= dictNext(di
)) != NULL
) {
3882 robj
*keyobj
= dictGetEntryKey(de
);
3884 sds key
= keyobj
->ptr
;
3885 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3886 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3887 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3888 addReplyBulkLen(c
,keyobj
);
3890 addReply(c
,shared
.crlf
);
3895 dictReleaseIterator(di
);
3896 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
3899 static void dbsizeCommand(redisClient
*c
) {
3901 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3904 static void lastsaveCommand(redisClient
*c
) {
3906 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3909 static void typeCommand(redisClient
*c
) {
3913 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3918 case REDIS_STRING
: type
= "+string"; break;
3919 case REDIS_LIST
: type
= "+list"; break;
3920 case REDIS_SET
: type
= "+set"; break;
3921 case REDIS_ZSET
: type
= "+zset"; break;
3922 default: type
= "unknown"; break;
3925 addReplySds(c
,sdsnew(type
));
3926 addReply(c
,shared
.crlf
);
3929 static void saveCommand(redisClient
*c
) {
3930 if (server
.bgsavechildpid
!= -1) {
3931 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3934 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3935 addReply(c
,shared
.ok
);
3937 addReply(c
,shared
.err
);
3941 static void bgsaveCommand(redisClient
*c
) {
3942 if (server
.bgsavechildpid
!= -1) {
3943 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3946 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3947 char *status
= "+Background saving started\r\n";
3948 addReplySds(c
,sdsnew(status
));
3950 addReply(c
,shared
.err
);
3954 static void shutdownCommand(redisClient
*c
) {
3955 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3956 /* Kill the saving child if there is a background saving in progress.
3957 We want to avoid race conditions, for instance our saving child may
3958 overwrite the synchronous saving did by SHUTDOWN. */
3959 if (server
.bgsavechildpid
!= -1) {
3960 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3961 kill(server
.bgsavechildpid
,SIGKILL
);
3962 rdbRemoveTempFile(server
.bgsavechildpid
);
3964 if (server
.appendonly
) {
3965 /* Append only file: fsync() the AOF and exit */
3966 fsync(server
.appendfd
);
3967 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3970 /* Snapshotting. Perform a SYNC SAVE and exit */
3971 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3972 if (server
.daemonize
)
3973 unlink(server
.pidfile
);
3974 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3975 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3976 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3979 /* Ooops.. error saving! The best we can do is to continue operating.
3980 * Note that if there was a background saving process, in the next
3981 * cron() Redis will be notified that the background saving aborted,
3982 * handling special stuff like slaves pending for synchronization... */
3983 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3984 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3989 static void renameGenericCommand(redisClient
*c
, int nx
) {
3992 /* To use the same key as src and dst is probably an error */
3993 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3994 addReply(c
,shared
.sameobjecterr
);
3998 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4000 addReply(c
,shared
.nokeyerr
);
4004 deleteIfVolatile(c
->db
,c
->argv
[2]);
4005 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4008 addReply(c
,shared
.czero
);
4011 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4013 incrRefCount(c
->argv
[2]);
4015 deleteKey(c
->db
,c
->argv
[1]);
4017 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4020 static void renameCommand(redisClient
*c
) {
4021 renameGenericCommand(c
,0);
4024 static void renamenxCommand(redisClient
*c
) {
4025 renameGenericCommand(c
,1);
4028 static void moveCommand(redisClient
*c
) {
4033 /* Obtain source and target DB pointers */
4036 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4037 addReply(c
,shared
.outofrangeerr
);
4041 selectDb(c
,srcid
); /* Back to the source DB */
4043 /* If the user is moving using as target the same
4044 * DB as the source DB it is probably an error. */
4046 addReply(c
,shared
.sameobjecterr
);
4050 /* Check if the element exists and get a reference */
4051 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4053 addReply(c
,shared
.czero
);
4057 /* Try to add the element to the target DB */
4058 deleteIfVolatile(dst
,c
->argv
[1]);
4059 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4060 addReply(c
,shared
.czero
);
4063 incrRefCount(c
->argv
[1]);
4066 /* OK! key moved, free the entry in the source DB */
4067 deleteKey(src
,c
->argv
[1]);
4069 addReply(c
,shared
.cone
);
4072 /* =================================== Lists ================================ */
4073 static void pushGenericCommand(redisClient
*c
, int where
) {
4077 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4079 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4080 addReply(c
,shared
.cone
);
4083 lobj
= createListObject();
4085 if (where
== REDIS_HEAD
) {
4086 listAddNodeHead(list
,c
->argv
[2]);
4088 listAddNodeTail(list
,c
->argv
[2]);
4090 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4091 incrRefCount(c
->argv
[1]);
4092 incrRefCount(c
->argv
[2]);
4094 if (lobj
->type
!= REDIS_LIST
) {
4095 addReply(c
,shared
.wrongtypeerr
);
4098 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4099 addReply(c
,shared
.cone
);
4103 if (where
== REDIS_HEAD
) {
4104 listAddNodeHead(list
,c
->argv
[2]);
4106 listAddNodeTail(list
,c
->argv
[2]);
4108 incrRefCount(c
->argv
[2]);
4111 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4114 static void lpushCommand(redisClient
*c
) {
4115 pushGenericCommand(c
,REDIS_HEAD
);
4118 static void rpushCommand(redisClient
*c
) {
4119 pushGenericCommand(c
,REDIS_TAIL
);
4122 static void llenCommand(redisClient
*c
) {
4126 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4128 addReply(c
,shared
.czero
);
4131 if (o
->type
!= REDIS_LIST
) {
4132 addReply(c
,shared
.wrongtypeerr
);
4135 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4140 static void lindexCommand(redisClient
*c
) {
4142 int index
= atoi(c
->argv
[2]->ptr
);
4144 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4146 addReply(c
,shared
.nullbulk
);
4148 if (o
->type
!= REDIS_LIST
) {
4149 addReply(c
,shared
.wrongtypeerr
);
4151 list
*list
= o
->ptr
;
4154 ln
= listIndex(list
, index
);
4156 addReply(c
,shared
.nullbulk
);
4158 robj
*ele
= listNodeValue(ln
);
4159 addReplyBulkLen(c
,ele
);
4161 addReply(c
,shared
.crlf
);
4167 static void lsetCommand(redisClient
*c
) {
4169 int index
= atoi(c
->argv
[2]->ptr
);
4171 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4173 addReply(c
,shared
.nokeyerr
);
4175 if (o
->type
!= REDIS_LIST
) {
4176 addReply(c
,shared
.wrongtypeerr
);
4178 list
*list
= o
->ptr
;
4181 ln
= listIndex(list
, index
);
4183 addReply(c
,shared
.outofrangeerr
);
4185 robj
*ele
= listNodeValue(ln
);
4188 listNodeValue(ln
) = c
->argv
[3];
4189 incrRefCount(c
->argv
[3]);
4190 addReply(c
,shared
.ok
);
4197 static void popGenericCommand(redisClient
*c
, int where
) {
4200 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4202 addReply(c
,shared
.nullbulk
);
4204 if (o
->type
!= REDIS_LIST
) {
4205 addReply(c
,shared
.wrongtypeerr
);
4207 list
*list
= o
->ptr
;
4210 if (where
== REDIS_HEAD
)
4211 ln
= listFirst(list
);
4213 ln
= listLast(list
);
4216 addReply(c
,shared
.nullbulk
);
4218 robj
*ele
= listNodeValue(ln
);
4219 addReplyBulkLen(c
,ele
);
4221 addReply(c
,shared
.crlf
);
4222 listDelNode(list
,ln
);
4229 static void lpopCommand(redisClient
*c
) {
4230 popGenericCommand(c
,REDIS_HEAD
);
4233 static void rpopCommand(redisClient
*c
) {
4234 popGenericCommand(c
,REDIS_TAIL
);
4237 static void lrangeCommand(redisClient
*c
) {
4239 int start
= atoi(c
->argv
[2]->ptr
);
4240 int end
= atoi(c
->argv
[3]->ptr
);
4242 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4244 addReply(c
,shared
.nullmultibulk
);
4246 if (o
->type
!= REDIS_LIST
) {
4247 addReply(c
,shared
.wrongtypeerr
);
4249 list
*list
= o
->ptr
;
4251 int llen
= listLength(list
);
4255 /* convert negative indexes */
4256 if (start
< 0) start
= llen
+start
;
4257 if (end
< 0) end
= llen
+end
;
4258 if (start
< 0) start
= 0;
4259 if (end
< 0) end
= 0;
4261 /* indexes sanity checks */
4262 if (start
> end
|| start
>= llen
) {
4263 /* Out of range start or start > end result in empty list */
4264 addReply(c
,shared
.emptymultibulk
);
4267 if (end
>= llen
) end
= llen
-1;
4268 rangelen
= (end
-start
)+1;
4270 /* Return the result in form of a multi-bulk reply */
4271 ln
= listIndex(list
, start
);
4272 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4273 for (j
= 0; j
< rangelen
; j
++) {
4274 ele
= listNodeValue(ln
);
4275 addReplyBulkLen(c
,ele
);
4277 addReply(c
,shared
.crlf
);
4284 static void ltrimCommand(redisClient
*c
) {
4286 int start
= atoi(c
->argv
[2]->ptr
);
4287 int end
= atoi(c
->argv
[3]->ptr
);
4289 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4291 addReply(c
,shared
.ok
);
4293 if (o
->type
!= REDIS_LIST
) {
4294 addReply(c
,shared
.wrongtypeerr
);
4296 list
*list
= o
->ptr
;
4298 int llen
= listLength(list
);
4299 int j
, ltrim
, rtrim
;
4301 /* convert negative indexes */
4302 if (start
< 0) start
= llen
+start
;
4303 if (end
< 0) end
= llen
+end
;
4304 if (start
< 0) start
= 0;
4305 if (end
< 0) end
= 0;
4307 /* indexes sanity checks */
4308 if (start
> end
|| start
>= llen
) {
4309 /* Out of range start or start > end result in empty list */
4313 if (end
>= llen
) end
= llen
-1;
4318 /* Remove list elements to perform the trim */
4319 for (j
= 0; j
< ltrim
; j
++) {
4320 ln
= listFirst(list
);
4321 listDelNode(list
,ln
);
4323 for (j
= 0; j
< rtrim
; j
++) {
4324 ln
= listLast(list
);
4325 listDelNode(list
,ln
);
4328 addReply(c
,shared
.ok
);
4333 static void lremCommand(redisClient
*c
) {
4336 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4338 addReply(c
,shared
.czero
);
4340 if (o
->type
!= REDIS_LIST
) {
4341 addReply(c
,shared
.wrongtypeerr
);
4343 list
*list
= o
->ptr
;
4344 listNode
*ln
, *next
;
4345 int toremove
= atoi(c
->argv
[2]->ptr
);
4350 toremove
= -toremove
;
4353 ln
= fromtail
? list
->tail
: list
->head
;
4355 robj
*ele
= listNodeValue(ln
);
4357 next
= fromtail
? ln
->prev
: ln
->next
;
4358 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4359 listDelNode(list
,ln
);
4362 if (toremove
&& removed
== toremove
) break;
4366 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4371 /* This is the semantic of this command:
4372 * RPOPLPUSH srclist dstlist:
4373 * IF LLEN(srclist) > 0
4374 * element = RPOP srclist
4375 * LPUSH dstlist element
4382 * The idea is to be able to get an element from a list in a reliable way
4383 * since the element is not just returned but pushed against another list
4384 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4386 static void rpoplpushcommand(redisClient
*c
) {
4389 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4391 addReply(c
,shared
.nullbulk
);
4393 if (sobj
->type
!= REDIS_LIST
) {
4394 addReply(c
,shared
.wrongtypeerr
);
4396 list
*srclist
= sobj
->ptr
;
4397 listNode
*ln
= listLast(srclist
);
4400 addReply(c
,shared
.nullbulk
);
4402 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4403 robj
*ele
= listNodeValue(ln
);
4406 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4407 addReply(c
,shared
.wrongtypeerr
);
4411 /* Add the element to the target list (unless it's directly
4412 * passed to some BLPOP-ing client */
4413 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4415 /* Create the list if the key does not exist */
4416 dobj
= createListObject();
4417 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4418 incrRefCount(c
->argv
[2]);
4420 dstlist
= dobj
->ptr
;
4421 listAddNodeHead(dstlist
,ele
);
4425 /* Send the element to the client as reply as well */
4426 addReplyBulkLen(c
,ele
);
4428 addReply(c
,shared
.crlf
);
4430 /* Finally remove the element from the source list */
4431 listDelNode(srclist
,ln
);
4439 /* ==================================== Sets ================================ */
4441 static void saddCommand(redisClient
*c
) {
4444 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4446 set
= createSetObject();
4447 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4448 incrRefCount(c
->argv
[1]);
4450 if (set
->type
!= REDIS_SET
) {
4451 addReply(c
,shared
.wrongtypeerr
);
4455 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4456 incrRefCount(c
->argv
[2]);
4458 addReply(c
,shared
.cone
);
4460 addReply(c
,shared
.czero
);
4464 static void sremCommand(redisClient
*c
) {
4467 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4469 addReply(c
,shared
.czero
);
4471 if (set
->type
!= REDIS_SET
) {
4472 addReply(c
,shared
.wrongtypeerr
);
4475 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4477 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4478 addReply(c
,shared
.cone
);
4480 addReply(c
,shared
.czero
);
4485 static void smoveCommand(redisClient
*c
) {
4486 robj
*srcset
, *dstset
;
4488 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4489 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4491 /* If the source key does not exist return 0, if it's of the wrong type
4493 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4494 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4497 /* Error if the destination key is not a set as well */
4498 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4499 addReply(c
,shared
.wrongtypeerr
);
4502 /* Remove the element from the source set */
4503 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4504 /* Key not found in the src set! return zero */
4505 addReply(c
,shared
.czero
);
4509 /* Add the element to the destination set */
4511 dstset
= createSetObject();
4512 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4513 incrRefCount(c
->argv
[2]);
4515 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4516 incrRefCount(c
->argv
[3]);
4517 addReply(c
,shared
.cone
);
4520 static void sismemberCommand(redisClient
*c
) {
4523 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4525 addReply(c
,shared
.czero
);
4527 if (set
->type
!= REDIS_SET
) {
4528 addReply(c
,shared
.wrongtypeerr
);
4531 if (dictFind(set
->ptr
,c
->argv
[2]))
4532 addReply(c
,shared
.cone
);
4534 addReply(c
,shared
.czero
);
4538 static void scardCommand(redisClient
*c
) {
4542 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4544 addReply(c
,shared
.czero
);
4547 if (o
->type
!= REDIS_SET
) {
4548 addReply(c
,shared
.wrongtypeerr
);
4551 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4557 static void spopCommand(redisClient
*c
) {
4561 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4563 addReply(c
,shared
.nullbulk
);
4565 if (set
->type
!= REDIS_SET
) {
4566 addReply(c
,shared
.wrongtypeerr
);
4569 de
= dictGetRandomKey(set
->ptr
);
4571 addReply(c
,shared
.nullbulk
);
4573 robj
*ele
= dictGetEntryKey(de
);
4575 addReplyBulkLen(c
,ele
);
4577 addReply(c
,shared
.crlf
);
4578 dictDelete(set
->ptr
,ele
);
4579 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4585 static void srandmemberCommand(redisClient
*c
) {
4589 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4591 addReply(c
,shared
.nullbulk
);
4593 if (set
->type
!= REDIS_SET
) {
4594 addReply(c
,shared
.wrongtypeerr
);
4597 de
= dictGetRandomKey(set
->ptr
);
4599 addReply(c
,shared
.nullbulk
);
4601 robj
*ele
= dictGetEntryKey(de
);
4603 addReplyBulkLen(c
,ele
);
4605 addReply(c
,shared
.crlf
);
4610 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4611 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4613 return dictSize(*d1
)-dictSize(*d2
);
4616 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4617 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4620 robj
*lenobj
= NULL
, *dstset
= NULL
;
4621 unsigned long j
, cardinality
= 0;
4623 for (j
= 0; j
< setsnum
; j
++) {
4627 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4628 lookupKeyRead(c
->db
,setskeys
[j
]);
4632 if (deleteKey(c
->db
,dstkey
))
4634 addReply(c
,shared
.czero
);
4636 addReply(c
,shared
.nullmultibulk
);
4640 if (setobj
->type
!= REDIS_SET
) {
4642 addReply(c
,shared
.wrongtypeerr
);
4645 dv
[j
] = setobj
->ptr
;
4647 /* Sort sets from the smallest to largest, this will improve our
4648 * algorithm's performace */
4649 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4651 /* The first thing we should output is the total number of elements...
4652 * since this is a multi-bulk write, but at this stage we don't know
4653 * the intersection set size, so we use a trick, append an empty object
4654 * to the output list and save the pointer to later modify it with the
4657 lenobj
= createObject(REDIS_STRING
,NULL
);
4659 decrRefCount(lenobj
);
4661 /* If we have a target key where to store the resulting set
4662 * create this key with an empty set inside */
4663 dstset
= createSetObject();
4666 /* Iterate all the elements of the first (smallest) set, and test
4667 * the element against all the other sets, if at least one set does
4668 * not include the element it is discarded */
4669 di
= dictGetIterator(dv
[0]);
4671 while((de
= dictNext(di
)) != NULL
) {
4674 for (j
= 1; j
< setsnum
; j
++)
4675 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4677 continue; /* at least one set does not contain the member */
4678 ele
= dictGetEntryKey(de
);
4680 addReplyBulkLen(c
,ele
);
4682 addReply(c
,shared
.crlf
);
4685 dictAdd(dstset
->ptr
,ele
,NULL
);
4689 dictReleaseIterator(di
);
4692 /* Store the resulting set into the target */
4693 deleteKey(c
->db
,dstkey
);
4694 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4695 incrRefCount(dstkey
);
4699 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4701 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4702 dictSize((dict
*)dstset
->ptr
)));
4708 static void sinterCommand(redisClient
*c
) {
4709 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4712 static void sinterstoreCommand(redisClient
*c
) {
4713 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4716 #define REDIS_OP_UNION 0
4717 #define REDIS_OP_DIFF 1
4719 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4720 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4723 robj
*dstset
= NULL
;
4724 int j
, cardinality
= 0;
4726 for (j
= 0; j
< setsnum
; j
++) {
4730 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4731 lookupKeyRead(c
->db
,setskeys
[j
]);
4736 if (setobj
->type
!= REDIS_SET
) {
4738 addReply(c
,shared
.wrongtypeerr
);
4741 dv
[j
] = setobj
->ptr
;
4744 /* We need a temp set object to store our union. If the dstkey
4745 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4746 * this set object will be the resulting object to set into the target key*/
4747 dstset
= createSetObject();
4749 /* Iterate all the elements of all the sets, add every element a single
4750 * time to the result set */
4751 for (j
= 0; j
< setsnum
; j
++) {
4752 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4753 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4755 di
= dictGetIterator(dv
[j
]);
4757 while((de
= dictNext(di
)) != NULL
) {
4760 /* dictAdd will not add the same element multiple times */
4761 ele
= dictGetEntryKey(de
);
4762 if (op
== REDIS_OP_UNION
|| j
== 0) {
4763 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4767 } else if (op
== REDIS_OP_DIFF
) {
4768 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4773 dictReleaseIterator(di
);
4775 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4778 /* Output the content of the resulting set, if not in STORE mode */
4780 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4781 di
= dictGetIterator(dstset
->ptr
);
4782 while((de
= dictNext(di
)) != NULL
) {
4785 ele
= dictGetEntryKey(de
);
4786 addReplyBulkLen(c
,ele
);
4788 addReply(c
,shared
.crlf
);
4790 dictReleaseIterator(di
);
4792 /* If we have a target key where to store the resulting set
4793 * create this key with the result set inside */
4794 deleteKey(c
->db
,dstkey
);
4795 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4796 incrRefCount(dstkey
);
4801 decrRefCount(dstset
);
4803 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4804 dictSize((dict
*)dstset
->ptr
)));
4810 static void sunionCommand(redisClient
*c
) {
4811 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4814 static void sunionstoreCommand(redisClient
*c
) {
4815 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4818 static void sdiffCommand(redisClient
*c
) {
4819 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4822 static void sdiffstoreCommand(redisClient
*c
) {
4823 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4826 /* ==================================== ZSets =============================== */
4828 /* ZSETs are ordered sets using two data structures to hold the same elements
4829 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4832 * The elements are added to an hash table mapping Redis objects to scores.
4833 * At the same time the elements are added to a skip list mapping scores
4834 * to Redis objects (so objects are sorted by scores in this "view"). */
4836 /* This skiplist implementation is almost a C translation of the original
4837 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4838 * Alternative to Balanced Trees", modified in three ways:
4839 * a) this implementation allows for repeated values.
4840 * b) the comparison is not just by key (our 'score') but by satellite data.
4841 * c) there is a back pointer, so it's a doubly linked list with the back
4842 * pointers being only at "level 1". This allows to traverse the list
4843 * from tail to head, useful for ZREVRANGE. */
4845 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4846 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4848 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4850 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
4856 static zskiplist
*zslCreate(void) {
4860 zsl
= zmalloc(sizeof(*zsl
));
4863 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4864 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
4865 zsl
->header
->forward
[j
] = NULL
;
4867 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
4868 if (j
< ZSKIPLIST_MAXLEVEL
-1)
4869 zsl
->header
->span
[j
] = 0;
4871 zsl
->header
->backward
= NULL
;
4876 static void zslFreeNode(zskiplistNode
*node
) {
4877 decrRefCount(node
->obj
);
4878 zfree(node
->forward
);
4883 static void zslFree(zskiplist
*zsl
) {
4884 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4886 zfree(zsl
->header
->forward
);
4887 zfree(zsl
->header
->span
);
4890 next
= node
->forward
[0];
4897 static int zslRandomLevel(void) {
4899 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4904 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4905 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4906 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
4910 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4911 /* store rank that is crossed to reach the insert position */
4912 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
4914 while (x
->forward
[i
] &&
4915 (x
->forward
[i
]->score
< score
||
4916 (x
->forward
[i
]->score
== score
&&
4917 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
4918 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
4923 /* we assume the key is not already inside, since we allow duplicated
4924 * scores, and the re-insertion of score and redis object should never
4925 * happpen since the caller of zslInsert() should test in the hash table
4926 * if the element is already inside or not. */
4927 level
= zslRandomLevel();
4928 if (level
> zsl
->level
) {
4929 for (i
= zsl
->level
; i
< level
; i
++) {
4931 update
[i
] = zsl
->header
;
4932 update
[i
]->span
[i
-1] = zsl
->length
;
4936 x
= zslCreateNode(level
,score
,obj
);
4937 for (i
= 0; i
< level
; i
++) {
4938 x
->forward
[i
] = update
[i
]->forward
[i
];
4939 update
[i
]->forward
[i
] = x
;
4941 /* update span covered by update[i] as x is inserted here */
4943 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
4944 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
4948 /* increment span for untouched levels */
4949 for (i
= level
; i
< zsl
->level
; i
++) {
4950 update
[i
]->span
[i
-1]++;
4953 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4955 x
->forward
[0]->backward
= x
;
4961 /* Delete an element with matching score/object from the skiplist. */
4962 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4963 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4967 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4968 while (x
->forward
[i
] &&
4969 (x
->forward
[i
]->score
< score
||
4970 (x
->forward
[i
]->score
== score
&&
4971 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4975 /* We may have multiple elements with the same score, what we need
4976 * is to find the element with both the right score and object. */
4978 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4979 for (i
= 0; i
< zsl
->level
; i
++) {
4980 if (update
[i
]->forward
[i
] == x
) {
4982 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
4984 update
[i
]->forward
[i
] = x
->forward
[i
];
4986 /* invariant: i > 0, because update[0]->forward[0]
4987 * is always equal to x */
4988 update
[i
]->span
[i
-1] -= 1;
4991 if (x
->forward
[0]) {
4992 x
->forward
[0]->backward
= x
->backward
;
4994 zsl
->tail
= x
->backward
;
4997 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5002 return 0; /* not found */
5004 return 0; /* not found */
5007 /* Delete all the elements with score between min and max from the skiplist.
5008 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5009 * Note that this function takes the reference to the hash table view of the
5010 * sorted set, in order to remove the elements from the hash table too. */
5011 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5012 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5013 unsigned long removed
= 0;
5017 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5018 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5022 /* We may have multiple elements with the same score, what we need
5023 * is to find the element with both the right score and object. */
5025 while (x
&& x
->score
<= max
) {
5026 zskiplistNode
*next
;
5028 for (i
= 0; i
< zsl
->level
; i
++) {
5029 if (update
[i
]->forward
[i
] == x
) {
5031 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5033 update
[i
]->forward
[i
] = x
->forward
[i
];
5035 /* invariant: i > 0, because update[0]->forward[0]
5036 * is always equal to x */
5037 update
[i
]->span
[i
-1] -= 1;
5040 if (x
->forward
[0]) {
5041 x
->forward
[0]->backward
= x
->backward
;
5043 zsl
->tail
= x
->backward
;
5045 next
= x
->forward
[0];
5046 dictDelete(dict
,x
->obj
);
5048 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5054 return removed
; /* not found */
5057 /* Delete all the elements with rank between start and end from the skiplist.
5058 * Start and end are inclusive. */
5059 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5060 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5061 unsigned long traversed
= 0, removed
= 0;
5064 /* start and end are given 0-based, but zsl uses 1-based
5065 * ranks internally */
5069 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5070 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5071 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5079 while (x
&& traversed
<= end
) {
5080 zskiplistNode
*next
;
5082 for (i
= 0; i
< zsl
->level
; i
++) {
5083 if (update
[i
]->forward
[i
] == x
) {
5085 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5087 update
[i
]->forward
[i
] = x
->forward
[i
];
5089 /* invariant: i > 0, because update[0]->forward[0]
5090 * is always equal to x */
5091 update
[i
]->span
[i
-1] -= 1;
5094 if (x
->forward
[0]) {
5095 x
->forward
[0]->backward
= x
->backward
;
5097 zsl
->tail
= x
->backward
;
5099 next
= x
->forward
[0];
5100 dictDelete(dict
,x
->obj
);
5102 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5112 /* Find the first node having a score equal or greater than the specified one.
5113 * Returns NULL if there is no match. */
5114 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5119 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5120 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5123 /* We may have multiple elements with the same score, what we need
5124 * is to find the element with both the right score and object. */
5125 return x
->forward
[0];
5128 /* Find the rank for an element by both score and key.
5129 * Returns 0 when the element cannot be found, rank otherwise.
5130 * Note that the rank is 1-based due to the span of zsl->header to the
5132 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5134 unsigned long rank
= 0;
5138 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5139 while (x
->forward
[i
] &&
5140 (x
->forward
[i
]->score
< score
||
5141 (x
->forward
[i
]->score
== score
&&
5142 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5143 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5147 /* x might be equal to zsl->header, so test if obj is non-NULL */
5148 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5155 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5156 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5158 unsigned long traversed
= 0;
5162 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5163 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) <= rank
) {
5164 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5168 if (traversed
== rank
) {
5175 /* The actual Z-commands implementations */
5177 /* This generic command implements both ZADD and ZINCRBY.
5178 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5179 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5180 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5185 zsetobj
= lookupKeyWrite(c
->db
,key
);
5186 if (zsetobj
== NULL
) {
5187 zsetobj
= createZsetObject();
5188 dictAdd(c
->db
->dict
,key
,zsetobj
);
5191 if (zsetobj
->type
!= REDIS_ZSET
) {
5192 addReply(c
,shared
.wrongtypeerr
);
5198 /* Ok now since we implement both ZADD and ZINCRBY here the code
5199 * needs to handle the two different conditions. It's all about setting
5200 * '*score', that is, the new score to set, to the right value. */
5201 score
= zmalloc(sizeof(double));
5205 /* Read the old score. If the element was not present starts from 0 */
5206 de
= dictFind(zs
->dict
,ele
);
5208 double *oldscore
= dictGetEntryVal(de
);
5209 *score
= *oldscore
+ scoreval
;
5217 /* What follows is a simple remove and re-insert operation that is common
5218 * to both ZADD and ZINCRBY... */
5219 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5220 /* case 1: New element */
5221 incrRefCount(ele
); /* added to hash */
5222 zslInsert(zs
->zsl
,*score
,ele
);
5223 incrRefCount(ele
); /* added to skiplist */
5226 addReplyDouble(c
,*score
);
5228 addReply(c
,shared
.cone
);
5233 /* case 2: Score update operation */
5234 de
= dictFind(zs
->dict
,ele
);
5235 redisAssert(de
!= NULL
);
5236 oldscore
= dictGetEntryVal(de
);
5237 if (*score
!= *oldscore
) {
5240 /* Remove and insert the element in the skip list with new score */
5241 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5242 redisAssert(deleted
!= 0);
5243 zslInsert(zs
->zsl
,*score
,ele
);
5245 /* Update the score in the hash table */
5246 dictReplace(zs
->dict
,ele
,score
);
5252 addReplyDouble(c
,*score
);
5254 addReply(c
,shared
.czero
);
5258 static void zaddCommand(redisClient
*c
) {
5261 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5262 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5265 static void zincrbyCommand(redisClient
*c
) {
5268 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5269 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5272 static void zremCommand(redisClient
*c
) {
5276 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5277 if (zsetobj
== NULL
) {
5278 addReply(c
,shared
.czero
);
5284 if (zsetobj
->type
!= REDIS_ZSET
) {
5285 addReply(c
,shared
.wrongtypeerr
);
5289 de
= dictFind(zs
->dict
,c
->argv
[2]);
5291 addReply(c
,shared
.czero
);
5294 /* Delete from the skiplist */
5295 oldscore
= dictGetEntryVal(de
);
5296 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5297 redisAssert(deleted
!= 0);
5299 /* Delete from the hash table */
5300 dictDelete(zs
->dict
,c
->argv
[2]);
5301 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5303 addReply(c
,shared
.cone
);
5307 static void zremrangebyscoreCommand(redisClient
*c
) {
5308 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5309 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5313 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5314 if (zsetobj
== NULL
) {
5315 addReply(c
,shared
.czero
);
5319 if (zsetobj
->type
!= REDIS_ZSET
) {
5320 addReply(c
,shared
.wrongtypeerr
);
5324 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5325 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5326 server
.dirty
+= deleted
;
5327 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5331 static void zremrangebyrankCommand(redisClient
*c
) {
5332 int start
= atoi(c
->argv
[2]->ptr
);
5333 int end
= atoi(c
->argv
[3]->ptr
);
5337 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5338 if (zsetobj
== NULL
) {
5339 addReply(c
,shared
.czero
);
5341 if (zsetobj
->type
!= REDIS_ZSET
) {
5342 addReply(c
,shared
.wrongtypeerr
);
5347 int llen
= zs
->zsl
->length
;
5350 /* convert negative indexes */
5351 if (start
< 0) start
= llen
+start
;
5352 if (end
< 0) end
= llen
+end
;
5353 if (start
< 0) start
= 0;
5354 if (end
< 0) end
= 0;
5356 /* indexes sanity checks */
5357 if (start
> end
|| start
>= llen
) {
5358 addReply(c
,shared
.czero
);
5361 if (end
>= llen
) end
= llen
-1;
5363 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
,end
,zs
->dict
);
5364 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5365 server
.dirty
+= deleted
;
5366 addReplyLong(c
, deleted
);
5370 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5372 int start
= atoi(c
->argv
[2]->ptr
);
5373 int end
= atoi(c
->argv
[3]->ptr
);
5376 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5378 } else if (c
->argc
>= 5) {
5379 addReply(c
,shared
.syntaxerr
);
5383 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5385 addReply(c
,shared
.nullmultibulk
);
5387 if (o
->type
!= REDIS_ZSET
) {
5388 addReply(c
,shared
.wrongtypeerr
);
5390 zset
*zsetobj
= o
->ptr
;
5391 zskiplist
*zsl
= zsetobj
->zsl
;
5394 int llen
= zsl
->length
;
5398 /* convert negative indexes */
5399 if (start
< 0) start
= llen
+start
;
5400 if (end
< 0) end
= llen
+end
;
5401 if (start
< 0) start
= 0;
5402 if (end
< 0) end
= 0;
5404 /* indexes sanity checks */
5405 if (start
> end
|| start
>= llen
) {
5406 /* Out of range start or start > end result in empty list */
5407 addReply(c
,shared
.emptymultibulk
);
5410 if (end
>= llen
) end
= llen
-1;
5411 rangelen
= (end
-start
)+1;
5413 /* check if starting point is trivial, before searching
5414 * the element in log(N) time */
5416 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
- start
);
5418 ln
= start
== 0 ? zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+ 1);
5421 /* Return the result in form of a multi-bulk reply */
5422 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5423 withscores
? (rangelen
*2) : rangelen
));
5424 for (j
= 0; j
< rangelen
; j
++) {
5426 addReplyBulkLen(c
,ele
);
5428 addReply(c
,shared
.crlf
);
5430 addReplyDouble(c
,ln
->score
);
5431 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5437 static void zrangeCommand(redisClient
*c
) {
5438 zrangeGenericCommand(c
,0);
5441 static void zrevrangeCommand(redisClient
*c
) {
5442 zrangeGenericCommand(c
,1);
5445 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5446 * If justcount is non-zero, just the count is returned. */
5447 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5450 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5451 int offset
= 0, limit
= -1;
5455 /* Parse the min-max interval. If one of the values is prefixed
5456 * by the "(" character, it's considered "open". For instance
5457 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5458 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5459 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5460 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5463 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5465 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5466 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5469 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5472 /* Parse "WITHSCORES": note that if the command was called with
5473 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5474 * enter the following paths to parse WITHSCORES and LIMIT. */
5475 if (c
->argc
== 5 || c
->argc
== 8) {
5476 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5481 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5485 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5490 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5491 addReply(c
,shared
.syntaxerr
);
5493 } else if (c
->argc
== (7 + withscores
)) {
5494 offset
= atoi(c
->argv
[5]->ptr
);
5495 limit
= atoi(c
->argv
[6]->ptr
);
5496 if (offset
< 0) offset
= 0;
5499 /* Ok, lookup the key and get the range */
5500 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5502 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5504 if (o
->type
!= REDIS_ZSET
) {
5505 addReply(c
,shared
.wrongtypeerr
);
5507 zset
*zsetobj
= o
->ptr
;
5508 zskiplist
*zsl
= zsetobj
->zsl
;
5510 robj
*ele
, *lenobj
= NULL
;
5511 unsigned long rangelen
= 0;
5513 /* Get the first node with the score >= min, or with
5514 * score > min if 'minex' is true. */
5515 ln
= zslFirstWithScore(zsl
,min
);
5516 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5519 /* No element matching the speciifed interval */
5520 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5524 /* We don't know in advance how many matching elements there
5525 * are in the list, so we push this object that will represent
5526 * the multi-bulk length in the output buffer, and will "fix"
5529 lenobj
= createObject(REDIS_STRING
,NULL
);
5531 decrRefCount(lenobj
);
5534 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5537 ln
= ln
->forward
[0];
5540 if (limit
== 0) break;
5543 addReplyBulkLen(c
,ele
);
5545 addReply(c
,shared
.crlf
);
5547 addReplyDouble(c
,ln
->score
);
5549 ln
= ln
->forward
[0];
5551 if (limit
> 0) limit
--;
5554 addReplyLong(c
,(long)rangelen
);
5556 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5557 withscores
? (rangelen
*2) : rangelen
);
5563 static void zrangebyscoreCommand(redisClient
*c
) {
5564 genericZrangebyscoreCommand(c
,0);
5567 static void zcountCommand(redisClient
*c
) {
5568 genericZrangebyscoreCommand(c
,1);
5571 static void zcardCommand(redisClient
*c
) {
5575 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5577 addReply(c
,shared
.czero
);
5580 if (o
->type
!= REDIS_ZSET
) {
5581 addReply(c
,shared
.wrongtypeerr
);
5584 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5589 static void zscoreCommand(redisClient
*c
) {
5593 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5595 addReply(c
,shared
.nullbulk
);
5598 if (o
->type
!= REDIS_ZSET
) {
5599 addReply(c
,shared
.wrongtypeerr
);
5604 de
= dictFind(zs
->dict
,c
->argv
[2]);
5606 addReply(c
,shared
.nullbulk
);
5608 double *score
= dictGetEntryVal(de
);
5610 addReplyDouble(c
,*score
);
5616 static void zrankCommand(redisClient
*c
) {
5618 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5620 addReply(c
,shared
.nullbulk
);
5623 if (o
->type
!= REDIS_ZSET
) {
5624 addReply(c
,shared
.wrongtypeerr
);
5627 zskiplist
*zsl
= zs
->zsl
;
5631 de
= dictFind(zs
->dict
,c
->argv
[2]);
5633 addReply(c
,shared
.nullbulk
);
5637 double *score
= dictGetEntryVal(de
);
5638 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5640 addReplyLong(c
, rank
-1);
5642 addReply(c
,shared
.nullbulk
);
5647 /* ========================= Non type-specific commands ==================== */
5649 static void flushdbCommand(redisClient
*c
) {
5650 server
.dirty
+= dictSize(c
->db
->dict
);
5651 dictEmpty(c
->db
->dict
);
5652 dictEmpty(c
->db
->expires
);
5653 addReply(c
,shared
.ok
);
5656 static void flushallCommand(redisClient
*c
) {
5657 server
.dirty
+= emptyDb();
5658 addReply(c
,shared
.ok
);
5659 rdbSave(server
.dbfilename
);
5663 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5664 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5666 so
->pattern
= pattern
;
5670 /* Return the value associated to the key with a name obtained
5671 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5672 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5676 int prefixlen
, sublen
, postfixlen
;
5677 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5681 char buf
[REDIS_SORTKEY_MAX
+1];
5684 /* If the pattern is "#" return the substitution object itself in order
5685 * to implement the "SORT ... GET #" feature. */
5686 spat
= pattern
->ptr
;
5687 if (spat
[0] == '#' && spat
[1] == '\0') {
5691 /* The substitution object may be specially encoded. If so we create
5692 * a decoded object on the fly. Otherwise getDecodedObject will just
5693 * increment the ref count, that we'll decrement later. */
5694 subst
= getDecodedObject(subst
);
5697 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5698 p
= strchr(spat
,'*');
5700 decrRefCount(subst
);
5705 sublen
= sdslen(ssub
);
5706 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5707 memcpy(keyname
.buf
,spat
,prefixlen
);
5708 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5709 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5710 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5711 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5713 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5714 decrRefCount(subst
);
5716 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5717 return lookupKeyRead(db
,&keyobj
);
5720 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5721 * the additional parameter is not standard but a BSD-specific we have to
5722 * pass sorting parameters via the global 'server' structure */
5723 static int sortCompare(const void *s1
, const void *s2
) {
5724 const redisSortObject
*so1
= s1
, *so2
= s2
;
5727 if (!server
.sort_alpha
) {
5728 /* Numeric sorting. Here it's trivial as we precomputed scores */
5729 if (so1
->u
.score
> so2
->u
.score
) {
5731 } else if (so1
->u
.score
< so2
->u
.score
) {
5737 /* Alphanumeric sorting */
5738 if (server
.sort_bypattern
) {
5739 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5740 /* At least one compare object is NULL */
5741 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5743 else if (so1
->u
.cmpobj
== NULL
)
5748 /* We have both the objects, use strcoll */
5749 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5752 /* Compare elements directly */
5755 dec1
= getDecodedObject(so1
->obj
);
5756 dec2
= getDecodedObject(so2
->obj
);
5757 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5762 return server
.sort_desc
? -cmp
: cmp
;
5765 /* The SORT command is the most complex command in Redis. Warning: this code
5766 * is optimized for speed and a bit less for readability */
5767 static void sortCommand(redisClient
*c
) {
5770 int desc
= 0, alpha
= 0;
5771 int limit_start
= 0, limit_count
= -1, start
, end
;
5772 int j
, dontsort
= 0, vectorlen
;
5773 int getop
= 0; /* GET operation counter */
5774 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5775 redisSortObject
*vector
; /* Resulting vector to sort */
5777 /* Lookup the key to sort. It must be of the right types */
5778 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5779 if (sortval
== NULL
) {
5780 addReply(c
,shared
.nullmultibulk
);
5783 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5784 sortval
->type
!= REDIS_ZSET
)
5786 addReply(c
,shared
.wrongtypeerr
);
5790 /* Create a list of operations to perform for every sorted element.
5791 * Operations can be GET/DEL/INCR/DECR */
5792 operations
= listCreate();
5793 listSetFreeMethod(operations
,zfree
);
5796 /* Now we need to protect sortval incrementing its count, in the future
5797 * SORT may have options able to overwrite/delete keys during the sorting
5798 * and the sorted key itself may get destroied */
5799 incrRefCount(sortval
);
5801 /* The SORT command has an SQL-alike syntax, parse it */
5802 while(j
< c
->argc
) {
5803 int leftargs
= c
->argc
-j
-1;
5804 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5806 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5808 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5810 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5811 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5812 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5814 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5815 storekey
= c
->argv
[j
+1];
5817 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5818 sortby
= c
->argv
[j
+1];
5819 /* If the BY pattern does not contain '*', i.e. it is constant,
5820 * we don't need to sort nor to lookup the weight keys. */
5821 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5823 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5824 listAddNodeTail(operations
,createSortOperation(
5825 REDIS_SORT_GET
,c
->argv
[j
+1]));
5829 decrRefCount(sortval
);
5830 listRelease(operations
);
5831 addReply(c
,shared
.syntaxerr
);
5837 /* Load the sorting vector with all the objects to sort */
5838 switch(sortval
->type
) {
5839 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5840 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5841 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5842 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5844 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5847 if (sortval
->type
== REDIS_LIST
) {
5848 list
*list
= sortval
->ptr
;
5852 listRewind(list
,&li
);
5853 while((ln
= listNext(&li
))) {
5854 robj
*ele
= ln
->value
;
5855 vector
[j
].obj
= ele
;
5856 vector
[j
].u
.score
= 0;
5857 vector
[j
].u
.cmpobj
= NULL
;
5865 if (sortval
->type
== REDIS_SET
) {
5868 zset
*zs
= sortval
->ptr
;
5872 di
= dictGetIterator(set
);
5873 while((setele
= dictNext(di
)) != NULL
) {
5874 vector
[j
].obj
= dictGetEntryKey(setele
);
5875 vector
[j
].u
.score
= 0;
5876 vector
[j
].u
.cmpobj
= NULL
;
5879 dictReleaseIterator(di
);
5881 redisAssert(j
== vectorlen
);
5883 /* Now it's time to load the right scores in the sorting vector */
5884 if (dontsort
== 0) {
5885 for (j
= 0; j
< vectorlen
; j
++) {
5889 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5890 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5892 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5894 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5895 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5897 /* Don't need to decode the object if it's
5898 * integer-encoded (the only encoding supported) so
5899 * far. We can just cast it */
5900 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5901 vector
[j
].u
.score
= (long)byval
->ptr
;
5903 redisAssert(1 != 1);
5908 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5909 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5911 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5912 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5914 redisAssert(1 != 1);
5921 /* We are ready to sort the vector... perform a bit of sanity check
5922 * on the LIMIT option too. We'll use a partial version of quicksort. */
5923 start
= (limit_start
< 0) ? 0 : limit_start
;
5924 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5925 if (start
>= vectorlen
) {
5926 start
= vectorlen
-1;
5929 if (end
>= vectorlen
) end
= vectorlen
-1;
5931 if (dontsort
== 0) {
5932 server
.sort_desc
= desc
;
5933 server
.sort_alpha
= alpha
;
5934 server
.sort_bypattern
= sortby
? 1 : 0;
5935 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5936 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5938 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5941 /* Send command output to the output buffer, performing the specified
5942 * GET/DEL/INCR/DECR operations if any. */
5943 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5944 if (storekey
== NULL
) {
5945 /* STORE option not specified, sent the sorting result to client */
5946 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5947 for (j
= start
; j
<= end
; j
++) {
5952 addReplyBulkLen(c
,vector
[j
].obj
);
5953 addReply(c
,vector
[j
].obj
);
5954 addReply(c
,shared
.crlf
);
5956 listRewind(operations
,&li
);
5957 while((ln
= listNext(&li
))) {
5958 redisSortOperation
*sop
= ln
->value
;
5959 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5962 if (sop
->type
== REDIS_SORT_GET
) {
5963 if (!val
|| val
->type
!= REDIS_STRING
) {
5964 addReply(c
,shared
.nullbulk
);
5966 addReplyBulkLen(c
,val
);
5968 addReply(c
,shared
.crlf
);
5971 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5976 robj
*listObject
= createListObject();
5977 list
*listPtr
= (list
*) listObject
->ptr
;
5979 /* STORE option specified, set the sorting result as a List object */
5980 for (j
= start
; j
<= end
; j
++) {
5985 listAddNodeTail(listPtr
,vector
[j
].obj
);
5986 incrRefCount(vector
[j
].obj
);
5988 listRewind(operations
,&li
);
5989 while((ln
= listNext(&li
))) {
5990 redisSortOperation
*sop
= ln
->value
;
5991 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5994 if (sop
->type
== REDIS_SORT_GET
) {
5995 if (!val
|| val
->type
!= REDIS_STRING
) {
5996 listAddNodeTail(listPtr
,createStringObject("",0));
5998 listAddNodeTail(listPtr
,val
);
6002 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6006 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6007 incrRefCount(storekey
);
6009 /* Note: we add 1 because the DB is dirty anyway since even if the
6010 * SORT result is empty a new key is set and maybe the old content
6012 server
.dirty
+= 1+outputlen
;
6013 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6017 decrRefCount(sortval
);
6018 listRelease(operations
);
6019 for (j
= 0; j
< vectorlen
; j
++) {
6020 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6021 decrRefCount(vector
[j
].u
.cmpobj
);
6026 /* Convert an amount of bytes into a human readable string in the form
6027 * of 100B, 2G, 100M, 4K, and so forth. */
6028 static void bytesToHuman(char *s
, unsigned long long n
) {
6033 sprintf(s
,"%lluB",n
);
6035 } else if (n
< (1024*1024)) {
6036 d
= (double)n
/(1024);
6037 sprintf(s
,"%.2fK",d
);
6038 } else if (n
< (1024LL*1024*1024)) {
6039 d
= (double)n
/(1024*1024);
6040 sprintf(s
,"%.2fM",d
);
6041 } else if (n
< (1024LL*1024*1024*1024)) {
6042 d
= (double)n
/(1024LL*1024*1024);
6043 sprintf(s
,"%.2fG",d
);
6047 /* Create the string returned by the INFO command. This is decoupled
6048 * by the INFO command itself as we need to report the same information
6049 * on memory corruption problems. */
6050 static sds
genRedisInfoString(void) {
6052 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6056 bytesToHuman(hmem
,zmalloc_used_memory());
6057 info
= sdscatprintf(sdsempty(),
6058 "redis_version:%s\r\n"
6060 "multiplexing_api:%s\r\n"
6061 "process_id:%ld\r\n"
6062 "uptime_in_seconds:%ld\r\n"
6063 "uptime_in_days:%ld\r\n"
6064 "connected_clients:%d\r\n"
6065 "connected_slaves:%d\r\n"
6066 "blocked_clients:%d\r\n"
6067 "used_memory:%zu\r\n"
6068 "used_memory_human:%s\r\n"
6069 "changes_since_last_save:%lld\r\n"
6070 "bgsave_in_progress:%d\r\n"
6071 "last_save_time:%ld\r\n"
6072 "bgrewriteaof_in_progress:%d\r\n"
6073 "total_connections_received:%lld\r\n"
6074 "total_commands_processed:%lld\r\n"
6078 (sizeof(long) == 8) ? "64" : "32",
6083 listLength(server
.clients
)-listLength(server
.slaves
),
6084 listLength(server
.slaves
),
6085 server
.blpop_blocked_clients
,
6086 zmalloc_used_memory(),
6089 server
.bgsavechildpid
!= -1,
6091 server
.bgrewritechildpid
!= -1,
6092 server
.stat_numconnections
,
6093 server
.stat_numcommands
,
6094 server
.vm_enabled
!= 0,
6095 server
.masterhost
== NULL
? "master" : "slave"
6097 if (server
.masterhost
) {
6098 info
= sdscatprintf(info
,
6099 "master_host:%s\r\n"
6100 "master_port:%d\r\n"
6101 "master_link_status:%s\r\n"
6102 "master_last_io_seconds_ago:%d\r\n"
6105 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6107 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6110 if (server
.vm_enabled
) {
6112 info
= sdscatprintf(info
,
6113 "vm_conf_max_memory:%llu\r\n"
6114 "vm_conf_page_size:%llu\r\n"
6115 "vm_conf_pages:%llu\r\n"
6116 "vm_stats_used_pages:%llu\r\n"
6117 "vm_stats_swapped_objects:%llu\r\n"
6118 "vm_stats_swappin_count:%llu\r\n"
6119 "vm_stats_swappout_count:%llu\r\n"
6120 "vm_stats_io_newjobs_len:%lu\r\n"
6121 "vm_stats_io_processing_len:%lu\r\n"
6122 "vm_stats_io_processed_len:%lu\r\n"
6123 "vm_stats_io_active_threads:%lu\r\n"
6124 "vm_stats_blocked_clients:%lu\r\n"
6125 ,(unsigned long long) server
.vm_max_memory
,
6126 (unsigned long long) server
.vm_page_size
,
6127 (unsigned long long) server
.vm_pages
,
6128 (unsigned long long) server
.vm_stats_used_pages
,
6129 (unsigned long long) server
.vm_stats_swapped_objects
,
6130 (unsigned long long) server
.vm_stats_swapins
,
6131 (unsigned long long) server
.vm_stats_swapouts
,
6132 (unsigned long) listLength(server
.io_newjobs
),
6133 (unsigned long) listLength(server
.io_processing
),
6134 (unsigned long) listLength(server
.io_processed
),
6135 (unsigned long) server
.io_active_threads
,
6136 (unsigned long) server
.vm_blocked_clients
6140 for (j
= 0; j
< server
.dbnum
; j
++) {
6141 long long keys
, vkeys
;
6143 keys
= dictSize(server
.db
[j
].dict
);
6144 vkeys
= dictSize(server
.db
[j
].expires
);
6145 if (keys
|| vkeys
) {
6146 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6153 static void infoCommand(redisClient
*c
) {
6154 sds info
= genRedisInfoString();
6155 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6156 (unsigned long)sdslen(info
)));
6157 addReplySds(c
,info
);
6158 addReply(c
,shared
.crlf
);
6161 static void monitorCommand(redisClient
*c
) {
6162 /* ignore MONITOR if aleady slave or in monitor mode */
6163 if (c
->flags
& REDIS_SLAVE
) return;
6165 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6167 listAddNodeTail(server
.monitors
,c
);
6168 addReply(c
,shared
.ok
);
6171 /* ================================= Expire ================================= */
6172 static int removeExpire(redisDb
*db
, robj
*key
) {
6173 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6180 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6181 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6189 /* Return the expire time of the specified key, or -1 if no expire
6190 * is associated with this key (i.e. the key is non volatile) */
6191 static time_t getExpire(redisDb
*db
, robj
*key
) {
6194 /* No expire? return ASAP */
6195 if (dictSize(db
->expires
) == 0 ||
6196 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6198 return (time_t) dictGetEntryVal(de
);
6201 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6205 /* No expire? return ASAP */
6206 if (dictSize(db
->expires
) == 0 ||
6207 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6209 /* Lookup the expire */
6210 when
= (time_t) dictGetEntryVal(de
);
6211 if (time(NULL
) <= when
) return 0;
6213 /* Delete the key */
6214 dictDelete(db
->expires
,key
);
6215 return dictDelete(db
->dict
,key
) == DICT_OK
;
6218 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6221 /* No expire? return ASAP */
6222 if (dictSize(db
->expires
) == 0 ||
6223 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6225 /* Delete the key */
6227 dictDelete(db
->expires
,key
);
6228 return dictDelete(db
->dict
,key
) == DICT_OK
;
6231 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6234 de
= dictFind(c
->db
->dict
,key
);
6236 addReply(c
,shared
.czero
);
6240 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6241 addReply(c
, shared
.cone
);
6244 time_t when
= time(NULL
)+seconds
;
6245 if (setExpire(c
->db
,key
,when
)) {
6246 addReply(c
,shared
.cone
);
6249 addReply(c
,shared
.czero
);
6255 static void expireCommand(redisClient
*c
) {
6256 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6259 static void expireatCommand(redisClient
*c
) {
6260 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6263 static void ttlCommand(redisClient
*c
) {
6267 expire
= getExpire(c
->db
,c
->argv
[1]);
6269 ttl
= (int) (expire
-time(NULL
));
6270 if (ttl
< 0) ttl
= -1;
6272 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6275 /* ================================ MULTI/EXEC ============================== */
6277 /* Client state initialization for MULTI/EXEC */
6278 static void initClientMultiState(redisClient
*c
) {
6279 c
->mstate
.commands
= NULL
;
6280 c
->mstate
.count
= 0;
6283 /* Release all the resources associated with MULTI/EXEC state */
6284 static void freeClientMultiState(redisClient
*c
) {
6287 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6289 multiCmd
*mc
= c
->mstate
.commands
+j
;
6291 for (i
= 0; i
< mc
->argc
; i
++)
6292 decrRefCount(mc
->argv
[i
]);
6295 zfree(c
->mstate
.commands
);
6298 /* Add a new command into the MULTI commands queue */
6299 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6303 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6304 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6305 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6308 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6309 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6310 for (j
= 0; j
< c
->argc
; j
++)
6311 incrRefCount(mc
->argv
[j
]);
6315 static void multiCommand(redisClient
*c
) {
6316 c
->flags
|= REDIS_MULTI
;
6317 addReply(c
,shared
.ok
);
6320 static void discardCommand(redisClient
*c
) {
6321 if (!(c
->flags
& REDIS_MULTI
)) {
6322 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6326 freeClientMultiState(c
);
6327 initClientMultiState(c
);
6328 c
->flags
&= (~REDIS_MULTI
);
6329 addReply(c
,shared
.ok
);
6332 static void execCommand(redisClient
*c
) {
6337 if (!(c
->flags
& REDIS_MULTI
)) {
6338 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6342 orig_argv
= c
->argv
;
6343 orig_argc
= c
->argc
;
6344 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6345 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6346 c
->argc
= c
->mstate
.commands
[j
].argc
;
6347 c
->argv
= c
->mstate
.commands
[j
].argv
;
6348 call(c
,c
->mstate
.commands
[j
].cmd
);
6350 c
->argv
= orig_argv
;
6351 c
->argc
= orig_argc
;
6352 freeClientMultiState(c
);
6353 initClientMultiState(c
);
6354 c
->flags
&= (~REDIS_MULTI
);
6357 /* =========================== Blocking Operations ========================= */
6359 /* Currently Redis blocking operations support is limited to list POP ops,
6360 * so the current implementation is not fully generic, but it is also not
6361 * completely specific so it will not require a rewrite to support new
6362 * kind of blocking operations in the future.
6364 * Still it's important to note that list blocking operations can be already
6365 * used as a notification mechanism in order to implement other blocking
6366 * operations at application level, so there must be a very strong evidence
6367 * of usefulness and generality before new blocking operations are implemented.
6369 * This is how the current blocking POP works, we use BLPOP as example:
6370 * - If the user calls BLPOP and the key exists and contains a non empty list
6371 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6372 * if there is not to block.
6373 * - If instead BLPOP is called and the key does not exists or the list is
6374 * empty we need to block. In order to do so we remove the notification for
6375 * new data to read in the client socket (so that we'll not serve new
6376 * requests if the blocking request is not served). Also we put the client
6377 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6378 * blocking for this keys.
6379 * - If a PUSH operation against a key with blocked clients waiting is
6380 * performed, we serve the first in the list: basically instead to push
6381 * the new element inside the list we return it to the (first / oldest)
6382 * blocking client, unblock the client, and remove it form the list.
6384 * The above comment and the source code should be enough in order to understand
6385 * the implementation and modify / fix it later.
6388 /* Set a client in blocking mode for the specified key, with the specified
6390 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6395 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6396 c
->blockingkeysnum
= numkeys
;
6397 c
->blockingto
= timeout
;
6398 for (j
= 0; j
< numkeys
; j
++) {
6399 /* Add the key in the client structure, to map clients -> keys */
6400 c
->blockingkeys
[j
] = keys
[j
];
6401 incrRefCount(keys
[j
]);
6403 /* And in the other "side", to map keys -> clients */
6404 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6408 /* For every key we take a list of clients blocked for it */
6410 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6411 incrRefCount(keys
[j
]);
6412 assert(retval
== DICT_OK
);
6414 l
= dictGetEntryVal(de
);
6416 listAddNodeTail(l
,c
);
6418 /* Mark the client as a blocked client */
6419 c
->flags
|= REDIS_BLOCKED
;
6420 server
.blpop_blocked_clients
++;
6423 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6424 static void unblockClientWaitingData(redisClient
*c
) {
6429 assert(c
->blockingkeys
!= NULL
);
6430 /* The client may wait for multiple keys, so unblock it for every key. */
6431 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6432 /* Remove this client from the list of clients waiting for this key. */
6433 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6435 l
= dictGetEntryVal(de
);
6436 listDelNode(l
,listSearchKey(l
,c
));
6437 /* If the list is empty we need to remove it to avoid wasting memory */
6438 if (listLength(l
) == 0)
6439 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6440 decrRefCount(c
->blockingkeys
[j
]);
6442 /* Cleanup the client structure */
6443 zfree(c
->blockingkeys
);
6444 c
->blockingkeys
= NULL
;
6445 c
->flags
&= (~REDIS_BLOCKED
);
6446 server
.blpop_blocked_clients
--;
6447 /* We want to process data if there is some command waiting
6448 * in the input buffer. Note that this is safe even if
6449 * unblockClientWaitingData() gets called from freeClient() because
6450 * freeClient() will be smart enough to call this function
6451 * *after* c->querybuf was set to NULL. */
6452 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6455 /* This should be called from any function PUSHing into lists.
6456 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6457 * 'ele' is the element pushed.
6459 * If the function returns 0 there was no client waiting for a list push
6462 * If the function returns 1 there was a client waiting for a list push
6463 * against this key, the element was passed to this client thus it's not
6464 * needed to actually add it to the list and the caller should return asap. */
6465 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6466 struct dictEntry
*de
;
6467 redisClient
*receiver
;
6471 de
= dictFind(c
->db
->blockingkeys
,key
);
6472 if (de
== NULL
) return 0;
6473 l
= dictGetEntryVal(de
);
6476 receiver
= ln
->value
;
6478 addReplySds(receiver
,sdsnew("*2\r\n"));
6479 addReplyBulkLen(receiver
,key
);
6480 addReply(receiver
,key
);
6481 addReply(receiver
,shared
.crlf
);
6482 addReplyBulkLen(receiver
,ele
);
6483 addReply(receiver
,ele
);
6484 addReply(receiver
,shared
.crlf
);
6485 unblockClientWaitingData(receiver
);
6489 /* Blocking RPOP/LPOP */
6490 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6495 for (j
= 1; j
< c
->argc
-1; j
++) {
6496 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6498 if (o
->type
!= REDIS_LIST
) {
6499 addReply(c
,shared
.wrongtypeerr
);
6502 list
*list
= o
->ptr
;
6503 if (listLength(list
) != 0) {
6504 /* If the list contains elements fall back to the usual
6505 * non-blocking POP operation */
6506 robj
*argv
[2], **orig_argv
;
6509 /* We need to alter the command arguments before to call
6510 * popGenericCommand() as the command takes a single key. */
6511 orig_argv
= c
->argv
;
6512 orig_argc
= c
->argc
;
6513 argv
[1] = c
->argv
[j
];
6517 /* Also the return value is different, we need to output
6518 * the multi bulk reply header and the key name. The
6519 * "real" command will add the last element (the value)
6520 * for us. If this souds like an hack to you it's just
6521 * because it is... */
6522 addReplySds(c
,sdsnew("*2\r\n"));
6523 addReplyBulkLen(c
,argv
[1]);
6524 addReply(c
,argv
[1]);
6525 addReply(c
,shared
.crlf
);
6526 popGenericCommand(c
,where
);
6528 /* Fix the client structure with the original stuff */
6529 c
->argv
= orig_argv
;
6530 c
->argc
= orig_argc
;
6536 /* If the list is empty or the key does not exists we must block */
6537 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6538 if (timeout
> 0) timeout
+= time(NULL
);
6539 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6542 static void blpopCommand(redisClient
*c
) {
6543 blockingPopGenericCommand(c
,REDIS_HEAD
);
6546 static void brpopCommand(redisClient
*c
) {
6547 blockingPopGenericCommand(c
,REDIS_TAIL
);
6550 /* =============================== Replication ============================= */
6552 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6553 ssize_t nwritten
, ret
= size
;
6554 time_t start
= time(NULL
);
6558 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6559 nwritten
= write(fd
,ptr
,size
);
6560 if (nwritten
== -1) return -1;
6564 if ((time(NULL
)-start
) > timeout
) {
6572 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6573 ssize_t nread
, totread
= 0;
6574 time_t start
= time(NULL
);
6578 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6579 nread
= read(fd
,ptr
,size
);
6580 if (nread
== -1) return -1;
6585 if ((time(NULL
)-start
) > timeout
) {
6593 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6600 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6603 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6614 static void syncCommand(redisClient
*c
) {
6615 /* ignore SYNC if aleady slave or in monitor mode */
6616 if (c
->flags
& REDIS_SLAVE
) return;
6618 /* SYNC can't be issued when the server has pending data to send to
6619 * the client about already issued commands. We need a fresh reply
6620 * buffer registering the differences between the BGSAVE and the current
6621 * dataset, so that we can copy to other slaves if needed. */
6622 if (listLength(c
->reply
) != 0) {
6623 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6627 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6628 /* Here we need to check if there is a background saving operation
6629 * in progress, or if it is required to start one */
6630 if (server
.bgsavechildpid
!= -1) {
6631 /* Ok a background save is in progress. Let's check if it is a good
6632 * one for replication, i.e. if there is another slave that is
6633 * registering differences since the server forked to save */
6638 listRewind(server
.slaves
,&li
);
6639 while((ln
= listNext(&li
))) {
6641 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6644 /* Perfect, the server is already registering differences for
6645 * another slave. Set the right state, and copy the buffer. */
6646 listRelease(c
->reply
);
6647 c
->reply
= listDup(slave
->reply
);
6648 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6649 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6651 /* No way, we need to wait for the next BGSAVE in order to
6652 * register differences */
6653 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6654 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6657 /* Ok we don't have a BGSAVE in progress, let's start one */
6658 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6659 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6660 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6661 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6664 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6667 c
->flags
|= REDIS_SLAVE
;
6669 listAddNodeTail(server
.slaves
,c
);
6673 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6674 redisClient
*slave
= privdata
;
6676 REDIS_NOTUSED(mask
);
6677 char buf
[REDIS_IOBUF_LEN
];
6678 ssize_t nwritten
, buflen
;
6680 if (slave
->repldboff
== 0) {
6681 /* Write the bulk write count before to transfer the DB. In theory here
6682 * we don't know how much room there is in the output buffer of the
6683 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6684 * operations) will never be smaller than the few bytes we need. */
6687 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6689 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6697 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6698 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6700 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6701 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6705 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6706 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6711 slave
->repldboff
+= nwritten
;
6712 if (slave
->repldboff
== slave
->repldbsize
) {
6713 close(slave
->repldbfd
);
6714 slave
->repldbfd
= -1;
6715 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6716 slave
->replstate
= REDIS_REPL_ONLINE
;
6717 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6718 sendReplyToClient
, slave
) == AE_ERR
) {
6722 addReplySds(slave
,sdsempty());
6723 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6727 /* This function is called at the end of every backgrond saving.
6728 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6729 * otherwise REDIS_ERR is passed to the function.
6731 * The goal of this function is to handle slaves waiting for a successful
6732 * background saving in order to perform non-blocking synchronization. */
6733 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6735 int startbgsave
= 0;
6738 listRewind(server
.slaves
,&li
);
6739 while((ln
= listNext(&li
))) {
6740 redisClient
*slave
= ln
->value
;
6742 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6744 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6745 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6746 struct redis_stat buf
;
6748 if (bgsaveerr
!= REDIS_OK
) {
6750 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6753 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6754 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6756 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6759 slave
->repldboff
= 0;
6760 slave
->repldbsize
= buf
.st_size
;
6761 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6762 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6763 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6770 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6773 listRewind(server
.slaves
,&li
);
6774 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6775 while((ln
= listNext(&li
))) {
6776 redisClient
*slave
= ln
->value
;
6778 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6785 static int syncWithMaster(void) {
6786 char buf
[1024], tmpfile
[256], authcmd
[1024];
6788 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6792 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6797 /* AUTH with the master if required. */
6798 if(server
.masterauth
) {
6799 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6800 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6802 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6806 /* Read the AUTH result. */
6807 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6809 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6813 if (buf
[0] != '+') {
6815 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6820 /* Issue the SYNC command */
6821 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6823 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6827 /* Read the bulk write count */
6828 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6830 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6834 if (buf
[0] != '$') {
6836 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6839 dumpsize
= atoi(buf
+1);
6840 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6841 /* Read the bulk write data on a temp file */
6842 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6843 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6846 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6850 int nread
, nwritten
;
6852 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6854 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6860 nwritten
= write(dfd
,buf
,nread
);
6861 if (nwritten
== -1) {
6862 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6870 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6871 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6877 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6878 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6882 server
.master
= createClient(fd
);
6883 server
.master
->flags
|= REDIS_MASTER
;
6884 server
.master
->authenticated
= 1;
6885 server
.replstate
= REDIS_REPL_CONNECTED
;
6889 static void slaveofCommand(redisClient
*c
) {
6890 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6891 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6892 if (server
.masterhost
) {
6893 sdsfree(server
.masterhost
);
6894 server
.masterhost
= NULL
;
6895 if (server
.master
) freeClient(server
.master
);
6896 server
.replstate
= REDIS_REPL_NONE
;
6897 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6900 sdsfree(server
.masterhost
);
6901 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6902 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6903 if (server
.master
) freeClient(server
.master
);
6904 server
.replstate
= REDIS_REPL_CONNECT
;
6905 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6906 server
.masterhost
, server
.masterport
);
6908 addReply(c
,shared
.ok
);
6911 /* ============================ Maxmemory directive ======================== */
6913 /* Try to free one object form the pre-allocated objects free list.
6914 * This is useful under low mem conditions as by default we take 1 million
6915 * free objects allocated. On success REDIS_OK is returned, otherwise
6917 static int tryFreeOneObjectFromFreelist(void) {
6920 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6921 if (listLength(server
.objfreelist
)) {
6922 listNode
*head
= listFirst(server
.objfreelist
);
6923 o
= listNodeValue(head
);
6924 listDelNode(server
.objfreelist
,head
);
6925 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6929 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6934 /* This function gets called when 'maxmemory' is set on the config file to limit
6935 * the max memory used by the server, and we are out of memory.
6936 * This function will try to, in order:
6938 * - Free objects from the free list
6939 * - Try to remove keys with an EXPIRE set
6941 * It is not possible to free enough memory to reach used-memory < maxmemory
6942 * the server will start refusing commands that will enlarge even more the
6945 static void freeMemoryIfNeeded(void) {
6946 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6947 int j
, k
, freed
= 0;
6949 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6950 for (j
= 0; j
< server
.dbnum
; j
++) {
6952 robj
*minkey
= NULL
;
6953 struct dictEntry
*de
;
6955 if (dictSize(server
.db
[j
].expires
)) {
6957 /* From a sample of three keys drop the one nearest to
6958 * the natural expire */
6959 for (k
= 0; k
< 3; k
++) {
6962 de
= dictGetRandomKey(server
.db
[j
].expires
);
6963 t
= (time_t) dictGetEntryVal(de
);
6964 if (minttl
== -1 || t
< minttl
) {
6965 minkey
= dictGetEntryKey(de
);
6969 deleteKey(server
.db
+j
,minkey
);
6972 if (!freed
) return; /* nothing to free... */
6976 /* ============================== Append Only file ========================== */
6978 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6979 sds buf
= sdsempty();
6985 /* The DB this command was targetting is not the same as the last command
6986 * we appendend. To issue a SELECT command is needed. */
6987 if (dictid
!= server
.appendseldb
) {
6990 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6991 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6992 (unsigned long)strlen(seldb
),seldb
);
6993 server
.appendseldb
= dictid
;
6996 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6997 * EXPIREs into EXPIREATs calls */
6998 if (cmd
->proc
== expireCommand
) {
7001 tmpargv
[0] = createStringObject("EXPIREAT",8);
7002 tmpargv
[1] = argv
[1];
7003 incrRefCount(argv
[1]);
7004 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7005 tmpargv
[2] = createObject(REDIS_STRING
,
7006 sdscatprintf(sdsempty(),"%ld",when
));
7010 /* Append the actual command */
7011 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7012 for (j
= 0; j
< argc
; j
++) {
7015 o
= getDecodedObject(o
);
7016 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7017 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7018 buf
= sdscatlen(buf
,"\r\n",2);
7022 /* Free the objects from the modified argv for EXPIREAT */
7023 if (cmd
->proc
== expireCommand
) {
7024 for (j
= 0; j
< 3; j
++)
7025 decrRefCount(argv
[j
]);
7028 /* We want to perform a single write. This should be guaranteed atomic
7029 * at least if the filesystem we are writing is a real physical one.
7030 * While this will save us against the server being killed I don't think
7031 * there is much to do about the whole server stopping for power problems
7033 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7034 if (nwritten
!= (signed)sdslen(buf
)) {
7035 /* Ooops, we are in troubles. The best thing to do for now is
7036 * to simply exit instead to give the illusion that everything is
7037 * working as expected. */
7038 if (nwritten
== -1) {
7039 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7041 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7045 /* If a background append only file rewriting is in progress we want to
7046 * accumulate the differences between the child DB and the current one
7047 * in a buffer, so that when the child process will do its work we
7048 * can append the differences to the new append only file. */
7049 if (server
.bgrewritechildpid
!= -1)
7050 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7054 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7055 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7056 now
-server
.lastfsync
> 1))
7058 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7059 server
.lastfsync
= now
;
7063 /* In Redis commands are always executed in the context of a client, so in
7064 * order to load the append only file we need to create a fake client. */
7065 static struct redisClient
*createFakeClient(void) {
7066 struct redisClient
*c
= zmalloc(sizeof(*c
));
7070 c
->querybuf
= sdsempty();
7074 /* We set the fake client as a slave waiting for the synchronization
7075 * so that Redis will not try to send replies to this client. */
7076 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7077 c
->reply
= listCreate();
7078 listSetFreeMethod(c
->reply
,decrRefCount
);
7079 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7083 static void freeFakeClient(struct redisClient
*c
) {
7084 sdsfree(c
->querybuf
);
7085 listRelease(c
->reply
);
7089 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7090 * error (the append only file is zero-length) REDIS_ERR is returned. On
7091 * fatal error an error message is logged and the program exists. */
7092 int loadAppendOnlyFile(char *filename
) {
7093 struct redisClient
*fakeClient
;
7094 FILE *fp
= fopen(filename
,"r");
7095 struct redis_stat sb
;
7096 unsigned long long loadedkeys
= 0;
7098 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7102 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7106 fakeClient
= createFakeClient();
7113 struct redisCommand
*cmd
;
7115 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7121 if (buf
[0] != '*') goto fmterr
;
7123 argv
= zmalloc(sizeof(robj
*)*argc
);
7124 for (j
= 0; j
< argc
; j
++) {
7125 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7126 if (buf
[0] != '$') goto fmterr
;
7127 len
= strtol(buf
+1,NULL
,10);
7128 argsds
= sdsnewlen(NULL
,len
);
7129 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7130 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7131 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7134 /* Command lookup */
7135 cmd
= lookupCommand(argv
[0]->ptr
);
7137 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7140 /* Try object sharing and encoding */
7141 if (server
.shareobjects
) {
7143 for(j
= 1; j
< argc
; j
++)
7144 argv
[j
] = tryObjectSharing(argv
[j
]);
7146 if (cmd
->flags
& REDIS_CMD_BULK
)
7147 tryObjectEncoding(argv
[argc
-1]);
7148 /* Run the command in the context of a fake client */
7149 fakeClient
->argc
= argc
;
7150 fakeClient
->argv
= argv
;
7151 cmd
->proc(fakeClient
);
7152 /* Discard the reply objects list from the fake client */
7153 while(listLength(fakeClient
->reply
))
7154 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7155 /* Clean up, ready for the next command */
7156 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7158 /* Handle swapping while loading big datasets when VM is on */
7160 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7161 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7162 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7167 freeFakeClient(fakeClient
);
7172 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7174 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7178 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7182 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7183 static int fwriteBulk(FILE *fp
, robj
*obj
) {
7187 /* Avoid the incr/decr ref count business if possible to help
7188 * copy-on-write (we are often in a child process when this function
7190 * Also makes sure that key objects don't get incrRefCount-ed when VM
7192 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7193 obj
= getDecodedObject(obj
);
7196 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7197 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7198 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7200 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7201 if (decrrc
) decrRefCount(obj
);
7204 if (decrrc
) decrRefCount(obj
);
7208 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7209 static int fwriteBulkDouble(FILE *fp
, double d
) {
7210 char buf
[128], dbuf
[128];
7212 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7213 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7214 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7215 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7219 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7220 static int fwriteBulkLong(FILE *fp
, long l
) {
7221 char buf
[128], lbuf
[128];
7223 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7224 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7225 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7226 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7230 /* Write a sequence of commands able to fully rebuild the dataset into
7231 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7232 static int rewriteAppendOnlyFile(char *filename
) {
7233 dictIterator
*di
= NULL
;
7238 time_t now
= time(NULL
);
7240 /* Note that we have to use a different temp name here compared to the
7241 * one used by rewriteAppendOnlyFileBackground() function. */
7242 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7243 fp
= fopen(tmpfile
,"w");
7245 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7248 for (j
= 0; j
< server
.dbnum
; j
++) {
7249 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7250 redisDb
*db
= server
.db
+j
;
7252 if (dictSize(d
) == 0) continue;
7253 di
= dictGetIterator(d
);
7259 /* SELECT the new DB */
7260 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7261 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7263 /* Iterate this DB writing every entry */
7264 while((de
= dictNext(di
)) != NULL
) {
7269 key
= dictGetEntryKey(de
);
7270 /* If the value for this key is swapped, load a preview in memory.
7271 * We use a "swapped" flag to remember if we need to free the
7272 * value object instead to just increment the ref count anyway
7273 * in order to avoid copy-on-write of pages if we are forked() */
7274 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7275 key
->storage
== REDIS_VM_SWAPPING
) {
7276 o
= dictGetEntryVal(de
);
7279 o
= vmPreviewObject(key
);
7282 expiretime
= getExpire(db
,key
);
7284 /* Save the key and associated value */
7285 if (o
->type
== REDIS_STRING
) {
7286 /* Emit a SET command */
7287 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7288 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7290 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7291 if (fwriteBulk(fp
,o
) == 0) goto werr
;
7292 } else if (o
->type
== REDIS_LIST
) {
7293 /* Emit the RPUSHes needed to rebuild the list */
7294 list
*list
= o
->ptr
;
7298 listRewind(list
,&li
);
7299 while((ln
= listNext(&li
))) {
7300 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7301 robj
*eleobj
= listNodeValue(ln
);
7303 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7304 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7305 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7307 } else if (o
->type
== REDIS_SET
) {
7308 /* Emit the SADDs needed to rebuild the set */
7310 dictIterator
*di
= dictGetIterator(set
);
7313 while((de
= dictNext(di
)) != NULL
) {
7314 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7315 robj
*eleobj
= dictGetEntryKey(de
);
7317 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7318 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7319 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7321 dictReleaseIterator(di
);
7322 } else if (o
->type
== REDIS_ZSET
) {
7323 /* Emit the ZADDs needed to rebuild the sorted set */
7325 dictIterator
*di
= dictGetIterator(zs
->dict
);
7328 while((de
= dictNext(di
)) != NULL
) {
7329 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7330 robj
*eleobj
= dictGetEntryKey(de
);
7331 double *score
= dictGetEntryVal(de
);
7333 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7334 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7335 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7336 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7338 dictReleaseIterator(di
);
7340 redisAssert(0 != 0);
7342 /* Save the expire time */
7343 if (expiretime
!= -1) {
7344 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7345 /* If this key is already expired skip it */
7346 if (expiretime
< now
) continue;
7347 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7348 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7349 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7351 if (swapped
) decrRefCount(o
);
7353 dictReleaseIterator(di
);
7356 /* Make sure data will not remain on the OS's output buffers */
7361 /* Use RENAME to make sure the DB file is changed atomically only
7362 * if the generate DB file is ok. */
7363 if (rename(tmpfile
,filename
) == -1) {
7364 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7368 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7374 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7375 if (di
) dictReleaseIterator(di
);
7379 /* This is how rewriting of the append only file in background works:
7381 * 1) The user calls BGREWRITEAOF
7382 * 2) Redis calls this function, that forks():
7383 * 2a) the child rewrite the append only file in a temp file.
7384 * 2b) the parent accumulates differences in server.bgrewritebuf.
7385 * 3) When the child finished '2a' exists.
7386 * 4) The parent will trap the exit code, if it's OK, will append the
7387 * data accumulated into server.bgrewritebuf into the temp file, and
7388 * finally will rename(2) the temp file in the actual file name.
7389 * The the new file is reopened as the new append only file. Profit!
7391 static int rewriteAppendOnlyFileBackground(void) {
7394 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7395 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7396 if ((childpid
= fork()) == 0) {
7400 if (server
.vm_enabled
) vmReopenSwapFile();
7402 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7403 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7410 if (childpid
== -1) {
7411 redisLog(REDIS_WARNING
,
7412 "Can't rewrite append only file in background: fork: %s",
7416 redisLog(REDIS_NOTICE
,
7417 "Background append only file rewriting started by pid %d",childpid
);
7418 server
.bgrewritechildpid
= childpid
;
7419 /* We set appendseldb to -1 in order to force the next call to the
7420 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7421 * accumulated by the parent into server.bgrewritebuf will start
7422 * with a SELECT statement and it will be safe to merge. */
7423 server
.appendseldb
= -1;
7426 return REDIS_OK
; /* unreached */
7429 static void bgrewriteaofCommand(redisClient
*c
) {
7430 if (server
.bgrewritechildpid
!= -1) {
7431 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7434 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7435 char *status
= "+Background append only file rewriting started\r\n";
7436 addReplySds(c
,sdsnew(status
));
7438 addReply(c
,shared
.err
);
7442 static void aofRemoveTempFile(pid_t childpid
) {
7445 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7449 /* Virtual Memory is composed mainly of two subsystems:
7450 * - Blocking Virutal Memory
7451 * - Threaded Virtual Memory I/O
7452 * The two parts are not fully decoupled, but functions are split among two
7453 * different sections of the source code (delimited by comments) in order to
7454 * make more clear what functionality is about the blocking VM and what about
7455 * the threaded (not blocking) VM.
7459 * Redis VM is a blocking VM (one that blocks reading swapped values from
7460 * disk into memory when a value swapped out is needed in memory) that is made
7461 * unblocking by trying to examine the command argument vector in order to
7462 * load in background values that will likely be needed in order to exec
7463 * the command. The command is executed only once all the relevant keys
7464 * are loaded into memory.
7466 * This basically is almost as simple of a blocking VM, but almost as parallel
7467 * as a fully non-blocking VM.
7470 /* =================== Virtual Memory - Blocking Side ====================== */
7472 /* substitute the first occurrence of '%p' with the process pid in the
7473 * swap file name. */
7474 static void expandVmSwapFilename(void) {
7475 char *p
= strstr(server
.vm_swap_file
,"%p");
7481 new = sdscat(new,server
.vm_swap_file
);
7482 new = sdscatprintf(new,"%ld",(long) getpid());
7483 new = sdscat(new,p
+2);
7484 zfree(server
.vm_swap_file
);
7485 server
.vm_swap_file
= new;
7488 static void vmInit(void) {
7493 if (server
.vm_max_threads
!= 0)
7494 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7496 expandVmSwapFilename();
7497 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7498 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7499 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7501 if (server
.vm_fp
== NULL
) {
7502 redisLog(REDIS_WARNING
,
7503 "Impossible to open the swap file: %s. Exiting.",
7507 server
.vm_fd
= fileno(server
.vm_fp
);
7508 server
.vm_next_page
= 0;
7509 server
.vm_near_pages
= 0;
7510 server
.vm_stats_used_pages
= 0;
7511 server
.vm_stats_swapped_objects
= 0;
7512 server
.vm_stats_swapouts
= 0;
7513 server
.vm_stats_swapins
= 0;
7514 totsize
= server
.vm_pages
*server
.vm_page_size
;
7515 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7516 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7517 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7521 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7523 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7524 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7525 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7526 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7528 /* Initialize threaded I/O (used by Virtual Memory) */
7529 server
.io_newjobs
= listCreate();
7530 server
.io_processing
= listCreate();
7531 server
.io_processed
= listCreate();
7532 server
.io_ready_clients
= listCreate();
7533 pthread_mutex_init(&server
.io_mutex
,NULL
);
7534 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7535 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7536 server
.io_active_threads
= 0;
7537 if (pipe(pipefds
) == -1) {
7538 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7542 server
.io_ready_pipe_read
= pipefds
[0];
7543 server
.io_ready_pipe_write
= pipefds
[1];
7544 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7545 /* LZF requires a lot of stack */
7546 pthread_attr_init(&server
.io_threads_attr
);
7547 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7548 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7549 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7550 /* Listen for events in the threaded I/O pipe */
7551 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7552 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7553 oom("creating file event");
7556 /* Mark the page as used */
7557 static void vmMarkPageUsed(off_t page
) {
7558 off_t byte
= page
/8;
7560 redisAssert(vmFreePage(page
) == 1);
7561 server
.vm_bitmap
[byte
] |= 1<<bit
;
7564 /* Mark N contiguous pages as used, with 'page' being the first. */
7565 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7568 for (j
= 0; j
< count
; j
++)
7569 vmMarkPageUsed(page
+j
);
7570 server
.vm_stats_used_pages
+= count
;
7571 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
7572 (long long)count
, (long long)page
);
7575 /* Mark the page as free */
7576 static void vmMarkPageFree(off_t page
) {
7577 off_t byte
= page
/8;
7579 redisAssert(vmFreePage(page
) == 0);
7580 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7583 /* Mark N contiguous pages as free, with 'page' being the first. */
7584 static void vmMarkPagesFree(off_t page
, off_t count
) {
7587 for (j
= 0; j
< count
; j
++)
7588 vmMarkPageFree(page
+j
);
7589 server
.vm_stats_used_pages
-= count
;
7590 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
7591 (long long)count
, (long long)page
);
7594 /* Test if the page is free */
7595 static int vmFreePage(off_t page
) {
7596 off_t byte
= page
/8;
7598 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7601 /* Find N contiguous free pages storing the first page of the cluster in *first.
7602 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7603 * REDIS_ERR is returned.
7605 * This function uses a simple algorithm: we try to allocate
7606 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7607 * again from the start of the swap file searching for free spaces.
7609 * If it looks pretty clear that there are no free pages near our offset
7610 * we try to find less populated places doing a forward jump of
7611 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7612 * without hurry, and then we jump again and so forth...
7614 * This function can be improved using a free list to avoid to guess
7615 * too much, since we could collect data about freed pages.
7617 * note: I implemented this function just after watching an episode of
7618 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7620 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7621 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7623 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7624 server
.vm_near_pages
= 0;
7625 server
.vm_next_page
= 0;
7627 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7628 base
= server
.vm_next_page
;
7630 while(offset
< server
.vm_pages
) {
7631 off_t
this = base
+offset
;
7633 /* If we overflow, restart from page zero */
7634 if (this >= server
.vm_pages
) {
7635 this -= server
.vm_pages
;
7637 /* Just overflowed, what we found on tail is no longer
7638 * interesting, as it's no longer contiguous. */
7642 if (vmFreePage(this)) {
7643 /* This is a free page */
7645 /* Already got N free pages? Return to the caller, with success */
7647 *first
= this-(n
-1);
7648 server
.vm_next_page
= this+1;
7649 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
7653 /* The current one is not a free page */
7657 /* Fast-forward if the current page is not free and we already
7658 * searched enough near this place. */
7660 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7661 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7663 /* Note that even if we rewind after the jump, we are don't need
7664 * to make sure numfree is set to zero as we only jump *if* it
7665 * is set to zero. */
7667 /* Otherwise just check the next page */
7674 /* Write the specified object at the specified page of the swap file */
7675 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7676 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7677 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7678 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7679 redisLog(REDIS_WARNING
,
7680 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
7684 rdbSaveObject(server
.vm_fp
,o
);
7685 fflush(server
.vm_fp
);
7686 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7690 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7691 * needed to later retrieve the object into the key object.
7692 * If we can't find enough contiguous empty pages to swap the object on disk
7693 * REDIS_ERR is returned. */
7694 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7695 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7698 assert(key
->storage
== REDIS_VM_MEMORY
);
7699 assert(key
->refcount
== 1);
7700 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7701 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7702 key
->vm
.page
= page
;
7703 key
->vm
.usedpages
= pages
;
7704 key
->storage
= REDIS_VM_SWAPPED
;
7705 key
->vtype
= val
->type
;
7706 decrRefCount(val
); /* Deallocate the object from memory. */
7707 vmMarkPagesUsed(page
,pages
);
7708 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7709 (unsigned char*) key
->ptr
,
7710 (unsigned long long) page
, (unsigned long long) pages
);
7711 server
.vm_stats_swapped_objects
++;
7712 server
.vm_stats_swapouts
++;
7716 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7719 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7720 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7721 redisLog(REDIS_WARNING
,
7722 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7726 o
= rdbLoadObject(type
,server
.vm_fp
);
7728 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7731 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7735 /* Load the value object relative to the 'key' object from swap to memory.
7736 * The newly allocated object is returned.
7738 * If preview is true the unserialized object is returned to the caller but
7739 * no changes are made to the key object, nor the pages are marked as freed */
7740 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7743 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7744 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7746 key
->storage
= REDIS_VM_MEMORY
;
7747 key
->vm
.atime
= server
.unixtime
;
7748 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7749 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7750 (unsigned char*) key
->ptr
);
7751 server
.vm_stats_swapped_objects
--;
7753 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7754 (unsigned char*) key
->ptr
);
7756 server
.vm_stats_swapins
++;
7760 /* Plain object loading, from swap to memory */
7761 static robj
*vmLoadObject(robj
*key
) {
7762 /* If we are loading the object in background, stop it, we
7763 * need to load this object synchronously ASAP. */
7764 if (key
->storage
== REDIS_VM_LOADING
)
7765 vmCancelThreadedIOJob(key
);
7766 return vmGenericLoadObject(key
,0);
7769 /* Just load the value on disk, without to modify the key.
7770 * This is useful when we want to perform some operation on the value
7771 * without to really bring it from swap to memory, like while saving the
7772 * dataset or rewriting the append only log. */
7773 static robj
*vmPreviewObject(robj
*key
) {
7774 return vmGenericLoadObject(key
,1);
7777 /* How a good candidate is this object for swapping?
7778 * The better candidate it is, the greater the returned value.
7780 * Currently we try to perform a fast estimation of the object size in
7781 * memory, and combine it with aging informations.
7783 * Basically swappability = idle-time * log(estimated size)
7785 * Bigger objects are preferred over smaller objects, but not
7786 * proportionally, this is why we use the logarithm. This algorithm is
7787 * just a first try and will probably be tuned later. */
7788 static double computeObjectSwappability(robj
*o
) {
7789 time_t age
= server
.unixtime
- o
->vm
.atime
;
7793 struct dictEntry
*de
;
7796 if (age
<= 0) return 0;
7799 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7802 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7807 listNode
*ln
= listFirst(l
);
7809 asize
= sizeof(list
);
7811 robj
*ele
= ln
->value
;
7814 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7815 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7817 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7822 z
= (o
->type
== REDIS_ZSET
);
7823 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7825 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7826 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7831 de
= dictGetRandomKey(d
);
7832 ele
= dictGetEntryKey(de
);
7833 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7834 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7836 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7837 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7841 return (double)age
*log(1+asize
);
7844 /* Try to swap an object that's a good candidate for swapping.
7845 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7846 * to swap any object at all.
7848 * If 'usethreaded' is true, Redis will try to swap the object in background
7849 * using I/O threads. */
7850 static int vmSwapOneObject(int usethreads
) {
7852 struct dictEntry
*best
= NULL
;
7853 double best_swappability
= 0;
7854 redisDb
*best_db
= NULL
;
7857 for (j
= 0; j
< server
.dbnum
; j
++) {
7858 redisDb
*db
= server
.db
+j
;
7859 /* Why maxtries is set to 100?
7860 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7861 * are swappable objects */
7864 if (dictSize(db
->dict
) == 0) continue;
7865 for (i
= 0; i
< 5; i
++) {
7867 double swappability
;
7869 if (maxtries
) maxtries
--;
7870 de
= dictGetRandomKey(db
->dict
);
7871 key
= dictGetEntryKey(de
);
7872 val
= dictGetEntryVal(de
);
7873 /* Only swap objects that are currently in memory.
7875 * Also don't swap shared objects if threaded VM is on, as we
7876 * try to ensure that the main thread does not touch the
7877 * object while the I/O thread is using it, but we can't
7878 * control other keys without adding additional mutex. */
7879 if (key
->storage
!= REDIS_VM_MEMORY
||
7880 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7881 if (maxtries
) i
--; /* don't count this try */
7884 swappability
= computeObjectSwappability(val
);
7885 if (!best
|| swappability
> best_swappability
) {
7887 best_swappability
= swappability
;
7892 if (best
== NULL
) return REDIS_ERR
;
7893 key
= dictGetEntryKey(best
);
7894 val
= dictGetEntryVal(best
);
7896 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7897 key
->ptr
, best_swappability
);
7899 /* Unshare the key if needed */
7900 if (key
->refcount
> 1) {
7901 robj
*newkey
= dupStringObject(key
);
7903 key
= dictGetEntryKey(best
) = newkey
;
7907 vmSwapObjectThreaded(key
,val
,best_db
);
7910 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7911 dictGetEntryVal(best
) = NULL
;
7919 static int vmSwapOneObjectBlocking() {
7920 return vmSwapOneObject(0);
7923 static int vmSwapOneObjectThreaded() {
7924 return vmSwapOneObject(1);
7927 /* Return true if it's safe to swap out objects in a given moment.
7928 * Basically we don't want to swap objects out while there is a BGSAVE
7929 * or a BGAEOREWRITE running in backgroud. */
7930 static int vmCanSwapOut(void) {
7931 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7934 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7935 * and was deleted. Otherwise 0 is returned. */
7936 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7940 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7941 foundkey
= dictGetEntryKey(de
);
7942 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7947 /* =================== Virtual Memory - Threaded I/O ======================= */
7949 static void freeIOJob(iojob
*j
) {
7950 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7951 j
->type
== REDIS_IOJOB_DO_SWAP
||
7952 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7953 decrRefCount(j
->val
);
7954 decrRefCount(j
->key
);
7958 /* Every time a thread finished a Job, it writes a byte into the write side
7959 * of an unix pipe in order to "awake" the main thread, and this function
7961 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7965 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7967 REDIS_NOTUSED(mask
);
7968 REDIS_NOTUSED(privdata
);
7970 /* For every byte we read in the read side of the pipe, there is one
7971 * I/O job completed to process. */
7972 while((retval
= read(fd
,buf
,1)) == 1) {
7976 struct dictEntry
*de
;
7978 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7980 /* Get the processed element (the oldest one) */
7982 assert(listLength(server
.io_processed
) != 0);
7983 if (toprocess
== -1) {
7984 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7985 if (toprocess
<= 0) toprocess
= 1;
7987 ln
= listFirst(server
.io_processed
);
7989 listDelNode(server
.io_processed
,ln
);
7991 /* If this job is marked as canceled, just ignore it */
7996 /* Post process it in the main thread, as there are things we
7997 * can do just here to avoid race conditions and/or invasive locks */
7998 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
);
7999 de
= dictFind(j
->db
->dict
,j
->key
);
8001 key
= dictGetEntryKey(de
);
8002 if (j
->type
== REDIS_IOJOB_LOAD
) {
8005 /* Key loaded, bring it at home */
8006 key
->storage
= REDIS_VM_MEMORY
;
8007 key
->vm
.atime
= server
.unixtime
;
8008 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8009 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8010 (unsigned char*) key
->ptr
);
8011 server
.vm_stats_swapped_objects
--;
8012 server
.vm_stats_swapins
++;
8013 dictGetEntryVal(de
) = j
->val
;
8014 incrRefCount(j
->val
);
8017 /* Handle clients waiting for this key to be loaded. */
8018 handleClientsBlockedOnSwappedKey(db
,key
);
8019 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8020 /* Now we know the amount of pages required to swap this object.
8021 * Let's find some space for it, and queue this task again
8022 * rebranded as REDIS_IOJOB_DO_SWAP. */
8023 if (!vmCanSwapOut() ||
8024 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8026 /* Ooops... no space or we can't swap as there is
8027 * a fork()ed Redis trying to save stuff on disk. */
8029 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8031 /* Note that we need to mark this pages as used now,
8032 * if the job will be canceled, we'll mark them as freed
8034 vmMarkPagesUsed(j
->page
,j
->pages
);
8035 j
->type
= REDIS_IOJOB_DO_SWAP
;
8040 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8043 /* Key swapped. We can finally free some memory. */
8044 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8045 printf("key->storage: %d\n",key
->storage
);
8046 printf("key->name: %s\n",(char*)key
->ptr
);
8047 printf("key->refcount: %d\n",key
->refcount
);
8048 printf("val: %p\n",(void*)j
->val
);
8049 printf("val->type: %d\n",j
->val
->type
);
8050 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8052 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8053 val
= dictGetEntryVal(de
);
8054 key
->vm
.page
= j
->page
;
8055 key
->vm
.usedpages
= j
->pages
;
8056 key
->storage
= REDIS_VM_SWAPPED
;
8057 key
->vtype
= j
->val
->type
;
8058 decrRefCount(val
); /* Deallocate the object from memory. */
8059 dictGetEntryVal(de
) = NULL
;
8060 redisLog(REDIS_DEBUG
,
8061 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8062 (unsigned char*) key
->ptr
,
8063 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8064 server
.vm_stats_swapped_objects
++;
8065 server
.vm_stats_swapouts
++;
8067 /* Put a few more swap requests in queue if we are still
8069 if (trytoswap
&& vmCanSwapOut() &&
8070 zmalloc_used_memory() > server
.vm_max_memory
)
8075 more
= listLength(server
.io_newjobs
) <
8076 (unsigned) server
.vm_max_threads
;
8078 /* Don't waste CPU time if swappable objects are rare. */
8079 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8087 if (processed
== toprocess
) return;
8089 if (retval
< 0 && errno
!= EAGAIN
) {
8090 redisLog(REDIS_WARNING
,
8091 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8096 static void lockThreadedIO(void) {
8097 pthread_mutex_lock(&server
.io_mutex
);
8100 static void unlockThreadedIO(void) {
8101 pthread_mutex_unlock(&server
.io_mutex
);
8104 /* Remove the specified object from the threaded I/O queue if still not
8105 * processed, otherwise make sure to flag it as canceled. */
8106 static void vmCancelThreadedIOJob(robj
*o
) {
8108 server
.io_newjobs
, /* 0 */
8109 server
.io_processing
, /* 1 */
8110 server
.io_processed
/* 2 */
8114 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8117 /* Search for a matching key in one of the queues */
8118 for (i
= 0; i
< 3; i
++) {
8122 listRewind(lists
[i
],&li
);
8123 while ((ln
= listNext(&li
)) != NULL
) {
8124 iojob
*job
= ln
->value
;
8126 if (job
->canceled
) continue; /* Skip this, already canceled. */
8127 if (compareStringObjects(job
->key
,o
) == 0) {
8128 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8129 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8130 /* Mark the pages as free since the swap didn't happened
8131 * or happened but is now discarded. */
8132 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8133 vmMarkPagesFree(job
->page
,job
->pages
);
8134 /* Cancel the job. It depends on the list the job is
8137 case 0: /* io_newjobs */
8138 /* If the job was yet not processed the best thing to do
8139 * is to remove it from the queue at all */
8141 listDelNode(lists
[i
],ln
);
8143 case 1: /* io_processing */
8144 /* Oh Shi- the thread is messing with the Job:
8146 * Probably it's accessing the object if this is a
8147 * PREPARE_SWAP or DO_SWAP job.
8148 * If it's a LOAD job it may be reading from disk and
8149 * if we don't wait for the job to terminate before to
8150 * cancel it, maybe in a few microseconds data can be
8151 * corrupted in this pages. So the short story is:
8153 * Better to wait for the job to move into the
8154 * next queue (processed)... */
8156 /* We try again and again until the job is completed. */
8158 /* But let's wait some time for the I/O thread
8159 * to finish with this job. After all this condition
8160 * should be very rare. */
8163 case 2: /* io_processed */
8164 /* The job was already processed, that's easy...
8165 * just mark it as canceled so that we'll ignore it
8166 * when processing completed jobs. */
8170 /* Finally we have to adjust the storage type of the object
8171 * in order to "UNDO" the operaiton. */
8172 if (o
->storage
== REDIS_VM_LOADING
)
8173 o
->storage
= REDIS_VM_SWAPPED
;
8174 else if (o
->storage
== REDIS_VM_SWAPPING
)
8175 o
->storage
= REDIS_VM_MEMORY
;
8182 assert(1 != 1); /* We should never reach this */
8185 static void *IOThreadEntryPoint(void *arg
) {
8190 pthread_detach(pthread_self());
8192 /* Get a new job to process */
8194 if (listLength(server
.io_newjobs
) == 0) {
8195 /* No new jobs in queue, exit. */
8196 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8197 (long) pthread_self());
8198 server
.io_active_threads
--;
8202 ln
= listFirst(server
.io_newjobs
);
8204 listDelNode(server
.io_newjobs
,ln
);
8205 /* Add the job in the processing queue */
8206 j
->thread
= pthread_self();
8207 listAddNodeTail(server
.io_processing
,j
);
8208 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8210 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8211 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8213 /* Process the Job */
8214 if (j
->type
== REDIS_IOJOB_LOAD
) {
8215 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8216 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8217 FILE *fp
= fopen("/dev/null","w+");
8218 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8220 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8221 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8225 /* Done: insert the job into the processed queue */
8226 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8227 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8229 listDelNode(server
.io_processing
,ln
);
8230 listAddNodeTail(server
.io_processed
,j
);
8233 /* Signal the main thread there is new stuff to process */
8234 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8236 return NULL
; /* never reached */
8239 static void spawnIOThread(void) {
8241 sigset_t mask
, omask
;
8244 sigaddset(&mask
,SIGCHLD
);
8245 sigaddset(&mask
,SIGHUP
);
8246 sigaddset(&mask
,SIGPIPE
);
8247 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8248 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
8249 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8250 server
.io_active_threads
++;
8253 /* We need to wait for the last thread to exit before we are able to
8254 * fork() in order to BGSAVE or BGREWRITEAOF. */
8255 static void waitEmptyIOJobsQueue(void) {
8257 int io_processed_len
;
8260 if (listLength(server
.io_newjobs
) == 0 &&
8261 listLength(server
.io_processing
) == 0 &&
8262 server
.io_active_threads
== 0)
8267 /* While waiting for empty jobs queue condition we post-process some
8268 * finshed job, as I/O threads may be hanging trying to write against
8269 * the io_ready_pipe_write FD but there are so much pending jobs that
8271 io_processed_len
= listLength(server
.io_processed
);
8273 if (io_processed_len
) {
8274 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8275 usleep(1000); /* 1 millisecond */
8277 usleep(10000); /* 10 milliseconds */
8282 static void vmReopenSwapFile(void) {
8283 /* Note: we don't close the old one as we are in the child process
8284 * and don't want to mess at all with the original file object. */
8285 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8286 if (server
.vm_fp
== NULL
) {
8287 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8288 server
.vm_swap_file
);
8291 server
.vm_fd
= fileno(server
.vm_fp
);
8294 /* This function must be called while with threaded IO locked */
8295 static void queueIOJob(iojob
*j
) {
8296 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8297 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8298 listAddNodeTail(server
.io_newjobs
,j
);
8299 if (server
.io_active_threads
< server
.vm_max_threads
)
8303 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8306 assert(key
->storage
== REDIS_VM_MEMORY
);
8307 assert(key
->refcount
== 1);
8309 j
= zmalloc(sizeof(*j
));
8310 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8312 j
->key
= dupStringObject(key
);
8316 j
->thread
= (pthread_t
) -1;
8317 key
->storage
= REDIS_VM_SWAPPING
;
8325 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8327 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8328 * If there is not already a job loading the key, it is craeted.
8329 * The key is added to the io_keys list in the client structure, and also
8330 * in the hash table mapping swapped keys to waiting clients, that is,
8331 * server.io_waited_keys. */
8332 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8333 struct dictEntry
*de
;
8337 /* If the key does not exist or is already in RAM we don't need to
8338 * block the client at all. */
8339 de
= dictFind(c
->db
->dict
,key
);
8340 if (de
== NULL
) return 0;
8341 o
= dictGetEntryKey(de
);
8342 if (o
->storage
== REDIS_VM_MEMORY
) {
8344 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8345 /* We were swapping the key, undo it! */
8346 vmCancelThreadedIOJob(o
);
8350 /* OK: the key is either swapped, or being loaded just now. */
8352 /* Add the key to the list of keys this client is waiting for.
8353 * This maps clients to keys they are waiting for. */
8354 listAddNodeTail(c
->io_keys
,key
);
8357 /* Add the client to the swapped keys => clients waiting map. */
8358 de
= dictFind(c
->db
->io_keys
,key
);
8362 /* For every key we take a list of clients blocked for it */
8364 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8366 assert(retval
== DICT_OK
);
8368 l
= dictGetEntryVal(de
);
8370 listAddNodeTail(l
,c
);
8372 /* Are we already loading the key from disk? If not create a job */
8373 if (o
->storage
== REDIS_VM_SWAPPED
) {
8376 o
->storage
= REDIS_VM_LOADING
;
8377 j
= zmalloc(sizeof(*j
));
8378 j
->type
= REDIS_IOJOB_LOAD
;
8380 j
->key
= dupStringObject(key
);
8381 j
->key
->vtype
= o
->vtype
;
8382 j
->page
= o
->vm
.page
;
8385 j
->thread
= (pthread_t
) -1;
8393 /* Is this client attempting to run a command against swapped keys?
8394 * If so, block it ASAP, load the keys in background, then resume it.
8396 * The important idea about this function is that it can fail! If keys will
8397 * still be swapped when the client is resumed, this key lookups will
8398 * just block loading keys from disk. In practical terms this should only
8399 * happen with SORT BY command or if there is a bug in this function.
8401 * Return 1 if the client is marked as blocked, 0 if the client can
8402 * continue as the keys it is going to access appear to be in memory. */
8403 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8406 if (cmd
->vm_firstkey
== 0) return 0;
8407 last
= cmd
->vm_lastkey
;
8408 if (last
< 0) last
= c
->argc
+last
;
8409 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8410 waitForSwappedKey(c
,c
->argv
[j
]);
8411 /* If the client was blocked for at least one key, mark it as blocked. */
8412 if (listLength(c
->io_keys
)) {
8413 c
->flags
|= REDIS_IO_WAIT
;
8414 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8415 server
.vm_blocked_clients
++;
8422 /* Remove the 'key' from the list of blocked keys for a given client.
8424 * The function returns 1 when there are no longer blocking keys after
8425 * the current one was removed (and the client can be unblocked). */
8426 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8430 struct dictEntry
*de
;
8432 /* Remove the key from the list of keys this client is waiting for. */
8433 listRewind(c
->io_keys
,&li
);
8434 while ((ln
= listNext(&li
)) != NULL
) {
8435 if (compareStringObjects(ln
->value
,key
) == 0) {
8436 listDelNode(c
->io_keys
,ln
);
8442 /* Remove the client form the key => waiting clients map. */
8443 de
= dictFind(c
->db
->io_keys
,key
);
8445 l
= dictGetEntryVal(de
);
8446 ln
= listSearchKey(l
,c
);
8449 if (listLength(l
) == 0)
8450 dictDelete(c
->db
->io_keys
,key
);
8452 return listLength(c
->io_keys
) == 0;
8455 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8456 struct dictEntry
*de
;
8461 de
= dictFind(db
->io_keys
,key
);
8464 l
= dictGetEntryVal(de
);
8465 len
= listLength(l
);
8466 /* Note: we can't use something like while(listLength(l)) as the list
8467 * can be freed by the calling function when we remove the last element. */
8470 redisClient
*c
= ln
->value
;
8472 if (dontWaitForSwappedKey(c
,key
)) {
8473 /* Put the client in the list of clients ready to go as we
8474 * loaded all the keys about it. */
8475 listAddNodeTail(server
.io_ready_clients
,c
);
8480 /* ================================= Debugging ============================== */
8482 static void debugCommand(redisClient
*c
) {
8483 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8485 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8486 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8487 addReply(c
,shared
.err
);
8491 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8492 addReply(c
,shared
.err
);
8495 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8496 addReply(c
,shared
.ok
);
8497 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8499 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8500 addReply(c
,shared
.err
);
8503 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8504 addReply(c
,shared
.ok
);
8505 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8506 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8510 addReply(c
,shared
.nokeyerr
);
8513 key
= dictGetEntryKey(de
);
8514 val
= dictGetEntryVal(de
);
8515 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8516 key
->storage
== REDIS_VM_SWAPPING
)) {
8517 addReplySds(c
,sdscatprintf(sdsempty(),
8518 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8519 "encoding:%d serializedlength:%lld\r\n",
8520 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8521 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8523 addReplySds(c
,sdscatprintf(sdsempty(),
8524 "+Key at:%p refcount:%d, value swapped at: page %llu "
8525 "using %llu pages\r\n",
8526 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8527 (unsigned long long) key
->vm
.usedpages
));
8529 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8530 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8533 if (!server
.vm_enabled
) {
8534 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8538 addReply(c
,shared
.nokeyerr
);
8541 key
= dictGetEntryKey(de
);
8542 val
= dictGetEntryVal(de
);
8543 /* If the key is shared we want to create a copy */
8544 if (key
->refcount
> 1) {
8545 robj
*newkey
= dupStringObject(key
);
8547 key
= dictGetEntryKey(de
) = newkey
;
8550 if (key
->storage
!= REDIS_VM_MEMORY
) {
8551 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8552 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8553 dictGetEntryVal(de
) = NULL
;
8554 addReply(c
,shared
.ok
);
8556 addReply(c
,shared
.err
);
8559 addReplySds(c
,sdsnew(
8560 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8564 static void _redisAssert(char *estr
, char *file
, int line
) {
8565 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8566 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8567 #ifdef HAVE_BACKTRACE
8568 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8573 /* =================================== Main! ================================ */
8576 int linuxOvercommitMemoryValue(void) {
8577 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8581 if (fgets(buf
,64,fp
) == NULL
) {
8590 void linuxOvercommitMemoryWarning(void) {
8591 if (linuxOvercommitMemoryValue() == 0) {
8592 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.");
8595 #endif /* __linux__ */
8597 static void daemonize(void) {
8601 if (fork() != 0) exit(0); /* parent exits */
8602 setsid(); /* create a new session */
8604 /* Every output goes to /dev/null. If Redis is daemonized but
8605 * the 'logfile' is set to 'stdout' in the configuration file
8606 * it will not log at all. */
8607 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8608 dup2(fd
, STDIN_FILENO
);
8609 dup2(fd
, STDOUT_FILENO
);
8610 dup2(fd
, STDERR_FILENO
);
8611 if (fd
> STDERR_FILENO
) close(fd
);
8613 /* Try to write the pid file */
8614 fp
= fopen(server
.pidfile
,"w");
8616 fprintf(fp
,"%d\n",getpid());
8621 int main(int argc
, char **argv
) {
8626 resetServerSaveParams();
8627 loadServerConfig(argv
[1]);
8628 } else if (argc
> 2) {
8629 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8632 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'");
8634 if (server
.daemonize
) daemonize();
8636 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8638 linuxOvercommitMemoryWarning();
8641 if (server
.appendonly
) {
8642 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8643 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8645 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8646 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8648 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8649 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8651 aeDeleteEventLoop(server
.el
);
8655 /* ============================= Backtrace support ========================= */
8657 #ifdef HAVE_BACKTRACE
8658 static char *findFuncName(void *pointer
, unsigned long *offset
);
8660 static void *getMcontextEip(ucontext_t
*uc
) {
8661 #if defined(__FreeBSD__)
8662 return (void*) uc
->uc_mcontext
.mc_eip
;
8663 #elif defined(__dietlibc__)
8664 return (void*) uc
->uc_mcontext
.eip
;
8665 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8667 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8669 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8671 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8672 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8673 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8675 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8677 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8678 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8679 #elif defined(__ia64__) /* Linux IA64 */
8680 return (void*) uc
->uc_mcontext
.sc_ip
;
8686 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8688 char **messages
= NULL
;
8689 int i
, trace_size
= 0;
8690 unsigned long offset
=0;
8691 ucontext_t
*uc
= (ucontext_t
*) secret
;
8693 REDIS_NOTUSED(info
);
8695 redisLog(REDIS_WARNING
,
8696 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8697 infostring
= genRedisInfoString();
8698 redisLog(REDIS_WARNING
, "%s",infostring
);
8699 /* It's not safe to sdsfree() the returned string under memory
8700 * corruption conditions. Let it leak as we are going to abort */
8702 trace_size
= backtrace(trace
, 100);
8703 /* overwrite sigaction with caller's address */
8704 if (getMcontextEip(uc
) != NULL
) {
8705 trace
[1] = getMcontextEip(uc
);
8707 messages
= backtrace_symbols(trace
, trace_size
);
8709 for (i
=1; i
<trace_size
; ++i
) {
8710 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8712 p
= strchr(messages
[i
],'+');
8713 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8714 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8716 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8719 /* free(messages); Don't call free() with possibly corrupted memory. */
8723 static void setupSigSegvAction(void) {
8724 struct sigaction act
;
8726 sigemptyset (&act
.sa_mask
);
8727 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8728 * is used. Otherwise, sa_handler is used */
8729 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8730 act
.sa_sigaction
= segvHandler
;
8731 sigaction (SIGSEGV
, &act
, NULL
);
8732 sigaction (SIGBUS
, &act
, NULL
);
8733 sigaction (SIGFPE
, &act
, NULL
);
8734 sigaction (SIGILL
, &act
, NULL
);
8735 sigaction (SIGBUS
, &act
, NULL
);
8739 #include "staticsymbols.h"
8740 /* This function try to convert a pointer into a function name. It's used in
8741 * oreder to provide a backtrace under segmentation fault that's able to
8742 * display functions declared as static (otherwise the backtrace is useless). */
8743 static char *findFuncName(void *pointer
, unsigned long *offset
){
8745 unsigned long off
, minoff
= 0;
8747 /* Try to match against the Symbol with the smallest offset */
8748 for (i
=0; symsTable
[i
].pointer
; i
++) {
8749 unsigned long lp
= (unsigned long) pointer
;
8751 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8752 off
=lp
-symsTable
[i
].pointer
;
8753 if (ret
< 0 || off
< minoff
) {
8759 if (ret
== -1) return NULL
;
8761 return symsTable
[ret
].name
;
8763 #else /* HAVE_BACKTRACE */
8764 static void setupSigSegvAction(void) {
8766 #endif /* HAVE_BACKTRACE */