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.3"
40 #define __USE_POSIX199309
46 #endif /* HAVE_BACKTRACE */
54 #include <arpa/inet.h>
58 #include <sys/resource.h>
65 #include "solarisfixes.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 4
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_STRING 0
120 /* Objects encoding */
121 #define REDIS_ENCODING_RAW 0 /* Raw representation */
122 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
124 /* Object types only used for dumping to disk */
125 #define REDIS_EXPIRETIME 253
126 #define REDIS_SELECTDB 254
127 #define REDIS_EOF 255
129 /* Defines related to the dump file format. To store 32 bits lengths for short
130 * keys requires a lot of space, so we check the most significant 2 bits of
131 * the first byte to interpreter the length:
133 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
134 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
135 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
136 * 11|000000 this means: specially encoded object will follow. The six bits
137 * number specify the kind of object that follows.
138 * See the REDIS_RDB_ENC_* defines.
140 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
141 * values, will fit inside. */
142 #define REDIS_RDB_6BITLEN 0
143 #define REDIS_RDB_14BITLEN 1
144 #define REDIS_RDB_32BITLEN 2
145 #define REDIS_RDB_ENCVAL 3
146 #define REDIS_RDB_LENERR UINT_MAX
148 /* When a length of a string object stored on disk has the first two bits
149 * set, the remaining two bits specify a special encoding for the object
150 * accordingly to the following defines: */
151 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
152 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
153 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
154 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
156 /* Virtual memory object->where field. */
157 #define REDIS_VM_MEMORY 0 /* The object is on memory */
158 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
159 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
160 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
162 /* Virtual memory static configuration stuff.
163 * Check vmFindContiguousPages() to know more about this magic numbers. */
164 #define REDIS_VM_MAX_NEAR_PAGES 65536
165 #define REDIS_VM_MAX_RANDOM_JUMP 4096
166 #define REDIS_VM_MAX_THREADS 32
167 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
168 /* The following is the *percentage* of completed I/O jobs to process when the
169 * handelr is called. While Virtual Memory I/O operations are performed by
170 * threads, this operations must be processed by the main thread when completed
171 * in order to take effect. */
172 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
175 #define REDIS_SLAVE 1 /* This client is a slave server */
176 #define REDIS_MASTER 2 /* This client is a master server */
177 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
178 #define REDIS_MULTI 8 /* This client is in a MULTI context */
179 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
180 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
182 /* Slave replication state - slave side */
183 #define REDIS_REPL_NONE 0 /* No active replication */
184 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
185 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
187 /* Slave replication state - from the point of view of master
188 * Note that in SEND_BULK and ONLINE state the slave receives new updates
189 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
190 * to start the next background saving in order to send updates to it. */
191 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
192 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
193 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
194 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
196 /* List related stuff */
200 /* Sort operations */
201 #define REDIS_SORT_GET 0
202 #define REDIS_SORT_ASC 1
203 #define REDIS_SORT_DESC 2
204 #define REDIS_SORTKEY_MAX 1024
207 #define REDIS_DEBUG 0
208 #define REDIS_VERBOSE 1
209 #define REDIS_NOTICE 2
210 #define REDIS_WARNING 3
212 /* Anti-warning macro... */
213 #define REDIS_NOTUSED(V) ((void) V)
215 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
216 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
218 /* Append only defines */
219 #define APPENDFSYNC_NO 0
220 #define APPENDFSYNC_ALWAYS 1
221 #define APPENDFSYNC_EVERYSEC 2
223 /* We can print the stacktrace, so our assert is defined this way: */
224 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
225 static void _redisAssert(char *estr
, char *file
, int line
);
227 /*================================= Data types ============================== */
229 /* A redis object, that is a type able to hold a string / list / set */
231 /* The VM object structure */
232 struct redisObjectVM
{
233 off_t page
; /* the page at witch the object is stored on disk */
234 off_t usedpages
; /* number of pages used on disk */
235 time_t atime
; /* Last access time */
238 /* The actual Redis Object */
239 typedef struct redisObject
{
242 unsigned char encoding
;
243 unsigned char storage
; /* If this object is a key, where is the value?
244 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
245 unsigned char vtype
; /* If this object is a key, and value is swapped out,
246 * this is the type of the swapped out object. */
248 /* VM fields, this are only allocated if VM is active, otherwise the
249 * object allocation function will just allocate
250 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
251 * Redis without VM active will not have any overhead. */
252 struct redisObjectVM vm
;
255 /* Macro used to initalize a Redis object allocated on the stack.
256 * Note that this macro is taken near the structure definition to make sure
257 * we'll update it when the structure is changed, to avoid bugs like
258 * bug #85 introduced exactly in this way. */
259 #define initStaticStringObject(_var,_ptr) do { \
261 _var.type = REDIS_STRING; \
262 _var.encoding = REDIS_ENCODING_RAW; \
264 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
267 typedef struct redisDb
{
268 dict
*dict
; /* The keyspace for this DB */
269 dict
*expires
; /* Timeout of keys with a timeout set */
270 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
271 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
275 /* Client MULTI/EXEC state */
276 typedef struct multiCmd
{
279 struct redisCommand
*cmd
;
282 typedef struct multiState
{
283 multiCmd
*commands
; /* Array of MULTI commands */
284 int count
; /* Total number of MULTI commands */
287 /* With multiplexing we need to take per-clinet state.
288 * Clients are taken in a liked list. */
289 typedef struct redisClient
{
294 robj
**argv
, **mbargv
;
296 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
297 int multibulk
; /* multi bulk command format active */
300 time_t lastinteraction
; /* time of the last interaction, used for timeout */
301 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
302 int slaveseldb
; /* slave selected db, if this client is a slave */
303 int authenticated
; /* when requirepass is non-NULL */
304 int replstate
; /* replication state if this is a slave */
305 int repldbfd
; /* replication DB file descriptor */
306 long repldboff
; /* replication DB file offset */
307 off_t repldbsize
; /* replication DB file size */
308 multiState mstate
; /* MULTI/EXEC state */
309 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
310 * operation such as BLPOP. Otherwise NULL. */
311 int blockingkeysnum
; /* Number of blocking keys */
312 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
313 * is >= blockingto then the operation timed out. */
314 list
*io_keys
; /* Keys this client is waiting to be loaded from the
315 * swap file in order to continue. */
323 /* Global server state structure */
328 dict
*sharingpool
; /* Poll used for object sharing */
329 unsigned int sharingpoolsize
;
330 long long dirty
; /* changes to DB from the last save */
332 list
*slaves
, *monitors
;
333 char neterr
[ANET_ERR_LEN
];
335 int cronloops
; /* number of times the cron function run */
336 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
337 time_t lastsave
; /* Unix time of last save succeeede */
338 /* Fields used only for stats */
339 time_t stat_starttime
; /* server start time */
340 long long stat_numcommands
; /* number of processed commands */
341 long long stat_numconnections
; /* number of connections received */
354 pid_t bgsavechildpid
;
355 pid_t bgrewritechildpid
;
356 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
357 struct saveparam
*saveparams
;
362 char *appendfilename
;
366 /* Replication related */
371 redisClient
*master
; /* client that is master for this slave */
373 unsigned int maxclients
;
374 unsigned long long maxmemory
;
375 unsigned int blpop_blocked_clients
;
376 unsigned int vm_blocked_clients
;
377 /* Sort parameters - qsort_r() is only available under BSD so we
378 * have to take this state global, in order to pass it to sortCompare() */
382 /* Virtual memory configuration */
387 unsigned long long vm_max_memory
;
388 /* Virtual memory state */
391 off_t vm_next_page
; /* Next probably empty page */
392 off_t vm_near_pages
; /* Number of pages allocated sequentially */
393 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
394 time_t unixtime
; /* Unix time sampled every second. */
395 /* Virtual memory I/O threads stuff */
396 /* An I/O thread process an element taken from the io_jobs queue and
397 * put the result of the operation in the io_done list. While the
398 * job is being processed, it's put on io_processing queue. */
399 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
400 list
*io_processing
; /* List of VM I/O jobs being processed */
401 list
*io_processed
; /* List of VM I/O jobs already processed */
402 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
403 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
404 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
405 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
406 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
407 int io_active_threads
; /* Number of running I/O threads */
408 int vm_max_threads
; /* Max number of I/O threads running at the same time */
409 /* Our main thread is blocked on the event loop, locking for sockets ready
410 * to be read or written, so when a threaded I/O operation is ready to be
411 * processed by the main thread, the I/O thread will use a unix pipe to
412 * awake the main thread. The followings are the two pipe FDs. */
413 int io_ready_pipe_read
;
414 int io_ready_pipe_write
;
415 /* Virtual memory stats */
416 unsigned long long vm_stats_used_pages
;
417 unsigned long long vm_stats_swapped_objects
;
418 unsigned long long vm_stats_swapouts
;
419 unsigned long long vm_stats_swapins
;
423 typedef void redisCommandProc(redisClient
*c
);
424 struct redisCommand
{
426 redisCommandProc
*proc
;
429 /* What keys should be loaded in background when calling this command? */
430 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
431 int vm_lastkey
; /* THe last argument that's a key */
432 int vm_keystep
; /* The step between first and last key */
435 struct redisFunctionSym
{
437 unsigned long pointer
;
440 typedef struct _redisSortObject
{
448 typedef struct _redisSortOperation
{
451 } redisSortOperation
;
453 /* ZSETs use a specialized version of Skiplists */
455 typedef struct zskiplistNode
{
456 struct zskiplistNode
**forward
;
457 struct zskiplistNode
*backward
;
462 typedef struct zskiplist
{
463 struct zskiplistNode
*header
, *tail
;
464 unsigned long length
;
468 typedef struct zset
{
473 /* Our shared "common" objects */
475 struct sharedObjectsStruct
{
476 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
477 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
478 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
479 *outofrangeerr
, *plus
,
480 *select0
, *select1
, *select2
, *select3
, *select4
,
481 *select5
, *select6
, *select7
, *select8
, *select9
;
484 /* Global vars that are actally used as constants. The following double
485 * values are used for double on-disk serialization, and are initialized
486 * at runtime to avoid strange compiler optimizations. */
488 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
490 /* VM threaded I/O request message */
491 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
492 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
493 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
494 typedef struct iojob
{
495 int type
; /* Request type, REDIS_IOJOB_* */
496 redisDb
*db
;/* Redis database */
497 robj
*key
; /* This I/O request is about swapping this key */
498 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
499 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
500 off_t page
; /* Swap page where to read/write the object */
501 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
502 int canceled
; /* True if this command was canceled by blocking side of VM */
503 pthread_t thread
; /* ID of the thread processing this entry */
506 /*================================ Prototypes =============================== */
508 static void freeStringObject(robj
*o
);
509 static void freeListObject(robj
*o
);
510 static void freeSetObject(robj
*o
);
511 static void decrRefCount(void *o
);
512 static robj
*createObject(int type
, void *ptr
);
513 static void freeClient(redisClient
*c
);
514 static int rdbLoad(char *filename
);
515 static void addReply(redisClient
*c
, robj
*obj
);
516 static void addReplySds(redisClient
*c
, sds s
);
517 static void incrRefCount(robj
*o
);
518 static int rdbSaveBackground(char *filename
);
519 static robj
*createStringObject(char *ptr
, size_t len
);
520 static robj
*dupStringObject(robj
*o
);
521 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
522 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
523 static int syncWithMaster(void);
524 static robj
*tryObjectSharing(robj
*o
);
525 static int tryObjectEncoding(robj
*o
);
526 static robj
*getDecodedObject(robj
*o
);
527 static int removeExpire(redisDb
*db
, robj
*key
);
528 static int expireIfNeeded(redisDb
*db
, robj
*key
);
529 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
530 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
531 static int deleteKey(redisDb
*db
, robj
*key
);
532 static time_t getExpire(redisDb
*db
, robj
*key
);
533 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
534 static void updateSlavesWaitingBgsave(int bgsaveerr
);
535 static void freeMemoryIfNeeded(void);
536 static int processCommand(redisClient
*c
);
537 static void setupSigSegvAction(void);
538 static void rdbRemoveTempFile(pid_t childpid
);
539 static void aofRemoveTempFile(pid_t childpid
);
540 static size_t stringObjectLen(robj
*o
);
541 static void processInputBuffer(redisClient
*c
);
542 static zskiplist
*zslCreate(void);
543 static void zslFree(zskiplist
*zsl
);
544 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
545 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
546 static void initClientMultiState(redisClient
*c
);
547 static void freeClientMultiState(redisClient
*c
);
548 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
549 static void unblockClientWaitingData(redisClient
*c
);
550 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
551 static void vmInit(void);
552 static void vmMarkPagesFree(off_t page
, off_t count
);
553 static robj
*vmLoadObject(robj
*key
);
554 static robj
*vmPreviewObject(robj
*key
);
555 static int vmSwapOneObjectBlocking(void);
556 static int vmSwapOneObjectThreaded(void);
557 static int vmCanSwapOut(void);
558 static int tryFreeOneObjectFromFreelist(void);
559 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
560 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
561 static void vmCancelThreadedIOJob(robj
*o
);
562 static void lockThreadedIO(void);
563 static void unlockThreadedIO(void);
564 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
565 static void freeIOJob(iojob
*j
);
566 static void queueIOJob(iojob
*j
);
567 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
568 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
569 static void waitEmptyIOJobsQueue(void);
570 static void vmReopenSwapFile(void);
571 static int vmFreePage(off_t page
);
572 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
573 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
574 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
575 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
576 static struct redisCommand
*lookupCommand(char *name
);
577 static void call(redisClient
*c
, struct redisCommand
*cmd
);
578 static void resetClient(redisClient
*c
);
580 static void authCommand(redisClient
*c
);
581 static void pingCommand(redisClient
*c
);
582 static void echoCommand(redisClient
*c
);
583 static void setCommand(redisClient
*c
);
584 static void setnxCommand(redisClient
*c
);
585 static void getCommand(redisClient
*c
);
586 static void delCommand(redisClient
*c
);
587 static void existsCommand(redisClient
*c
);
588 static void incrCommand(redisClient
*c
);
589 static void decrCommand(redisClient
*c
);
590 static void incrbyCommand(redisClient
*c
);
591 static void decrbyCommand(redisClient
*c
);
592 static void selectCommand(redisClient
*c
);
593 static void randomkeyCommand(redisClient
*c
);
594 static void keysCommand(redisClient
*c
);
595 static void dbsizeCommand(redisClient
*c
);
596 static void lastsaveCommand(redisClient
*c
);
597 static void saveCommand(redisClient
*c
);
598 static void bgsaveCommand(redisClient
*c
);
599 static void bgrewriteaofCommand(redisClient
*c
);
600 static void shutdownCommand(redisClient
*c
);
601 static void moveCommand(redisClient
*c
);
602 static void renameCommand(redisClient
*c
);
603 static void renamenxCommand(redisClient
*c
);
604 static void lpushCommand(redisClient
*c
);
605 static void rpushCommand(redisClient
*c
);
606 static void lpopCommand(redisClient
*c
);
607 static void rpopCommand(redisClient
*c
);
608 static void llenCommand(redisClient
*c
);
609 static void lindexCommand(redisClient
*c
);
610 static void lrangeCommand(redisClient
*c
);
611 static void ltrimCommand(redisClient
*c
);
612 static void typeCommand(redisClient
*c
);
613 static void lsetCommand(redisClient
*c
);
614 static void saddCommand(redisClient
*c
);
615 static void sremCommand(redisClient
*c
);
616 static void smoveCommand(redisClient
*c
);
617 static void sismemberCommand(redisClient
*c
);
618 static void scardCommand(redisClient
*c
);
619 static void spopCommand(redisClient
*c
);
620 static void srandmemberCommand(redisClient
*c
);
621 static void sinterCommand(redisClient
*c
);
622 static void sinterstoreCommand(redisClient
*c
);
623 static void sunionCommand(redisClient
*c
);
624 static void sunionstoreCommand(redisClient
*c
);
625 static void sdiffCommand(redisClient
*c
);
626 static void sdiffstoreCommand(redisClient
*c
);
627 static void syncCommand(redisClient
*c
);
628 static void flushdbCommand(redisClient
*c
);
629 static void flushallCommand(redisClient
*c
);
630 static void sortCommand(redisClient
*c
);
631 static void lremCommand(redisClient
*c
);
632 static void rpoplpushcommand(redisClient
*c
);
633 static void infoCommand(redisClient
*c
);
634 static void mgetCommand(redisClient
*c
);
635 static void monitorCommand(redisClient
*c
);
636 static void expireCommand(redisClient
*c
);
637 static void expireatCommand(redisClient
*c
);
638 static void getsetCommand(redisClient
*c
);
639 static void ttlCommand(redisClient
*c
);
640 static void slaveofCommand(redisClient
*c
);
641 static void debugCommand(redisClient
*c
);
642 static void msetCommand(redisClient
*c
);
643 static void msetnxCommand(redisClient
*c
);
644 static void zaddCommand(redisClient
*c
);
645 static void zincrbyCommand(redisClient
*c
);
646 static void zrangeCommand(redisClient
*c
);
647 static void zrangebyscoreCommand(redisClient
*c
);
648 static void zcountCommand(redisClient
*c
);
649 static void zrevrangeCommand(redisClient
*c
);
650 static void zcardCommand(redisClient
*c
);
651 static void zremCommand(redisClient
*c
);
652 static void zscoreCommand(redisClient
*c
);
653 static void zremrangebyscoreCommand(redisClient
*c
);
654 static void multiCommand(redisClient
*c
);
655 static void execCommand(redisClient
*c
);
656 static void blpopCommand(redisClient
*c
);
657 static void brpopCommand(redisClient
*c
);
658 static void appendCommand(redisClient
*c
);
660 /*================================= Globals ================================= */
663 static struct redisServer server
; /* server global state */
664 static struct redisCommand cmdTable
[] = {
665 {"get",getCommand
,2,REDIS_CMD_INLINE
,1,1,1},
666 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
667 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
668 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
669 {"del",delCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
670 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
671 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
672 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
673 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,1,-1,1},
674 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
675 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
676 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
677 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
678 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
679 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
680 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
681 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,1,1,1},
682 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
683 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,1,1,1},
684 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,1,1,1},
685 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,1,1,1},
686 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,2,1},
687 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
688 {"srem",sremCommand
,3,REDIS_CMD_BULK
,1,1,1},
689 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,1,2,1},
690 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,1,1,1},
691 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
692 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
693 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,1,1,1},
694 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
695 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
696 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
697 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
698 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
699 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
700 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,1,1,1},
701 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
702 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
703 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,1,1,1},
704 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,1,1,1},
705 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
706 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
707 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,1,1,1},
708 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
709 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
710 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
711 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
712 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
713 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
714 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
715 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
716 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,0,0,0},
717 {"select",selectCommand
,2,REDIS_CMD_INLINE
,0,0,0},
718 {"move",moveCommand
,3,REDIS_CMD_INLINE
,1,1,1},
719 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,1,1,1},
720 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,1,1,1},
721 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,0,0,0},
722 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,0,0,0},
723 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,0,0,0},
724 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,0,0,0},
725 {"auth",authCommand
,2,REDIS_CMD_INLINE
,0,0,0},
726 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,0,0,0},
727 {"echo",echoCommand
,2,REDIS_CMD_BULK
,0,0,0},
728 {"save",saveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
729 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
730 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,0,0,0},
731 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,0,0,0},
732 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
733 {"type",typeCommand
,2,REDIS_CMD_INLINE
,1,1,1},
734 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,0,0,0},
735 {"exec",execCommand
,1,REDIS_CMD_INLINE
,0,0,0},
736 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,0,0,0},
737 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,0,0,0},
738 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,0,0,0},
739 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
740 {"info",infoCommand
,1,REDIS_CMD_INLINE
,0,0,0},
741 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,0,0,0},
742 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,1,1,1},
743 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,0,0,0},
744 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
745 {NULL
,NULL
,0,0,0,0,0}
748 /*============================ Utility functions ============================ */
750 /* Glob-style pattern matching. */
751 int stringmatchlen(const char *pattern
, int patternLen
,
752 const char *string
, int stringLen
, int nocase
)
757 while (pattern
[1] == '*') {
762 return 1; /* match */
764 if (stringmatchlen(pattern
+1, patternLen
-1,
765 string
, stringLen
, nocase
))
766 return 1; /* match */
770 return 0; /* no match */
774 return 0; /* no match */
784 not = pattern
[0] == '^';
791 if (pattern
[0] == '\\') {
794 if (pattern
[0] == string
[0])
796 } else if (pattern
[0] == ']') {
798 } else if (patternLen
== 0) {
802 } else if (pattern
[1] == '-' && patternLen
>= 3) {
803 int start
= pattern
[0];
804 int end
= pattern
[2];
812 start
= tolower(start
);
818 if (c
>= start
&& c
<= end
)
822 if (pattern
[0] == string
[0])
825 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
835 return 0; /* no match */
841 if (patternLen
>= 2) {
848 if (pattern
[0] != string
[0])
849 return 0; /* no match */
851 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
852 return 0; /* no match */
860 if (stringLen
== 0) {
861 while(*pattern
== '*') {
868 if (patternLen
== 0 && stringLen
== 0)
873 static void redisLog(int level
, const char *fmt
, ...) {
877 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
881 if (level
>= server
.verbosity
) {
887 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
888 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
889 vfprintf(fp
, fmt
, ap
);
895 if (server
.logfile
) fclose(fp
);
898 /*====================== Hash table type implementation ==================== */
900 /* This is an hash table type that uses the SDS dynamic strings libary as
901 * keys and radis objects as values (objects can hold SDS strings,
904 static void dictVanillaFree(void *privdata
, void *val
)
906 DICT_NOTUSED(privdata
);
910 static void dictListDestructor(void *privdata
, void *val
)
912 DICT_NOTUSED(privdata
);
913 listRelease((list
*)val
);
916 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
920 DICT_NOTUSED(privdata
);
922 l1
= sdslen((sds
)key1
);
923 l2
= sdslen((sds
)key2
);
924 if (l1
!= l2
) return 0;
925 return memcmp(key1
, key2
, l1
) == 0;
928 static void dictRedisObjectDestructor(void *privdata
, void *val
)
930 DICT_NOTUSED(privdata
);
932 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
936 static int dictObjKeyCompare(void *privdata
, const void *key1
,
939 const robj
*o1
= key1
, *o2
= key2
;
940 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
943 static unsigned int dictObjHash(const void *key
) {
945 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
948 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
951 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
954 o1
= getDecodedObject(o1
);
955 o2
= getDecodedObject(o2
);
956 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
962 static unsigned int dictEncObjHash(const void *key
) {
963 robj
*o
= (robj
*) key
;
965 if (o
->encoding
== REDIS_ENCODING_RAW
) {
966 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
968 if (o
->encoding
== REDIS_ENCODING_INT
) {
972 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
973 return dictGenHashFunction((unsigned char*)buf
, len
);
977 o
= getDecodedObject(o
);
978 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
985 /* Sets type and expires */
986 static dictType setDictType
= {
987 dictEncObjHash
, /* hash function */
990 dictEncObjKeyCompare
, /* key compare */
991 dictRedisObjectDestructor
, /* key destructor */
992 NULL
/* val destructor */
995 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
996 static dictType zsetDictType
= {
997 dictEncObjHash
, /* hash function */
1000 dictEncObjKeyCompare
, /* key compare */
1001 dictRedisObjectDestructor
, /* key destructor */
1002 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1006 static dictType hashDictType
= {
1007 dictObjHash
, /* hash function */
1010 dictObjKeyCompare
, /* key compare */
1011 dictRedisObjectDestructor
, /* key destructor */
1012 dictRedisObjectDestructor
/* val destructor */
1016 static dictType keyptrDictType
= {
1017 dictObjHash
, /* hash function */
1020 dictObjKeyCompare
, /* key compare */
1021 dictRedisObjectDestructor
, /* key destructor */
1022 NULL
/* val destructor */
1025 /* Keylist hash table type has unencoded redis objects as keys and
1026 * lists as values. It's used for blocking operations (BLPOP) and to
1027 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1028 static dictType keylistDictType
= {
1029 dictObjHash
, /* hash function */
1032 dictObjKeyCompare
, /* key compare */
1033 dictRedisObjectDestructor
, /* key destructor */
1034 dictListDestructor
/* val destructor */
1037 /* ========================= Random utility functions ======================= */
1039 /* Redis generally does not try to recover from out of memory conditions
1040 * when allocating objects or strings, it is not clear if it will be possible
1041 * to report this condition to the client since the networking layer itself
1042 * is based on heap allocation for send buffers, so we simply abort.
1043 * At least the code will be simpler to read... */
1044 static void oom(const char *msg
) {
1045 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1050 /* ====================== Redis server networking stuff ===================== */
1051 static void closeTimedoutClients(void) {
1054 time_t now
= time(NULL
);
1057 listRewind(server
.clients
,&li
);
1058 while ((ln
= listNext(&li
)) != NULL
) {
1059 c
= listNodeValue(ln
);
1060 if (server
.maxidletime
&&
1061 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1062 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1063 (now
- c
->lastinteraction
> server
.maxidletime
))
1065 redisLog(REDIS_VERBOSE
,"Closing idle client");
1067 } else if (c
->flags
& REDIS_BLOCKED
) {
1068 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1069 addReply(c
,shared
.nullmultibulk
);
1070 unblockClientWaitingData(c
);
1076 static int htNeedsResize(dict
*dict
) {
1077 long long size
, used
;
1079 size
= dictSlots(dict
);
1080 used
= dictSize(dict
);
1081 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1082 (used
*100/size
< REDIS_HT_MINFILL
));
1085 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1086 * we resize the hash table to save memory */
1087 static void tryResizeHashTables(void) {
1090 for (j
= 0; j
< server
.dbnum
; j
++) {
1091 if (htNeedsResize(server
.db
[j
].dict
)) {
1092 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1093 dictResize(server
.db
[j
].dict
);
1094 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1096 if (htNeedsResize(server
.db
[j
].expires
))
1097 dictResize(server
.db
[j
].expires
);
1101 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1102 void backgroundSaveDoneHandler(int statloc
) {
1103 int exitcode
= WEXITSTATUS(statloc
);
1104 int bysignal
= WIFSIGNALED(statloc
);
1106 if (!bysignal
&& exitcode
== 0) {
1107 redisLog(REDIS_NOTICE
,
1108 "Background saving terminated with success");
1110 server
.lastsave
= time(NULL
);
1111 } else if (!bysignal
&& exitcode
!= 0) {
1112 redisLog(REDIS_WARNING
, "Background saving error");
1114 redisLog(REDIS_WARNING
,
1115 "Background saving terminated by signal");
1116 rdbRemoveTempFile(server
.bgsavechildpid
);
1118 server
.bgsavechildpid
= -1;
1119 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1120 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1121 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1124 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1126 void backgroundRewriteDoneHandler(int statloc
) {
1127 int exitcode
= WEXITSTATUS(statloc
);
1128 int bysignal
= WIFSIGNALED(statloc
);
1130 if (!bysignal
&& exitcode
== 0) {
1134 redisLog(REDIS_NOTICE
,
1135 "Background append only file rewriting terminated with success");
1136 /* Now it's time to flush the differences accumulated by the parent */
1137 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1138 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1140 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1143 /* Flush our data... */
1144 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1145 (signed) sdslen(server
.bgrewritebuf
)) {
1146 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
));
1150 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1151 /* Now our work is to rename the temp file into the stable file. And
1152 * switch the file descriptor used by the server for append only. */
1153 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1154 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1158 /* Mission completed... almost */
1159 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1160 if (server
.appendfd
!= -1) {
1161 /* If append only is actually enabled... */
1162 close(server
.appendfd
);
1163 server
.appendfd
= fd
;
1165 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1166 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1168 /* If append only is disabled we just generate a dump in this
1169 * format. Why not? */
1172 } else if (!bysignal
&& exitcode
!= 0) {
1173 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1175 redisLog(REDIS_WARNING
,
1176 "Background append only file rewriting terminated by signal");
1179 sdsfree(server
.bgrewritebuf
);
1180 server
.bgrewritebuf
= sdsempty();
1181 aofRemoveTempFile(server
.bgrewritechildpid
);
1182 server
.bgrewritechildpid
= -1;
1185 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1186 int j
, loops
= server
.cronloops
++;
1187 REDIS_NOTUSED(eventLoop
);
1189 REDIS_NOTUSED(clientData
);
1191 /* We take a cached value of the unix time in the global state because
1192 * with virtual memory and aging there is to store the current time
1193 * in objects at every object access, and accuracy is not needed.
1194 * To access a global var is faster than calling time(NULL) */
1195 server
.unixtime
= time(NULL
);
1197 /* Show some info about non-empty databases */
1198 for (j
= 0; j
< server
.dbnum
; j
++) {
1199 long long size
, used
, vkeys
;
1201 size
= dictSlots(server
.db
[j
].dict
);
1202 used
= dictSize(server
.db
[j
].dict
);
1203 vkeys
= dictSize(server
.db
[j
].expires
);
1204 if (!(loops
% 5) && (used
|| vkeys
)) {
1205 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1206 /* dictPrintStats(server.dict); */
1210 /* We don't want to resize the hash tables while a bacground saving
1211 * is in progress: the saving child is created using fork() that is
1212 * implemented with a copy-on-write semantic in most modern systems, so
1213 * if we resize the HT while there is the saving child at work actually
1214 * a lot of memory movements in the parent will cause a lot of pages
1216 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1218 /* Show information about connected clients */
1220 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1221 listLength(server
.clients
)-listLength(server
.slaves
),
1222 listLength(server
.slaves
),
1223 zmalloc_used_memory(),
1224 dictSize(server
.sharingpool
));
1227 /* Close connections of timedout clients */
1228 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1229 closeTimedoutClients();
1231 /* Check if a background saving or AOF rewrite in progress terminated */
1232 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1236 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1237 if (pid
== server
.bgsavechildpid
) {
1238 backgroundSaveDoneHandler(statloc
);
1240 backgroundRewriteDoneHandler(statloc
);
1244 /* If there is not a background saving in progress check if
1245 * we have to save now */
1246 time_t now
= time(NULL
);
1247 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1248 struct saveparam
*sp
= server
.saveparams
+j
;
1250 if (server
.dirty
>= sp
->changes
&&
1251 now
-server
.lastsave
> sp
->seconds
) {
1252 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1253 sp
->changes
, sp
->seconds
);
1254 rdbSaveBackground(server
.dbfilename
);
1260 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1261 * will use few CPU cycles if there are few expiring keys, otherwise
1262 * it will get more aggressive to avoid that too much memory is used by
1263 * keys that can be removed from the keyspace. */
1264 for (j
= 0; j
< server
.dbnum
; j
++) {
1266 redisDb
*db
= server
.db
+j
;
1268 /* Continue to expire if at the end of the cycle more than 25%
1269 * of the keys were expired. */
1271 long num
= dictSize(db
->expires
);
1272 time_t now
= time(NULL
);
1275 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1276 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1281 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1282 t
= (time_t) dictGetEntryVal(de
);
1284 deleteKey(db
,dictGetEntryKey(de
));
1288 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1291 /* Swap a few keys on disk if we are over the memory limit and VM
1292 * is enbled. Try to free objects from the free list first. */
1293 if (vmCanSwapOut()) {
1294 while (server
.vm_enabled
&& zmalloc_used_memory() >
1295 server
.vm_max_memory
)
1299 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1300 retval
= (server
.vm_max_threads
== 0) ?
1301 vmSwapOneObjectBlocking() :
1302 vmSwapOneObjectThreaded();
1303 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1304 zmalloc_used_memory() >
1305 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1307 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1309 /* Note that when using threade I/O we free just one object,
1310 * because anyway when the I/O thread in charge to swap this
1311 * object out will finish, the handler of completed jobs
1312 * will try to swap more objects if we are still out of memory. */
1313 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1317 /* Check if we should connect to a MASTER */
1318 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1319 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1320 if (syncWithMaster() == REDIS_OK
) {
1321 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1327 /* This function gets called every time Redis is entering the
1328 * main loop of the event driven library, that is, before to sleep
1329 * for ready file descriptors. */
1330 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1331 REDIS_NOTUSED(eventLoop
);
1333 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1337 listRewind(server
.io_ready_clients
,&li
);
1338 while((ln
= listNext(&li
))) {
1339 redisClient
*c
= ln
->value
;
1340 struct redisCommand
*cmd
;
1342 /* Resume the client. */
1343 listDelNode(server
.io_ready_clients
,ln
);
1344 c
->flags
&= (~REDIS_IO_WAIT
);
1345 server
.vm_blocked_clients
--;
1346 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1347 readQueryFromClient
, c
);
1348 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1349 assert(cmd
!= NULL
);
1352 /* There may be more data to process in the input buffer. */
1353 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1354 processInputBuffer(c
);
1359 static void createSharedObjects(void) {
1360 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1361 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1362 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1363 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1364 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1365 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1366 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1367 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1368 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1369 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1370 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1371 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1372 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1373 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1374 "-ERR no such key\r\n"));
1375 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1376 "-ERR syntax error\r\n"));
1377 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1378 "-ERR source and destination objects are the same\r\n"));
1379 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1380 "-ERR index out of range\r\n"));
1381 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1382 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1383 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1384 shared
.select0
= createStringObject("select 0\r\n",10);
1385 shared
.select1
= createStringObject("select 1\r\n",10);
1386 shared
.select2
= createStringObject("select 2\r\n",10);
1387 shared
.select3
= createStringObject("select 3\r\n",10);
1388 shared
.select4
= createStringObject("select 4\r\n",10);
1389 shared
.select5
= createStringObject("select 5\r\n",10);
1390 shared
.select6
= createStringObject("select 6\r\n",10);
1391 shared
.select7
= createStringObject("select 7\r\n",10);
1392 shared
.select8
= createStringObject("select 8\r\n",10);
1393 shared
.select9
= createStringObject("select 9\r\n",10);
1396 static void appendServerSaveParams(time_t seconds
, int changes
) {
1397 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1398 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1399 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1400 server
.saveparamslen
++;
1403 static void resetServerSaveParams() {
1404 zfree(server
.saveparams
);
1405 server
.saveparams
= NULL
;
1406 server
.saveparamslen
= 0;
1409 static void initServerConfig() {
1410 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1411 server
.port
= REDIS_SERVERPORT
;
1412 server
.verbosity
= REDIS_VERBOSE
;
1413 server
.maxidletime
= REDIS_MAXIDLETIME
;
1414 server
.saveparams
= NULL
;
1415 server
.logfile
= NULL
; /* NULL = log on standard output */
1416 server
.bindaddr
= NULL
;
1417 server
.glueoutputbuf
= 1;
1418 server
.daemonize
= 0;
1419 server
.appendonly
= 0;
1420 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1421 server
.lastfsync
= time(NULL
);
1422 server
.appendfd
= -1;
1423 server
.appendseldb
= -1; /* Make sure the first time will not match */
1424 server
.pidfile
= "/var/run/redis.pid";
1425 server
.dbfilename
= "dump.rdb";
1426 server
.appendfilename
= "appendonly.aof";
1427 server
.requirepass
= NULL
;
1428 server
.shareobjects
= 0;
1429 server
.rdbcompression
= 1;
1430 server
.sharingpoolsize
= 1024;
1431 server
.maxclients
= 0;
1432 server
.blpop_blocked_clients
= 0;
1433 server
.maxmemory
= 0;
1434 server
.vm_enabled
= 0;
1435 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1436 server
.vm_page_size
= 256; /* 256 bytes per page */
1437 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1438 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1439 server
.vm_max_threads
= 4;
1440 server
.vm_blocked_clients
= 0;
1442 resetServerSaveParams();
1444 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1445 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1446 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1447 /* Replication related */
1449 server
.masterauth
= NULL
;
1450 server
.masterhost
= NULL
;
1451 server
.masterport
= 6379;
1452 server
.master
= NULL
;
1453 server
.replstate
= REDIS_REPL_NONE
;
1455 /* Double constants initialization */
1457 R_PosInf
= 1.0/R_Zero
;
1458 R_NegInf
= -1.0/R_Zero
;
1459 R_Nan
= R_Zero
/R_Zero
;
1462 static void initServer() {
1465 signal(SIGHUP
, SIG_IGN
);
1466 signal(SIGPIPE
, SIG_IGN
);
1467 setupSigSegvAction();
1469 server
.devnull
= fopen("/dev/null","w");
1470 if (server
.devnull
== NULL
) {
1471 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1474 server
.clients
= listCreate();
1475 server
.slaves
= listCreate();
1476 server
.monitors
= listCreate();
1477 server
.objfreelist
= listCreate();
1478 createSharedObjects();
1479 server
.el
= aeCreateEventLoop();
1480 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1481 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1482 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1483 if (server
.fd
== -1) {
1484 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1487 for (j
= 0; j
< server
.dbnum
; j
++) {
1488 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1489 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1490 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1491 if (server
.vm_enabled
)
1492 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1493 server
.db
[j
].id
= j
;
1495 server
.cronloops
= 0;
1496 server
.bgsavechildpid
= -1;
1497 server
.bgrewritechildpid
= -1;
1498 server
.bgrewritebuf
= sdsempty();
1499 server
.lastsave
= time(NULL
);
1501 server
.stat_numcommands
= 0;
1502 server
.stat_numconnections
= 0;
1503 server
.stat_starttime
= time(NULL
);
1504 server
.unixtime
= time(NULL
);
1505 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1506 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1507 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1509 if (server
.appendonly
) {
1510 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1511 if (server
.appendfd
== -1) {
1512 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1518 if (server
.vm_enabled
) vmInit();
1521 /* Empty the whole database */
1522 static long long emptyDb() {
1524 long long removed
= 0;
1526 for (j
= 0; j
< server
.dbnum
; j
++) {
1527 removed
+= dictSize(server
.db
[j
].dict
);
1528 dictEmpty(server
.db
[j
].dict
);
1529 dictEmpty(server
.db
[j
].expires
);
1534 static int yesnotoi(char *s
) {
1535 if (!strcasecmp(s
,"yes")) return 1;
1536 else if (!strcasecmp(s
,"no")) return 0;
1540 /* I agree, this is a very rudimental way to load a configuration...
1541 will improve later if the config gets more complex */
1542 static void loadServerConfig(char *filename
) {
1544 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1548 if (filename
[0] == '-' && filename
[1] == '\0')
1551 if ((fp
= fopen(filename
,"r")) == NULL
) {
1552 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1557 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1563 line
= sdstrim(line
," \t\r\n");
1565 /* Skip comments and blank lines*/
1566 if (line
[0] == '#' || line
[0] == '\0') {
1571 /* Split into arguments */
1572 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1573 sdstolower(argv
[0]);
1575 /* Execute config directives */
1576 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1577 server
.maxidletime
= atoi(argv
[1]);
1578 if (server
.maxidletime
< 0) {
1579 err
= "Invalid timeout value"; goto loaderr
;
1581 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1582 server
.port
= atoi(argv
[1]);
1583 if (server
.port
< 1 || server
.port
> 65535) {
1584 err
= "Invalid port"; goto loaderr
;
1586 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1587 server
.bindaddr
= zstrdup(argv
[1]);
1588 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1589 int seconds
= atoi(argv
[1]);
1590 int changes
= atoi(argv
[2]);
1591 if (seconds
< 1 || changes
< 0) {
1592 err
= "Invalid save parameters"; goto loaderr
;
1594 appendServerSaveParams(seconds
,changes
);
1595 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1596 if (chdir(argv
[1]) == -1) {
1597 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1598 argv
[1], strerror(errno
));
1601 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1602 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1603 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1604 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1605 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1607 err
= "Invalid log level. Must be one of debug, notice, warning";
1610 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1613 server
.logfile
= zstrdup(argv
[1]);
1614 if (!strcasecmp(server
.logfile
,"stdout")) {
1615 zfree(server
.logfile
);
1616 server
.logfile
= NULL
;
1618 if (server
.logfile
) {
1619 /* Test if we are able to open the file. The server will not
1620 * be able to abort just for this problem later... */
1621 logfp
= fopen(server
.logfile
,"a");
1622 if (logfp
== NULL
) {
1623 err
= sdscatprintf(sdsempty(),
1624 "Can't open the log file: %s", strerror(errno
));
1629 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1630 server
.dbnum
= atoi(argv
[1]);
1631 if (server
.dbnum
< 1) {
1632 err
= "Invalid number of databases"; goto loaderr
;
1634 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1635 server
.maxclients
= atoi(argv
[1]);
1636 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1637 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1638 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1639 server
.masterhost
= sdsnew(argv
[1]);
1640 server
.masterport
= atoi(argv
[2]);
1641 server
.replstate
= REDIS_REPL_CONNECT
;
1642 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1643 server
.masterauth
= zstrdup(argv
[1]);
1644 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1645 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1646 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1648 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1649 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1650 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1652 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1653 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1654 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1656 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1657 server
.sharingpoolsize
= atoi(argv
[1]);
1658 if (server
.sharingpoolsize
< 1) {
1659 err
= "invalid object sharing pool size"; goto loaderr
;
1661 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1662 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1663 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1665 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1666 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1667 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1669 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1670 if (!strcasecmp(argv
[1],"no")) {
1671 server
.appendfsync
= APPENDFSYNC_NO
;
1672 } else if (!strcasecmp(argv
[1],"always")) {
1673 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1674 } else if (!strcasecmp(argv
[1],"everysec")) {
1675 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1677 err
= "argument must be 'no', 'always' or 'everysec'";
1680 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1681 server
.requirepass
= zstrdup(argv
[1]);
1682 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1683 server
.pidfile
= zstrdup(argv
[1]);
1684 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1685 server
.dbfilename
= zstrdup(argv
[1]);
1686 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1687 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1688 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1690 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1691 zfree(server
.vm_swap_file
);
1692 server
.vm_swap_file
= zstrdup(argv
[1]);
1693 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1694 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1695 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1696 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1697 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1698 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1699 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1700 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1702 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1704 for (j
= 0; j
< argc
; j
++)
1709 if (fp
!= stdin
) fclose(fp
);
1713 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1714 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1715 fprintf(stderr
, ">>> '%s'\n", line
);
1716 fprintf(stderr
, "%s\n", err
);
1720 static void freeClientArgv(redisClient
*c
) {
1723 for (j
= 0; j
< c
->argc
; j
++)
1724 decrRefCount(c
->argv
[j
]);
1725 for (j
= 0; j
< c
->mbargc
; j
++)
1726 decrRefCount(c
->mbargv
[j
]);
1731 static void freeClient(redisClient
*c
) {
1734 /* Note that if the client we are freeing is blocked into a blocking
1735 * call, we have to set querybuf to NULL *before* to call
1736 * unblockClientWaitingData() to avoid processInputBuffer() will get
1737 * called. Also it is important to remove the file events after
1738 * this, because this call adds the READABLE event. */
1739 sdsfree(c
->querybuf
);
1741 if (c
->flags
& REDIS_BLOCKED
)
1742 unblockClientWaitingData(c
);
1744 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1745 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1746 listRelease(c
->reply
);
1749 /* Remove from the list of clients */
1750 ln
= listSearchKey(server
.clients
,c
);
1751 redisAssert(ln
!= NULL
);
1752 listDelNode(server
.clients
,ln
);
1753 /* Remove from the list of clients waiting for swapped keys */
1754 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1755 ln
= listSearchKey(server
.io_ready_clients
,c
);
1757 listDelNode(server
.io_ready_clients
,ln
);
1758 server
.vm_blocked_clients
--;
1761 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1762 ln
= listFirst(c
->io_keys
);
1763 dontWaitForSwappedKey(c
,ln
->value
);
1765 listRelease(c
->io_keys
);
1767 if (c
->flags
& REDIS_SLAVE
) {
1768 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1770 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1771 ln
= listSearchKey(l
,c
);
1772 redisAssert(ln
!= NULL
);
1775 if (c
->flags
& REDIS_MASTER
) {
1776 server
.master
= NULL
;
1777 server
.replstate
= REDIS_REPL_CONNECT
;
1781 freeClientMultiState(c
);
1785 #define GLUEREPLY_UP_TO (1024)
1786 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1788 char buf
[GLUEREPLY_UP_TO
];
1793 listRewind(c
->reply
,&li
);
1794 while((ln
= listNext(&li
))) {
1798 objlen
= sdslen(o
->ptr
);
1799 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1800 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1802 listDelNode(c
->reply
,ln
);
1804 if (copylen
== 0) return;
1808 /* Now the output buffer is empty, add the new single element */
1809 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1810 listAddNodeHead(c
->reply
,o
);
1813 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1814 redisClient
*c
= privdata
;
1815 int nwritten
= 0, totwritten
= 0, objlen
;
1818 REDIS_NOTUSED(mask
);
1820 /* Use writev() if we have enough buffers to send */
1821 if (!server
.glueoutputbuf
&&
1822 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1823 !(c
->flags
& REDIS_MASTER
))
1825 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1829 while(listLength(c
->reply
)) {
1830 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1831 glueReplyBuffersIfNeeded(c
);
1833 o
= listNodeValue(listFirst(c
->reply
));
1834 objlen
= sdslen(o
->ptr
);
1837 listDelNode(c
->reply
,listFirst(c
->reply
));
1841 if (c
->flags
& REDIS_MASTER
) {
1842 /* Don't reply to a master */
1843 nwritten
= objlen
- c
->sentlen
;
1845 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1846 if (nwritten
<= 0) break;
1848 c
->sentlen
+= nwritten
;
1849 totwritten
+= nwritten
;
1850 /* If we fully sent the object on head go to the next one */
1851 if (c
->sentlen
== objlen
) {
1852 listDelNode(c
->reply
,listFirst(c
->reply
));
1855 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1856 * bytes, in a single threaded server it's a good idea to serve
1857 * other clients as well, even if a very large request comes from
1858 * super fast link that is always able to accept data (in real world
1859 * scenario think about 'KEYS *' against the loopback interfae) */
1860 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1862 if (nwritten
== -1) {
1863 if (errno
== EAGAIN
) {
1866 redisLog(REDIS_VERBOSE
,
1867 "Error writing to client: %s", strerror(errno
));
1872 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1873 if (listLength(c
->reply
) == 0) {
1875 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1879 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1881 redisClient
*c
= privdata
;
1882 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1884 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1885 int offset
, ion
= 0;
1887 REDIS_NOTUSED(mask
);
1890 while (listLength(c
->reply
)) {
1891 offset
= c
->sentlen
;
1895 /* fill-in the iov[] array */
1896 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1897 o
= listNodeValue(node
);
1898 objlen
= sdslen(o
->ptr
);
1900 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1903 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1904 break; /* no more iovecs */
1906 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1907 iov
[ion
].iov_len
= objlen
- offset
;
1908 willwrite
+= objlen
- offset
;
1909 offset
= 0; /* just for the first item */
1916 /* write all collected blocks at once */
1917 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1918 if (errno
!= EAGAIN
) {
1919 redisLog(REDIS_VERBOSE
,
1920 "Error writing to client: %s", strerror(errno
));
1927 totwritten
+= nwritten
;
1928 offset
= c
->sentlen
;
1930 /* remove written robjs from c->reply */
1931 while (nwritten
&& listLength(c
->reply
)) {
1932 o
= listNodeValue(listFirst(c
->reply
));
1933 objlen
= sdslen(o
->ptr
);
1935 if(nwritten
>= objlen
- offset
) {
1936 listDelNode(c
->reply
, listFirst(c
->reply
));
1937 nwritten
-= objlen
- offset
;
1941 c
->sentlen
+= nwritten
;
1949 c
->lastinteraction
= time(NULL
);
1951 if (listLength(c
->reply
) == 0) {
1953 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1957 static struct redisCommand
*lookupCommand(char *name
) {
1959 while(cmdTable
[j
].name
!= NULL
) {
1960 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1966 /* resetClient prepare the client to process the next command */
1967 static void resetClient(redisClient
*c
) {
1973 /* Call() is the core of Redis execution of a command */
1974 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1977 dirty
= server
.dirty
;
1979 if (server
.appendonly
&& server
.dirty
-dirty
)
1980 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1981 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1982 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1983 if (listLength(server
.monitors
))
1984 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1985 server
.stat_numcommands
++;
1988 /* If this function gets called we already read a whole
1989 * command, argments are in the client argv/argc fields.
1990 * processCommand() execute the command or prepare the
1991 * server for a bulk read from the client.
1993 * If 1 is returned the client is still alive and valid and
1994 * and other operations can be performed by the caller. Otherwise
1995 * if 0 is returned the client was destroied (i.e. after QUIT). */
1996 static int processCommand(redisClient
*c
) {
1997 struct redisCommand
*cmd
;
1999 /* Free some memory if needed (maxmemory setting) */
2000 if (server
.maxmemory
) freeMemoryIfNeeded();
2002 /* Handle the multi bulk command type. This is an alternative protocol
2003 * supported by Redis in order to receive commands that are composed of
2004 * multiple binary-safe "bulk" arguments. The latency of processing is
2005 * a bit higher but this allows things like multi-sets, so if this
2006 * protocol is used only for MSET and similar commands this is a big win. */
2007 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2008 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2009 if (c
->multibulk
<= 0) {
2013 decrRefCount(c
->argv
[c
->argc
-1]);
2017 } else if (c
->multibulk
) {
2018 if (c
->bulklen
== -1) {
2019 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2020 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2024 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2025 decrRefCount(c
->argv
[0]);
2026 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2028 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2033 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2037 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2038 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2042 if (c
->multibulk
== 0) {
2046 /* Here we need to swap the multi-bulk argc/argv with the
2047 * normal argc/argv of the client structure. */
2049 c
->argv
= c
->mbargv
;
2050 c
->mbargv
= auxargv
;
2053 c
->argc
= c
->mbargc
;
2054 c
->mbargc
= auxargc
;
2056 /* We need to set bulklen to something different than -1
2057 * in order for the code below to process the command without
2058 * to try to read the last argument of a bulk command as
2059 * a special argument. */
2061 /* continue below and process the command */
2068 /* -- end of multi bulk commands processing -- */
2070 /* The QUIT command is handled as a special case. Normal command
2071 * procs are unable to close the client connection safely */
2072 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2077 /* Now lookup the command and check ASAP about trivial error conditions
2078 * such wrong arity, bad command name and so forth. */
2079 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2082 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2083 (char*)c
->argv
[0]->ptr
));
2086 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2087 (c
->argc
< -cmd
->arity
)) {
2089 sdscatprintf(sdsempty(),
2090 "-ERR wrong number of arguments for '%s' command\r\n",
2094 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2095 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2098 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2099 /* This is a bulk command, we have to read the last argument yet. */
2100 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2102 decrRefCount(c
->argv
[c
->argc
-1]);
2103 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2105 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2110 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2111 /* It is possible that the bulk read is already in the
2112 * buffer. Check this condition and handle it accordingly.
2113 * This is just a fast path, alternative to call processInputBuffer().
2114 * It's a good idea since the code is small and this condition
2115 * happens most of the times. */
2116 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2117 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2119 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2121 /* Otherwise return... there is to read the last argument
2122 * from the socket. */
2126 /* Let's try to share objects on the command arguments vector */
2127 if (server
.shareobjects
) {
2129 for(j
= 1; j
< c
->argc
; j
++)
2130 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2132 /* Let's try to encode the bulk object to save space. */
2133 if (cmd
->flags
& REDIS_CMD_BULK
)
2134 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2136 /* Check if the user is authenticated */
2137 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2138 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2143 /* Exec the command */
2144 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2145 queueMultiCommand(c
,cmd
);
2146 addReply(c
,shared
.queued
);
2148 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2149 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2153 /* Prepare the client for the next command */
2158 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2163 /* (args*2)+1 is enough room for args, spaces, newlines */
2164 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2166 if (argc
<= REDIS_STATIC_ARGS
) {
2169 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2172 for (j
= 0; j
< argc
; j
++) {
2173 if (j
!= 0) outv
[outc
++] = shared
.space
;
2174 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2177 lenobj
= createObject(REDIS_STRING
,
2178 sdscatprintf(sdsempty(),"%lu\r\n",
2179 (unsigned long) stringObjectLen(argv
[j
])));
2180 lenobj
->refcount
= 0;
2181 outv
[outc
++] = lenobj
;
2183 outv
[outc
++] = argv
[j
];
2185 outv
[outc
++] = shared
.crlf
;
2187 /* Increment all the refcounts at start and decrement at end in order to
2188 * be sure to free objects if there is no slave in a replication state
2189 * able to be feed with commands */
2190 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2191 listRewind(slaves
,&li
);
2192 while((ln
= listNext(&li
))) {
2193 redisClient
*slave
= ln
->value
;
2195 /* Don't feed slaves that are still waiting for BGSAVE to start */
2196 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2198 /* Feed all the other slaves, MONITORs and so on */
2199 if (slave
->slaveseldb
!= dictid
) {
2203 case 0: selectcmd
= shared
.select0
; break;
2204 case 1: selectcmd
= shared
.select1
; break;
2205 case 2: selectcmd
= shared
.select2
; break;
2206 case 3: selectcmd
= shared
.select3
; break;
2207 case 4: selectcmd
= shared
.select4
; break;
2208 case 5: selectcmd
= shared
.select5
; break;
2209 case 6: selectcmd
= shared
.select6
; break;
2210 case 7: selectcmd
= shared
.select7
; break;
2211 case 8: selectcmd
= shared
.select8
; break;
2212 case 9: selectcmd
= shared
.select9
; break;
2214 selectcmd
= createObject(REDIS_STRING
,
2215 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2216 selectcmd
->refcount
= 0;
2219 addReply(slave
,selectcmd
);
2220 slave
->slaveseldb
= dictid
;
2222 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2224 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2225 if (outv
!= static_outv
) zfree(outv
);
2228 static void processInputBuffer(redisClient
*c
) {
2230 /* Before to process the input buffer, make sure the client is not
2231 * waitig for a blocking operation such as BLPOP. Note that the first
2232 * iteration the client is never blocked, otherwise the processInputBuffer
2233 * would not be called at all, but after the execution of the first commands
2234 * in the input buffer the client may be blocked, and the "goto again"
2235 * will try to reiterate. The following line will make it return asap. */
2236 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2237 if (c
->bulklen
== -1) {
2238 /* Read the first line of the query */
2239 char *p
= strchr(c
->querybuf
,'\n');
2246 query
= c
->querybuf
;
2247 c
->querybuf
= sdsempty();
2248 querylen
= 1+(p
-(query
));
2249 if (sdslen(query
) > querylen
) {
2250 /* leave data after the first line of the query in the buffer */
2251 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2253 *p
= '\0'; /* remove "\n" */
2254 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2255 sdsupdatelen(query
);
2257 /* Now we can split the query in arguments */
2258 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2261 if (c
->argv
) zfree(c
->argv
);
2262 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2264 for (j
= 0; j
< argc
; j
++) {
2265 if (sdslen(argv
[j
])) {
2266 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2274 /* Execute the command. If the client is still valid
2275 * after processCommand() return and there is something
2276 * on the query buffer try to process the next command. */
2277 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2279 /* Nothing to process, argc == 0. Just process the query
2280 * buffer if it's not empty or return to the caller */
2281 if (sdslen(c
->querybuf
)) goto again
;
2284 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2285 redisLog(REDIS_VERBOSE
, "Client protocol error");
2290 /* Bulk read handling. Note that if we are at this point
2291 the client already sent a command terminated with a newline,
2292 we are reading the bulk data that is actually the last
2293 argument of the command. */
2294 int qbl
= sdslen(c
->querybuf
);
2296 if (c
->bulklen
<= qbl
) {
2297 /* Copy everything but the final CRLF as final argument */
2298 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2300 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2301 /* Process the command. If the client is still valid after
2302 * the processing and there is more data in the buffer
2303 * try to parse it. */
2304 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2310 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2311 redisClient
*c
= (redisClient
*) privdata
;
2312 char buf
[REDIS_IOBUF_LEN
];
2315 REDIS_NOTUSED(mask
);
2317 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2319 if (errno
== EAGAIN
) {
2322 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2326 } else if (nread
== 0) {
2327 redisLog(REDIS_VERBOSE
, "Client closed connection");
2332 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2333 c
->lastinteraction
= time(NULL
);
2337 if (!(c
->flags
& REDIS_BLOCKED
))
2338 processInputBuffer(c
);
2341 static int selectDb(redisClient
*c
, int id
) {
2342 if (id
< 0 || id
>= server
.dbnum
)
2344 c
->db
= &server
.db
[id
];
2348 static void *dupClientReplyValue(void *o
) {
2349 incrRefCount((robj
*)o
);
2353 static redisClient
*createClient(int fd
) {
2354 redisClient
*c
= zmalloc(sizeof(*c
));
2356 anetNonBlock(NULL
,fd
);
2357 anetTcpNoDelay(NULL
,fd
);
2358 if (!c
) return NULL
;
2361 c
->querybuf
= sdsempty();
2370 c
->lastinteraction
= time(NULL
);
2371 c
->authenticated
= 0;
2372 c
->replstate
= REDIS_REPL_NONE
;
2373 c
->reply
= listCreate();
2374 listSetFreeMethod(c
->reply
,decrRefCount
);
2375 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2376 c
->blockingkeys
= NULL
;
2377 c
->blockingkeysnum
= 0;
2378 c
->io_keys
= listCreate();
2379 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2380 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2381 readQueryFromClient
, c
) == AE_ERR
) {
2385 listAddNodeTail(server
.clients
,c
);
2386 initClientMultiState(c
);
2390 static void addReply(redisClient
*c
, robj
*obj
) {
2391 if (listLength(c
->reply
) == 0 &&
2392 (c
->replstate
== REDIS_REPL_NONE
||
2393 c
->replstate
== REDIS_REPL_ONLINE
) &&
2394 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2395 sendReplyToClient
, c
) == AE_ERR
) return;
2397 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2398 obj
= dupStringObject(obj
);
2399 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2401 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2404 static void addReplySds(redisClient
*c
, sds s
) {
2405 robj
*o
= createObject(REDIS_STRING
,s
);
2410 static void addReplyDouble(redisClient
*c
, double d
) {
2413 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2414 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2415 (unsigned long) strlen(buf
),buf
));
2418 static void addReplyLong(redisClient
*c
, long l
) {
2422 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2423 addReplySds(c
,sdsnewlen(buf
,len
));
2426 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2429 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2430 len
= sdslen(obj
->ptr
);
2432 long n
= (long)obj
->ptr
;
2434 /* Compute how many bytes will take this integer as a radix 10 string */
2440 while((n
= n
/10) != 0) {
2444 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2447 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2452 REDIS_NOTUSED(mask
);
2453 REDIS_NOTUSED(privdata
);
2455 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2456 if (cfd
== AE_ERR
) {
2457 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2460 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2461 if ((c
= createClient(cfd
)) == NULL
) {
2462 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2463 close(cfd
); /* May be already closed, just ingore errors */
2466 /* If maxclient directive is set and this is one client more... close the
2467 * connection. Note that we create the client instead to check before
2468 * for this condition, since now the socket is already set in nonblocking
2469 * mode and we can send an error for free using the Kernel I/O */
2470 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2471 char *err
= "-ERR max number of clients reached\r\n";
2473 /* That's a best effort error message, don't check write errors */
2474 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2475 /* Nothing to do, Just to avoid the warning... */
2480 server
.stat_numconnections
++;
2483 /* ======================= Redis objects implementation ===================== */
2485 static robj
*createObject(int type
, void *ptr
) {
2488 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2489 if (listLength(server
.objfreelist
)) {
2490 listNode
*head
= listFirst(server
.objfreelist
);
2491 o
= listNodeValue(head
);
2492 listDelNode(server
.objfreelist
,head
);
2493 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2495 if (server
.vm_enabled
) {
2496 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2497 o
= zmalloc(sizeof(*o
));
2499 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2503 o
->encoding
= REDIS_ENCODING_RAW
;
2506 if (server
.vm_enabled
) {
2507 /* Note that this code may run in the context of an I/O thread
2508 * and accessing to server.unixtime in theory is an error
2509 * (no locks). But in practice this is safe, and even if we read
2510 * garbage Redis will not fail, as it's just a statistical info */
2511 o
->vm
.atime
= server
.unixtime
;
2512 o
->storage
= REDIS_VM_MEMORY
;
2517 static robj
*createStringObject(char *ptr
, size_t len
) {
2518 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2521 static robj
*dupStringObject(robj
*o
) {
2522 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2523 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2526 static robj
*createListObject(void) {
2527 list
*l
= listCreate();
2529 listSetFreeMethod(l
,decrRefCount
);
2530 return createObject(REDIS_LIST
,l
);
2533 static robj
*createSetObject(void) {
2534 dict
*d
= dictCreate(&setDictType
,NULL
);
2535 return createObject(REDIS_SET
,d
);
2538 static robj
*createZsetObject(void) {
2539 zset
*zs
= zmalloc(sizeof(*zs
));
2541 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2542 zs
->zsl
= zslCreate();
2543 return createObject(REDIS_ZSET
,zs
);
2546 static void freeStringObject(robj
*o
) {
2547 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2552 static void freeListObject(robj
*o
) {
2553 listRelease((list
*) o
->ptr
);
2556 static void freeSetObject(robj
*o
) {
2557 dictRelease((dict
*) o
->ptr
);
2560 static void freeZsetObject(robj
*o
) {
2563 dictRelease(zs
->dict
);
2568 static void freeHashObject(robj
*o
) {
2569 dictRelease((dict
*) o
->ptr
);
2572 static void incrRefCount(robj
*o
) {
2573 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2577 static void decrRefCount(void *obj
) {
2580 /* Object is a key of a swapped out value, or in the process of being
2582 if (server
.vm_enabled
&&
2583 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2585 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2586 redisAssert(o
->refcount
== 1);
2588 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2589 redisAssert(o
->type
== REDIS_STRING
);
2590 freeStringObject(o
);
2591 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2592 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2593 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2594 !listAddNodeHead(server
.objfreelist
,o
))
2596 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2597 server
.vm_stats_swapped_objects
--;
2600 /* Object is in memory, or in the process of being swapped out. */
2601 if (--(o
->refcount
) == 0) {
2602 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2603 vmCancelThreadedIOJob(obj
);
2605 case REDIS_STRING
: freeStringObject(o
); break;
2606 case REDIS_LIST
: freeListObject(o
); break;
2607 case REDIS_SET
: freeSetObject(o
); break;
2608 case REDIS_ZSET
: freeZsetObject(o
); break;
2609 case REDIS_HASH
: freeHashObject(o
); break;
2610 default: redisAssert(0 != 0); break;
2612 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2613 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2614 !listAddNodeHead(server
.objfreelist
,o
))
2616 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2620 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2621 dictEntry
*de
= dictFind(db
->dict
,key
);
2623 robj
*key
= dictGetEntryKey(de
);
2624 robj
*val
= dictGetEntryVal(de
);
2626 if (server
.vm_enabled
) {
2627 if (key
->storage
== REDIS_VM_MEMORY
||
2628 key
->storage
== REDIS_VM_SWAPPING
)
2630 /* If we were swapping the object out, stop it, this key
2632 if (key
->storage
== REDIS_VM_SWAPPING
)
2633 vmCancelThreadedIOJob(key
);
2634 /* Update the access time of the key for the aging algorithm. */
2635 key
->vm
.atime
= server
.unixtime
;
2637 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2639 /* Our value was swapped on disk. Bring it at home. */
2640 redisAssert(val
== NULL
);
2641 val
= vmLoadObject(key
);
2642 dictGetEntryVal(de
) = val
;
2644 /* Clients blocked by the VM subsystem may be waiting for
2646 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2655 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2656 expireIfNeeded(db
,key
);
2657 return lookupKey(db
,key
);
2660 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2661 deleteIfVolatile(db
,key
);
2662 return lookupKey(db
,key
);
2665 static int deleteKey(redisDb
*db
, robj
*key
) {
2668 /* We need to protect key from destruction: after the first dictDelete()
2669 * it may happen that 'key' is no longer valid if we don't increment
2670 * it's count. This may happen when we get the object reference directly
2671 * from the hash table with dictRandomKey() or dict iterators */
2673 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2674 retval
= dictDelete(db
->dict
,key
);
2677 return retval
== DICT_OK
;
2680 /* Try to share an object against the shared objects pool */
2681 static robj
*tryObjectSharing(robj
*o
) {
2682 struct dictEntry
*de
;
2685 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2687 redisAssert(o
->type
== REDIS_STRING
);
2688 de
= dictFind(server
.sharingpool
,o
);
2690 robj
*shared
= dictGetEntryKey(de
);
2692 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2693 dictGetEntryVal(de
) = (void*) c
;
2694 incrRefCount(shared
);
2698 /* Here we are using a stream algorihtm: Every time an object is
2699 * shared we increment its count, everytime there is a miss we
2700 * recrement the counter of a random object. If this object reaches
2701 * zero we remove the object and put the current object instead. */
2702 if (dictSize(server
.sharingpool
) >=
2703 server
.sharingpoolsize
) {
2704 de
= dictGetRandomKey(server
.sharingpool
);
2705 redisAssert(de
!= NULL
);
2706 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2707 dictGetEntryVal(de
) = (void*) c
;
2709 dictDelete(server
.sharingpool
,de
->key
);
2712 c
= 0; /* If the pool is empty we want to add this object */
2717 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2718 redisAssert(retval
== DICT_OK
);
2725 /* Check if the nul-terminated string 's' can be represented by a long
2726 * (that is, is a number that fits into long without any other space or
2727 * character before or after the digits).
2729 * If so, the function returns REDIS_OK and *longval is set to the value
2730 * of the number. Otherwise REDIS_ERR is returned */
2731 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2732 char buf
[32], *endptr
;
2736 value
= strtol(s
, &endptr
, 10);
2737 if (endptr
[0] != '\0') return REDIS_ERR
;
2738 slen
= snprintf(buf
,32,"%ld",value
);
2740 /* If the number converted back into a string is not identical
2741 * then it's not possible to encode the string as integer */
2742 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2743 if (longval
) *longval
= value
;
2747 /* Try to encode a string object in order to save space */
2748 static int tryObjectEncoding(robj
*o
) {
2752 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2753 return REDIS_ERR
; /* Already encoded */
2755 /* It's not save to encode shared objects: shared objects can be shared
2756 * everywhere in the "object space" of Redis. Encoded objects can only
2757 * appear as "values" (and not, for instance, as keys) */
2758 if (o
->refcount
> 1) return REDIS_ERR
;
2760 /* Currently we try to encode only strings */
2761 redisAssert(o
->type
== REDIS_STRING
);
2763 /* Check if we can represent this string as a long integer */
2764 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2766 /* Ok, this object can be encoded */
2767 o
->encoding
= REDIS_ENCODING_INT
;
2769 o
->ptr
= (void*) value
;
2773 /* Get a decoded version of an encoded object (returned as a new object).
2774 * If the object is already raw-encoded just increment the ref count. */
2775 static robj
*getDecodedObject(robj
*o
) {
2778 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2782 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2785 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2786 dec
= createStringObject(buf
,strlen(buf
));
2789 redisAssert(1 != 1);
2793 /* Compare two string objects via strcmp() or alike.
2794 * Note that the objects may be integer-encoded. In such a case we
2795 * use snprintf() to get a string representation of the numbers on the stack
2796 * and compare the strings, it's much faster than calling getDecodedObject().
2798 * Important note: if objects are not integer encoded, but binary-safe strings,
2799 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2801 static int compareStringObjects(robj
*a
, robj
*b
) {
2802 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2803 char bufa
[128], bufb
[128], *astr
, *bstr
;
2806 if (a
== b
) return 0;
2807 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2808 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2814 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2815 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2821 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2824 static size_t stringObjectLen(robj
*o
) {
2825 redisAssert(o
->type
== REDIS_STRING
);
2826 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2827 return sdslen(o
->ptr
);
2831 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2835 /*============================ RDB saving/loading =========================== */
2837 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2838 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2842 static int rdbSaveTime(FILE *fp
, time_t t
) {
2843 int32_t t32
= (int32_t) t
;
2844 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2848 /* check rdbLoadLen() comments for more info */
2849 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2850 unsigned char buf
[2];
2853 /* Save a 6 bit len */
2854 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2855 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2856 } else if (len
< (1<<14)) {
2857 /* Save a 14 bit len */
2858 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2860 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2862 /* Save a 32 bit len */
2863 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2864 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2866 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2871 /* String objects in the form "2391" "-100" without any space and with a
2872 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2873 * encoded as integers to save space */
2874 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2876 char *endptr
, buf
[32];
2878 /* Check if it's possible to encode this value as a number */
2879 value
= strtoll(s
, &endptr
, 10);
2880 if (endptr
[0] != '\0') return 0;
2881 snprintf(buf
,32,"%lld",value
);
2883 /* If the number converted back into a string is not identical
2884 * then it's not possible to encode the string as integer */
2885 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2887 /* Finally check if it fits in our ranges */
2888 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2889 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2890 enc
[1] = value
&0xFF;
2892 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2893 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2894 enc
[1] = value
&0xFF;
2895 enc
[2] = (value
>>8)&0xFF;
2897 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2898 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2899 enc
[1] = value
&0xFF;
2900 enc
[2] = (value
>>8)&0xFF;
2901 enc
[3] = (value
>>16)&0xFF;
2902 enc
[4] = (value
>>24)&0xFF;
2909 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2910 unsigned int comprlen
, outlen
;
2914 /* We require at least four bytes compression for this to be worth it */
2915 outlen
= sdslen(obj
->ptr
)-4;
2916 if (outlen
<= 0) return 0;
2917 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2918 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2919 if (comprlen
== 0) {
2923 /* Data compressed! Let's save it on disk */
2924 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2925 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2926 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2927 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2928 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2937 /* Save a string objet as [len][data] on disk. If the object is a string
2938 * representation of an integer value we try to safe it in a special form */
2939 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2943 len
= sdslen(obj
->ptr
);
2945 /* Try integer encoding */
2947 unsigned char buf
[5];
2948 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2949 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2954 /* Try LZF compression - under 20 bytes it's unable to compress even
2955 * aaaaaaaaaaaaaaaaaa so skip it */
2956 if (server
.rdbcompression
&& len
> 20) {
2959 retval
= rdbSaveLzfStringObject(fp
,obj
);
2960 if (retval
== -1) return -1;
2961 if (retval
> 0) return 0;
2962 /* retval == 0 means data can't be compressed, save the old way */
2965 /* Store verbatim */
2966 if (rdbSaveLen(fp
,len
) == -1) return -1;
2967 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2971 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2972 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2975 /* Avoid incr/decr ref count business when possible.
2976 * This plays well with copy-on-write given that we are probably
2977 * in a child process (BGSAVE). Also this makes sure key objects
2978 * of swapped objects are not incRefCount-ed (an assert does not allow
2979 * this in order to avoid bugs) */
2980 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2981 obj
= getDecodedObject(obj
);
2982 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2985 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2990 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2991 * 8 bit integer specifing the length of the representation.
2992 * This 8 bit integer has special values in order to specify the following
2998 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2999 unsigned char buf
[128];
3005 } else if (!isfinite(val
)) {
3007 buf
[0] = (val
< 0) ? 255 : 254;
3009 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3010 buf
[0] = strlen((char*)buf
+1);
3013 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3017 /* Save a Redis object. */
3018 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3019 if (o
->type
== REDIS_STRING
) {
3020 /* Save a string value */
3021 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3022 } else if (o
->type
== REDIS_LIST
) {
3023 /* Save a list value */
3024 list
*list
= o
->ptr
;
3028 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3029 listRewind(list
,&li
);
3030 while((ln
= listNext(&li
))) {
3031 robj
*eleobj
= listNodeValue(ln
);
3033 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3035 } else if (o
->type
== REDIS_SET
) {
3036 /* Save a set value */
3038 dictIterator
*di
= dictGetIterator(set
);
3041 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3042 while((de
= dictNext(di
)) != NULL
) {
3043 robj
*eleobj
= dictGetEntryKey(de
);
3045 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3047 dictReleaseIterator(di
);
3048 } else if (o
->type
== REDIS_ZSET
) {
3049 /* Save a set value */
3051 dictIterator
*di
= dictGetIterator(zs
->dict
);
3054 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3055 while((de
= dictNext(di
)) != NULL
) {
3056 robj
*eleobj
= dictGetEntryKey(de
);
3057 double *score
= dictGetEntryVal(de
);
3059 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3060 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3062 dictReleaseIterator(di
);
3064 redisAssert(0 != 0);
3069 /* Return the length the object will have on disk if saved with
3070 * the rdbSaveObject() function. Currently we use a trick to get
3071 * this length with very little changes to the code. In the future
3072 * we could switch to a faster solution. */
3073 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3074 if (fp
== NULL
) fp
= server
.devnull
;
3076 assert(rdbSaveObject(fp
,o
) != 1);
3080 /* Return the number of pages required to save this object in the swap file */
3081 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3082 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3084 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3087 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3088 static int rdbSave(char *filename
) {
3089 dictIterator
*di
= NULL
;
3094 time_t now
= time(NULL
);
3096 /* Wait for I/O therads to terminate, just in case this is a
3097 * foreground-saving, to avoid seeking the swap file descriptor at the
3099 if (server
.vm_enabled
)
3100 waitEmptyIOJobsQueue();
3102 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3103 fp
= fopen(tmpfile
,"w");
3105 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3108 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3109 for (j
= 0; j
< server
.dbnum
; j
++) {
3110 redisDb
*db
= server
.db
+j
;
3112 if (dictSize(d
) == 0) continue;
3113 di
= dictGetIterator(d
);
3119 /* Write the SELECT DB opcode */
3120 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3121 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3123 /* Iterate this DB writing every entry */
3124 while((de
= dictNext(di
)) != NULL
) {
3125 robj
*key
= dictGetEntryKey(de
);
3126 robj
*o
= dictGetEntryVal(de
);
3127 time_t expiretime
= getExpire(db
,key
);
3129 /* Save the expire time */
3130 if (expiretime
!= -1) {
3131 /* If this key is already expired skip it */
3132 if (expiretime
< now
) continue;
3133 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3134 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3136 /* Save the key and associated value. This requires special
3137 * handling if the value is swapped out. */
3138 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3139 key
->storage
== REDIS_VM_SWAPPING
) {
3140 /* Save type, key, value */
3141 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3142 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3143 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3145 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3147 /* Get a preview of the object in memory */
3148 po
= vmPreviewObject(key
);
3149 /* Save type, key, value */
3150 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3151 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3152 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3153 /* Remove the loaded object from memory */
3157 dictReleaseIterator(di
);
3160 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3162 /* Make sure data will not remain on the OS's output buffers */
3167 /* Use RENAME to make sure the DB file is changed atomically only
3168 * if the generate DB file is ok. */
3169 if (rename(tmpfile
,filename
) == -1) {
3170 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3174 redisLog(REDIS_NOTICE
,"DB saved on disk");
3176 server
.lastsave
= time(NULL
);
3182 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3183 if (di
) dictReleaseIterator(di
);
3187 static int rdbSaveBackground(char *filename
) {
3190 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3191 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3192 if ((childpid
= fork()) == 0) {
3194 if (server
.vm_enabled
) vmReopenSwapFile();
3196 if (rdbSave(filename
) == REDIS_OK
) {
3203 if (childpid
== -1) {
3204 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3208 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3209 server
.bgsavechildpid
= childpid
;
3212 return REDIS_OK
; /* unreached */
3215 static void rdbRemoveTempFile(pid_t childpid
) {
3218 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3222 static int rdbLoadType(FILE *fp
) {
3224 if (fread(&type
,1,1,fp
) == 0) return -1;
3228 static time_t rdbLoadTime(FILE *fp
) {
3230 if (fread(&t32
,4,1,fp
) == 0) return -1;
3231 return (time_t) t32
;
3234 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3235 * of this file for a description of how this are stored on disk.
3237 * isencoded is set to 1 if the readed length is not actually a length but
3238 * an "encoding type", check the above comments for more info */
3239 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3240 unsigned char buf
[2];
3244 if (isencoded
) *isencoded
= 0;
3245 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3246 type
= (buf
[0]&0xC0)>>6;
3247 if (type
== REDIS_RDB_6BITLEN
) {
3248 /* Read a 6 bit len */
3250 } else if (type
== REDIS_RDB_ENCVAL
) {
3251 /* Read a 6 bit len encoding type */
3252 if (isencoded
) *isencoded
= 1;
3254 } else if (type
== REDIS_RDB_14BITLEN
) {
3255 /* Read a 14 bit len */
3256 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3257 return ((buf
[0]&0x3F)<<8)|buf
[1];
3259 /* Read a 32 bit len */
3260 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3265 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3266 unsigned char enc
[4];
3269 if (enctype
== REDIS_RDB_ENC_INT8
) {
3270 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3271 val
= (signed char)enc
[0];
3272 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3274 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3275 v
= enc
[0]|(enc
[1]<<8);
3277 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3279 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3280 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3283 val
= 0; /* anti-warning */
3286 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3289 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3290 unsigned int len
, clen
;
3291 unsigned char *c
= NULL
;
3294 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3295 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3296 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3297 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3298 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3299 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3301 return createObject(REDIS_STRING
,val
);
3308 static robj
*rdbLoadStringObject(FILE*fp
) {
3313 len
= rdbLoadLen(fp
,&isencoded
);
3316 case REDIS_RDB_ENC_INT8
:
3317 case REDIS_RDB_ENC_INT16
:
3318 case REDIS_RDB_ENC_INT32
:
3319 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3320 case REDIS_RDB_ENC_LZF
:
3321 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3327 if (len
== REDIS_RDB_LENERR
) return NULL
;
3328 val
= sdsnewlen(NULL
,len
);
3329 if (len
&& fread(val
,len
,1,fp
) == 0) {
3333 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3336 /* For information about double serialization check rdbSaveDoubleValue() */
3337 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3341 if (fread(&len
,1,1,fp
) == 0) return -1;
3343 case 255: *val
= R_NegInf
; return 0;
3344 case 254: *val
= R_PosInf
; return 0;
3345 case 253: *val
= R_Nan
; return 0;
3347 if (fread(buf
,len
,1,fp
) == 0) return -1;
3349 sscanf(buf
, "%lg", val
);
3354 /* Load a Redis object of the specified type from the specified file.
3355 * On success a newly allocated object is returned, otherwise NULL. */
3356 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3359 if (type
== REDIS_STRING
) {
3360 /* Read string value */
3361 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3362 tryObjectEncoding(o
);
3363 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3364 /* Read list/set value */
3367 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3368 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3369 /* It's faster to expand the dict to the right size asap in order
3370 * to avoid rehashing */
3371 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3372 dictExpand(o
->ptr
,listlen
);
3373 /* Load every single element of the list/set */
3377 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3378 tryObjectEncoding(ele
);
3379 if (type
== REDIS_LIST
) {
3380 listAddNodeTail((list
*)o
->ptr
,ele
);
3382 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3385 } else if (type
== REDIS_ZSET
) {
3386 /* Read list/set value */
3390 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3391 o
= createZsetObject();
3393 /* Load every single element of the list/set */
3396 double *score
= zmalloc(sizeof(double));
3398 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3399 tryObjectEncoding(ele
);
3400 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3401 dictAdd(zs
->dict
,ele
,score
);
3402 zslInsert(zs
->zsl
,*score
,ele
);
3403 incrRefCount(ele
); /* added to skiplist */
3406 redisAssert(0 != 0);
3411 static int rdbLoad(char *filename
) {
3413 robj
*keyobj
= NULL
;
3415 int type
, retval
, rdbver
;
3416 dict
*d
= server
.db
[0].dict
;
3417 redisDb
*db
= server
.db
+0;
3419 time_t expiretime
= -1, now
= time(NULL
);
3420 long long loadedkeys
= 0;
3422 fp
= fopen(filename
,"r");
3423 if (!fp
) return REDIS_ERR
;
3424 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3426 if (memcmp(buf
,"REDIS",5) != 0) {
3428 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3431 rdbver
= atoi(buf
+5);
3434 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3441 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3442 if (type
== REDIS_EXPIRETIME
) {
3443 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3444 /* We read the time so we need to read the object type again */
3445 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3447 if (type
== REDIS_EOF
) break;
3448 /* Handle SELECT DB opcode as a special case */
3449 if (type
== REDIS_SELECTDB
) {
3450 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3452 if (dbid
>= (unsigned)server
.dbnum
) {
3453 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3456 db
= server
.db
+dbid
;
3461 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3463 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3464 /* Add the new object in the hash table */
3465 retval
= dictAdd(d
,keyobj
,o
);
3466 if (retval
== DICT_ERR
) {
3467 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3470 /* Set the expire time if needed */
3471 if (expiretime
!= -1) {
3472 setExpire(db
,keyobj
,expiretime
);
3473 /* Delete this key if already expired */
3474 if (expiretime
< now
) deleteKey(db
,keyobj
);
3478 /* Handle swapping while loading big datasets when VM is on */
3480 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3481 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3482 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3489 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3490 if (keyobj
) decrRefCount(keyobj
);
3491 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3493 return REDIS_ERR
; /* Just to avoid warning */
3496 /*================================== Commands =============================== */
3498 static void authCommand(redisClient
*c
) {
3499 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3500 c
->authenticated
= 1;
3501 addReply(c
,shared
.ok
);
3503 c
->authenticated
= 0;
3504 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3508 static void pingCommand(redisClient
*c
) {
3509 addReply(c
,shared
.pong
);
3512 static void echoCommand(redisClient
*c
) {
3513 addReplyBulkLen(c
,c
->argv
[1]);
3514 addReply(c
,c
->argv
[1]);
3515 addReply(c
,shared
.crlf
);
3518 /*=================================== Strings =============================== */
3520 static void setGenericCommand(redisClient
*c
, int nx
) {
3523 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3524 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3525 if (retval
== DICT_ERR
) {
3527 /* If the key is about a swapped value, we want a new key object
3528 * to overwrite the old. So we delete the old key in the database.
3529 * This will also make sure that swap pages about the old object
3530 * will be marked as free. */
3531 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3532 incrRefCount(c
->argv
[1]);
3533 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3534 incrRefCount(c
->argv
[2]);
3536 addReply(c
,shared
.czero
);
3540 incrRefCount(c
->argv
[1]);
3541 incrRefCount(c
->argv
[2]);
3544 removeExpire(c
->db
,c
->argv
[1]);
3545 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3548 static void setCommand(redisClient
*c
) {
3549 setGenericCommand(c
,0);
3552 static void setnxCommand(redisClient
*c
) {
3553 setGenericCommand(c
,1);
3556 static int getGenericCommand(redisClient
*c
) {
3557 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3560 addReply(c
,shared
.nullbulk
);
3563 if (o
->type
!= REDIS_STRING
) {
3564 addReply(c
,shared
.wrongtypeerr
);
3567 addReplyBulkLen(c
,o
);
3569 addReply(c
,shared
.crlf
);
3575 static void getCommand(redisClient
*c
) {
3576 getGenericCommand(c
);
3579 static void getsetCommand(redisClient
*c
) {
3580 if (getGenericCommand(c
) == REDIS_ERR
) return;
3581 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3582 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3584 incrRefCount(c
->argv
[1]);
3586 incrRefCount(c
->argv
[2]);
3588 removeExpire(c
->db
,c
->argv
[1]);
3591 static void mgetCommand(redisClient
*c
) {
3594 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3595 for (j
= 1; j
< c
->argc
; j
++) {
3596 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3598 addReply(c
,shared
.nullbulk
);
3600 if (o
->type
!= REDIS_STRING
) {
3601 addReply(c
,shared
.nullbulk
);
3603 addReplyBulkLen(c
,o
);
3605 addReply(c
,shared
.crlf
);
3611 static void msetGenericCommand(redisClient
*c
, int nx
) {
3612 int j
, busykeys
= 0;
3614 if ((c
->argc
% 2) == 0) {
3615 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3618 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3619 * set nothing at all if at least one already key exists. */
3621 for (j
= 1; j
< c
->argc
; j
+= 2) {
3622 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3628 addReply(c
, shared
.czero
);
3632 for (j
= 1; j
< c
->argc
; j
+= 2) {
3635 tryObjectEncoding(c
->argv
[j
+1]);
3636 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3637 if (retval
== DICT_ERR
) {
3638 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3639 incrRefCount(c
->argv
[j
+1]);
3641 incrRefCount(c
->argv
[j
]);
3642 incrRefCount(c
->argv
[j
+1]);
3644 removeExpire(c
->db
,c
->argv
[j
]);
3646 server
.dirty
+= (c
->argc
-1)/2;
3647 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3650 static void msetCommand(redisClient
*c
) {
3651 msetGenericCommand(c
,0);
3654 static void msetnxCommand(redisClient
*c
) {
3655 msetGenericCommand(c
,1);
3658 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3663 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3667 if (o
->type
!= REDIS_STRING
) {
3672 if (o
->encoding
== REDIS_ENCODING_RAW
)
3673 value
= strtoll(o
->ptr
, &eptr
, 10);
3674 else if (o
->encoding
== REDIS_ENCODING_INT
)
3675 value
= (long)o
->ptr
;
3677 redisAssert(1 != 1);
3682 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3683 tryObjectEncoding(o
);
3684 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3685 if (retval
== DICT_ERR
) {
3686 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3687 removeExpire(c
->db
,c
->argv
[1]);
3689 incrRefCount(c
->argv
[1]);
3692 addReply(c
,shared
.colon
);
3694 addReply(c
,shared
.crlf
);
3697 static void incrCommand(redisClient
*c
) {
3698 incrDecrCommand(c
,1);
3701 static void decrCommand(redisClient
*c
) {
3702 incrDecrCommand(c
,-1);
3705 static void incrbyCommand(redisClient
*c
) {
3706 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3707 incrDecrCommand(c
,incr
);
3710 static void decrbyCommand(redisClient
*c
) {
3711 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3712 incrDecrCommand(c
,-incr
);
3715 static void appendCommand(redisClient
*c
) {
3720 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3722 /* Create the key */
3723 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3724 incrRefCount(c
->argv
[1]);
3725 incrRefCount(c
->argv
[2]);
3726 totlen
= stringObjectLen(c
->argv
[2]);
3730 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3733 o
= dictGetEntryVal(de
);
3734 if (o
->type
!= REDIS_STRING
) {
3735 addReply(c
,shared
.wrongtypeerr
);
3738 /* If the object is specially encoded or shared we have to make
3740 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3741 robj
*decoded
= getDecodedObject(o
);
3743 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3744 decrRefCount(decoded
);
3745 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3748 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3749 o
->ptr
= sdscatlen(o
->ptr
,
3750 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3752 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3753 (unsigned long) c
->argv
[2]->ptr
);
3755 totlen
= sdslen(o
->ptr
);
3758 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3761 /* ========================= Type agnostic commands ========================= */
3763 static void delCommand(redisClient
*c
) {
3766 for (j
= 1; j
< c
->argc
; j
++) {
3767 if (deleteKey(c
->db
,c
->argv
[j
])) {
3774 addReply(c
,shared
.czero
);
3777 addReply(c
,shared
.cone
);
3780 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3785 static void existsCommand(redisClient
*c
) {
3786 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3789 static void selectCommand(redisClient
*c
) {
3790 int id
= atoi(c
->argv
[1]->ptr
);
3792 if (selectDb(c
,id
) == REDIS_ERR
) {
3793 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3795 addReply(c
,shared
.ok
);
3799 static void randomkeyCommand(redisClient
*c
) {
3803 de
= dictGetRandomKey(c
->db
->dict
);
3804 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3807 addReply(c
,shared
.plus
);
3808 addReply(c
,shared
.crlf
);
3810 addReply(c
,shared
.plus
);
3811 addReply(c
,dictGetEntryKey(de
));
3812 addReply(c
,shared
.crlf
);
3816 static void keysCommand(redisClient
*c
) {
3819 sds pattern
= c
->argv
[1]->ptr
;
3820 int plen
= sdslen(pattern
);
3821 unsigned long numkeys
= 0, keyslen
= 0;
3822 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3824 di
= dictGetIterator(c
->db
->dict
);
3826 decrRefCount(lenobj
);
3827 while((de
= dictNext(di
)) != NULL
) {
3828 robj
*keyobj
= dictGetEntryKey(de
);
3830 sds key
= keyobj
->ptr
;
3831 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3832 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3833 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3835 addReply(c
,shared
.space
);
3838 keyslen
+= sdslen(key
);
3842 dictReleaseIterator(di
);
3843 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3844 addReply(c
,shared
.crlf
);
3847 static void dbsizeCommand(redisClient
*c
) {
3849 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3852 static void lastsaveCommand(redisClient
*c
) {
3854 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3857 static void typeCommand(redisClient
*c
) {
3861 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3866 case REDIS_STRING
: type
= "+string"; break;
3867 case REDIS_LIST
: type
= "+list"; break;
3868 case REDIS_SET
: type
= "+set"; break;
3869 case REDIS_ZSET
: type
= "+zset"; break;
3870 default: type
= "unknown"; break;
3873 addReplySds(c
,sdsnew(type
));
3874 addReply(c
,shared
.crlf
);
3877 static void saveCommand(redisClient
*c
) {
3878 if (server
.bgsavechildpid
!= -1) {
3879 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3882 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3883 addReply(c
,shared
.ok
);
3885 addReply(c
,shared
.err
);
3889 static void bgsaveCommand(redisClient
*c
) {
3890 if (server
.bgsavechildpid
!= -1) {
3891 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3894 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3895 char *status
= "+Background saving started\r\n";
3896 addReplySds(c
,sdsnew(status
));
3898 addReply(c
,shared
.err
);
3902 static void shutdownCommand(redisClient
*c
) {
3903 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3904 /* Kill the saving child if there is a background saving in progress.
3905 We want to avoid race conditions, for instance our saving child may
3906 overwrite the synchronous saving did by SHUTDOWN. */
3907 if (server
.bgsavechildpid
!= -1) {
3908 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3909 kill(server
.bgsavechildpid
,SIGKILL
);
3910 rdbRemoveTempFile(server
.bgsavechildpid
);
3912 if (server
.appendonly
) {
3913 /* Append only file: fsync() the AOF and exit */
3914 fsync(server
.appendfd
);
3915 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3918 /* Snapshotting. Perform a SYNC SAVE and exit */
3919 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3920 if (server
.daemonize
)
3921 unlink(server
.pidfile
);
3922 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3923 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3924 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3927 /* Ooops.. error saving! The best we can do is to continue operating.
3928 * Note that if there was a background saving process, in the next
3929 * cron() Redis will be notified that the background saving aborted,
3930 * handling special stuff like slaves pending for synchronization... */
3931 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3932 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3937 static void renameGenericCommand(redisClient
*c
, int nx
) {
3940 /* To use the same key as src and dst is probably an error */
3941 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3942 addReply(c
,shared
.sameobjecterr
);
3946 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3948 addReply(c
,shared
.nokeyerr
);
3952 deleteIfVolatile(c
->db
,c
->argv
[2]);
3953 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3956 addReply(c
,shared
.czero
);
3959 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3961 incrRefCount(c
->argv
[2]);
3963 deleteKey(c
->db
,c
->argv
[1]);
3965 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3968 static void renameCommand(redisClient
*c
) {
3969 renameGenericCommand(c
,0);
3972 static void renamenxCommand(redisClient
*c
) {
3973 renameGenericCommand(c
,1);
3976 static void moveCommand(redisClient
*c
) {
3981 /* Obtain source and target DB pointers */
3984 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3985 addReply(c
,shared
.outofrangeerr
);
3989 selectDb(c
,srcid
); /* Back to the source DB */
3991 /* If the user is moving using as target the same
3992 * DB as the source DB it is probably an error. */
3994 addReply(c
,shared
.sameobjecterr
);
3998 /* Check if the element exists and get a reference */
3999 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4001 addReply(c
,shared
.czero
);
4005 /* Try to add the element to the target DB */
4006 deleteIfVolatile(dst
,c
->argv
[1]);
4007 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4008 addReply(c
,shared
.czero
);
4011 incrRefCount(c
->argv
[1]);
4014 /* OK! key moved, free the entry in the source DB */
4015 deleteKey(src
,c
->argv
[1]);
4017 addReply(c
,shared
.cone
);
4020 /* =================================== Lists ================================ */
4021 static void pushGenericCommand(redisClient
*c
, int where
) {
4025 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4027 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4028 addReply(c
,shared
.ok
);
4031 lobj
= createListObject();
4033 if (where
== REDIS_HEAD
) {
4034 listAddNodeHead(list
,c
->argv
[2]);
4036 listAddNodeTail(list
,c
->argv
[2]);
4038 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4039 incrRefCount(c
->argv
[1]);
4040 incrRefCount(c
->argv
[2]);
4042 if (lobj
->type
!= REDIS_LIST
) {
4043 addReply(c
,shared
.wrongtypeerr
);
4046 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4047 addReply(c
,shared
.ok
);
4051 if (where
== REDIS_HEAD
) {
4052 listAddNodeHead(list
,c
->argv
[2]);
4054 listAddNodeTail(list
,c
->argv
[2]);
4056 incrRefCount(c
->argv
[2]);
4059 addReply(c
,shared
.ok
);
4062 static void lpushCommand(redisClient
*c
) {
4063 pushGenericCommand(c
,REDIS_HEAD
);
4066 static void rpushCommand(redisClient
*c
) {
4067 pushGenericCommand(c
,REDIS_TAIL
);
4070 static void llenCommand(redisClient
*c
) {
4074 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4076 addReply(c
,shared
.czero
);
4079 if (o
->type
!= REDIS_LIST
) {
4080 addReply(c
,shared
.wrongtypeerr
);
4083 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4088 static void lindexCommand(redisClient
*c
) {
4090 int index
= atoi(c
->argv
[2]->ptr
);
4092 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4094 addReply(c
,shared
.nullbulk
);
4096 if (o
->type
!= REDIS_LIST
) {
4097 addReply(c
,shared
.wrongtypeerr
);
4099 list
*list
= o
->ptr
;
4102 ln
= listIndex(list
, index
);
4104 addReply(c
,shared
.nullbulk
);
4106 robj
*ele
= listNodeValue(ln
);
4107 addReplyBulkLen(c
,ele
);
4109 addReply(c
,shared
.crlf
);
4115 static void lsetCommand(redisClient
*c
) {
4117 int index
= atoi(c
->argv
[2]->ptr
);
4119 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4121 addReply(c
,shared
.nokeyerr
);
4123 if (o
->type
!= REDIS_LIST
) {
4124 addReply(c
,shared
.wrongtypeerr
);
4126 list
*list
= o
->ptr
;
4129 ln
= listIndex(list
, index
);
4131 addReply(c
,shared
.outofrangeerr
);
4133 robj
*ele
= listNodeValue(ln
);
4136 listNodeValue(ln
) = c
->argv
[3];
4137 incrRefCount(c
->argv
[3]);
4138 addReply(c
,shared
.ok
);
4145 static void popGenericCommand(redisClient
*c
, int where
) {
4148 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4150 addReply(c
,shared
.nullbulk
);
4152 if (o
->type
!= REDIS_LIST
) {
4153 addReply(c
,shared
.wrongtypeerr
);
4155 list
*list
= o
->ptr
;
4158 if (where
== REDIS_HEAD
)
4159 ln
= listFirst(list
);
4161 ln
= listLast(list
);
4164 addReply(c
,shared
.nullbulk
);
4166 robj
*ele
= listNodeValue(ln
);
4167 addReplyBulkLen(c
,ele
);
4169 addReply(c
,shared
.crlf
);
4170 listDelNode(list
,ln
);
4177 static void lpopCommand(redisClient
*c
) {
4178 popGenericCommand(c
,REDIS_HEAD
);
4181 static void rpopCommand(redisClient
*c
) {
4182 popGenericCommand(c
,REDIS_TAIL
);
4185 static void lrangeCommand(redisClient
*c
) {
4187 int start
= atoi(c
->argv
[2]->ptr
);
4188 int end
= atoi(c
->argv
[3]->ptr
);
4190 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4192 addReply(c
,shared
.nullmultibulk
);
4194 if (o
->type
!= REDIS_LIST
) {
4195 addReply(c
,shared
.wrongtypeerr
);
4197 list
*list
= o
->ptr
;
4199 int llen
= listLength(list
);
4203 /* convert negative indexes */
4204 if (start
< 0) start
= llen
+start
;
4205 if (end
< 0) end
= llen
+end
;
4206 if (start
< 0) start
= 0;
4207 if (end
< 0) end
= 0;
4209 /* indexes sanity checks */
4210 if (start
> end
|| start
>= llen
) {
4211 /* Out of range start or start > end result in empty list */
4212 addReply(c
,shared
.emptymultibulk
);
4215 if (end
>= llen
) end
= llen
-1;
4216 rangelen
= (end
-start
)+1;
4218 /* Return the result in form of a multi-bulk reply */
4219 ln
= listIndex(list
, start
);
4220 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4221 for (j
= 0; j
< rangelen
; j
++) {
4222 ele
= listNodeValue(ln
);
4223 addReplyBulkLen(c
,ele
);
4225 addReply(c
,shared
.crlf
);
4232 static void ltrimCommand(redisClient
*c
) {
4234 int start
= atoi(c
->argv
[2]->ptr
);
4235 int end
= atoi(c
->argv
[3]->ptr
);
4237 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4239 addReply(c
,shared
.ok
);
4241 if (o
->type
!= REDIS_LIST
) {
4242 addReply(c
,shared
.wrongtypeerr
);
4244 list
*list
= o
->ptr
;
4246 int llen
= listLength(list
);
4247 int j
, ltrim
, rtrim
;
4249 /* convert negative indexes */
4250 if (start
< 0) start
= llen
+start
;
4251 if (end
< 0) end
= llen
+end
;
4252 if (start
< 0) start
= 0;
4253 if (end
< 0) end
= 0;
4255 /* indexes sanity checks */
4256 if (start
> end
|| start
>= llen
) {
4257 /* Out of range start or start > end result in empty list */
4261 if (end
>= llen
) end
= llen
-1;
4266 /* Remove list elements to perform the trim */
4267 for (j
= 0; j
< ltrim
; j
++) {
4268 ln
= listFirst(list
);
4269 listDelNode(list
,ln
);
4271 for (j
= 0; j
< rtrim
; j
++) {
4272 ln
= listLast(list
);
4273 listDelNode(list
,ln
);
4276 addReply(c
,shared
.ok
);
4281 static void lremCommand(redisClient
*c
) {
4284 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4286 addReply(c
,shared
.czero
);
4288 if (o
->type
!= REDIS_LIST
) {
4289 addReply(c
,shared
.wrongtypeerr
);
4291 list
*list
= o
->ptr
;
4292 listNode
*ln
, *next
;
4293 int toremove
= atoi(c
->argv
[2]->ptr
);
4298 toremove
= -toremove
;
4301 ln
= fromtail
? list
->tail
: list
->head
;
4303 robj
*ele
= listNodeValue(ln
);
4305 next
= fromtail
? ln
->prev
: ln
->next
;
4306 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4307 listDelNode(list
,ln
);
4310 if (toremove
&& removed
== toremove
) break;
4314 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4319 /* This is the semantic of this command:
4320 * RPOPLPUSH srclist dstlist:
4321 * IF LLEN(srclist) > 0
4322 * element = RPOP srclist
4323 * LPUSH dstlist element
4330 * The idea is to be able to get an element from a list in a reliable way
4331 * since the element is not just returned but pushed against another list
4332 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4334 static void rpoplpushcommand(redisClient
*c
) {
4337 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4339 addReply(c
,shared
.nullbulk
);
4341 if (sobj
->type
!= REDIS_LIST
) {
4342 addReply(c
,shared
.wrongtypeerr
);
4344 list
*srclist
= sobj
->ptr
;
4345 listNode
*ln
= listLast(srclist
);
4348 addReply(c
,shared
.nullbulk
);
4350 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4351 robj
*ele
= listNodeValue(ln
);
4354 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4355 addReply(c
,shared
.wrongtypeerr
);
4359 /* Add the element to the target list (unless it's directly
4360 * passed to some BLPOP-ing client */
4361 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4363 /* Create the list if the key does not exist */
4364 dobj
= createListObject();
4365 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4366 incrRefCount(c
->argv
[2]);
4368 dstlist
= dobj
->ptr
;
4369 listAddNodeHead(dstlist
,ele
);
4373 /* Send the element to the client as reply as well */
4374 addReplyBulkLen(c
,ele
);
4376 addReply(c
,shared
.crlf
);
4378 /* Finally remove the element from the source list */
4379 listDelNode(srclist
,ln
);
4387 /* ==================================== Sets ================================ */
4389 static void saddCommand(redisClient
*c
) {
4392 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4394 set
= createSetObject();
4395 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4396 incrRefCount(c
->argv
[1]);
4398 if (set
->type
!= REDIS_SET
) {
4399 addReply(c
,shared
.wrongtypeerr
);
4403 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4404 incrRefCount(c
->argv
[2]);
4406 addReply(c
,shared
.cone
);
4408 addReply(c
,shared
.czero
);
4412 static void sremCommand(redisClient
*c
) {
4415 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4417 addReply(c
,shared
.czero
);
4419 if (set
->type
!= REDIS_SET
) {
4420 addReply(c
,shared
.wrongtypeerr
);
4423 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4425 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4426 addReply(c
,shared
.cone
);
4428 addReply(c
,shared
.czero
);
4433 static void smoveCommand(redisClient
*c
) {
4434 robj
*srcset
, *dstset
;
4436 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4437 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4439 /* If the source key does not exist return 0, if it's of the wrong type
4441 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4442 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4445 /* Error if the destination key is not a set as well */
4446 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4447 addReply(c
,shared
.wrongtypeerr
);
4450 /* Remove the element from the source set */
4451 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4452 /* Key not found in the src set! return zero */
4453 addReply(c
,shared
.czero
);
4457 /* Add the element to the destination set */
4459 dstset
= createSetObject();
4460 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4461 incrRefCount(c
->argv
[2]);
4463 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4464 incrRefCount(c
->argv
[3]);
4465 addReply(c
,shared
.cone
);
4468 static void sismemberCommand(redisClient
*c
) {
4471 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4473 addReply(c
,shared
.czero
);
4475 if (set
->type
!= REDIS_SET
) {
4476 addReply(c
,shared
.wrongtypeerr
);
4479 if (dictFind(set
->ptr
,c
->argv
[2]))
4480 addReply(c
,shared
.cone
);
4482 addReply(c
,shared
.czero
);
4486 static void scardCommand(redisClient
*c
) {
4490 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4492 addReply(c
,shared
.czero
);
4495 if (o
->type
!= REDIS_SET
) {
4496 addReply(c
,shared
.wrongtypeerr
);
4499 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4505 static void spopCommand(redisClient
*c
) {
4509 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4511 addReply(c
,shared
.nullbulk
);
4513 if (set
->type
!= REDIS_SET
) {
4514 addReply(c
,shared
.wrongtypeerr
);
4517 de
= dictGetRandomKey(set
->ptr
);
4519 addReply(c
,shared
.nullbulk
);
4521 robj
*ele
= dictGetEntryKey(de
);
4523 addReplyBulkLen(c
,ele
);
4525 addReply(c
,shared
.crlf
);
4526 dictDelete(set
->ptr
,ele
);
4527 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4533 static void srandmemberCommand(redisClient
*c
) {
4537 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4539 addReply(c
,shared
.nullbulk
);
4541 if (set
->type
!= REDIS_SET
) {
4542 addReply(c
,shared
.wrongtypeerr
);
4545 de
= dictGetRandomKey(set
->ptr
);
4547 addReply(c
,shared
.nullbulk
);
4549 robj
*ele
= dictGetEntryKey(de
);
4551 addReplyBulkLen(c
,ele
);
4553 addReply(c
,shared
.crlf
);
4558 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4559 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4561 return dictSize(*d1
)-dictSize(*d2
);
4564 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4565 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4568 robj
*lenobj
= NULL
, *dstset
= NULL
;
4569 unsigned long j
, cardinality
= 0;
4571 for (j
= 0; j
< setsnum
; j
++) {
4575 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4576 lookupKeyRead(c
->db
,setskeys
[j
]);
4580 if (deleteKey(c
->db
,dstkey
))
4582 addReply(c
,shared
.czero
);
4584 addReply(c
,shared
.nullmultibulk
);
4588 if (setobj
->type
!= REDIS_SET
) {
4590 addReply(c
,shared
.wrongtypeerr
);
4593 dv
[j
] = setobj
->ptr
;
4595 /* Sort sets from the smallest to largest, this will improve our
4596 * algorithm's performace */
4597 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4599 /* The first thing we should output is the total number of elements...
4600 * since this is a multi-bulk write, but at this stage we don't know
4601 * the intersection set size, so we use a trick, append an empty object
4602 * to the output list and save the pointer to later modify it with the
4605 lenobj
= createObject(REDIS_STRING
,NULL
);
4607 decrRefCount(lenobj
);
4609 /* If we have a target key where to store the resulting set
4610 * create this key with an empty set inside */
4611 dstset
= createSetObject();
4614 /* Iterate all the elements of the first (smallest) set, and test
4615 * the element against all the other sets, if at least one set does
4616 * not include the element it is discarded */
4617 di
= dictGetIterator(dv
[0]);
4619 while((de
= dictNext(di
)) != NULL
) {
4622 for (j
= 1; j
< setsnum
; j
++)
4623 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4625 continue; /* at least one set does not contain the member */
4626 ele
= dictGetEntryKey(de
);
4628 addReplyBulkLen(c
,ele
);
4630 addReply(c
,shared
.crlf
);
4633 dictAdd(dstset
->ptr
,ele
,NULL
);
4637 dictReleaseIterator(di
);
4640 /* Store the resulting set into the target */
4641 deleteKey(c
->db
,dstkey
);
4642 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4643 incrRefCount(dstkey
);
4647 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4649 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4650 dictSize((dict
*)dstset
->ptr
)));
4656 static void sinterCommand(redisClient
*c
) {
4657 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4660 static void sinterstoreCommand(redisClient
*c
) {
4661 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4664 #define REDIS_OP_UNION 0
4665 #define REDIS_OP_DIFF 1
4667 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4668 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4671 robj
*dstset
= NULL
;
4672 int j
, cardinality
= 0;
4674 for (j
= 0; j
< setsnum
; j
++) {
4678 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4679 lookupKeyRead(c
->db
,setskeys
[j
]);
4684 if (setobj
->type
!= REDIS_SET
) {
4686 addReply(c
,shared
.wrongtypeerr
);
4689 dv
[j
] = setobj
->ptr
;
4692 /* We need a temp set object to store our union. If the dstkey
4693 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4694 * this set object will be the resulting object to set into the target key*/
4695 dstset
= createSetObject();
4697 /* Iterate all the elements of all the sets, add every element a single
4698 * time to the result set */
4699 for (j
= 0; j
< setsnum
; j
++) {
4700 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4701 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4703 di
= dictGetIterator(dv
[j
]);
4705 while((de
= dictNext(di
)) != NULL
) {
4708 /* dictAdd will not add the same element multiple times */
4709 ele
= dictGetEntryKey(de
);
4710 if (op
== REDIS_OP_UNION
|| j
== 0) {
4711 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4715 } else if (op
== REDIS_OP_DIFF
) {
4716 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4721 dictReleaseIterator(di
);
4723 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4726 /* Output the content of the resulting set, if not in STORE mode */
4728 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4729 di
= dictGetIterator(dstset
->ptr
);
4730 while((de
= dictNext(di
)) != NULL
) {
4733 ele
= dictGetEntryKey(de
);
4734 addReplyBulkLen(c
,ele
);
4736 addReply(c
,shared
.crlf
);
4738 dictReleaseIterator(di
);
4740 /* If we have a target key where to store the resulting set
4741 * create this key with the result set inside */
4742 deleteKey(c
->db
,dstkey
);
4743 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4744 incrRefCount(dstkey
);
4749 decrRefCount(dstset
);
4751 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4752 dictSize((dict
*)dstset
->ptr
)));
4758 static void sunionCommand(redisClient
*c
) {
4759 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4762 static void sunionstoreCommand(redisClient
*c
) {
4763 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4766 static void sdiffCommand(redisClient
*c
) {
4767 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4770 static void sdiffstoreCommand(redisClient
*c
) {
4771 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4774 /* ==================================== ZSets =============================== */
4776 /* ZSETs are ordered sets using two data structures to hold the same elements
4777 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4780 * The elements are added to an hash table mapping Redis objects to scores.
4781 * At the same time the elements are added to a skip list mapping scores
4782 * to Redis objects (so objects are sorted by scores in this "view"). */
4784 /* This skiplist implementation is almost a C translation of the original
4785 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4786 * Alternative to Balanced Trees", modified in three ways:
4787 * a) this implementation allows for repeated values.
4788 * b) the comparison is not just by key (our 'score') but by satellite data.
4789 * c) there is a back pointer, so it's a doubly linked list with the back
4790 * pointers being only at "level 1". This allows to traverse the list
4791 * from tail to head, useful for ZREVRANGE. */
4793 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4794 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4796 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4802 static zskiplist
*zslCreate(void) {
4806 zsl
= zmalloc(sizeof(*zsl
));
4809 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4810 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4811 zsl
->header
->forward
[j
] = NULL
;
4812 zsl
->header
->backward
= NULL
;
4817 static void zslFreeNode(zskiplistNode
*node
) {
4818 decrRefCount(node
->obj
);
4819 zfree(node
->forward
);
4823 static void zslFree(zskiplist
*zsl
) {
4824 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4826 zfree(zsl
->header
->forward
);
4829 next
= node
->forward
[0];
4836 static int zslRandomLevel(void) {
4838 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4843 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4844 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4848 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4849 while (x
->forward
[i
] &&
4850 (x
->forward
[i
]->score
< score
||
4851 (x
->forward
[i
]->score
== score
&&
4852 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4856 /* we assume the key is not already inside, since we allow duplicated
4857 * scores, and the re-insertion of score and redis object should never
4858 * happpen since the caller of zslInsert() should test in the hash table
4859 * if the element is already inside or not. */
4860 level
= zslRandomLevel();
4861 if (level
> zsl
->level
) {
4862 for (i
= zsl
->level
; i
< level
; i
++)
4863 update
[i
] = zsl
->header
;
4866 x
= zslCreateNode(level
,score
,obj
);
4867 for (i
= 0; i
< level
; i
++) {
4868 x
->forward
[i
] = update
[i
]->forward
[i
];
4869 update
[i
]->forward
[i
] = x
;
4871 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4873 x
->forward
[0]->backward
= x
;
4879 /* Delete an element with matching score/object from the skiplist. */
4880 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4881 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4885 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4886 while (x
->forward
[i
] &&
4887 (x
->forward
[i
]->score
< score
||
4888 (x
->forward
[i
]->score
== score
&&
4889 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4893 /* We may have multiple elements with the same score, what we need
4894 * is to find the element with both the right score and object. */
4896 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4897 for (i
= 0; i
< zsl
->level
; i
++) {
4898 if (update
[i
]->forward
[i
] != x
) break;
4899 update
[i
]->forward
[i
] = x
->forward
[i
];
4901 if (x
->forward
[0]) {
4902 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4905 zsl
->tail
= x
->backward
;
4908 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4913 return 0; /* not found */
4915 return 0; /* not found */
4918 /* Delete all the elements with score between min and max from the skiplist.
4919 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4920 * Note that this function takes the reference to the hash table view of the
4921 * sorted set, in order to remove the elements from the hash table too. */
4922 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4923 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4924 unsigned long removed
= 0;
4928 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4929 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4933 /* We may have multiple elements with the same score, what we need
4934 * is to find the element with both the right score and object. */
4936 while (x
&& x
->score
<= max
) {
4937 zskiplistNode
*next
;
4939 for (i
= 0; i
< zsl
->level
; i
++) {
4940 if (update
[i
]->forward
[i
] != x
) break;
4941 update
[i
]->forward
[i
] = x
->forward
[i
];
4943 if (x
->forward
[0]) {
4944 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4947 zsl
->tail
= x
->backward
;
4949 next
= x
->forward
[0];
4950 dictDelete(dict
,x
->obj
);
4952 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4958 return removed
; /* not found */
4961 /* Find the first node having a score equal or greater than the specified one.
4962 * Returns NULL if there is no match. */
4963 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4968 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4969 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4972 /* We may have multiple elements with the same score, what we need
4973 * is to find the element with both the right score and object. */
4974 return x
->forward
[0];
4977 /* The actual Z-commands implementations */
4979 /* This generic command implements both ZADD and ZINCRBY.
4980 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4981 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4982 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4987 zsetobj
= lookupKeyWrite(c
->db
,key
);
4988 if (zsetobj
== NULL
) {
4989 zsetobj
= createZsetObject();
4990 dictAdd(c
->db
->dict
,key
,zsetobj
);
4993 if (zsetobj
->type
!= REDIS_ZSET
) {
4994 addReply(c
,shared
.wrongtypeerr
);
5000 /* Ok now since we implement both ZADD and ZINCRBY here the code
5001 * needs to handle the two different conditions. It's all about setting
5002 * '*score', that is, the new score to set, to the right value. */
5003 score
= zmalloc(sizeof(double));
5007 /* Read the old score. If the element was not present starts from 0 */
5008 de
= dictFind(zs
->dict
,ele
);
5010 double *oldscore
= dictGetEntryVal(de
);
5011 *score
= *oldscore
+ scoreval
;
5019 /* What follows is a simple remove and re-insert operation that is common
5020 * to both ZADD and ZINCRBY... */
5021 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5022 /* case 1: New element */
5023 incrRefCount(ele
); /* added to hash */
5024 zslInsert(zs
->zsl
,*score
,ele
);
5025 incrRefCount(ele
); /* added to skiplist */
5028 addReplyDouble(c
,*score
);
5030 addReply(c
,shared
.cone
);
5035 /* case 2: Score update operation */
5036 de
= dictFind(zs
->dict
,ele
);
5037 redisAssert(de
!= NULL
);
5038 oldscore
= dictGetEntryVal(de
);
5039 if (*score
!= *oldscore
) {
5042 /* Remove and insert the element in the skip list with new score */
5043 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5044 redisAssert(deleted
!= 0);
5045 zslInsert(zs
->zsl
,*score
,ele
);
5047 /* Update the score in the hash table */
5048 dictReplace(zs
->dict
,ele
,score
);
5054 addReplyDouble(c
,*score
);
5056 addReply(c
,shared
.czero
);
5060 static void zaddCommand(redisClient
*c
) {
5063 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5064 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5067 static void zincrbyCommand(redisClient
*c
) {
5070 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5071 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5074 static void zremCommand(redisClient
*c
) {
5078 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5079 if (zsetobj
== NULL
) {
5080 addReply(c
,shared
.czero
);
5086 if (zsetobj
->type
!= REDIS_ZSET
) {
5087 addReply(c
,shared
.wrongtypeerr
);
5091 de
= dictFind(zs
->dict
,c
->argv
[2]);
5093 addReply(c
,shared
.czero
);
5096 /* Delete from the skiplist */
5097 oldscore
= dictGetEntryVal(de
);
5098 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5099 redisAssert(deleted
!= 0);
5101 /* Delete from the hash table */
5102 dictDelete(zs
->dict
,c
->argv
[2]);
5103 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5105 addReply(c
,shared
.cone
);
5109 static void zremrangebyscoreCommand(redisClient
*c
) {
5110 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5111 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5115 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5116 if (zsetobj
== NULL
) {
5117 addReply(c
,shared
.czero
);
5121 if (zsetobj
->type
!= REDIS_ZSET
) {
5122 addReply(c
,shared
.wrongtypeerr
);
5126 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5127 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5128 server
.dirty
+= deleted
;
5129 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5133 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5135 int start
= atoi(c
->argv
[2]->ptr
);
5136 int end
= atoi(c
->argv
[3]->ptr
);
5139 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5141 } else if (c
->argc
>= 5) {
5142 addReply(c
,shared
.syntaxerr
);
5146 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5148 addReply(c
,shared
.nullmultibulk
);
5150 if (o
->type
!= REDIS_ZSET
) {
5151 addReply(c
,shared
.wrongtypeerr
);
5153 zset
*zsetobj
= o
->ptr
;
5154 zskiplist
*zsl
= zsetobj
->zsl
;
5157 int llen
= zsl
->length
;
5161 /* convert negative indexes */
5162 if (start
< 0) start
= llen
+start
;
5163 if (end
< 0) end
= llen
+end
;
5164 if (start
< 0) start
= 0;
5165 if (end
< 0) end
= 0;
5167 /* indexes sanity checks */
5168 if (start
> end
|| start
>= llen
) {
5169 /* Out of range start or start > end result in empty list */
5170 addReply(c
,shared
.emptymultibulk
);
5173 if (end
>= llen
) end
= llen
-1;
5174 rangelen
= (end
-start
)+1;
5176 /* Return the result in form of a multi-bulk reply */
5182 ln
= zsl
->header
->forward
[0];
5184 ln
= ln
->forward
[0];
5187 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5188 withscores
? (rangelen
*2) : rangelen
));
5189 for (j
= 0; j
< rangelen
; j
++) {
5191 addReplyBulkLen(c
,ele
);
5193 addReply(c
,shared
.crlf
);
5195 addReplyDouble(c
,ln
->score
);
5196 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5202 static void zrangeCommand(redisClient
*c
) {
5203 zrangeGenericCommand(c
,0);
5206 static void zrevrangeCommand(redisClient
*c
) {
5207 zrangeGenericCommand(c
,1);
5210 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5211 * If justcount is non-zero, just the count is returned. */
5212 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5215 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5216 int offset
= 0, limit
= -1;
5220 /* Parse the min-max interval. If one of the values is prefixed
5221 * by the "(" character, it's considered "open". For instance
5222 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5223 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5224 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5225 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5228 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5230 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5231 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5234 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5237 /* Parse "WITHSCORES": note that if the command was called with
5238 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5239 * enter the following paths to parse WITHSCORES and LIMIT. */
5240 if (c
->argc
== 5 || c
->argc
== 8) {
5241 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5246 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5250 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5255 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5256 addReply(c
,shared
.syntaxerr
);
5258 } else if (c
->argc
== (7 + withscores
)) {
5259 offset
= atoi(c
->argv
[5]->ptr
);
5260 limit
= atoi(c
->argv
[6]->ptr
);
5261 if (offset
< 0) offset
= 0;
5264 /* Ok, lookup the key and get the range */
5265 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5267 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5269 if (o
->type
!= REDIS_ZSET
) {
5270 addReply(c
,shared
.wrongtypeerr
);
5272 zset
*zsetobj
= o
->ptr
;
5273 zskiplist
*zsl
= zsetobj
->zsl
;
5275 robj
*ele
, *lenobj
= NULL
;
5276 unsigned long rangelen
= 0;
5278 /* Get the first node with the score >= min, or with
5279 * score > min if 'minex' is true. */
5280 ln
= zslFirstWithScore(zsl
,min
);
5281 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5284 /* No element matching the speciifed interval */
5285 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5289 /* We don't know in advance how many matching elements there
5290 * are in the list, so we push this object that will represent
5291 * the multi-bulk length in the output buffer, and will "fix"
5294 lenobj
= createObject(REDIS_STRING
,NULL
);
5296 decrRefCount(lenobj
);
5299 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5302 ln
= ln
->forward
[0];
5305 if (limit
== 0) break;
5308 addReplyBulkLen(c
,ele
);
5310 addReply(c
,shared
.crlf
);
5312 addReplyDouble(c
,ln
->score
);
5314 ln
= ln
->forward
[0];
5316 if (limit
> 0) limit
--;
5319 addReplyLong(c
,(long)rangelen
);
5321 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5322 withscores
? (rangelen
*2) : rangelen
);
5328 static void zrangebyscoreCommand(redisClient
*c
) {
5329 genericZrangebyscoreCommand(c
,0);
5332 static void zcountCommand(redisClient
*c
) {
5333 genericZrangebyscoreCommand(c
,1);
5336 static void zcardCommand(redisClient
*c
) {
5340 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5342 addReply(c
,shared
.czero
);
5345 if (o
->type
!= REDIS_ZSET
) {
5346 addReply(c
,shared
.wrongtypeerr
);
5349 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5354 static void zscoreCommand(redisClient
*c
) {
5358 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5360 addReply(c
,shared
.nullbulk
);
5363 if (o
->type
!= REDIS_ZSET
) {
5364 addReply(c
,shared
.wrongtypeerr
);
5369 de
= dictFind(zs
->dict
,c
->argv
[2]);
5371 addReply(c
,shared
.nullbulk
);
5373 double *score
= dictGetEntryVal(de
);
5375 addReplyDouble(c
,*score
);
5381 /* ========================= Non type-specific commands ==================== */
5383 static void flushdbCommand(redisClient
*c
) {
5384 server
.dirty
+= dictSize(c
->db
->dict
);
5385 dictEmpty(c
->db
->dict
);
5386 dictEmpty(c
->db
->expires
);
5387 addReply(c
,shared
.ok
);
5390 static void flushallCommand(redisClient
*c
) {
5391 server
.dirty
+= emptyDb();
5392 addReply(c
,shared
.ok
);
5393 rdbSave(server
.dbfilename
);
5397 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5398 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5400 so
->pattern
= pattern
;
5404 /* Return the value associated to the key with a name obtained
5405 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5406 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5410 int prefixlen
, sublen
, postfixlen
;
5411 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5415 char buf
[REDIS_SORTKEY_MAX
+1];
5418 /* If the pattern is "#" return the substitution object itself in order
5419 * to implement the "SORT ... GET #" feature. */
5420 spat
= pattern
->ptr
;
5421 if (spat
[0] == '#' && spat
[1] == '\0') {
5425 /* The substitution object may be specially encoded. If so we create
5426 * a decoded object on the fly. Otherwise getDecodedObject will just
5427 * increment the ref count, that we'll decrement later. */
5428 subst
= getDecodedObject(subst
);
5431 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5432 p
= strchr(spat
,'*');
5434 decrRefCount(subst
);
5439 sublen
= sdslen(ssub
);
5440 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5441 memcpy(keyname
.buf
,spat
,prefixlen
);
5442 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5443 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5444 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5445 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5447 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5448 decrRefCount(subst
);
5450 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5451 return lookupKeyRead(db
,&keyobj
);
5454 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5455 * the additional parameter is not standard but a BSD-specific we have to
5456 * pass sorting parameters via the global 'server' structure */
5457 static int sortCompare(const void *s1
, const void *s2
) {
5458 const redisSortObject
*so1
= s1
, *so2
= s2
;
5461 if (!server
.sort_alpha
) {
5462 /* Numeric sorting. Here it's trivial as we precomputed scores */
5463 if (so1
->u
.score
> so2
->u
.score
) {
5465 } else if (so1
->u
.score
< so2
->u
.score
) {
5471 /* Alphanumeric sorting */
5472 if (server
.sort_bypattern
) {
5473 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5474 /* At least one compare object is NULL */
5475 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5477 else if (so1
->u
.cmpobj
== NULL
)
5482 /* We have both the objects, use strcoll */
5483 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5486 /* Compare elements directly */
5489 dec1
= getDecodedObject(so1
->obj
);
5490 dec2
= getDecodedObject(so2
->obj
);
5491 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5496 return server
.sort_desc
? -cmp
: cmp
;
5499 /* The SORT command is the most complex command in Redis. Warning: this code
5500 * is optimized for speed and a bit less for readability */
5501 static void sortCommand(redisClient
*c
) {
5504 int desc
= 0, alpha
= 0;
5505 int limit_start
= 0, limit_count
= -1, start
, end
;
5506 int j
, dontsort
= 0, vectorlen
;
5507 int getop
= 0; /* GET operation counter */
5508 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5509 redisSortObject
*vector
; /* Resulting vector to sort */
5511 /* Lookup the key to sort. It must be of the right types */
5512 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5513 if (sortval
== NULL
) {
5514 addReply(c
,shared
.nullmultibulk
);
5517 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5518 sortval
->type
!= REDIS_ZSET
)
5520 addReply(c
,shared
.wrongtypeerr
);
5524 /* Create a list of operations to perform for every sorted element.
5525 * Operations can be GET/DEL/INCR/DECR */
5526 operations
= listCreate();
5527 listSetFreeMethod(operations
,zfree
);
5530 /* Now we need to protect sortval incrementing its count, in the future
5531 * SORT may have options able to overwrite/delete keys during the sorting
5532 * and the sorted key itself may get destroied */
5533 incrRefCount(sortval
);
5535 /* The SORT command has an SQL-alike syntax, parse it */
5536 while(j
< c
->argc
) {
5537 int leftargs
= c
->argc
-j
-1;
5538 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5540 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5542 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5544 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5545 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5546 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5548 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5549 storekey
= c
->argv
[j
+1];
5551 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5552 sortby
= c
->argv
[j
+1];
5553 /* If the BY pattern does not contain '*', i.e. it is constant,
5554 * we don't need to sort nor to lookup the weight keys. */
5555 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5557 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5558 listAddNodeTail(operations
,createSortOperation(
5559 REDIS_SORT_GET
,c
->argv
[j
+1]));
5563 decrRefCount(sortval
);
5564 listRelease(operations
);
5565 addReply(c
,shared
.syntaxerr
);
5571 /* Load the sorting vector with all the objects to sort */
5572 switch(sortval
->type
) {
5573 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5574 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5575 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5576 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5578 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5581 if (sortval
->type
== REDIS_LIST
) {
5582 list
*list
= sortval
->ptr
;
5586 listRewind(list
,&li
);
5587 while((ln
= listNext(&li
))) {
5588 robj
*ele
= ln
->value
;
5589 vector
[j
].obj
= ele
;
5590 vector
[j
].u
.score
= 0;
5591 vector
[j
].u
.cmpobj
= NULL
;
5599 if (sortval
->type
== REDIS_SET
) {
5602 zset
*zs
= sortval
->ptr
;
5606 di
= dictGetIterator(set
);
5607 while((setele
= dictNext(di
)) != NULL
) {
5608 vector
[j
].obj
= dictGetEntryKey(setele
);
5609 vector
[j
].u
.score
= 0;
5610 vector
[j
].u
.cmpobj
= NULL
;
5613 dictReleaseIterator(di
);
5615 redisAssert(j
== vectorlen
);
5617 /* Now it's time to load the right scores in the sorting vector */
5618 if (dontsort
== 0) {
5619 for (j
= 0; j
< vectorlen
; j
++) {
5623 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5624 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5626 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5628 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5629 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5631 /* Don't need to decode the object if it's
5632 * integer-encoded (the only encoding supported) so
5633 * far. We can just cast it */
5634 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5635 vector
[j
].u
.score
= (long)byval
->ptr
;
5637 redisAssert(1 != 1);
5642 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5643 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5645 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5646 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5648 redisAssert(1 != 1);
5655 /* We are ready to sort the vector... perform a bit of sanity check
5656 * on the LIMIT option too. We'll use a partial version of quicksort. */
5657 start
= (limit_start
< 0) ? 0 : limit_start
;
5658 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5659 if (start
>= vectorlen
) {
5660 start
= vectorlen
-1;
5663 if (end
>= vectorlen
) end
= vectorlen
-1;
5665 if (dontsort
== 0) {
5666 server
.sort_desc
= desc
;
5667 server
.sort_alpha
= alpha
;
5668 server
.sort_bypattern
= sortby
? 1 : 0;
5669 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5670 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5672 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5675 /* Send command output to the output buffer, performing the specified
5676 * GET/DEL/INCR/DECR operations if any. */
5677 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5678 if (storekey
== NULL
) {
5679 /* STORE option not specified, sent the sorting result to client */
5680 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5681 for (j
= start
; j
<= end
; j
++) {
5686 addReplyBulkLen(c
,vector
[j
].obj
);
5687 addReply(c
,vector
[j
].obj
);
5688 addReply(c
,shared
.crlf
);
5690 listRewind(operations
,&li
);
5691 while((ln
= listNext(&li
))) {
5692 redisSortOperation
*sop
= ln
->value
;
5693 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5696 if (sop
->type
== REDIS_SORT_GET
) {
5697 if (!val
|| val
->type
!= REDIS_STRING
) {
5698 addReply(c
,shared
.nullbulk
);
5700 addReplyBulkLen(c
,val
);
5702 addReply(c
,shared
.crlf
);
5705 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5710 robj
*listObject
= createListObject();
5711 list
*listPtr
= (list
*) listObject
->ptr
;
5713 /* STORE option specified, set the sorting result as a List object */
5714 for (j
= start
; j
<= end
; j
++) {
5719 listAddNodeTail(listPtr
,vector
[j
].obj
);
5720 incrRefCount(vector
[j
].obj
);
5722 listRewind(operations
,&li
);
5723 while((ln
= listNext(&li
))) {
5724 redisSortOperation
*sop
= ln
->value
;
5725 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5728 if (sop
->type
== REDIS_SORT_GET
) {
5729 if (!val
|| val
->type
!= REDIS_STRING
) {
5730 listAddNodeTail(listPtr
,createStringObject("",0));
5732 listAddNodeTail(listPtr
,val
);
5736 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5740 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5741 incrRefCount(storekey
);
5743 /* Note: we add 1 because the DB is dirty anyway since even if the
5744 * SORT result is empty a new key is set and maybe the old content
5746 server
.dirty
+= 1+outputlen
;
5747 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5751 decrRefCount(sortval
);
5752 listRelease(operations
);
5753 for (j
= 0; j
< vectorlen
; j
++) {
5754 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5755 decrRefCount(vector
[j
].u
.cmpobj
);
5760 /* Convert an amount of bytes into a human readable string in the form
5761 * of 100B, 2G, 100M, 4K, and so forth. */
5762 static void bytesToHuman(char *s
, unsigned long long n
) {
5767 sprintf(s
,"%lluB",n
);
5769 } else if (n
< (1024*1024)) {
5770 d
= (double)n
/(1024);
5771 sprintf(s
,"%.2fK",d
);
5772 } else if (n
< (1024LL*1024*1024)) {
5773 d
= (double)n
/(1024*1024);
5774 sprintf(s
,"%.2fM",d
);
5775 } else if (n
< (1024LL*1024*1024*1024)) {
5776 d
= (double)n
/(1024LL*1024*1024);
5777 sprintf(s
,"%.2fG",d
);
5781 /* Create the string returned by the INFO command. This is decoupled
5782 * by the INFO command itself as we need to report the same information
5783 * on memory corruption problems. */
5784 static sds
genRedisInfoString(void) {
5786 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5790 bytesToHuman(hmem
,zmalloc_used_memory());
5791 info
= sdscatprintf(sdsempty(),
5792 "redis_version:%s\r\n"
5794 "multiplexing_api:%s\r\n"
5795 "process_id:%ld\r\n"
5796 "uptime_in_seconds:%ld\r\n"
5797 "uptime_in_days:%ld\r\n"
5798 "connected_clients:%d\r\n"
5799 "connected_slaves:%d\r\n"
5800 "blocked_clients:%d\r\n"
5801 "used_memory:%zu\r\n"
5802 "used_memory_human:%s\r\n"
5803 "changes_since_last_save:%lld\r\n"
5804 "bgsave_in_progress:%d\r\n"
5805 "last_save_time:%ld\r\n"
5806 "bgrewriteaof_in_progress:%d\r\n"
5807 "total_connections_received:%lld\r\n"
5808 "total_commands_processed:%lld\r\n"
5812 (sizeof(long) == 8) ? "64" : "32",
5817 listLength(server
.clients
)-listLength(server
.slaves
),
5818 listLength(server
.slaves
),
5819 server
.blpop_blocked_clients
,
5820 zmalloc_used_memory(),
5823 server
.bgsavechildpid
!= -1,
5825 server
.bgrewritechildpid
!= -1,
5826 server
.stat_numconnections
,
5827 server
.stat_numcommands
,
5828 server
.vm_enabled
!= 0,
5829 server
.masterhost
== NULL
? "master" : "slave"
5831 if (server
.masterhost
) {
5832 info
= sdscatprintf(info
,
5833 "master_host:%s\r\n"
5834 "master_port:%d\r\n"
5835 "master_link_status:%s\r\n"
5836 "master_last_io_seconds_ago:%d\r\n"
5839 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5841 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5844 if (server
.vm_enabled
) {
5846 info
= sdscatprintf(info
,
5847 "vm_conf_max_memory:%llu\r\n"
5848 "vm_conf_page_size:%llu\r\n"
5849 "vm_conf_pages:%llu\r\n"
5850 "vm_stats_used_pages:%llu\r\n"
5851 "vm_stats_swapped_objects:%llu\r\n"
5852 "vm_stats_swappin_count:%llu\r\n"
5853 "vm_stats_swappout_count:%llu\r\n"
5854 "vm_stats_io_newjobs_len:%lu\r\n"
5855 "vm_stats_io_processing_len:%lu\r\n"
5856 "vm_stats_io_processed_len:%lu\r\n"
5857 "vm_stats_io_active_threads:%lu\r\n"
5858 "vm_stats_blocked_clients:%lu\r\n"
5859 ,(unsigned long long) server
.vm_max_memory
,
5860 (unsigned long long) server
.vm_page_size
,
5861 (unsigned long long) server
.vm_pages
,
5862 (unsigned long long) server
.vm_stats_used_pages
,
5863 (unsigned long long) server
.vm_stats_swapped_objects
,
5864 (unsigned long long) server
.vm_stats_swapins
,
5865 (unsigned long long) server
.vm_stats_swapouts
,
5866 (unsigned long) listLength(server
.io_newjobs
),
5867 (unsigned long) listLength(server
.io_processing
),
5868 (unsigned long) listLength(server
.io_processed
),
5869 (unsigned long) server
.io_active_threads
,
5870 (unsigned long) server
.vm_blocked_clients
5874 for (j
= 0; j
< server
.dbnum
; j
++) {
5875 long long keys
, vkeys
;
5877 keys
= dictSize(server
.db
[j
].dict
);
5878 vkeys
= dictSize(server
.db
[j
].expires
);
5879 if (keys
|| vkeys
) {
5880 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5887 static void infoCommand(redisClient
*c
) {
5888 sds info
= genRedisInfoString();
5889 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5890 (unsigned long)sdslen(info
)));
5891 addReplySds(c
,info
);
5892 addReply(c
,shared
.crlf
);
5895 static void monitorCommand(redisClient
*c
) {
5896 /* ignore MONITOR if aleady slave or in monitor mode */
5897 if (c
->flags
& REDIS_SLAVE
) return;
5899 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5901 listAddNodeTail(server
.monitors
,c
);
5902 addReply(c
,shared
.ok
);
5905 /* ================================= Expire ================================= */
5906 static int removeExpire(redisDb
*db
, robj
*key
) {
5907 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5914 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5915 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5923 /* Return the expire time of the specified key, or -1 if no expire
5924 * is associated with this key (i.e. the key is non volatile) */
5925 static time_t getExpire(redisDb
*db
, robj
*key
) {
5928 /* No expire? return ASAP */
5929 if (dictSize(db
->expires
) == 0 ||
5930 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5932 return (time_t) dictGetEntryVal(de
);
5935 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5939 /* No expire? return ASAP */
5940 if (dictSize(db
->expires
) == 0 ||
5941 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5943 /* Lookup the expire */
5944 when
= (time_t) dictGetEntryVal(de
);
5945 if (time(NULL
) <= when
) return 0;
5947 /* Delete the key */
5948 dictDelete(db
->expires
,key
);
5949 return dictDelete(db
->dict
,key
) == DICT_OK
;
5952 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5955 /* No expire? return ASAP */
5956 if (dictSize(db
->expires
) == 0 ||
5957 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5959 /* Delete the key */
5961 dictDelete(db
->expires
,key
);
5962 return dictDelete(db
->dict
,key
) == DICT_OK
;
5965 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5968 de
= dictFind(c
->db
->dict
,key
);
5970 addReply(c
,shared
.czero
);
5974 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5975 addReply(c
, shared
.cone
);
5978 time_t when
= time(NULL
)+seconds
;
5979 if (setExpire(c
->db
,key
,when
)) {
5980 addReply(c
,shared
.cone
);
5983 addReply(c
,shared
.czero
);
5989 static void expireCommand(redisClient
*c
) {
5990 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5993 static void expireatCommand(redisClient
*c
) {
5994 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5997 static void ttlCommand(redisClient
*c
) {
6001 expire
= getExpire(c
->db
,c
->argv
[1]);
6003 ttl
= (int) (expire
-time(NULL
));
6004 if (ttl
< 0) ttl
= -1;
6006 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6009 /* ================================ MULTI/EXEC ============================== */
6011 /* Client state initialization for MULTI/EXEC */
6012 static void initClientMultiState(redisClient
*c
) {
6013 c
->mstate
.commands
= NULL
;
6014 c
->mstate
.count
= 0;
6017 /* Release all the resources associated with MULTI/EXEC state */
6018 static void freeClientMultiState(redisClient
*c
) {
6021 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6023 multiCmd
*mc
= c
->mstate
.commands
+j
;
6025 for (i
= 0; i
< mc
->argc
; i
++)
6026 decrRefCount(mc
->argv
[i
]);
6029 zfree(c
->mstate
.commands
);
6032 /* Add a new command into the MULTI commands queue */
6033 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6037 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6038 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6039 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6042 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6043 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6044 for (j
= 0; j
< c
->argc
; j
++)
6045 incrRefCount(mc
->argv
[j
]);
6049 static void multiCommand(redisClient
*c
) {
6050 c
->flags
|= REDIS_MULTI
;
6051 addReply(c
,shared
.ok
);
6054 static void execCommand(redisClient
*c
) {
6059 if (!(c
->flags
& REDIS_MULTI
)) {
6060 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6064 orig_argv
= c
->argv
;
6065 orig_argc
= c
->argc
;
6066 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6067 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6068 c
->argc
= c
->mstate
.commands
[j
].argc
;
6069 c
->argv
= c
->mstate
.commands
[j
].argv
;
6070 call(c
,c
->mstate
.commands
[j
].cmd
);
6072 c
->argv
= orig_argv
;
6073 c
->argc
= orig_argc
;
6074 freeClientMultiState(c
);
6075 initClientMultiState(c
);
6076 c
->flags
&= (~REDIS_MULTI
);
6079 /* =========================== Blocking Operations ========================= */
6081 /* Currently Redis blocking operations support is limited to list POP ops,
6082 * so the current implementation is not fully generic, but it is also not
6083 * completely specific so it will not require a rewrite to support new
6084 * kind of blocking operations in the future.
6086 * Still it's important to note that list blocking operations can be already
6087 * used as a notification mechanism in order to implement other blocking
6088 * operations at application level, so there must be a very strong evidence
6089 * of usefulness and generality before new blocking operations are implemented.
6091 * This is how the current blocking POP works, we use BLPOP as example:
6092 * - If the user calls BLPOP and the key exists and contains a non empty list
6093 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6094 * if there is not to block.
6095 * - If instead BLPOP is called and the key does not exists or the list is
6096 * empty we need to block. In order to do so we remove the notification for
6097 * new data to read in the client socket (so that we'll not serve new
6098 * requests if the blocking request is not served). Also we put the client
6099 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6100 * blocking for this keys.
6101 * - If a PUSH operation against a key with blocked clients waiting is
6102 * performed, we serve the first in the list: basically instead to push
6103 * the new element inside the list we return it to the (first / oldest)
6104 * blocking client, unblock the client, and remove it form the list.
6106 * The above comment and the source code should be enough in order to understand
6107 * the implementation and modify / fix it later.
6110 /* Set a client in blocking mode for the specified key, with the specified
6112 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6117 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6118 c
->blockingkeysnum
= numkeys
;
6119 c
->blockingto
= timeout
;
6120 for (j
= 0; j
< numkeys
; j
++) {
6121 /* Add the key in the client structure, to map clients -> keys */
6122 c
->blockingkeys
[j
] = keys
[j
];
6123 incrRefCount(keys
[j
]);
6125 /* And in the other "side", to map keys -> clients */
6126 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6130 /* For every key we take a list of clients blocked for it */
6132 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6133 incrRefCount(keys
[j
]);
6134 assert(retval
== DICT_OK
);
6136 l
= dictGetEntryVal(de
);
6138 listAddNodeTail(l
,c
);
6140 /* Mark the client as a blocked client */
6141 c
->flags
|= REDIS_BLOCKED
;
6142 server
.blpop_blocked_clients
++;
6145 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6146 static void unblockClientWaitingData(redisClient
*c
) {
6151 assert(c
->blockingkeys
!= NULL
);
6152 /* The client may wait for multiple keys, so unblock it for every key. */
6153 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6154 /* Remove this client from the list of clients waiting for this key. */
6155 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6157 l
= dictGetEntryVal(de
);
6158 listDelNode(l
,listSearchKey(l
,c
));
6159 /* If the list is empty we need to remove it to avoid wasting memory */
6160 if (listLength(l
) == 0)
6161 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6162 decrRefCount(c
->blockingkeys
[j
]);
6164 /* Cleanup the client structure */
6165 zfree(c
->blockingkeys
);
6166 c
->blockingkeys
= NULL
;
6167 c
->flags
&= (~REDIS_BLOCKED
);
6168 server
.blpop_blocked_clients
--;
6169 /* We want to process data if there is some command waiting
6170 * in the input buffer. Note that this is safe even if
6171 * unblockClientWaitingData() gets called from freeClient() because
6172 * freeClient() will be smart enough to call this function
6173 * *after* c->querybuf was set to NULL. */
6174 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6177 /* This should be called from any function PUSHing into lists.
6178 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6179 * 'ele' is the element pushed.
6181 * If the function returns 0 there was no client waiting for a list push
6184 * If the function returns 1 there was a client waiting for a list push
6185 * against this key, the element was passed to this client thus it's not
6186 * needed to actually add it to the list and the caller should return asap. */
6187 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6188 struct dictEntry
*de
;
6189 redisClient
*receiver
;
6193 de
= dictFind(c
->db
->blockingkeys
,key
);
6194 if (de
== NULL
) return 0;
6195 l
= dictGetEntryVal(de
);
6198 receiver
= ln
->value
;
6200 addReplySds(receiver
,sdsnew("*2\r\n"));
6201 addReplyBulkLen(receiver
,key
);
6202 addReply(receiver
,key
);
6203 addReply(receiver
,shared
.crlf
);
6204 addReplyBulkLen(receiver
,ele
);
6205 addReply(receiver
,ele
);
6206 addReply(receiver
,shared
.crlf
);
6207 unblockClientWaitingData(receiver
);
6211 /* Blocking RPOP/LPOP */
6212 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6217 for (j
= 1; j
< c
->argc
-1; j
++) {
6218 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6220 if (o
->type
!= REDIS_LIST
) {
6221 addReply(c
,shared
.wrongtypeerr
);
6224 list
*list
= o
->ptr
;
6225 if (listLength(list
) != 0) {
6226 /* If the list contains elements fall back to the usual
6227 * non-blocking POP operation */
6228 robj
*argv
[2], **orig_argv
;
6231 /* We need to alter the command arguments before to call
6232 * popGenericCommand() as the command takes a single key. */
6233 orig_argv
= c
->argv
;
6234 orig_argc
= c
->argc
;
6235 argv
[1] = c
->argv
[j
];
6239 /* Also the return value is different, we need to output
6240 * the multi bulk reply header and the key name. The
6241 * "real" command will add the last element (the value)
6242 * for us. If this souds like an hack to you it's just
6243 * because it is... */
6244 addReplySds(c
,sdsnew("*2\r\n"));
6245 addReplyBulkLen(c
,argv
[1]);
6246 addReply(c
,argv
[1]);
6247 addReply(c
,shared
.crlf
);
6248 popGenericCommand(c
,where
);
6250 /* Fix the client structure with the original stuff */
6251 c
->argv
= orig_argv
;
6252 c
->argc
= orig_argc
;
6258 /* If the list is empty or the key does not exists we must block */
6259 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6260 if (timeout
> 0) timeout
+= time(NULL
);
6261 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6264 static void blpopCommand(redisClient
*c
) {
6265 blockingPopGenericCommand(c
,REDIS_HEAD
);
6268 static void brpopCommand(redisClient
*c
) {
6269 blockingPopGenericCommand(c
,REDIS_TAIL
);
6272 /* =============================== Replication ============================= */
6274 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6275 ssize_t nwritten
, ret
= size
;
6276 time_t start
= time(NULL
);
6280 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6281 nwritten
= write(fd
,ptr
,size
);
6282 if (nwritten
== -1) return -1;
6286 if ((time(NULL
)-start
) > timeout
) {
6294 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6295 ssize_t nread
, totread
= 0;
6296 time_t start
= time(NULL
);
6300 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6301 nread
= read(fd
,ptr
,size
);
6302 if (nread
== -1) return -1;
6307 if ((time(NULL
)-start
) > timeout
) {
6315 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6322 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6325 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6336 static void syncCommand(redisClient
*c
) {
6337 /* ignore SYNC if aleady slave or in monitor mode */
6338 if (c
->flags
& REDIS_SLAVE
) return;
6340 /* SYNC can't be issued when the server has pending data to send to
6341 * the client about already issued commands. We need a fresh reply
6342 * buffer registering the differences between the BGSAVE and the current
6343 * dataset, so that we can copy to other slaves if needed. */
6344 if (listLength(c
->reply
) != 0) {
6345 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6349 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6350 /* Here we need to check if there is a background saving operation
6351 * in progress, or if it is required to start one */
6352 if (server
.bgsavechildpid
!= -1) {
6353 /* Ok a background save is in progress. Let's check if it is a good
6354 * one for replication, i.e. if there is another slave that is
6355 * registering differences since the server forked to save */
6360 listRewind(server
.slaves
,&li
);
6361 while((ln
= listNext(&li
))) {
6363 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6366 /* Perfect, the server is already registering differences for
6367 * another slave. Set the right state, and copy the buffer. */
6368 listRelease(c
->reply
);
6369 c
->reply
= listDup(slave
->reply
);
6370 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6371 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6373 /* No way, we need to wait for the next BGSAVE in order to
6374 * register differences */
6375 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6376 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6379 /* Ok we don't have a BGSAVE in progress, let's start one */
6380 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6381 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6382 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6383 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6386 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6389 c
->flags
|= REDIS_SLAVE
;
6391 listAddNodeTail(server
.slaves
,c
);
6395 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6396 redisClient
*slave
= privdata
;
6398 REDIS_NOTUSED(mask
);
6399 char buf
[REDIS_IOBUF_LEN
];
6400 ssize_t nwritten
, buflen
;
6402 if (slave
->repldboff
== 0) {
6403 /* Write the bulk write count before to transfer the DB. In theory here
6404 * we don't know how much room there is in the output buffer of the
6405 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6406 * operations) will never be smaller than the few bytes we need. */
6409 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6411 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6419 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6420 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6422 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6423 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6427 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6428 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6433 slave
->repldboff
+= nwritten
;
6434 if (slave
->repldboff
== slave
->repldbsize
) {
6435 close(slave
->repldbfd
);
6436 slave
->repldbfd
= -1;
6437 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6438 slave
->replstate
= REDIS_REPL_ONLINE
;
6439 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6440 sendReplyToClient
, slave
) == AE_ERR
) {
6444 addReplySds(slave
,sdsempty());
6445 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6449 /* This function is called at the end of every backgrond saving.
6450 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6451 * otherwise REDIS_ERR is passed to the function.
6453 * The goal of this function is to handle slaves waiting for a successful
6454 * background saving in order to perform non-blocking synchronization. */
6455 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6457 int startbgsave
= 0;
6460 listRewind(server
.slaves
,&li
);
6461 while((ln
= listNext(&li
))) {
6462 redisClient
*slave
= ln
->value
;
6464 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6466 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6467 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6468 struct redis_stat buf
;
6470 if (bgsaveerr
!= REDIS_OK
) {
6472 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6475 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6476 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6478 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6481 slave
->repldboff
= 0;
6482 slave
->repldbsize
= buf
.st_size
;
6483 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6484 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6485 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6492 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6495 listRewind(server
.slaves
,&li
);
6496 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6497 while((ln
= listNext(&li
))) {
6498 redisClient
*slave
= ln
->value
;
6500 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6507 static int syncWithMaster(void) {
6508 char buf
[1024], tmpfile
[256], authcmd
[1024];
6510 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6514 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6519 /* AUTH with the master if required. */
6520 if(server
.masterauth
) {
6521 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6522 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6524 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6528 /* Read the AUTH result. */
6529 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6531 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6535 if (buf
[0] != '+') {
6537 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6542 /* Issue the SYNC command */
6543 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6545 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6549 /* Read the bulk write count */
6550 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6552 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6556 if (buf
[0] != '$') {
6558 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6561 dumpsize
= atoi(buf
+1);
6562 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6563 /* Read the bulk write data on a temp file */
6564 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6565 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6568 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6572 int nread
, nwritten
;
6574 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6576 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6582 nwritten
= write(dfd
,buf
,nread
);
6583 if (nwritten
== -1) {
6584 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6592 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6593 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6599 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6600 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6604 server
.master
= createClient(fd
);
6605 server
.master
->flags
|= REDIS_MASTER
;
6606 server
.master
->authenticated
= 1;
6607 server
.replstate
= REDIS_REPL_CONNECTED
;
6611 static void slaveofCommand(redisClient
*c
) {
6612 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6613 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6614 if (server
.masterhost
) {
6615 sdsfree(server
.masterhost
);
6616 server
.masterhost
= NULL
;
6617 if (server
.master
) freeClient(server
.master
);
6618 server
.replstate
= REDIS_REPL_NONE
;
6619 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6622 sdsfree(server
.masterhost
);
6623 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6624 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6625 if (server
.master
) freeClient(server
.master
);
6626 server
.replstate
= REDIS_REPL_CONNECT
;
6627 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6628 server
.masterhost
, server
.masterport
);
6630 addReply(c
,shared
.ok
);
6633 /* ============================ Maxmemory directive ======================== */
6635 /* Try to free one object form the pre-allocated objects free list.
6636 * This is useful under low mem conditions as by default we take 1 million
6637 * free objects allocated. On success REDIS_OK is returned, otherwise
6639 static int tryFreeOneObjectFromFreelist(void) {
6642 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6643 if (listLength(server
.objfreelist
)) {
6644 listNode
*head
= listFirst(server
.objfreelist
);
6645 o
= listNodeValue(head
);
6646 listDelNode(server
.objfreelist
,head
);
6647 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6651 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6656 /* This function gets called when 'maxmemory' is set on the config file to limit
6657 * the max memory used by the server, and we are out of memory.
6658 * This function will try to, in order:
6660 * - Free objects from the free list
6661 * - Try to remove keys with an EXPIRE set
6663 * It is not possible to free enough memory to reach used-memory < maxmemory
6664 * the server will start refusing commands that will enlarge even more the
6667 static void freeMemoryIfNeeded(void) {
6668 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6669 int j
, k
, freed
= 0;
6671 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6672 for (j
= 0; j
< server
.dbnum
; j
++) {
6674 robj
*minkey
= NULL
;
6675 struct dictEntry
*de
;
6677 if (dictSize(server
.db
[j
].expires
)) {
6679 /* From a sample of three keys drop the one nearest to
6680 * the natural expire */
6681 for (k
= 0; k
< 3; k
++) {
6684 de
= dictGetRandomKey(server
.db
[j
].expires
);
6685 t
= (time_t) dictGetEntryVal(de
);
6686 if (minttl
== -1 || t
< minttl
) {
6687 minkey
= dictGetEntryKey(de
);
6691 deleteKey(server
.db
+j
,minkey
);
6694 if (!freed
) return; /* nothing to free... */
6698 /* ============================== Append Only file ========================== */
6700 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6701 sds buf
= sdsempty();
6707 /* The DB this command was targetting is not the same as the last command
6708 * we appendend. To issue a SELECT command is needed. */
6709 if (dictid
!= server
.appendseldb
) {
6712 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6713 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6714 (unsigned long)strlen(seldb
),seldb
);
6715 server
.appendseldb
= dictid
;
6718 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6719 * EXPIREs into EXPIREATs calls */
6720 if (cmd
->proc
== expireCommand
) {
6723 tmpargv
[0] = createStringObject("EXPIREAT",8);
6724 tmpargv
[1] = argv
[1];
6725 incrRefCount(argv
[1]);
6726 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6727 tmpargv
[2] = createObject(REDIS_STRING
,
6728 sdscatprintf(sdsempty(),"%ld",when
));
6732 /* Append the actual command */
6733 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6734 for (j
= 0; j
< argc
; j
++) {
6737 o
= getDecodedObject(o
);
6738 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6739 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6740 buf
= sdscatlen(buf
,"\r\n",2);
6744 /* Free the objects from the modified argv for EXPIREAT */
6745 if (cmd
->proc
== expireCommand
) {
6746 for (j
= 0; j
< 3; j
++)
6747 decrRefCount(argv
[j
]);
6750 /* We want to perform a single write. This should be guaranteed atomic
6751 * at least if the filesystem we are writing is a real physical one.
6752 * While this will save us against the server being killed I don't think
6753 * there is much to do about the whole server stopping for power problems
6755 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6756 if (nwritten
!= (signed)sdslen(buf
)) {
6757 /* Ooops, we are in troubles. The best thing to do for now is
6758 * to simply exit instead to give the illusion that everything is
6759 * working as expected. */
6760 if (nwritten
== -1) {
6761 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6763 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6767 /* If a background append only file rewriting is in progress we want to
6768 * accumulate the differences between the child DB and the current one
6769 * in a buffer, so that when the child process will do its work we
6770 * can append the differences to the new append only file. */
6771 if (server
.bgrewritechildpid
!= -1)
6772 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6776 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6777 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6778 now
-server
.lastfsync
> 1))
6780 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6781 server
.lastfsync
= now
;
6785 /* In Redis commands are always executed in the context of a client, so in
6786 * order to load the append only file we need to create a fake client. */
6787 static struct redisClient
*createFakeClient(void) {
6788 struct redisClient
*c
= zmalloc(sizeof(*c
));
6792 c
->querybuf
= sdsempty();
6796 /* We set the fake client as a slave waiting for the synchronization
6797 * so that Redis will not try to send replies to this client. */
6798 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6799 c
->reply
= listCreate();
6800 listSetFreeMethod(c
->reply
,decrRefCount
);
6801 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6805 static void freeFakeClient(struct redisClient
*c
) {
6806 sdsfree(c
->querybuf
);
6807 listRelease(c
->reply
);
6811 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6812 * error (the append only file is zero-length) REDIS_ERR is returned. On
6813 * fatal error an error message is logged and the program exists. */
6814 int loadAppendOnlyFile(char *filename
) {
6815 struct redisClient
*fakeClient
;
6816 FILE *fp
= fopen(filename
,"r");
6817 struct redis_stat sb
;
6818 unsigned long long loadedkeys
= 0;
6820 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6824 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6828 fakeClient
= createFakeClient();
6835 struct redisCommand
*cmd
;
6837 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6843 if (buf
[0] != '*') goto fmterr
;
6845 argv
= zmalloc(sizeof(robj
*)*argc
);
6846 for (j
= 0; j
< argc
; j
++) {
6847 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6848 if (buf
[0] != '$') goto fmterr
;
6849 len
= strtol(buf
+1,NULL
,10);
6850 argsds
= sdsnewlen(NULL
,len
);
6851 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6852 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6853 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6856 /* Command lookup */
6857 cmd
= lookupCommand(argv
[0]->ptr
);
6859 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6862 /* Try object sharing and encoding */
6863 if (server
.shareobjects
) {
6865 for(j
= 1; j
< argc
; j
++)
6866 argv
[j
] = tryObjectSharing(argv
[j
]);
6868 if (cmd
->flags
& REDIS_CMD_BULK
)
6869 tryObjectEncoding(argv
[argc
-1]);
6870 /* Run the command in the context of a fake client */
6871 fakeClient
->argc
= argc
;
6872 fakeClient
->argv
= argv
;
6873 cmd
->proc(fakeClient
);
6874 /* Discard the reply objects list from the fake client */
6875 while(listLength(fakeClient
->reply
))
6876 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6877 /* Clean up, ready for the next command */
6878 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6880 /* Handle swapping while loading big datasets when VM is on */
6882 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6883 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6884 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6889 freeFakeClient(fakeClient
);
6894 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6896 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6900 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6904 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6905 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6909 /* Avoid the incr/decr ref count business if possible to help
6910 * copy-on-write (we are often in a child process when this function
6912 * Also makes sure that key objects don't get incrRefCount-ed when VM
6914 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6915 obj
= getDecodedObject(obj
);
6918 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6919 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6920 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6922 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6923 if (decrrc
) decrRefCount(obj
);
6926 if (decrrc
) decrRefCount(obj
);
6930 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6931 static int fwriteBulkDouble(FILE *fp
, double d
) {
6932 char buf
[128], dbuf
[128];
6934 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6935 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6936 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6937 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6941 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6942 static int fwriteBulkLong(FILE *fp
, long l
) {
6943 char buf
[128], lbuf
[128];
6945 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6946 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6947 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6948 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6952 /* Write a sequence of commands able to fully rebuild the dataset into
6953 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6954 static int rewriteAppendOnlyFile(char *filename
) {
6955 dictIterator
*di
= NULL
;
6960 time_t now
= time(NULL
);
6962 /* Note that we have to use a different temp name here compared to the
6963 * one used by rewriteAppendOnlyFileBackground() function. */
6964 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6965 fp
= fopen(tmpfile
,"w");
6967 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6970 for (j
= 0; j
< server
.dbnum
; j
++) {
6971 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6972 redisDb
*db
= server
.db
+j
;
6974 if (dictSize(d
) == 0) continue;
6975 di
= dictGetIterator(d
);
6981 /* SELECT the new DB */
6982 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6983 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6985 /* Iterate this DB writing every entry */
6986 while((de
= dictNext(di
)) != NULL
) {
6991 key
= dictGetEntryKey(de
);
6992 /* If the value for this key is swapped, load a preview in memory.
6993 * We use a "swapped" flag to remember if we need to free the
6994 * value object instead to just increment the ref count anyway
6995 * in order to avoid copy-on-write of pages if we are forked() */
6996 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6997 key
->storage
== REDIS_VM_SWAPPING
) {
6998 o
= dictGetEntryVal(de
);
7001 o
= vmPreviewObject(key
);
7004 expiretime
= getExpire(db
,key
);
7006 /* Save the key and associated value */
7007 if (o
->type
== REDIS_STRING
) {
7008 /* Emit a SET command */
7009 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7010 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7012 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7013 if (fwriteBulk(fp
,o
) == 0) goto werr
;
7014 } else if (o
->type
== REDIS_LIST
) {
7015 /* Emit the RPUSHes needed to rebuild the list */
7016 list
*list
= o
->ptr
;
7020 listRewind(list
,&li
);
7021 while((ln
= listNext(&li
))) {
7022 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7023 robj
*eleobj
= listNodeValue(ln
);
7025 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7026 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7027 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7029 } else if (o
->type
== REDIS_SET
) {
7030 /* Emit the SADDs needed to rebuild the set */
7032 dictIterator
*di
= dictGetIterator(set
);
7035 while((de
= dictNext(di
)) != NULL
) {
7036 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7037 robj
*eleobj
= dictGetEntryKey(de
);
7039 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7040 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7041 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7043 dictReleaseIterator(di
);
7044 } else if (o
->type
== REDIS_ZSET
) {
7045 /* Emit the ZADDs needed to rebuild the sorted set */
7047 dictIterator
*di
= dictGetIterator(zs
->dict
);
7050 while((de
= dictNext(di
)) != NULL
) {
7051 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7052 robj
*eleobj
= dictGetEntryKey(de
);
7053 double *score
= dictGetEntryVal(de
);
7055 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7056 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7057 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7058 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7060 dictReleaseIterator(di
);
7062 redisAssert(0 != 0);
7064 /* Save the expire time */
7065 if (expiretime
!= -1) {
7066 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7067 /* If this key is already expired skip it */
7068 if (expiretime
< now
) continue;
7069 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7070 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7071 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7073 if (swapped
) decrRefCount(o
);
7075 dictReleaseIterator(di
);
7078 /* Make sure data will not remain on the OS's output buffers */
7083 /* Use RENAME to make sure the DB file is changed atomically only
7084 * if the generate DB file is ok. */
7085 if (rename(tmpfile
,filename
) == -1) {
7086 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7090 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7096 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7097 if (di
) dictReleaseIterator(di
);
7101 /* This is how rewriting of the append only file in background works:
7103 * 1) The user calls BGREWRITEAOF
7104 * 2) Redis calls this function, that forks():
7105 * 2a) the child rewrite the append only file in a temp file.
7106 * 2b) the parent accumulates differences in server.bgrewritebuf.
7107 * 3) When the child finished '2a' exists.
7108 * 4) The parent will trap the exit code, if it's OK, will append the
7109 * data accumulated into server.bgrewritebuf into the temp file, and
7110 * finally will rename(2) the temp file in the actual file name.
7111 * The the new file is reopened as the new append only file. Profit!
7113 static int rewriteAppendOnlyFileBackground(void) {
7116 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7117 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7118 if ((childpid
= fork()) == 0) {
7122 if (server
.vm_enabled
) vmReopenSwapFile();
7124 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7125 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7132 if (childpid
== -1) {
7133 redisLog(REDIS_WARNING
,
7134 "Can't rewrite append only file in background: fork: %s",
7138 redisLog(REDIS_NOTICE
,
7139 "Background append only file rewriting started by pid %d",childpid
);
7140 server
.bgrewritechildpid
= childpid
;
7141 /* We set appendseldb to -1 in order to force the next call to the
7142 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7143 * accumulated by the parent into server.bgrewritebuf will start
7144 * with a SELECT statement and it will be safe to merge. */
7145 server
.appendseldb
= -1;
7148 return REDIS_OK
; /* unreached */
7151 static void bgrewriteaofCommand(redisClient
*c
) {
7152 if (server
.bgrewritechildpid
!= -1) {
7153 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7156 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7157 char *status
= "+Background append only file rewriting started\r\n";
7158 addReplySds(c
,sdsnew(status
));
7160 addReply(c
,shared
.err
);
7164 static void aofRemoveTempFile(pid_t childpid
) {
7167 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7171 /* Virtual Memory is composed mainly of two subsystems:
7172 * - Blocking Virutal Memory
7173 * - Threaded Virtual Memory I/O
7174 * The two parts are not fully decoupled, but functions are split among two
7175 * different sections of the source code (delimited by comments) in order to
7176 * make more clear what functionality is about the blocking VM and what about
7177 * the threaded (not blocking) VM.
7181 * Redis VM is a blocking VM (one that blocks reading swapped values from
7182 * disk into memory when a value swapped out is needed in memory) that is made
7183 * unblocking by trying to examine the command argument vector in order to
7184 * load in background values that will likely be needed in order to exec
7185 * the command. The command is executed only once all the relevant keys
7186 * are loaded into memory.
7188 * This basically is almost as simple of a blocking VM, but almost as parallel
7189 * as a fully non-blocking VM.
7192 /* =================== Virtual Memory - Blocking Side ====================== */
7194 /* substitute the first occurrence of '%p' with the process pid in the
7195 * swap file name. */
7196 static void expandVmSwapFilename(void) {
7197 char *p
= strstr(server
.vm_swap_file
,"%p");
7203 new = sdscat(new,server
.vm_swap_file
);
7204 new = sdscatprintf(new,"%ld",(long) getpid());
7205 new = sdscat(new,p
+2);
7206 zfree(server
.vm_swap_file
);
7207 server
.vm_swap_file
= new;
7210 static void vmInit(void) {
7215 if (server
.vm_max_threads
!= 0)
7216 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7218 expandVmSwapFilename();
7219 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7220 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7221 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7223 if (server
.vm_fp
== NULL
) {
7224 redisLog(REDIS_WARNING
,
7225 "Impossible to open the swap file: %s. Exiting.",
7229 server
.vm_fd
= fileno(server
.vm_fp
);
7230 server
.vm_next_page
= 0;
7231 server
.vm_near_pages
= 0;
7232 server
.vm_stats_used_pages
= 0;
7233 server
.vm_stats_swapped_objects
= 0;
7234 server
.vm_stats_swapouts
= 0;
7235 server
.vm_stats_swapins
= 0;
7236 totsize
= server
.vm_pages
*server
.vm_page_size
;
7237 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7238 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7239 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7243 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7245 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7246 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7247 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7248 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7250 /* Initialize threaded I/O (used by Virtual Memory) */
7251 server
.io_newjobs
= listCreate();
7252 server
.io_processing
= listCreate();
7253 server
.io_processed
= listCreate();
7254 server
.io_ready_clients
= listCreate();
7255 pthread_mutex_init(&server
.io_mutex
,NULL
);
7256 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7257 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7258 server
.io_active_threads
= 0;
7259 if (pipe(pipefds
) == -1) {
7260 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7264 server
.io_ready_pipe_read
= pipefds
[0];
7265 server
.io_ready_pipe_write
= pipefds
[1];
7266 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7267 /* LZF requires a lot of stack */
7268 pthread_attr_init(&server
.io_threads_attr
);
7269 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7270 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7271 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7272 /* Listen for events in the threaded I/O pipe */
7273 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7274 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7275 oom("creating file event");
7278 /* Mark the page as used */
7279 static void vmMarkPageUsed(off_t page
) {
7280 off_t byte
= page
/8;
7282 redisAssert(vmFreePage(page
) == 1);
7283 server
.vm_bitmap
[byte
] |= 1<<bit
;
7286 /* Mark N contiguous pages as used, with 'page' being the first. */
7287 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7290 for (j
= 0; j
< count
; j
++)
7291 vmMarkPageUsed(page
+j
);
7292 server
.vm_stats_used_pages
+= count
;
7293 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
7294 (long long)count
, (long long)page
);
7297 /* Mark the page as free */
7298 static void vmMarkPageFree(off_t page
) {
7299 off_t byte
= page
/8;
7301 redisAssert(vmFreePage(page
) == 0);
7302 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7305 /* Mark N contiguous pages as free, with 'page' being the first. */
7306 static void vmMarkPagesFree(off_t page
, off_t count
) {
7309 for (j
= 0; j
< count
; j
++)
7310 vmMarkPageFree(page
+j
);
7311 server
.vm_stats_used_pages
-= count
;
7312 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
7313 (long long)count
, (long long)page
);
7316 /* Test if the page is free */
7317 static int vmFreePage(off_t page
) {
7318 off_t byte
= page
/8;
7320 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7323 /* Find N contiguous free pages storing the first page of the cluster in *first.
7324 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7325 * REDIS_ERR is returned.
7327 * This function uses a simple algorithm: we try to allocate
7328 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7329 * again from the start of the swap file searching for free spaces.
7331 * If it looks pretty clear that there are no free pages near our offset
7332 * we try to find less populated places doing a forward jump of
7333 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7334 * without hurry, and then we jump again and so forth...
7336 * This function can be improved using a free list to avoid to guess
7337 * too much, since we could collect data about freed pages.
7339 * note: I implemented this function just after watching an episode of
7340 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7342 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7343 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7345 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7346 server
.vm_near_pages
= 0;
7347 server
.vm_next_page
= 0;
7349 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7350 base
= server
.vm_next_page
;
7352 while(offset
< server
.vm_pages
) {
7353 off_t
this = base
+offset
;
7355 /* If we overflow, restart from page zero */
7356 if (this >= server
.vm_pages
) {
7357 this -= server
.vm_pages
;
7359 /* Just overflowed, what we found on tail is no longer
7360 * interesting, as it's no longer contiguous. */
7364 if (vmFreePage(this)) {
7365 /* This is a free page */
7367 /* Already got N free pages? Return to the caller, with success */
7369 *first
= this-(n
-1);
7370 server
.vm_next_page
= this+1;
7371 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
7375 /* The current one is not a free page */
7379 /* Fast-forward if the current page is not free and we already
7380 * searched enough near this place. */
7382 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7383 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7385 /* Note that even if we rewind after the jump, we are don't need
7386 * to make sure numfree is set to zero as we only jump *if* it
7387 * is set to zero. */
7389 /* Otherwise just check the next page */
7396 /* Write the specified object at the specified page of the swap file */
7397 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7398 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7399 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7400 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7401 redisLog(REDIS_WARNING
,
7402 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
7406 rdbSaveObject(server
.vm_fp
,o
);
7407 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7411 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7412 * needed to later retrieve the object into the key object.
7413 * If we can't find enough contiguous empty pages to swap the object on disk
7414 * REDIS_ERR is returned. */
7415 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7416 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7419 assert(key
->storage
== REDIS_VM_MEMORY
);
7420 assert(key
->refcount
== 1);
7421 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7422 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7423 key
->vm
.page
= page
;
7424 key
->vm
.usedpages
= pages
;
7425 key
->storage
= REDIS_VM_SWAPPED
;
7426 key
->vtype
= val
->type
;
7427 decrRefCount(val
); /* Deallocate the object from memory. */
7428 vmMarkPagesUsed(page
,pages
);
7429 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7430 (unsigned char*) key
->ptr
,
7431 (unsigned long long) page
, (unsigned long long) pages
);
7432 server
.vm_stats_swapped_objects
++;
7433 server
.vm_stats_swapouts
++;
7434 fflush(server
.vm_fp
);
7438 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7441 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7442 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7443 redisLog(REDIS_WARNING
,
7444 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7448 o
= rdbLoadObject(type
,server
.vm_fp
);
7450 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7453 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7457 /* Load the value object relative to the 'key' object from swap to memory.
7458 * The newly allocated object is returned.
7460 * If preview is true the unserialized object is returned to the caller but
7461 * no changes are made to the key object, nor the pages are marked as freed */
7462 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7465 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7466 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7468 key
->storage
= REDIS_VM_MEMORY
;
7469 key
->vm
.atime
= server
.unixtime
;
7470 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7471 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7472 (unsigned char*) key
->ptr
);
7473 server
.vm_stats_swapped_objects
--;
7475 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7476 (unsigned char*) key
->ptr
);
7478 server
.vm_stats_swapins
++;
7482 /* Plain object loading, from swap to memory */
7483 static robj
*vmLoadObject(robj
*key
) {
7484 /* If we are loading the object in background, stop it, we
7485 * need to load this object synchronously ASAP. */
7486 if (key
->storage
== REDIS_VM_LOADING
)
7487 vmCancelThreadedIOJob(key
);
7488 return vmGenericLoadObject(key
,0);
7491 /* Just load the value on disk, without to modify the key.
7492 * This is useful when we want to perform some operation on the value
7493 * without to really bring it from swap to memory, like while saving the
7494 * dataset or rewriting the append only log. */
7495 static robj
*vmPreviewObject(robj
*key
) {
7496 return vmGenericLoadObject(key
,1);
7499 /* How a good candidate is this object for swapping?
7500 * The better candidate it is, the greater the returned value.
7502 * Currently we try to perform a fast estimation of the object size in
7503 * memory, and combine it with aging informations.
7505 * Basically swappability = idle-time * log(estimated size)
7507 * Bigger objects are preferred over smaller objects, but not
7508 * proportionally, this is why we use the logarithm. This algorithm is
7509 * just a first try and will probably be tuned later. */
7510 static double computeObjectSwappability(robj
*o
) {
7511 time_t age
= server
.unixtime
- o
->vm
.atime
;
7515 struct dictEntry
*de
;
7518 if (age
<= 0) return 0;
7521 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7524 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7529 listNode
*ln
= listFirst(l
);
7531 asize
= sizeof(list
);
7533 robj
*ele
= ln
->value
;
7536 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7537 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7539 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7544 z
= (o
->type
== REDIS_ZSET
);
7545 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7547 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7548 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7553 de
= dictGetRandomKey(d
);
7554 ele
= dictGetEntryKey(de
);
7555 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7556 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7558 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7559 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7563 return (double)age
*log(1+asize
);
7566 /* Try to swap an object that's a good candidate for swapping.
7567 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7568 * to swap any object at all.
7570 * If 'usethreaded' is true, Redis will try to swap the object in background
7571 * using I/O threads. */
7572 static int vmSwapOneObject(int usethreads
) {
7574 struct dictEntry
*best
= NULL
;
7575 double best_swappability
= 0;
7576 redisDb
*best_db
= NULL
;
7579 for (j
= 0; j
< server
.dbnum
; j
++) {
7580 redisDb
*db
= server
.db
+j
;
7581 /* Why maxtries is set to 100?
7582 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7583 * are swappable objects */
7586 if (dictSize(db
->dict
) == 0) continue;
7587 for (i
= 0; i
< 5; i
++) {
7589 double swappability
;
7591 if (maxtries
) maxtries
--;
7592 de
= dictGetRandomKey(db
->dict
);
7593 key
= dictGetEntryKey(de
);
7594 val
= dictGetEntryVal(de
);
7595 /* Only swap objects that are currently in memory.
7597 * Also don't swap shared objects if threaded VM is on, as we
7598 * try to ensure that the main thread does not touch the
7599 * object while the I/O thread is using it, but we can't
7600 * control other keys without adding additional mutex. */
7601 if (key
->storage
!= REDIS_VM_MEMORY
||
7602 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7603 if (maxtries
) i
--; /* don't count this try */
7606 swappability
= computeObjectSwappability(val
);
7607 if (!best
|| swappability
> best_swappability
) {
7609 best_swappability
= swappability
;
7614 if (best
== NULL
) return REDIS_ERR
;
7615 key
= dictGetEntryKey(best
);
7616 val
= dictGetEntryVal(best
);
7618 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7619 key
->ptr
, best_swappability
);
7621 /* Unshare the key if needed */
7622 if (key
->refcount
> 1) {
7623 robj
*newkey
= dupStringObject(key
);
7625 key
= dictGetEntryKey(best
) = newkey
;
7629 vmSwapObjectThreaded(key
,val
,best_db
);
7632 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7633 dictGetEntryVal(best
) = NULL
;
7641 static int vmSwapOneObjectBlocking() {
7642 return vmSwapOneObject(0);
7645 static int vmSwapOneObjectThreaded() {
7646 return vmSwapOneObject(1);
7649 /* Return true if it's safe to swap out objects in a given moment.
7650 * Basically we don't want to swap objects out while there is a BGSAVE
7651 * or a BGAEOREWRITE running in backgroud. */
7652 static int vmCanSwapOut(void) {
7653 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7656 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7657 * and was deleted. Otherwise 0 is returned. */
7658 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7662 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7663 foundkey
= dictGetEntryKey(de
);
7664 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7669 /* =================== Virtual Memory - Threaded I/O ======================= */
7671 static void freeIOJob(iojob
*j
) {
7672 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7673 j
->type
== REDIS_IOJOB_DO_SWAP
||
7674 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7675 decrRefCount(j
->val
);
7676 decrRefCount(j
->key
);
7680 /* Every time a thread finished a Job, it writes a byte into the write side
7681 * of an unix pipe in order to "awake" the main thread, and this function
7683 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7687 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7689 REDIS_NOTUSED(mask
);
7690 REDIS_NOTUSED(privdata
);
7692 /* For every byte we read in the read side of the pipe, there is one
7693 * I/O job completed to process. */
7694 while((retval
= read(fd
,buf
,1)) == 1) {
7698 struct dictEntry
*de
;
7700 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7702 /* Get the processed element (the oldest one) */
7704 assert(listLength(server
.io_processed
) != 0);
7705 if (toprocess
== -1) {
7706 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7707 if (toprocess
<= 0) toprocess
= 1;
7709 ln
= listFirst(server
.io_processed
);
7711 listDelNode(server
.io_processed
,ln
);
7713 /* If this job is marked as canceled, just ignore it */
7718 /* Post process it in the main thread, as there are things we
7719 * can do just here to avoid race conditions and/or invasive locks */
7720 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
);
7721 de
= dictFind(j
->db
->dict
,j
->key
);
7723 key
= dictGetEntryKey(de
);
7724 if (j
->type
== REDIS_IOJOB_LOAD
) {
7727 /* Key loaded, bring it at home */
7728 key
->storage
= REDIS_VM_MEMORY
;
7729 key
->vm
.atime
= server
.unixtime
;
7730 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7731 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7732 (unsigned char*) key
->ptr
);
7733 server
.vm_stats_swapped_objects
--;
7734 server
.vm_stats_swapins
++;
7735 dictGetEntryVal(de
) = j
->val
;
7736 incrRefCount(j
->val
);
7739 /* Handle clients waiting for this key to be loaded. */
7740 handleClientsBlockedOnSwappedKey(db
,key
);
7741 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7742 /* Now we know the amount of pages required to swap this object.
7743 * Let's find some space for it, and queue this task again
7744 * rebranded as REDIS_IOJOB_DO_SWAP. */
7745 if (!vmCanSwapOut() ||
7746 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7748 /* Ooops... no space or we can't swap as there is
7749 * a fork()ed Redis trying to save stuff on disk. */
7751 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7753 /* Note that we need to mark this pages as used now,
7754 * if the job will be canceled, we'll mark them as freed
7756 vmMarkPagesUsed(j
->page
,j
->pages
);
7757 j
->type
= REDIS_IOJOB_DO_SWAP
;
7762 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7765 /* Key swapped. We can finally free some memory. */
7766 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7767 printf("key->storage: %d\n",key
->storage
);
7768 printf("key->name: %s\n",(char*)key
->ptr
);
7769 printf("key->refcount: %d\n",key
->refcount
);
7770 printf("val: %p\n",(void*)j
->val
);
7771 printf("val->type: %d\n",j
->val
->type
);
7772 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7774 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7775 val
= dictGetEntryVal(de
);
7776 key
->vm
.page
= j
->page
;
7777 key
->vm
.usedpages
= j
->pages
;
7778 key
->storage
= REDIS_VM_SWAPPED
;
7779 key
->vtype
= j
->val
->type
;
7780 decrRefCount(val
); /* Deallocate the object from memory. */
7781 dictGetEntryVal(de
) = NULL
;
7782 redisLog(REDIS_DEBUG
,
7783 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7784 (unsigned char*) key
->ptr
,
7785 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7786 server
.vm_stats_swapped_objects
++;
7787 server
.vm_stats_swapouts
++;
7789 /* Put a few more swap requests in queue if we are still
7791 if (trytoswap
&& vmCanSwapOut() &&
7792 zmalloc_used_memory() > server
.vm_max_memory
)
7797 more
= listLength(server
.io_newjobs
) <
7798 (unsigned) server
.vm_max_threads
;
7800 /* Don't waste CPU time if swappable objects are rare. */
7801 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
7809 if (processed
== toprocess
) return;
7811 if (retval
< 0 && errno
!= EAGAIN
) {
7812 redisLog(REDIS_WARNING
,
7813 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7818 static void lockThreadedIO(void) {
7819 pthread_mutex_lock(&server
.io_mutex
);
7822 static void unlockThreadedIO(void) {
7823 pthread_mutex_unlock(&server
.io_mutex
);
7826 /* Remove the specified object from the threaded I/O queue if still not
7827 * processed, otherwise make sure to flag it as canceled. */
7828 static void vmCancelThreadedIOJob(robj
*o
) {
7830 server
.io_newjobs
, /* 0 */
7831 server
.io_processing
, /* 1 */
7832 server
.io_processed
/* 2 */
7836 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7839 /* Search for a matching key in one of the queues */
7840 for (i
= 0; i
< 3; i
++) {
7844 listRewind(lists
[i
],&li
);
7845 while ((ln
= listNext(&li
)) != NULL
) {
7846 iojob
*job
= ln
->value
;
7848 if (job
->canceled
) continue; /* Skip this, already canceled. */
7849 if (compareStringObjects(job
->key
,o
) == 0) {
7850 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7851 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
7852 /* Mark the pages as free since the swap didn't happened
7853 * or happened but is now discarded. */
7854 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
7855 vmMarkPagesFree(job
->page
,job
->pages
);
7856 /* Cancel the job. It depends on the list the job is
7859 case 0: /* io_newjobs */
7860 /* If the job was yet not processed the best thing to do
7861 * is to remove it from the queue at all */
7863 listDelNode(lists
[i
],ln
);
7865 case 1: /* io_processing */
7866 /* Oh Shi- the thread is messing with the Job:
7868 * Probably it's accessing the object if this is a
7869 * PREPARE_SWAP or DO_SWAP job.
7870 * If it's a LOAD job it may be reading from disk and
7871 * if we don't wait for the job to terminate before to
7872 * cancel it, maybe in a few microseconds data can be
7873 * corrupted in this pages. So the short story is:
7875 * Better to wait for the job to move into the
7876 * next queue (processed)... */
7878 /* We try again and again until the job is completed. */
7880 /* But let's wait some time for the I/O thread
7881 * to finish with this job. After all this condition
7882 * should be very rare. */
7885 case 2: /* io_processed */
7886 /* The job was already processed, that's easy...
7887 * just mark it as canceled so that we'll ignore it
7888 * when processing completed jobs. */
7892 /* Finally we have to adjust the storage type of the object
7893 * in order to "UNDO" the operaiton. */
7894 if (o
->storage
== REDIS_VM_LOADING
)
7895 o
->storage
= REDIS_VM_SWAPPED
;
7896 else if (o
->storage
== REDIS_VM_SWAPPING
)
7897 o
->storage
= REDIS_VM_MEMORY
;
7904 assert(1 != 1); /* We should never reach this */
7907 static void *IOThreadEntryPoint(void *arg
) {
7912 pthread_detach(pthread_self());
7914 /* Get a new job to process */
7916 if (listLength(server
.io_newjobs
) == 0) {
7917 /* No new jobs in queue, exit. */
7918 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
7919 (long) pthread_self());
7920 server
.io_active_threads
--;
7924 ln
= listFirst(server
.io_newjobs
);
7926 listDelNode(server
.io_newjobs
,ln
);
7927 /* Add the job in the processing queue */
7928 j
->thread
= pthread_self();
7929 listAddNodeTail(server
.io_processing
,j
);
7930 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7932 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
7933 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7935 /* Process the Job */
7936 if (j
->type
== REDIS_IOJOB_LOAD
) {
7937 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
7938 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7939 FILE *fp
= fopen("/dev/null","w+");
7940 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7942 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7943 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7947 /* Done: insert the job into the processed queue */
7948 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
7949 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7951 listDelNode(server
.io_processing
,ln
);
7952 listAddNodeTail(server
.io_processed
,j
);
7955 /* Signal the main thread there is new stuff to process */
7956 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7958 return NULL
; /* never reached */
7961 static void spawnIOThread(void) {
7963 sigset_t mask
, omask
;
7966 sigaddset(&mask
,SIGCHLD
);
7967 sigaddset(&mask
,SIGHUP
);
7968 sigaddset(&mask
,SIGPIPE
);
7969 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
7970 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7971 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
7972 server
.io_active_threads
++;
7975 /* We need to wait for the last thread to exit before we are able to
7976 * fork() in order to BGSAVE or BGREWRITEAOF. */
7977 static void waitEmptyIOJobsQueue(void) {
7979 int io_processed_len
;
7982 if (listLength(server
.io_newjobs
) == 0 &&
7983 listLength(server
.io_processing
) == 0 &&
7984 server
.io_active_threads
== 0)
7989 /* While waiting for empty jobs queue condition we post-process some
7990 * finshed job, as I/O threads may be hanging trying to write against
7991 * the io_ready_pipe_write FD but there are so much pending jobs that
7993 io_processed_len
= listLength(server
.io_processed
);
7995 if (io_processed_len
) {
7996 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
7997 usleep(1000); /* 1 millisecond */
7999 usleep(10000); /* 10 milliseconds */
8004 static void vmReopenSwapFile(void) {
8005 /* Note: we don't close the old one as we are in the child process
8006 * and don't want to mess at all with the original file object. */
8007 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8008 if (server
.vm_fp
== NULL
) {
8009 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8010 server
.vm_swap_file
);
8013 server
.vm_fd
= fileno(server
.vm_fp
);
8016 /* This function must be called while with threaded IO locked */
8017 static void queueIOJob(iojob
*j
) {
8018 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8019 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8020 listAddNodeTail(server
.io_newjobs
,j
);
8021 if (server
.io_active_threads
< server
.vm_max_threads
)
8025 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8028 assert(key
->storage
== REDIS_VM_MEMORY
);
8029 assert(key
->refcount
== 1);
8031 j
= zmalloc(sizeof(*j
));
8032 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8034 j
->key
= dupStringObject(key
);
8038 j
->thread
= (pthread_t
) -1;
8039 key
->storage
= REDIS_VM_SWAPPING
;
8047 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8049 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8050 * If there is not already a job loading the key, it is craeted.
8051 * The key is added to the io_keys list in the client structure, and also
8052 * in the hash table mapping swapped keys to waiting clients, that is,
8053 * server.io_waited_keys. */
8054 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8055 struct dictEntry
*de
;
8059 /* If the key does not exist or is already in RAM we don't need to
8060 * block the client at all. */
8061 de
= dictFind(c
->db
->dict
,key
);
8062 if (de
== NULL
) return 0;
8063 o
= dictGetEntryKey(de
);
8064 if (o
->storage
== REDIS_VM_MEMORY
) {
8066 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8067 /* We were swapping the key, undo it! */
8068 vmCancelThreadedIOJob(o
);
8072 /* OK: the key is either swapped, or being loaded just now. */
8074 /* Add the key to the list of keys this client is waiting for.
8075 * This maps clients to keys they are waiting for. */
8076 listAddNodeTail(c
->io_keys
,key
);
8079 /* Add the client to the swapped keys => clients waiting map. */
8080 de
= dictFind(c
->db
->io_keys
,key
);
8084 /* For every key we take a list of clients blocked for it */
8086 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8088 assert(retval
== DICT_OK
);
8090 l
= dictGetEntryVal(de
);
8092 listAddNodeTail(l
,c
);
8094 /* Are we already loading the key from disk? If not create a job */
8095 if (o
->storage
== REDIS_VM_SWAPPED
) {
8098 o
->storage
= REDIS_VM_LOADING
;
8099 j
= zmalloc(sizeof(*j
));
8100 j
->type
= REDIS_IOJOB_LOAD
;
8102 j
->key
= dupStringObject(key
);
8103 j
->key
->vtype
= o
->vtype
;
8104 j
->page
= o
->vm
.page
;
8107 j
->thread
= (pthread_t
) -1;
8115 /* Is this client attempting to run a command against swapped keys?
8116 * If so, block it ASAP, load the keys in background, then resume it.
8118 * The important idea about this function is that it can fail! If keys will
8119 * still be swapped when the client is resumed, this key lookups will
8120 * just block loading keys from disk. In practical terms this should only
8121 * happen with SORT BY command or if there is a bug in this function.
8123 * Return 1 if the client is marked as blocked, 0 if the client can
8124 * continue as the keys it is going to access appear to be in memory. */
8125 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8128 if (cmd
->vm_firstkey
== 0) return 0;
8129 last
= cmd
->vm_lastkey
;
8130 if (last
< 0) last
= c
->argc
+last
;
8131 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8132 waitForSwappedKey(c
,c
->argv
[j
]);
8133 /* If the client was blocked for at least one key, mark it as blocked. */
8134 if (listLength(c
->io_keys
)) {
8135 c
->flags
|= REDIS_IO_WAIT
;
8136 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8137 server
.vm_blocked_clients
++;
8144 /* Remove the 'key' from the list of blocked keys for a given client.
8146 * The function returns 1 when there are no longer blocking keys after
8147 * the current one was removed (and the client can be unblocked). */
8148 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8152 struct dictEntry
*de
;
8154 /* Remove the key from the list of keys this client is waiting for. */
8155 listRewind(c
->io_keys
,&li
);
8156 while ((ln
= listNext(&li
)) != NULL
) {
8157 if (compareStringObjects(ln
->value
,key
) == 0) {
8158 listDelNode(c
->io_keys
,ln
);
8164 /* Remove the client form the key => waiting clients map. */
8165 de
= dictFind(c
->db
->io_keys
,key
);
8167 l
= dictGetEntryVal(de
);
8168 ln
= listSearchKey(l
,c
);
8171 if (listLength(l
) == 0)
8172 dictDelete(c
->db
->io_keys
,key
);
8174 return listLength(c
->io_keys
) == 0;
8177 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8178 struct dictEntry
*de
;
8183 de
= dictFind(db
->io_keys
,key
);
8186 l
= dictGetEntryVal(de
);
8187 len
= listLength(l
);
8188 /* Note: we can't use something like while(listLength(l)) as the list
8189 * can be freed by the calling function when we remove the last element. */
8192 redisClient
*c
= ln
->value
;
8194 if (dontWaitForSwappedKey(c
,key
)) {
8195 /* Put the client in the list of clients ready to go as we
8196 * loaded all the keys about it. */
8197 listAddNodeTail(server
.io_ready_clients
,c
);
8202 /* ================================= Debugging ============================== */
8204 static void debugCommand(redisClient
*c
) {
8205 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8207 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8208 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8209 addReply(c
,shared
.err
);
8213 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8214 addReply(c
,shared
.err
);
8217 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8218 addReply(c
,shared
.ok
);
8219 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8221 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8222 addReply(c
,shared
.err
);
8225 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8226 addReply(c
,shared
.ok
);
8227 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8228 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8232 addReply(c
,shared
.nokeyerr
);
8235 key
= dictGetEntryKey(de
);
8236 val
= dictGetEntryVal(de
);
8237 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8238 key
->storage
== REDIS_VM_SWAPPING
)) {
8239 addReplySds(c
,sdscatprintf(sdsempty(),
8240 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8241 "encoding:%d serializedlength:%lld\r\n",
8242 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8243 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8245 addReplySds(c
,sdscatprintf(sdsempty(),
8246 "+Key at:%p refcount:%d, value swapped at: page %llu "
8247 "using %llu pages\r\n",
8248 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8249 (unsigned long long) key
->vm
.usedpages
));
8251 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8252 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8255 if (!server
.vm_enabled
) {
8256 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8260 addReply(c
,shared
.nokeyerr
);
8263 key
= dictGetEntryKey(de
);
8264 val
= dictGetEntryVal(de
);
8265 /* If the key is shared we want to create a copy */
8266 if (key
->refcount
> 1) {
8267 robj
*newkey
= dupStringObject(key
);
8269 key
= dictGetEntryKey(de
) = newkey
;
8272 if (key
->storage
!= REDIS_VM_MEMORY
) {
8273 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8274 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8275 dictGetEntryVal(de
) = NULL
;
8276 addReply(c
,shared
.ok
);
8278 addReply(c
,shared
.err
);
8281 addReplySds(c
,sdsnew(
8282 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8286 static void _redisAssert(char *estr
, char *file
, int line
) {
8287 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8288 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8289 #ifdef HAVE_BACKTRACE
8290 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8295 /* =================================== Main! ================================ */
8298 int linuxOvercommitMemoryValue(void) {
8299 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8303 if (fgets(buf
,64,fp
) == NULL
) {
8312 void linuxOvercommitMemoryWarning(void) {
8313 if (linuxOvercommitMemoryValue() == 0) {
8314 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.");
8317 #endif /* __linux__ */
8319 static void daemonize(void) {
8323 if (fork() != 0) exit(0); /* parent exits */
8324 setsid(); /* create a new session */
8326 /* Every output goes to /dev/null. If Redis is daemonized but
8327 * the 'logfile' is set to 'stdout' in the configuration file
8328 * it will not log at all. */
8329 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8330 dup2(fd
, STDIN_FILENO
);
8331 dup2(fd
, STDOUT_FILENO
);
8332 dup2(fd
, STDERR_FILENO
);
8333 if (fd
> STDERR_FILENO
) close(fd
);
8335 /* Try to write the pid file */
8336 fp
= fopen(server
.pidfile
,"w");
8338 fprintf(fp
,"%d\n",getpid());
8343 int main(int argc
, char **argv
) {
8348 resetServerSaveParams();
8349 loadServerConfig(argv
[1]);
8350 } else if (argc
> 2) {
8351 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8354 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'");
8356 if (server
.daemonize
) daemonize();
8358 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8360 linuxOvercommitMemoryWarning();
8363 if (server
.appendonly
) {
8364 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8365 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8367 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8368 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8370 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8371 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8373 aeDeleteEventLoop(server
.el
);
8377 /* ============================= Backtrace support ========================= */
8379 #ifdef HAVE_BACKTRACE
8380 static char *findFuncName(void *pointer
, unsigned long *offset
);
8382 static void *getMcontextEip(ucontext_t
*uc
) {
8383 #if defined(__FreeBSD__)
8384 return (void*) uc
->uc_mcontext
.mc_eip
;
8385 #elif defined(__dietlibc__)
8386 return (void*) uc
->uc_mcontext
.eip
;
8387 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8389 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8391 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8393 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8394 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8395 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8397 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8399 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8400 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8401 #elif defined(__ia64__) /* Linux IA64 */
8402 return (void*) uc
->uc_mcontext
.sc_ip
;
8408 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8410 char **messages
= NULL
;
8411 int i
, trace_size
= 0;
8412 unsigned long offset
=0;
8413 ucontext_t
*uc
= (ucontext_t
*) secret
;
8415 REDIS_NOTUSED(info
);
8417 redisLog(REDIS_WARNING
,
8418 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8419 infostring
= genRedisInfoString();
8420 redisLog(REDIS_WARNING
, "%s",infostring
);
8421 /* It's not safe to sdsfree() the returned string under memory
8422 * corruption conditions. Let it leak as we are going to abort */
8424 trace_size
= backtrace(trace
, 100);
8425 /* overwrite sigaction with caller's address */
8426 if (getMcontextEip(uc
) != NULL
) {
8427 trace
[1] = getMcontextEip(uc
);
8429 messages
= backtrace_symbols(trace
, trace_size
);
8431 for (i
=1; i
<trace_size
; ++i
) {
8432 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8434 p
= strchr(messages
[i
],'+');
8435 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8436 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8438 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8441 /* free(messages); Don't call free() with possibly corrupted memory. */
8445 static void setupSigSegvAction(void) {
8446 struct sigaction act
;
8448 sigemptyset (&act
.sa_mask
);
8449 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8450 * is used. Otherwise, sa_handler is used */
8451 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8452 act
.sa_sigaction
= segvHandler
;
8453 sigaction (SIGSEGV
, &act
, NULL
);
8454 sigaction (SIGBUS
, &act
, NULL
);
8455 sigaction (SIGFPE
, &act
, NULL
);
8456 sigaction (SIGILL
, &act
, NULL
);
8457 sigaction (SIGBUS
, &act
, NULL
);
8461 #include "staticsymbols.h"
8462 /* This function try to convert a pointer into a function name. It's used in
8463 * oreder to provide a backtrace under segmentation fault that's able to
8464 * display functions declared as static (otherwise the backtrace is useless). */
8465 static char *findFuncName(void *pointer
, unsigned long *offset
){
8467 unsigned long off
, minoff
= 0;
8469 /* Try to match against the Symbol with the smallest offset */
8470 for (i
=0; symsTable
[i
].pointer
; i
++) {
8471 unsigned long lp
= (unsigned long) pointer
;
8473 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8474 off
=lp
-symsTable
[i
].pointer
;
8475 if (ret
< 0 || off
< minoff
) {
8481 if (ret
== -1) return NULL
;
8483 return symsTable
[ret
].name
;
8485 #else /* HAVE_BACKTRACE */
8486 static void setupSigSegvAction(void) {
8488 #endif /* HAVE_BACKTRACE */