2 * Copyright (c) 2006-2009, 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
;
431 struct redisFunctionSym
{
433 unsigned long pointer
;
436 typedef struct _redisSortObject
{
444 typedef struct _redisSortOperation
{
447 } redisSortOperation
;
449 /* ZSETs use a specialized version of Skiplists */
451 typedef struct zskiplistNode
{
452 struct zskiplistNode
**forward
;
453 struct zskiplistNode
*backward
;
458 typedef struct zskiplist
{
459 struct zskiplistNode
*header
, *tail
;
460 unsigned long length
;
464 typedef struct zset
{
469 /* Our shared "common" objects */
471 struct sharedObjectsStruct
{
472 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
473 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
474 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
475 *outofrangeerr
, *plus
,
476 *select0
, *select1
, *select2
, *select3
, *select4
,
477 *select5
, *select6
, *select7
, *select8
, *select9
;
480 /* Global vars that are actally used as constants. The following double
481 * values are used for double on-disk serialization, and are initialized
482 * at runtime to avoid strange compiler optimizations. */
484 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
486 /* VM threaded I/O request message */
487 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
488 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
489 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
490 typedef struct iojob
{
491 int type
; /* Request type, REDIS_IOJOB_* */
492 redisDb
*db
;/* Redis database */
493 robj
*key
; /* This I/O request is about swapping this key */
494 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
495 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
496 off_t page
; /* Swap page where to read/write the object */
497 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
498 int canceled
; /* True if this command was canceled by blocking side of VM */
499 pthread_t thread
; /* ID of the thread processing this entry */
502 /*================================ Prototypes =============================== */
504 static void freeStringObject(robj
*o
);
505 static void freeListObject(robj
*o
);
506 static void freeSetObject(robj
*o
);
507 static void decrRefCount(void *o
);
508 static robj
*createObject(int type
, void *ptr
);
509 static void freeClient(redisClient
*c
);
510 static int rdbLoad(char *filename
);
511 static void addReply(redisClient
*c
, robj
*obj
);
512 static void addReplySds(redisClient
*c
, sds s
);
513 static void incrRefCount(robj
*o
);
514 static int rdbSaveBackground(char *filename
);
515 static robj
*createStringObject(char *ptr
, size_t len
);
516 static robj
*dupStringObject(robj
*o
);
517 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
518 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
519 static int syncWithMaster(void);
520 static robj
*tryObjectSharing(robj
*o
);
521 static int tryObjectEncoding(robj
*o
);
522 static robj
*getDecodedObject(robj
*o
);
523 static int removeExpire(redisDb
*db
, robj
*key
);
524 static int expireIfNeeded(redisDb
*db
, robj
*key
);
525 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
526 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
527 static int deleteKey(redisDb
*db
, robj
*key
);
528 static time_t getExpire(redisDb
*db
, robj
*key
);
529 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
530 static void updateSlavesWaitingBgsave(int bgsaveerr
);
531 static void freeMemoryIfNeeded(void);
532 static int processCommand(redisClient
*c
);
533 static void setupSigSegvAction(void);
534 static void rdbRemoveTempFile(pid_t childpid
);
535 static void aofRemoveTempFile(pid_t childpid
);
536 static size_t stringObjectLen(robj
*o
);
537 static void processInputBuffer(redisClient
*c
);
538 static zskiplist
*zslCreate(void);
539 static void zslFree(zskiplist
*zsl
);
540 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
541 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
542 static void initClientMultiState(redisClient
*c
);
543 static void freeClientMultiState(redisClient
*c
);
544 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
545 static void unblockClientWaitingData(redisClient
*c
);
546 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
547 static void vmInit(void);
548 static void vmMarkPagesFree(off_t page
, off_t count
);
549 static robj
*vmLoadObject(robj
*key
);
550 static robj
*vmPreviewObject(robj
*key
);
551 static int vmSwapOneObjectBlocking(void);
552 static int vmSwapOneObjectThreaded(void);
553 static int vmCanSwapOut(void);
554 static int tryFreeOneObjectFromFreelist(void);
555 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
556 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
557 static void vmCancelThreadedIOJob(robj
*o
);
558 static void lockThreadedIO(void);
559 static void unlockThreadedIO(void);
560 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
561 static void freeIOJob(iojob
*j
);
562 static void queueIOJob(iojob
*j
);
563 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
564 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
565 static void waitEmptyIOJobsQueue(void);
566 static void vmReopenSwapFile(void);
567 static int vmFreePage(off_t page
);
568 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
569 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
570 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
571 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
572 static struct redisCommand
*lookupCommand(char *name
);
573 static void call(redisClient
*c
, struct redisCommand
*cmd
);
574 static void resetClient(redisClient
*c
);
576 static void authCommand(redisClient
*c
);
577 static void pingCommand(redisClient
*c
);
578 static void echoCommand(redisClient
*c
);
579 static void setCommand(redisClient
*c
);
580 static void setnxCommand(redisClient
*c
);
581 static void getCommand(redisClient
*c
);
582 static void delCommand(redisClient
*c
);
583 static void existsCommand(redisClient
*c
);
584 static void incrCommand(redisClient
*c
);
585 static void decrCommand(redisClient
*c
);
586 static void incrbyCommand(redisClient
*c
);
587 static void decrbyCommand(redisClient
*c
);
588 static void selectCommand(redisClient
*c
);
589 static void randomkeyCommand(redisClient
*c
);
590 static void keysCommand(redisClient
*c
);
591 static void dbsizeCommand(redisClient
*c
);
592 static void lastsaveCommand(redisClient
*c
);
593 static void saveCommand(redisClient
*c
);
594 static void bgsaveCommand(redisClient
*c
);
595 static void bgrewriteaofCommand(redisClient
*c
);
596 static void shutdownCommand(redisClient
*c
);
597 static void moveCommand(redisClient
*c
);
598 static void renameCommand(redisClient
*c
);
599 static void renamenxCommand(redisClient
*c
);
600 static void lpushCommand(redisClient
*c
);
601 static void rpushCommand(redisClient
*c
);
602 static void lpopCommand(redisClient
*c
);
603 static void rpopCommand(redisClient
*c
);
604 static void llenCommand(redisClient
*c
);
605 static void lindexCommand(redisClient
*c
);
606 static void lrangeCommand(redisClient
*c
);
607 static void ltrimCommand(redisClient
*c
);
608 static void typeCommand(redisClient
*c
);
609 static void lsetCommand(redisClient
*c
);
610 static void saddCommand(redisClient
*c
);
611 static void sremCommand(redisClient
*c
);
612 static void smoveCommand(redisClient
*c
);
613 static void sismemberCommand(redisClient
*c
);
614 static void scardCommand(redisClient
*c
);
615 static void spopCommand(redisClient
*c
);
616 static void srandmemberCommand(redisClient
*c
);
617 static void sinterCommand(redisClient
*c
);
618 static void sinterstoreCommand(redisClient
*c
);
619 static void sunionCommand(redisClient
*c
);
620 static void sunionstoreCommand(redisClient
*c
);
621 static void sdiffCommand(redisClient
*c
);
622 static void sdiffstoreCommand(redisClient
*c
);
623 static void syncCommand(redisClient
*c
);
624 static void flushdbCommand(redisClient
*c
);
625 static void flushallCommand(redisClient
*c
);
626 static void sortCommand(redisClient
*c
);
627 static void lremCommand(redisClient
*c
);
628 static void rpoplpushcommand(redisClient
*c
);
629 static void infoCommand(redisClient
*c
);
630 static void mgetCommand(redisClient
*c
);
631 static void monitorCommand(redisClient
*c
);
632 static void expireCommand(redisClient
*c
);
633 static void expireatCommand(redisClient
*c
);
634 static void getsetCommand(redisClient
*c
);
635 static void ttlCommand(redisClient
*c
);
636 static void slaveofCommand(redisClient
*c
);
637 static void debugCommand(redisClient
*c
);
638 static void msetCommand(redisClient
*c
);
639 static void msetnxCommand(redisClient
*c
);
640 static void zaddCommand(redisClient
*c
);
641 static void zincrbyCommand(redisClient
*c
);
642 static void zrangeCommand(redisClient
*c
);
643 static void zrangebyscoreCommand(redisClient
*c
);
644 static void zrevrangeCommand(redisClient
*c
);
645 static void zcardCommand(redisClient
*c
);
646 static void zremCommand(redisClient
*c
);
647 static void zscoreCommand(redisClient
*c
);
648 static void zremrangebyscoreCommand(redisClient
*c
);
649 static void multiCommand(redisClient
*c
);
650 static void execCommand(redisClient
*c
);
651 static void blpopCommand(redisClient
*c
);
652 static void brpopCommand(redisClient
*c
);
653 static void appendCommand(redisClient
*c
);
655 /*================================= Globals ================================= */
658 static struct redisServer server
; /* server global state */
659 static struct redisCommand cmdTable
[] = {
660 {"get",getCommand
,2,REDIS_CMD_INLINE
},
661 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
662 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
663 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
664 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
665 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
666 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
667 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
668 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
669 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
670 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
671 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
672 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
673 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
674 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
675 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
676 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
677 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
678 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
679 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
680 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
681 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
682 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
683 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
684 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
685 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
686 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
687 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
688 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
689 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
690 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
691 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
692 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
693 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
694 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
695 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
696 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
697 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
698 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
699 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
700 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
701 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
702 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
703 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
704 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
705 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
706 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
707 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
708 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
709 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
710 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
711 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
712 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
713 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
714 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
715 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
716 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
717 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
718 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
719 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
720 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
721 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
722 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
723 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
724 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
725 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
726 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
727 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
728 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
729 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
730 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
731 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
732 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
733 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
734 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
735 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
736 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
737 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
738 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
742 /*============================ Utility functions ============================ */
744 /* Glob-style pattern matching. */
745 int stringmatchlen(const char *pattern
, int patternLen
,
746 const char *string
, int stringLen
, int nocase
)
751 while (pattern
[1] == '*') {
756 return 1; /* match */
758 if (stringmatchlen(pattern
+1, patternLen
-1,
759 string
, stringLen
, nocase
))
760 return 1; /* match */
764 return 0; /* no match */
768 return 0; /* no match */
778 not = pattern
[0] == '^';
785 if (pattern
[0] == '\\') {
788 if (pattern
[0] == string
[0])
790 } else if (pattern
[0] == ']') {
792 } else if (patternLen
== 0) {
796 } else if (pattern
[1] == '-' && patternLen
>= 3) {
797 int start
= pattern
[0];
798 int end
= pattern
[2];
806 start
= tolower(start
);
812 if (c
>= start
&& c
<= end
)
816 if (pattern
[0] == string
[0])
819 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
829 return 0; /* no match */
835 if (patternLen
>= 2) {
842 if (pattern
[0] != string
[0])
843 return 0; /* no match */
845 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
846 return 0; /* no match */
854 if (stringLen
== 0) {
855 while(*pattern
== '*') {
862 if (patternLen
== 0 && stringLen
== 0)
867 static void redisLog(int level
, const char *fmt
, ...) {
871 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
875 if (level
>= server
.verbosity
) {
881 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
882 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
883 vfprintf(fp
, fmt
, ap
);
889 if (server
.logfile
) fclose(fp
);
892 /*====================== Hash table type implementation ==================== */
894 /* This is an hash table type that uses the SDS dynamic strings libary as
895 * keys and radis objects as values (objects can hold SDS strings,
898 static void dictVanillaFree(void *privdata
, void *val
)
900 DICT_NOTUSED(privdata
);
904 static void dictListDestructor(void *privdata
, void *val
)
906 DICT_NOTUSED(privdata
);
907 listRelease((list
*)val
);
910 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
914 DICT_NOTUSED(privdata
);
916 l1
= sdslen((sds
)key1
);
917 l2
= sdslen((sds
)key2
);
918 if (l1
!= l2
) return 0;
919 return memcmp(key1
, key2
, l1
) == 0;
922 static void dictRedisObjectDestructor(void *privdata
, void *val
)
924 DICT_NOTUSED(privdata
);
926 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
930 static int dictObjKeyCompare(void *privdata
, const void *key1
,
933 const robj
*o1
= key1
, *o2
= key2
;
934 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
937 static unsigned int dictObjHash(const void *key
) {
939 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
942 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
945 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
948 o1
= getDecodedObject(o1
);
949 o2
= getDecodedObject(o2
);
950 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
956 static unsigned int dictEncObjHash(const void *key
) {
957 robj
*o
= (robj
*) key
;
959 if (o
->encoding
== REDIS_ENCODING_RAW
) {
960 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
962 if (o
->encoding
== REDIS_ENCODING_INT
) {
966 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
967 return dictGenHashFunction((unsigned char*)buf
, len
);
971 o
= getDecodedObject(o
);
972 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
979 /* Sets type and expires */
980 static dictType setDictType
= {
981 dictEncObjHash
, /* hash function */
984 dictEncObjKeyCompare
, /* key compare */
985 dictRedisObjectDestructor
, /* key destructor */
986 NULL
/* val destructor */
989 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
990 static dictType zsetDictType
= {
991 dictEncObjHash
, /* hash function */
994 dictEncObjKeyCompare
, /* key compare */
995 dictRedisObjectDestructor
, /* key destructor */
996 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1000 static dictType hashDictType
= {
1001 dictObjHash
, /* hash function */
1004 dictObjKeyCompare
, /* key compare */
1005 dictRedisObjectDestructor
, /* key destructor */
1006 dictRedisObjectDestructor
/* val destructor */
1010 static dictType keyptrDictType
= {
1011 dictObjHash
, /* hash function */
1014 dictObjKeyCompare
, /* key compare */
1015 dictRedisObjectDestructor
, /* key destructor */
1016 NULL
/* val destructor */
1019 /* Keylist hash table type has unencoded redis objects as keys and
1020 * lists as values. It's used for blocking operations (BLPOP) and to
1021 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1022 static dictType keylistDictType
= {
1023 dictObjHash
, /* hash function */
1026 dictObjKeyCompare
, /* key compare */
1027 dictRedisObjectDestructor
, /* key destructor */
1028 dictListDestructor
/* val destructor */
1031 /* ========================= Random utility functions ======================= */
1033 /* Redis generally does not try to recover from out of memory conditions
1034 * when allocating objects or strings, it is not clear if it will be possible
1035 * to report this condition to the client since the networking layer itself
1036 * is based on heap allocation for send buffers, so we simply abort.
1037 * At least the code will be simpler to read... */
1038 static void oom(const char *msg
) {
1039 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1044 /* ====================== Redis server networking stuff ===================== */
1045 static void closeTimedoutClients(void) {
1048 time_t now
= time(NULL
);
1051 listRewind(server
.clients
,&li
);
1052 while ((ln
= listNext(&li
)) != NULL
) {
1053 c
= listNodeValue(ln
);
1054 if (server
.maxidletime
&&
1055 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1056 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1057 (now
- c
->lastinteraction
> server
.maxidletime
))
1059 redisLog(REDIS_VERBOSE
,"Closing idle client");
1061 } else if (c
->flags
& REDIS_BLOCKED
) {
1062 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1063 addReply(c
,shared
.nullmultibulk
);
1064 unblockClientWaitingData(c
);
1070 static int htNeedsResize(dict
*dict
) {
1071 long long size
, used
;
1073 size
= dictSlots(dict
);
1074 used
= dictSize(dict
);
1075 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1076 (used
*100/size
< REDIS_HT_MINFILL
));
1079 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1080 * we resize the hash table to save memory */
1081 static void tryResizeHashTables(void) {
1084 for (j
= 0; j
< server
.dbnum
; j
++) {
1085 if (htNeedsResize(server
.db
[j
].dict
)) {
1086 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1087 dictResize(server
.db
[j
].dict
);
1088 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1090 if (htNeedsResize(server
.db
[j
].expires
))
1091 dictResize(server
.db
[j
].expires
);
1095 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1096 void backgroundSaveDoneHandler(int statloc
) {
1097 int exitcode
= WEXITSTATUS(statloc
);
1098 int bysignal
= WIFSIGNALED(statloc
);
1100 if (!bysignal
&& exitcode
== 0) {
1101 redisLog(REDIS_NOTICE
,
1102 "Background saving terminated with success");
1104 server
.lastsave
= time(NULL
);
1105 } else if (!bysignal
&& exitcode
!= 0) {
1106 redisLog(REDIS_WARNING
, "Background saving error");
1108 redisLog(REDIS_WARNING
,
1109 "Background saving terminated by signal");
1110 rdbRemoveTempFile(server
.bgsavechildpid
);
1112 server
.bgsavechildpid
= -1;
1113 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1114 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1115 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1118 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1120 void backgroundRewriteDoneHandler(int statloc
) {
1121 int exitcode
= WEXITSTATUS(statloc
);
1122 int bysignal
= WIFSIGNALED(statloc
);
1124 if (!bysignal
&& exitcode
== 0) {
1128 redisLog(REDIS_NOTICE
,
1129 "Background append only file rewriting terminated with success");
1130 /* Now it's time to flush the differences accumulated by the parent */
1131 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1132 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1134 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1137 /* Flush our data... */
1138 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1139 (signed) sdslen(server
.bgrewritebuf
)) {
1140 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
));
1144 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1145 /* Now our work is to rename the temp file into the stable file. And
1146 * switch the file descriptor used by the server for append only. */
1147 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1148 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1152 /* Mission completed... almost */
1153 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1154 if (server
.appendfd
!= -1) {
1155 /* If append only is actually enabled... */
1156 close(server
.appendfd
);
1157 server
.appendfd
= fd
;
1159 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1160 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1162 /* If append only is disabled we just generate a dump in this
1163 * format. Why not? */
1166 } else if (!bysignal
&& exitcode
!= 0) {
1167 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1169 redisLog(REDIS_WARNING
,
1170 "Background append only file rewriting terminated by signal");
1173 sdsfree(server
.bgrewritebuf
);
1174 server
.bgrewritebuf
= sdsempty();
1175 aofRemoveTempFile(server
.bgrewritechildpid
);
1176 server
.bgrewritechildpid
= -1;
1179 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1180 int j
, loops
= server
.cronloops
++;
1181 REDIS_NOTUSED(eventLoop
);
1183 REDIS_NOTUSED(clientData
);
1185 /* We take a cached value of the unix time in the global state because
1186 * with virtual memory and aging there is to store the current time
1187 * in objects at every object access, and accuracy is not needed.
1188 * To access a global var is faster than calling time(NULL) */
1189 server
.unixtime
= time(NULL
);
1191 /* Show some info about non-empty databases */
1192 for (j
= 0; j
< server
.dbnum
; j
++) {
1193 long long size
, used
, vkeys
;
1195 size
= dictSlots(server
.db
[j
].dict
);
1196 used
= dictSize(server
.db
[j
].dict
);
1197 vkeys
= dictSize(server
.db
[j
].expires
);
1198 if (!(loops
% 5) && (used
|| vkeys
)) {
1199 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1200 /* dictPrintStats(server.dict); */
1204 /* We don't want to resize the hash tables while a bacground saving
1205 * is in progress: the saving child is created using fork() that is
1206 * implemented with a copy-on-write semantic in most modern systems, so
1207 * if we resize the HT while there is the saving child at work actually
1208 * a lot of memory movements in the parent will cause a lot of pages
1210 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1212 /* Show information about connected clients */
1214 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1215 listLength(server
.clients
)-listLength(server
.slaves
),
1216 listLength(server
.slaves
),
1217 zmalloc_used_memory(),
1218 dictSize(server
.sharingpool
));
1221 /* Close connections of timedout clients */
1222 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1223 closeTimedoutClients();
1225 /* Check if a background saving or AOF rewrite in progress terminated */
1226 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1230 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1231 if (pid
== server
.bgsavechildpid
) {
1232 backgroundSaveDoneHandler(statloc
);
1234 backgroundRewriteDoneHandler(statloc
);
1238 /* If there is not a background saving in progress check if
1239 * we have to save now */
1240 time_t now
= time(NULL
);
1241 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1242 struct saveparam
*sp
= server
.saveparams
+j
;
1244 if (server
.dirty
>= sp
->changes
&&
1245 now
-server
.lastsave
> sp
->seconds
) {
1246 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1247 sp
->changes
, sp
->seconds
);
1248 rdbSaveBackground(server
.dbfilename
);
1254 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1255 * will use few CPU cycles if there are few expiring keys, otherwise
1256 * it will get more aggressive to avoid that too much memory is used by
1257 * keys that can be removed from the keyspace. */
1258 for (j
= 0; j
< server
.dbnum
; j
++) {
1260 redisDb
*db
= server
.db
+j
;
1262 /* Continue to expire if at the end of the cycle more than 25%
1263 * of the keys were expired. */
1265 long num
= dictSize(db
->expires
);
1266 time_t now
= time(NULL
);
1269 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1270 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1275 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1276 t
= (time_t) dictGetEntryVal(de
);
1278 deleteKey(db
,dictGetEntryKey(de
));
1282 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1285 /* Swap a few keys on disk if we are over the memory limit and VM
1286 * is enbled. Try to free objects from the free list first. */
1287 if (vmCanSwapOut()) {
1288 while (server
.vm_enabled
&& zmalloc_used_memory() >
1289 server
.vm_max_memory
)
1293 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1294 retval
= (server
.vm_max_threads
== 0) ?
1295 vmSwapOneObjectBlocking() :
1296 vmSwapOneObjectThreaded();
1297 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1298 zmalloc_used_memory() >
1299 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1301 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1303 /* Note that when using threade I/O we free just one object,
1304 * because anyway when the I/O thread in charge to swap this
1305 * object out will finish, the handler of completed jobs
1306 * will try to swap more objects if we are still out of memory. */
1307 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1311 /* Check if we should connect to a MASTER */
1312 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1313 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1314 if (syncWithMaster() == REDIS_OK
) {
1315 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1321 /* This function gets called every time Redis is entering the
1322 * main loop of the event driven library, that is, before to sleep
1323 * for ready file descriptors. */
1324 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1325 REDIS_NOTUSED(eventLoop
);
1327 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1331 listRewind(server
.io_ready_clients
,&li
);
1332 while((ln
= listNext(&li
))) {
1333 redisClient
*c
= ln
->value
;
1334 struct redisCommand
*cmd
;
1336 /* Resume the client. */
1337 listDelNode(server
.io_ready_clients
,ln
);
1338 c
->flags
&= (~REDIS_IO_WAIT
);
1339 server
.vm_blocked_clients
--;
1340 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1341 readQueryFromClient
, c
);
1342 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1343 assert(cmd
!= NULL
);
1346 /* There may be more data to process in the input buffer. */
1347 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1348 processInputBuffer(c
);
1353 static void createSharedObjects(void) {
1354 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1355 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1356 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1357 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1358 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1359 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1360 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1361 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1362 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1363 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1364 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1365 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1366 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1367 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1368 "-ERR no such key\r\n"));
1369 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1370 "-ERR syntax error\r\n"));
1371 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1372 "-ERR source and destination objects are the same\r\n"));
1373 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1374 "-ERR index out of range\r\n"));
1375 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1376 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1377 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1378 shared
.select0
= createStringObject("select 0\r\n",10);
1379 shared
.select1
= createStringObject("select 1\r\n",10);
1380 shared
.select2
= createStringObject("select 2\r\n",10);
1381 shared
.select3
= createStringObject("select 3\r\n",10);
1382 shared
.select4
= createStringObject("select 4\r\n",10);
1383 shared
.select5
= createStringObject("select 5\r\n",10);
1384 shared
.select6
= createStringObject("select 6\r\n",10);
1385 shared
.select7
= createStringObject("select 7\r\n",10);
1386 shared
.select8
= createStringObject("select 8\r\n",10);
1387 shared
.select9
= createStringObject("select 9\r\n",10);
1390 static void appendServerSaveParams(time_t seconds
, int changes
) {
1391 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1392 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1393 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1394 server
.saveparamslen
++;
1397 static void resetServerSaveParams() {
1398 zfree(server
.saveparams
);
1399 server
.saveparams
= NULL
;
1400 server
.saveparamslen
= 0;
1403 static void initServerConfig() {
1404 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1405 server
.port
= REDIS_SERVERPORT
;
1406 server
.verbosity
= REDIS_VERBOSE
;
1407 server
.maxidletime
= REDIS_MAXIDLETIME
;
1408 server
.saveparams
= NULL
;
1409 server
.logfile
= NULL
; /* NULL = log on standard output */
1410 server
.bindaddr
= NULL
;
1411 server
.glueoutputbuf
= 1;
1412 server
.daemonize
= 0;
1413 server
.appendonly
= 0;
1414 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1415 server
.lastfsync
= time(NULL
);
1416 server
.appendfd
= -1;
1417 server
.appendseldb
= -1; /* Make sure the first time will not match */
1418 server
.pidfile
= "/var/run/redis.pid";
1419 server
.dbfilename
= "dump.rdb";
1420 server
.appendfilename
= "appendonly.aof";
1421 server
.requirepass
= NULL
;
1422 server
.shareobjects
= 0;
1423 server
.rdbcompression
= 1;
1424 server
.sharingpoolsize
= 1024;
1425 server
.maxclients
= 0;
1426 server
.blpop_blocked_clients
= 0;
1427 server
.maxmemory
= 0;
1428 server
.vm_enabled
= 0;
1429 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1430 server
.vm_page_size
= 256; /* 256 bytes per page */
1431 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1432 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1433 server
.vm_max_threads
= 4;
1434 server
.vm_blocked_clients
= 0;
1436 resetServerSaveParams();
1438 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1439 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1440 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1441 /* Replication related */
1443 server
.masterauth
= NULL
;
1444 server
.masterhost
= NULL
;
1445 server
.masterport
= 6379;
1446 server
.master
= NULL
;
1447 server
.replstate
= REDIS_REPL_NONE
;
1449 /* Double constants initialization */
1451 R_PosInf
= 1.0/R_Zero
;
1452 R_NegInf
= -1.0/R_Zero
;
1453 R_Nan
= R_Zero
/R_Zero
;
1456 static void initServer() {
1459 signal(SIGHUP
, SIG_IGN
);
1460 signal(SIGPIPE
, SIG_IGN
);
1461 setupSigSegvAction();
1463 server
.devnull
= fopen("/dev/null","w");
1464 if (server
.devnull
== NULL
) {
1465 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1468 server
.clients
= listCreate();
1469 server
.slaves
= listCreate();
1470 server
.monitors
= listCreate();
1471 server
.objfreelist
= listCreate();
1472 createSharedObjects();
1473 server
.el
= aeCreateEventLoop();
1474 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1475 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1476 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1477 if (server
.fd
== -1) {
1478 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1481 for (j
= 0; j
< server
.dbnum
; j
++) {
1482 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1483 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1484 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1485 if (server
.vm_enabled
)
1486 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1487 server
.db
[j
].id
= j
;
1489 server
.cronloops
= 0;
1490 server
.bgsavechildpid
= -1;
1491 server
.bgrewritechildpid
= -1;
1492 server
.bgrewritebuf
= sdsempty();
1493 server
.lastsave
= time(NULL
);
1495 server
.stat_numcommands
= 0;
1496 server
.stat_numconnections
= 0;
1497 server
.stat_starttime
= time(NULL
);
1498 server
.unixtime
= time(NULL
);
1499 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1500 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1501 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1503 if (server
.appendonly
) {
1504 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1505 if (server
.appendfd
== -1) {
1506 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1512 if (server
.vm_enabled
) vmInit();
1515 /* Empty the whole database */
1516 static long long emptyDb() {
1518 long long removed
= 0;
1520 for (j
= 0; j
< server
.dbnum
; j
++) {
1521 removed
+= dictSize(server
.db
[j
].dict
);
1522 dictEmpty(server
.db
[j
].dict
);
1523 dictEmpty(server
.db
[j
].expires
);
1528 static int yesnotoi(char *s
) {
1529 if (!strcasecmp(s
,"yes")) return 1;
1530 else if (!strcasecmp(s
,"no")) return 0;
1534 /* I agree, this is a very rudimental way to load a configuration...
1535 will improve later if the config gets more complex */
1536 static void loadServerConfig(char *filename
) {
1538 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1542 if (filename
[0] == '-' && filename
[1] == '\0')
1545 if ((fp
= fopen(filename
,"r")) == NULL
) {
1546 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1551 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1557 line
= sdstrim(line
," \t\r\n");
1559 /* Skip comments and blank lines*/
1560 if (line
[0] == '#' || line
[0] == '\0') {
1565 /* Split into arguments */
1566 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1567 sdstolower(argv
[0]);
1569 /* Execute config directives */
1570 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1571 server
.maxidletime
= atoi(argv
[1]);
1572 if (server
.maxidletime
< 0) {
1573 err
= "Invalid timeout value"; goto loaderr
;
1575 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1576 server
.port
= atoi(argv
[1]);
1577 if (server
.port
< 1 || server
.port
> 65535) {
1578 err
= "Invalid port"; goto loaderr
;
1580 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1581 server
.bindaddr
= zstrdup(argv
[1]);
1582 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1583 int seconds
= atoi(argv
[1]);
1584 int changes
= atoi(argv
[2]);
1585 if (seconds
< 1 || changes
< 0) {
1586 err
= "Invalid save parameters"; goto loaderr
;
1588 appendServerSaveParams(seconds
,changes
);
1589 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1590 if (chdir(argv
[1]) == -1) {
1591 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1592 argv
[1], strerror(errno
));
1595 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1596 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1597 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1598 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1599 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1601 err
= "Invalid log level. Must be one of debug, notice, warning";
1604 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1607 server
.logfile
= zstrdup(argv
[1]);
1608 if (!strcasecmp(server
.logfile
,"stdout")) {
1609 zfree(server
.logfile
);
1610 server
.logfile
= NULL
;
1612 if (server
.logfile
) {
1613 /* Test if we are able to open the file. The server will not
1614 * be able to abort just for this problem later... */
1615 logfp
= fopen(server
.logfile
,"a");
1616 if (logfp
== NULL
) {
1617 err
= sdscatprintf(sdsempty(),
1618 "Can't open the log file: %s", strerror(errno
));
1623 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1624 server
.dbnum
= atoi(argv
[1]);
1625 if (server
.dbnum
< 1) {
1626 err
= "Invalid number of databases"; goto loaderr
;
1628 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1629 server
.maxclients
= atoi(argv
[1]);
1630 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1631 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1632 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1633 server
.masterhost
= sdsnew(argv
[1]);
1634 server
.masterport
= atoi(argv
[2]);
1635 server
.replstate
= REDIS_REPL_CONNECT
;
1636 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1637 server
.masterauth
= zstrdup(argv
[1]);
1638 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1639 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1640 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1642 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1643 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1644 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1646 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1647 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1648 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1650 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1651 server
.sharingpoolsize
= atoi(argv
[1]);
1652 if (server
.sharingpoolsize
< 1) {
1653 err
= "invalid object sharing pool size"; goto loaderr
;
1655 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1656 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1657 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1659 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1660 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1661 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1663 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1664 if (!strcasecmp(argv
[1],"no")) {
1665 server
.appendfsync
= APPENDFSYNC_NO
;
1666 } else if (!strcasecmp(argv
[1],"always")) {
1667 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1668 } else if (!strcasecmp(argv
[1],"everysec")) {
1669 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1671 err
= "argument must be 'no', 'always' or 'everysec'";
1674 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1675 server
.requirepass
= zstrdup(argv
[1]);
1676 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1677 server
.pidfile
= zstrdup(argv
[1]);
1678 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1679 server
.dbfilename
= zstrdup(argv
[1]);
1680 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1681 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1682 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1684 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1685 zfree(server
.vm_swap_file
);
1686 server
.vm_swap_file
= zstrdup(argv
[1]);
1687 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1688 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1689 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1690 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1691 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1692 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1693 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1694 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1696 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1698 for (j
= 0; j
< argc
; j
++)
1703 if (fp
!= stdin
) fclose(fp
);
1707 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1708 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1709 fprintf(stderr
, ">>> '%s'\n", line
);
1710 fprintf(stderr
, "%s\n", err
);
1714 static void freeClientArgv(redisClient
*c
) {
1717 for (j
= 0; j
< c
->argc
; j
++)
1718 decrRefCount(c
->argv
[j
]);
1719 for (j
= 0; j
< c
->mbargc
; j
++)
1720 decrRefCount(c
->mbargv
[j
]);
1725 static void freeClient(redisClient
*c
) {
1728 /* Note that if the client we are freeing is blocked into a blocking
1729 * call, we have to set querybuf to NULL *before* to call
1730 * unblockClientWaitingData() to avoid processInputBuffer() will get
1731 * called. Also it is important to remove the file events after
1732 * this, because this call adds the READABLE event. */
1733 sdsfree(c
->querybuf
);
1735 if (c
->flags
& REDIS_BLOCKED
)
1736 unblockClientWaitingData(c
);
1738 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1739 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1740 listRelease(c
->reply
);
1743 /* Remove from the list of clients */
1744 ln
= listSearchKey(server
.clients
,c
);
1745 redisAssert(ln
!= NULL
);
1746 listDelNode(server
.clients
,ln
);
1747 /* Remove from the list of clients waiting for swapped keys */
1748 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1749 ln
= listSearchKey(server
.io_ready_clients
,c
);
1751 listDelNode(server
.io_ready_clients
,ln
);
1752 server
.vm_blocked_clients
--;
1755 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1756 ln
= listFirst(c
->io_keys
);
1757 dontWaitForSwappedKey(c
,ln
->value
);
1759 listRelease(c
->io_keys
);
1761 if (c
->flags
& REDIS_SLAVE
) {
1762 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1764 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1765 ln
= listSearchKey(l
,c
);
1766 redisAssert(ln
!= NULL
);
1769 if (c
->flags
& REDIS_MASTER
) {
1770 server
.master
= NULL
;
1771 server
.replstate
= REDIS_REPL_CONNECT
;
1775 freeClientMultiState(c
);
1779 #define GLUEREPLY_UP_TO (1024)
1780 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1782 char buf
[GLUEREPLY_UP_TO
];
1787 listRewind(c
->reply
,&li
);
1788 while((ln
= listNext(&li
))) {
1792 objlen
= sdslen(o
->ptr
);
1793 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1794 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1796 listDelNode(c
->reply
,ln
);
1798 if (copylen
== 0) return;
1802 /* Now the output buffer is empty, add the new single element */
1803 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1804 listAddNodeHead(c
->reply
,o
);
1807 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1808 redisClient
*c
= privdata
;
1809 int nwritten
= 0, totwritten
= 0, objlen
;
1812 REDIS_NOTUSED(mask
);
1814 /* Use writev() if we have enough buffers to send */
1815 if (!server
.glueoutputbuf
&&
1816 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1817 !(c
->flags
& REDIS_MASTER
))
1819 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1823 while(listLength(c
->reply
)) {
1824 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1825 glueReplyBuffersIfNeeded(c
);
1827 o
= listNodeValue(listFirst(c
->reply
));
1828 objlen
= sdslen(o
->ptr
);
1831 listDelNode(c
->reply
,listFirst(c
->reply
));
1835 if (c
->flags
& REDIS_MASTER
) {
1836 /* Don't reply to a master */
1837 nwritten
= objlen
- c
->sentlen
;
1839 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1840 if (nwritten
<= 0) break;
1842 c
->sentlen
+= nwritten
;
1843 totwritten
+= nwritten
;
1844 /* If we fully sent the object on head go to the next one */
1845 if (c
->sentlen
== objlen
) {
1846 listDelNode(c
->reply
,listFirst(c
->reply
));
1849 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1850 * bytes, in a single threaded server it's a good idea to serve
1851 * other clients as well, even if a very large request comes from
1852 * super fast link that is always able to accept data (in real world
1853 * scenario think about 'KEYS *' against the loopback interfae) */
1854 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1856 if (nwritten
== -1) {
1857 if (errno
== EAGAIN
) {
1860 redisLog(REDIS_VERBOSE
,
1861 "Error writing to client: %s", strerror(errno
));
1866 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1867 if (listLength(c
->reply
) == 0) {
1869 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1873 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1875 redisClient
*c
= privdata
;
1876 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1878 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1879 int offset
, ion
= 0;
1881 REDIS_NOTUSED(mask
);
1884 while (listLength(c
->reply
)) {
1885 offset
= c
->sentlen
;
1889 /* fill-in the iov[] array */
1890 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1891 o
= listNodeValue(node
);
1892 objlen
= sdslen(o
->ptr
);
1894 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1897 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1898 break; /* no more iovecs */
1900 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1901 iov
[ion
].iov_len
= objlen
- offset
;
1902 willwrite
+= objlen
- offset
;
1903 offset
= 0; /* just for the first item */
1910 /* write all collected blocks at once */
1911 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1912 if (errno
!= EAGAIN
) {
1913 redisLog(REDIS_VERBOSE
,
1914 "Error writing to client: %s", strerror(errno
));
1921 totwritten
+= nwritten
;
1922 offset
= c
->sentlen
;
1924 /* remove written robjs from c->reply */
1925 while (nwritten
&& listLength(c
->reply
)) {
1926 o
= listNodeValue(listFirst(c
->reply
));
1927 objlen
= sdslen(o
->ptr
);
1929 if(nwritten
>= objlen
- offset
) {
1930 listDelNode(c
->reply
, listFirst(c
->reply
));
1931 nwritten
-= objlen
- offset
;
1935 c
->sentlen
+= nwritten
;
1943 c
->lastinteraction
= time(NULL
);
1945 if (listLength(c
->reply
) == 0) {
1947 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1951 static struct redisCommand
*lookupCommand(char *name
) {
1953 while(cmdTable
[j
].name
!= NULL
) {
1954 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1960 /* resetClient prepare the client to process the next command */
1961 static void resetClient(redisClient
*c
) {
1967 /* Call() is the core of Redis execution of a command */
1968 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1971 dirty
= server
.dirty
;
1973 if (server
.appendonly
&& server
.dirty
-dirty
)
1974 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1975 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1976 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1977 if (listLength(server
.monitors
))
1978 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1979 server
.stat_numcommands
++;
1982 /* If this function gets called we already read a whole
1983 * command, argments are in the client argv/argc fields.
1984 * processCommand() execute the command or prepare the
1985 * server for a bulk read from the client.
1987 * If 1 is returned the client is still alive and valid and
1988 * and other operations can be performed by the caller. Otherwise
1989 * if 0 is returned the client was destroied (i.e. after QUIT). */
1990 static int processCommand(redisClient
*c
) {
1991 struct redisCommand
*cmd
;
1993 /* Free some memory if needed (maxmemory setting) */
1994 if (server
.maxmemory
) freeMemoryIfNeeded();
1996 /* Handle the multi bulk command type. This is an alternative protocol
1997 * supported by Redis in order to receive commands that are composed of
1998 * multiple binary-safe "bulk" arguments. The latency of processing is
1999 * a bit higher but this allows things like multi-sets, so if this
2000 * protocol is used only for MSET and similar commands this is a big win. */
2001 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2002 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2003 if (c
->multibulk
<= 0) {
2007 decrRefCount(c
->argv
[c
->argc
-1]);
2011 } else if (c
->multibulk
) {
2012 if (c
->bulklen
== -1) {
2013 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2014 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2018 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2019 decrRefCount(c
->argv
[0]);
2020 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2022 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2027 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2031 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2032 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2036 if (c
->multibulk
== 0) {
2040 /* Here we need to swap the multi-bulk argc/argv with the
2041 * normal argc/argv of the client structure. */
2043 c
->argv
= c
->mbargv
;
2044 c
->mbargv
= auxargv
;
2047 c
->argc
= c
->mbargc
;
2048 c
->mbargc
= auxargc
;
2050 /* We need to set bulklen to something different than -1
2051 * in order for the code below to process the command without
2052 * to try to read the last argument of a bulk command as
2053 * a special argument. */
2055 /* continue below and process the command */
2062 /* -- end of multi bulk commands processing -- */
2064 /* The QUIT command is handled as a special case. Normal command
2065 * procs are unable to close the client connection safely */
2066 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2071 /* Now lookup the command and check ASAP about trivial error conditions
2072 * such wrong arity, bad command name and so forth. */
2073 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2076 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2077 (char*)c
->argv
[0]->ptr
));
2080 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2081 (c
->argc
< -cmd
->arity
)) {
2083 sdscatprintf(sdsempty(),
2084 "-ERR wrong number of arguments for '%s' command\r\n",
2088 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2089 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2092 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2093 /* This is a bulk command, we have to read the last argument yet. */
2094 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2096 decrRefCount(c
->argv
[c
->argc
-1]);
2097 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2099 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2104 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2105 /* It is possible that the bulk read is already in the
2106 * buffer. Check this condition and handle it accordingly.
2107 * This is just a fast path, alternative to call processInputBuffer().
2108 * It's a good idea since the code is small and this condition
2109 * happens most of the times. */
2110 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2111 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2113 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2115 /* Otherwise return... there is to read the last argument
2116 * from the socket. */
2120 /* Let's try to share objects on the command arguments vector */
2121 if (server
.shareobjects
) {
2123 for(j
= 1; j
< c
->argc
; j
++)
2124 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2126 /* Let's try to encode the bulk object to save space. */
2127 if (cmd
->flags
& REDIS_CMD_BULK
)
2128 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2130 /* Check if the user is authenticated */
2131 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2132 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2137 /* Exec the command */
2138 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2139 queueMultiCommand(c
,cmd
);
2140 addReply(c
,shared
.queued
);
2142 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2143 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2147 /* Prepare the client for the next command */
2152 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2157 /* (args*2)+1 is enough room for args, spaces, newlines */
2158 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2160 if (argc
<= REDIS_STATIC_ARGS
) {
2163 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2166 for (j
= 0; j
< argc
; j
++) {
2167 if (j
!= 0) outv
[outc
++] = shared
.space
;
2168 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2171 lenobj
= createObject(REDIS_STRING
,
2172 sdscatprintf(sdsempty(),"%lu\r\n",
2173 (unsigned long) stringObjectLen(argv
[j
])));
2174 lenobj
->refcount
= 0;
2175 outv
[outc
++] = lenobj
;
2177 outv
[outc
++] = argv
[j
];
2179 outv
[outc
++] = shared
.crlf
;
2181 /* Increment all the refcounts at start and decrement at end in order to
2182 * be sure to free objects if there is no slave in a replication state
2183 * able to be feed with commands */
2184 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2185 listRewind(slaves
,&li
);
2186 while((ln
= listNext(&li
))) {
2187 redisClient
*slave
= ln
->value
;
2189 /* Don't feed slaves that are still waiting for BGSAVE to start */
2190 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2192 /* Feed all the other slaves, MONITORs and so on */
2193 if (slave
->slaveseldb
!= dictid
) {
2197 case 0: selectcmd
= shared
.select0
; break;
2198 case 1: selectcmd
= shared
.select1
; break;
2199 case 2: selectcmd
= shared
.select2
; break;
2200 case 3: selectcmd
= shared
.select3
; break;
2201 case 4: selectcmd
= shared
.select4
; break;
2202 case 5: selectcmd
= shared
.select5
; break;
2203 case 6: selectcmd
= shared
.select6
; break;
2204 case 7: selectcmd
= shared
.select7
; break;
2205 case 8: selectcmd
= shared
.select8
; break;
2206 case 9: selectcmd
= shared
.select9
; break;
2208 selectcmd
= createObject(REDIS_STRING
,
2209 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2210 selectcmd
->refcount
= 0;
2213 addReply(slave
,selectcmd
);
2214 slave
->slaveseldb
= dictid
;
2216 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2218 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2219 if (outv
!= static_outv
) zfree(outv
);
2222 static void processInputBuffer(redisClient
*c
) {
2224 /* Before to process the input buffer, make sure the client is not
2225 * waitig for a blocking operation such as BLPOP. Note that the first
2226 * iteration the client is never blocked, otherwise the processInputBuffer
2227 * would not be called at all, but after the execution of the first commands
2228 * in the input buffer the client may be blocked, and the "goto again"
2229 * will try to reiterate. The following line will make it return asap. */
2230 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2231 if (c
->bulklen
== -1) {
2232 /* Read the first line of the query */
2233 char *p
= strchr(c
->querybuf
,'\n');
2240 query
= c
->querybuf
;
2241 c
->querybuf
= sdsempty();
2242 querylen
= 1+(p
-(query
));
2243 if (sdslen(query
) > querylen
) {
2244 /* leave data after the first line of the query in the buffer */
2245 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2247 *p
= '\0'; /* remove "\n" */
2248 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2249 sdsupdatelen(query
);
2251 /* Now we can split the query in arguments */
2252 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2255 if (c
->argv
) zfree(c
->argv
);
2256 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2258 for (j
= 0; j
< argc
; j
++) {
2259 if (sdslen(argv
[j
])) {
2260 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2268 /* Execute the command. If the client is still valid
2269 * after processCommand() return and there is something
2270 * on the query buffer try to process the next command. */
2271 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2273 /* Nothing to process, argc == 0. Just process the query
2274 * buffer if it's not empty or return to the caller */
2275 if (sdslen(c
->querybuf
)) goto again
;
2278 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2279 redisLog(REDIS_VERBOSE
, "Client protocol error");
2284 /* Bulk read handling. Note that if we are at this point
2285 the client already sent a command terminated with a newline,
2286 we are reading the bulk data that is actually the last
2287 argument of the command. */
2288 int qbl
= sdslen(c
->querybuf
);
2290 if (c
->bulklen
<= qbl
) {
2291 /* Copy everything but the final CRLF as final argument */
2292 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2294 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2295 /* Process the command. If the client is still valid after
2296 * the processing and there is more data in the buffer
2297 * try to parse it. */
2298 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2304 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2305 redisClient
*c
= (redisClient
*) privdata
;
2306 char buf
[REDIS_IOBUF_LEN
];
2309 REDIS_NOTUSED(mask
);
2311 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2313 if (errno
== EAGAIN
) {
2316 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2320 } else if (nread
== 0) {
2321 redisLog(REDIS_VERBOSE
, "Client closed connection");
2326 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2327 c
->lastinteraction
= time(NULL
);
2331 processInputBuffer(c
);
2334 static int selectDb(redisClient
*c
, int id
) {
2335 if (id
< 0 || id
>= server
.dbnum
)
2337 c
->db
= &server
.db
[id
];
2341 static void *dupClientReplyValue(void *o
) {
2342 incrRefCount((robj
*)o
);
2346 static redisClient
*createClient(int fd
) {
2347 redisClient
*c
= zmalloc(sizeof(*c
));
2349 anetNonBlock(NULL
,fd
);
2350 anetTcpNoDelay(NULL
,fd
);
2351 if (!c
) return NULL
;
2354 c
->querybuf
= sdsempty();
2363 c
->lastinteraction
= time(NULL
);
2364 c
->authenticated
= 0;
2365 c
->replstate
= REDIS_REPL_NONE
;
2366 c
->reply
= listCreate();
2367 listSetFreeMethod(c
->reply
,decrRefCount
);
2368 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2369 c
->blockingkeys
= NULL
;
2370 c
->blockingkeysnum
= 0;
2371 c
->io_keys
= listCreate();
2372 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2373 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2374 readQueryFromClient
, c
) == AE_ERR
) {
2378 listAddNodeTail(server
.clients
,c
);
2379 initClientMultiState(c
);
2383 static void addReply(redisClient
*c
, robj
*obj
) {
2384 if (listLength(c
->reply
) == 0 &&
2385 (c
->replstate
== REDIS_REPL_NONE
||
2386 c
->replstate
== REDIS_REPL_ONLINE
) &&
2387 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2388 sendReplyToClient
, c
) == AE_ERR
) return;
2390 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2391 obj
= dupStringObject(obj
);
2392 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2394 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2397 static void addReplySds(redisClient
*c
, sds s
) {
2398 robj
*o
= createObject(REDIS_STRING
,s
);
2403 static void addReplyDouble(redisClient
*c
, double d
) {
2406 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2407 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2408 (unsigned long) strlen(buf
),buf
));
2411 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2414 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2415 len
= sdslen(obj
->ptr
);
2417 long n
= (long)obj
->ptr
;
2419 /* Compute how many bytes will take this integer as a radix 10 string */
2425 while((n
= n
/10) != 0) {
2429 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2432 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2437 REDIS_NOTUSED(mask
);
2438 REDIS_NOTUSED(privdata
);
2440 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2441 if (cfd
== AE_ERR
) {
2442 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2445 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2446 if ((c
= createClient(cfd
)) == NULL
) {
2447 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2448 close(cfd
); /* May be already closed, just ingore errors */
2451 /* If maxclient directive is set and this is one client more... close the
2452 * connection. Note that we create the client instead to check before
2453 * for this condition, since now the socket is already set in nonblocking
2454 * mode and we can send an error for free using the Kernel I/O */
2455 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2456 char *err
= "-ERR max number of clients reached\r\n";
2458 /* That's a best effort error message, don't check write errors */
2459 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2460 /* Nothing to do, Just to avoid the warning... */
2465 server
.stat_numconnections
++;
2468 /* ======================= Redis objects implementation ===================== */
2470 static robj
*createObject(int type
, void *ptr
) {
2473 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2474 if (listLength(server
.objfreelist
)) {
2475 listNode
*head
= listFirst(server
.objfreelist
);
2476 o
= listNodeValue(head
);
2477 listDelNode(server
.objfreelist
,head
);
2478 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2480 if (server
.vm_enabled
) {
2481 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2482 o
= zmalloc(sizeof(*o
));
2484 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2488 o
->encoding
= REDIS_ENCODING_RAW
;
2491 if (server
.vm_enabled
) {
2492 /* Note that this code may run in the context of an I/O thread
2493 * and accessing to server.unixtime in theory is an error
2494 * (no locks). But in practice this is safe, and even if we read
2495 * garbage Redis will not fail, as it's just a statistical info */
2496 o
->vm
.atime
= server
.unixtime
;
2497 o
->storage
= REDIS_VM_MEMORY
;
2502 static robj
*createStringObject(char *ptr
, size_t len
) {
2503 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2506 static robj
*dupStringObject(robj
*o
) {
2507 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2508 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2511 static robj
*createListObject(void) {
2512 list
*l
= listCreate();
2514 listSetFreeMethod(l
,decrRefCount
);
2515 return createObject(REDIS_LIST
,l
);
2518 static robj
*createSetObject(void) {
2519 dict
*d
= dictCreate(&setDictType
,NULL
);
2520 return createObject(REDIS_SET
,d
);
2523 static robj
*createZsetObject(void) {
2524 zset
*zs
= zmalloc(sizeof(*zs
));
2526 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2527 zs
->zsl
= zslCreate();
2528 return createObject(REDIS_ZSET
,zs
);
2531 static void freeStringObject(robj
*o
) {
2532 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2537 static void freeListObject(robj
*o
) {
2538 listRelease((list
*) o
->ptr
);
2541 static void freeSetObject(robj
*o
) {
2542 dictRelease((dict
*) o
->ptr
);
2545 static void freeZsetObject(robj
*o
) {
2548 dictRelease(zs
->dict
);
2553 static void freeHashObject(robj
*o
) {
2554 dictRelease((dict
*) o
->ptr
);
2557 static void incrRefCount(robj
*o
) {
2558 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2562 static void decrRefCount(void *obj
) {
2565 /* Object is a key of a swapped out value, or in the process of being
2567 if (server
.vm_enabled
&&
2568 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2570 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2571 redisAssert(o
->refcount
== 1);
2573 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2574 redisAssert(o
->type
== REDIS_STRING
);
2575 freeStringObject(o
);
2576 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2577 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2578 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2579 !listAddNodeHead(server
.objfreelist
,o
))
2581 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2582 server
.vm_stats_swapped_objects
--;
2585 /* Object is in memory, or in the process of being swapped out. */
2586 if (--(o
->refcount
) == 0) {
2587 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2588 vmCancelThreadedIOJob(obj
);
2590 case REDIS_STRING
: freeStringObject(o
); break;
2591 case REDIS_LIST
: freeListObject(o
); break;
2592 case REDIS_SET
: freeSetObject(o
); break;
2593 case REDIS_ZSET
: freeZsetObject(o
); break;
2594 case REDIS_HASH
: freeHashObject(o
); break;
2595 default: redisAssert(0 != 0); break;
2597 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2598 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2599 !listAddNodeHead(server
.objfreelist
,o
))
2601 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2605 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2606 dictEntry
*de
= dictFind(db
->dict
,key
);
2608 robj
*key
= dictGetEntryKey(de
);
2609 robj
*val
= dictGetEntryVal(de
);
2611 if (server
.vm_enabled
) {
2612 if (key
->storage
== REDIS_VM_MEMORY
||
2613 key
->storage
== REDIS_VM_SWAPPING
)
2615 /* If we were swapping the object out, stop it, this key
2617 if (key
->storage
== REDIS_VM_SWAPPING
)
2618 vmCancelThreadedIOJob(key
);
2619 /* Update the access time of the key for the aging algorithm. */
2620 key
->vm
.atime
= server
.unixtime
;
2622 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2624 /* Our value was swapped on disk. Bring it at home. */
2625 redisAssert(val
== NULL
);
2626 val
= vmLoadObject(key
);
2627 dictGetEntryVal(de
) = val
;
2629 /* Clients blocked by the VM subsystem may be waiting for
2631 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2640 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2641 expireIfNeeded(db
,key
);
2642 return lookupKey(db
,key
);
2645 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2646 deleteIfVolatile(db
,key
);
2647 return lookupKey(db
,key
);
2650 static int deleteKey(redisDb
*db
, robj
*key
) {
2653 /* We need to protect key from destruction: after the first dictDelete()
2654 * it may happen that 'key' is no longer valid if we don't increment
2655 * it's count. This may happen when we get the object reference directly
2656 * from the hash table with dictRandomKey() or dict iterators */
2658 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2659 retval
= dictDelete(db
->dict
,key
);
2662 return retval
== DICT_OK
;
2665 /* Try to share an object against the shared objects pool */
2666 static robj
*tryObjectSharing(robj
*o
) {
2667 struct dictEntry
*de
;
2670 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2672 redisAssert(o
->type
== REDIS_STRING
);
2673 de
= dictFind(server
.sharingpool
,o
);
2675 robj
*shared
= dictGetEntryKey(de
);
2677 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2678 dictGetEntryVal(de
) = (void*) c
;
2679 incrRefCount(shared
);
2683 /* Here we are using a stream algorihtm: Every time an object is
2684 * shared we increment its count, everytime there is a miss we
2685 * recrement the counter of a random object. If this object reaches
2686 * zero we remove the object and put the current object instead. */
2687 if (dictSize(server
.sharingpool
) >=
2688 server
.sharingpoolsize
) {
2689 de
= dictGetRandomKey(server
.sharingpool
);
2690 redisAssert(de
!= NULL
);
2691 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2692 dictGetEntryVal(de
) = (void*) c
;
2694 dictDelete(server
.sharingpool
,de
->key
);
2697 c
= 0; /* If the pool is empty we want to add this object */
2702 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2703 redisAssert(retval
== DICT_OK
);
2710 /* Check if the nul-terminated string 's' can be represented by a long
2711 * (that is, is a number that fits into long without any other space or
2712 * character before or after the digits).
2714 * If so, the function returns REDIS_OK and *longval is set to the value
2715 * of the number. Otherwise REDIS_ERR is returned */
2716 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2717 char buf
[32], *endptr
;
2721 value
= strtol(s
, &endptr
, 10);
2722 if (endptr
[0] != '\0') return REDIS_ERR
;
2723 slen
= snprintf(buf
,32,"%ld",value
);
2725 /* If the number converted back into a string is not identical
2726 * then it's not possible to encode the string as integer */
2727 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2728 if (longval
) *longval
= value
;
2732 /* Try to encode a string object in order to save space */
2733 static int tryObjectEncoding(robj
*o
) {
2737 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2738 return REDIS_ERR
; /* Already encoded */
2740 /* It's not save to encode shared objects: shared objects can be shared
2741 * everywhere in the "object space" of Redis. Encoded objects can only
2742 * appear as "values" (and not, for instance, as keys) */
2743 if (o
->refcount
> 1) return REDIS_ERR
;
2745 /* Currently we try to encode only strings */
2746 redisAssert(o
->type
== REDIS_STRING
);
2748 /* Check if we can represent this string as a long integer */
2749 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2751 /* Ok, this object can be encoded */
2752 o
->encoding
= REDIS_ENCODING_INT
;
2754 o
->ptr
= (void*) value
;
2758 /* Get a decoded version of an encoded object (returned as a new object).
2759 * If the object is already raw-encoded just increment the ref count. */
2760 static robj
*getDecodedObject(robj
*o
) {
2763 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2767 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2770 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2771 dec
= createStringObject(buf
,strlen(buf
));
2774 redisAssert(1 != 1);
2778 /* Compare two string objects via strcmp() or alike.
2779 * Note that the objects may be integer-encoded. In such a case we
2780 * use snprintf() to get a string representation of the numbers on the stack
2781 * and compare the strings, it's much faster than calling getDecodedObject().
2783 * Important note: if objects are not integer encoded, but binary-safe strings,
2784 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2786 static int compareStringObjects(robj
*a
, robj
*b
) {
2787 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2788 char bufa
[128], bufb
[128], *astr
, *bstr
;
2791 if (a
== b
) return 0;
2792 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2793 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2799 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2800 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2806 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2809 static size_t stringObjectLen(robj
*o
) {
2810 redisAssert(o
->type
== REDIS_STRING
);
2811 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2812 return sdslen(o
->ptr
);
2816 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2820 /*============================ RDB saving/loading =========================== */
2822 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2823 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2827 static int rdbSaveTime(FILE *fp
, time_t t
) {
2828 int32_t t32
= (int32_t) t
;
2829 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2833 /* check rdbLoadLen() comments for more info */
2834 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2835 unsigned char buf
[2];
2838 /* Save a 6 bit len */
2839 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2840 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2841 } else if (len
< (1<<14)) {
2842 /* Save a 14 bit len */
2843 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2845 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2847 /* Save a 32 bit len */
2848 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2849 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2851 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2856 /* String objects in the form "2391" "-100" without any space and with a
2857 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2858 * encoded as integers to save space */
2859 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2861 char *endptr
, buf
[32];
2863 /* Check if it's possible to encode this value as a number */
2864 value
= strtoll(s
, &endptr
, 10);
2865 if (endptr
[0] != '\0') return 0;
2866 snprintf(buf
,32,"%lld",value
);
2868 /* If the number converted back into a string is not identical
2869 * then it's not possible to encode the string as integer */
2870 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2872 /* Finally check if it fits in our ranges */
2873 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2874 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2875 enc
[1] = value
&0xFF;
2877 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2878 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2879 enc
[1] = value
&0xFF;
2880 enc
[2] = (value
>>8)&0xFF;
2882 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2883 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2884 enc
[1] = value
&0xFF;
2885 enc
[2] = (value
>>8)&0xFF;
2886 enc
[3] = (value
>>16)&0xFF;
2887 enc
[4] = (value
>>24)&0xFF;
2894 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2895 unsigned int comprlen
, outlen
;
2899 /* We require at least four bytes compression for this to be worth it */
2900 outlen
= sdslen(obj
->ptr
)-4;
2901 if (outlen
<= 0) return 0;
2902 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2903 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2904 if (comprlen
== 0) {
2908 /* Data compressed! Let's save it on disk */
2909 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2910 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2911 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2912 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2913 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2922 /* Save a string objet as [len][data] on disk. If the object is a string
2923 * representation of an integer value we try to safe it in a special form */
2924 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2928 len
= sdslen(obj
->ptr
);
2930 /* Try integer encoding */
2932 unsigned char buf
[5];
2933 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2934 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2939 /* Try LZF compression - under 20 bytes it's unable to compress even
2940 * aaaaaaaaaaaaaaaaaa so skip it */
2941 if (server
.rdbcompression
&& len
> 20) {
2944 retval
= rdbSaveLzfStringObject(fp
,obj
);
2945 if (retval
== -1) return -1;
2946 if (retval
> 0) return 0;
2947 /* retval == 0 means data can't be compressed, save the old way */
2950 /* Store verbatim */
2951 if (rdbSaveLen(fp
,len
) == -1) return -1;
2952 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2956 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2957 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2960 /* Avoid incr/decr ref count business when possible.
2961 * This plays well with copy-on-write given that we are probably
2962 * in a child process (BGSAVE). Also this makes sure key objects
2963 * of swapped objects are not incRefCount-ed (an assert does not allow
2964 * this in order to avoid bugs) */
2965 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2966 obj
= getDecodedObject(obj
);
2967 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2970 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2975 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2976 * 8 bit integer specifing the length of the representation.
2977 * This 8 bit integer has special values in order to specify the following
2983 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2984 unsigned char buf
[128];
2990 } else if (!isfinite(val
)) {
2992 buf
[0] = (val
< 0) ? 255 : 254;
2994 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2995 buf
[0] = strlen((char*)buf
+1);
2998 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3002 /* Save a Redis object. */
3003 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3004 if (o
->type
== REDIS_STRING
) {
3005 /* Save a string value */
3006 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3007 } else if (o
->type
== REDIS_LIST
) {
3008 /* Save a list value */
3009 list
*list
= o
->ptr
;
3013 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3014 listRewind(list
,&li
);
3015 while((ln
= listNext(&li
))) {
3016 robj
*eleobj
= listNodeValue(ln
);
3018 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3020 } else if (o
->type
== REDIS_SET
) {
3021 /* Save a set value */
3023 dictIterator
*di
= dictGetIterator(set
);
3026 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3027 while((de
= dictNext(di
)) != NULL
) {
3028 robj
*eleobj
= dictGetEntryKey(de
);
3030 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3032 dictReleaseIterator(di
);
3033 } else if (o
->type
== REDIS_ZSET
) {
3034 /* Save a set value */
3036 dictIterator
*di
= dictGetIterator(zs
->dict
);
3039 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3040 while((de
= dictNext(di
)) != NULL
) {
3041 robj
*eleobj
= dictGetEntryKey(de
);
3042 double *score
= dictGetEntryVal(de
);
3044 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3045 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3047 dictReleaseIterator(di
);
3049 redisAssert(0 != 0);
3054 /* Return the length the object will have on disk if saved with
3055 * the rdbSaveObject() function. Currently we use a trick to get
3056 * this length with very little changes to the code. In the future
3057 * we could switch to a faster solution. */
3058 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3059 if (fp
== NULL
) fp
= server
.devnull
;
3061 assert(rdbSaveObject(fp
,o
) != 1);
3065 /* Return the number of pages required to save this object in the swap file */
3066 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3067 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3069 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3072 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3073 static int rdbSave(char *filename
) {
3074 dictIterator
*di
= NULL
;
3079 time_t now
= time(NULL
);
3081 /* Wait for I/O therads to terminate, just in case this is a
3082 * foreground-saving, to avoid seeking the swap file descriptor at the
3084 if (server
.vm_enabled
)
3085 waitEmptyIOJobsQueue();
3087 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3088 fp
= fopen(tmpfile
,"w");
3090 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3093 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3094 for (j
= 0; j
< server
.dbnum
; j
++) {
3095 redisDb
*db
= server
.db
+j
;
3097 if (dictSize(d
) == 0) continue;
3098 di
= dictGetIterator(d
);
3104 /* Write the SELECT DB opcode */
3105 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3106 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3108 /* Iterate this DB writing every entry */
3109 while((de
= dictNext(di
)) != NULL
) {
3110 robj
*key
= dictGetEntryKey(de
);
3111 robj
*o
= dictGetEntryVal(de
);
3112 time_t expiretime
= getExpire(db
,key
);
3114 /* Save the expire time */
3115 if (expiretime
!= -1) {
3116 /* If this key is already expired skip it */
3117 if (expiretime
< now
) continue;
3118 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3119 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3121 /* Save the key and associated value. This requires special
3122 * handling if the value is swapped out. */
3123 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3124 key
->storage
== REDIS_VM_SWAPPING
) {
3125 /* Save type, key, value */
3126 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3127 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3128 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3130 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3132 /* Get a preview of the object in memory */
3133 po
= vmPreviewObject(key
);
3134 /* Save type, key, value */
3135 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3136 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3137 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3138 /* Remove the loaded object from memory */
3142 dictReleaseIterator(di
);
3145 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3147 /* Make sure data will not remain on the OS's output buffers */
3152 /* Use RENAME to make sure the DB file is changed atomically only
3153 * if the generate DB file is ok. */
3154 if (rename(tmpfile
,filename
) == -1) {
3155 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3159 redisLog(REDIS_NOTICE
,"DB saved on disk");
3161 server
.lastsave
= time(NULL
);
3167 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3168 if (di
) dictReleaseIterator(di
);
3172 static int rdbSaveBackground(char *filename
) {
3175 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3176 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3177 if ((childpid
= fork()) == 0) {
3179 if (server
.vm_enabled
) vmReopenSwapFile();
3181 if (rdbSave(filename
) == REDIS_OK
) {
3188 if (childpid
== -1) {
3189 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3193 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3194 server
.bgsavechildpid
= childpid
;
3197 return REDIS_OK
; /* unreached */
3200 static void rdbRemoveTempFile(pid_t childpid
) {
3203 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3207 static int rdbLoadType(FILE *fp
) {
3209 if (fread(&type
,1,1,fp
) == 0) return -1;
3213 static time_t rdbLoadTime(FILE *fp
) {
3215 if (fread(&t32
,4,1,fp
) == 0) return -1;
3216 return (time_t) t32
;
3219 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3220 * of this file for a description of how this are stored on disk.
3222 * isencoded is set to 1 if the readed length is not actually a length but
3223 * an "encoding type", check the above comments for more info */
3224 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3225 unsigned char buf
[2];
3229 if (isencoded
) *isencoded
= 0;
3230 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3231 type
= (buf
[0]&0xC0)>>6;
3232 if (type
== REDIS_RDB_6BITLEN
) {
3233 /* Read a 6 bit len */
3235 } else if (type
== REDIS_RDB_ENCVAL
) {
3236 /* Read a 6 bit len encoding type */
3237 if (isencoded
) *isencoded
= 1;
3239 } else if (type
== REDIS_RDB_14BITLEN
) {
3240 /* Read a 14 bit len */
3241 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3242 return ((buf
[0]&0x3F)<<8)|buf
[1];
3244 /* Read a 32 bit len */
3245 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3250 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3251 unsigned char enc
[4];
3254 if (enctype
== REDIS_RDB_ENC_INT8
) {
3255 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3256 val
= (signed char)enc
[0];
3257 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3259 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3260 v
= enc
[0]|(enc
[1]<<8);
3262 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3264 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3265 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3268 val
= 0; /* anti-warning */
3271 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3274 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3275 unsigned int len
, clen
;
3276 unsigned char *c
= NULL
;
3279 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3280 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3281 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3282 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3283 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3284 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3286 return createObject(REDIS_STRING
,val
);
3293 static robj
*rdbLoadStringObject(FILE*fp
) {
3298 len
= rdbLoadLen(fp
,&isencoded
);
3301 case REDIS_RDB_ENC_INT8
:
3302 case REDIS_RDB_ENC_INT16
:
3303 case REDIS_RDB_ENC_INT32
:
3304 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3305 case REDIS_RDB_ENC_LZF
:
3306 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3312 if (len
== REDIS_RDB_LENERR
) return NULL
;
3313 val
= sdsnewlen(NULL
,len
);
3314 if (len
&& fread(val
,len
,1,fp
) == 0) {
3318 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3321 /* For information about double serialization check rdbSaveDoubleValue() */
3322 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3326 if (fread(&len
,1,1,fp
) == 0) return -1;
3328 case 255: *val
= R_NegInf
; return 0;
3329 case 254: *val
= R_PosInf
; return 0;
3330 case 253: *val
= R_Nan
; return 0;
3332 if (fread(buf
,len
,1,fp
) == 0) return -1;
3334 sscanf(buf
, "%lg", val
);
3339 /* Load a Redis object of the specified type from the specified file.
3340 * On success a newly allocated object is returned, otherwise NULL. */
3341 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3344 if (type
== REDIS_STRING
) {
3345 /* Read string value */
3346 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3347 tryObjectEncoding(o
);
3348 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3349 /* Read list/set value */
3352 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3353 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3354 /* It's faster to expand the dict to the right size asap in order
3355 * to avoid rehashing */
3356 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3357 dictExpand(o
->ptr
,listlen
);
3358 /* Load every single element of the list/set */
3362 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3363 tryObjectEncoding(ele
);
3364 if (type
== REDIS_LIST
) {
3365 listAddNodeTail((list
*)o
->ptr
,ele
);
3367 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3370 } else if (type
== REDIS_ZSET
) {
3371 /* Read list/set value */
3375 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3376 o
= createZsetObject();
3378 /* Load every single element of the list/set */
3381 double *score
= zmalloc(sizeof(double));
3383 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3384 tryObjectEncoding(ele
);
3385 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3386 dictAdd(zs
->dict
,ele
,score
);
3387 zslInsert(zs
->zsl
,*score
,ele
);
3388 incrRefCount(ele
); /* added to skiplist */
3391 redisAssert(0 != 0);
3396 static int rdbLoad(char *filename
) {
3398 robj
*keyobj
= NULL
;
3400 int type
, retval
, rdbver
;
3401 dict
*d
= server
.db
[0].dict
;
3402 redisDb
*db
= server
.db
+0;
3404 time_t expiretime
= -1, now
= time(NULL
);
3405 long long loadedkeys
= 0;
3407 fp
= fopen(filename
,"r");
3408 if (!fp
) return REDIS_ERR
;
3409 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3411 if (memcmp(buf
,"REDIS",5) != 0) {
3413 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3416 rdbver
= atoi(buf
+5);
3419 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3426 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3427 if (type
== REDIS_EXPIRETIME
) {
3428 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3429 /* We read the time so we need to read the object type again */
3430 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3432 if (type
== REDIS_EOF
) break;
3433 /* Handle SELECT DB opcode as a special case */
3434 if (type
== REDIS_SELECTDB
) {
3435 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3437 if (dbid
>= (unsigned)server
.dbnum
) {
3438 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3441 db
= server
.db
+dbid
;
3446 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3448 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3449 /* Add the new object in the hash table */
3450 retval
= dictAdd(d
,keyobj
,o
);
3451 if (retval
== DICT_ERR
) {
3452 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3455 /* Set the expire time if needed */
3456 if (expiretime
!= -1) {
3457 setExpire(db
,keyobj
,expiretime
);
3458 /* Delete this key if already expired */
3459 if (expiretime
< now
) deleteKey(db
,keyobj
);
3463 /* Handle swapping while loading big datasets when VM is on */
3465 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3466 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3467 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3474 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3475 if (keyobj
) decrRefCount(keyobj
);
3476 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3478 return REDIS_ERR
; /* Just to avoid warning */
3481 /*================================== Commands =============================== */
3483 static void authCommand(redisClient
*c
) {
3484 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3485 c
->authenticated
= 1;
3486 addReply(c
,shared
.ok
);
3488 c
->authenticated
= 0;
3489 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3493 static void pingCommand(redisClient
*c
) {
3494 addReply(c
,shared
.pong
);
3497 static void echoCommand(redisClient
*c
) {
3498 addReplyBulkLen(c
,c
->argv
[1]);
3499 addReply(c
,c
->argv
[1]);
3500 addReply(c
,shared
.crlf
);
3503 /*=================================== Strings =============================== */
3505 static void setGenericCommand(redisClient
*c
, int nx
) {
3508 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3509 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3510 if (retval
== DICT_ERR
) {
3512 /* If the key is about a swapped value, we want a new key object
3513 * to overwrite the old. So we delete the old key in the database.
3514 * This will also make sure that swap pages about the old object
3515 * will be marked as free. */
3516 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3517 incrRefCount(c
->argv
[1]);
3518 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3519 incrRefCount(c
->argv
[2]);
3521 addReply(c
,shared
.czero
);
3525 incrRefCount(c
->argv
[1]);
3526 incrRefCount(c
->argv
[2]);
3529 removeExpire(c
->db
,c
->argv
[1]);
3530 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3533 static void setCommand(redisClient
*c
) {
3534 setGenericCommand(c
,0);
3537 static void setnxCommand(redisClient
*c
) {
3538 setGenericCommand(c
,1);
3541 static int getGenericCommand(redisClient
*c
) {
3542 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3545 addReply(c
,shared
.nullbulk
);
3548 if (o
->type
!= REDIS_STRING
) {
3549 addReply(c
,shared
.wrongtypeerr
);
3552 addReplyBulkLen(c
,o
);
3554 addReply(c
,shared
.crlf
);
3560 static void getCommand(redisClient
*c
) {
3561 getGenericCommand(c
);
3564 static void getsetCommand(redisClient
*c
) {
3565 if (getGenericCommand(c
) == REDIS_ERR
) return;
3566 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3567 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3569 incrRefCount(c
->argv
[1]);
3571 incrRefCount(c
->argv
[2]);
3573 removeExpire(c
->db
,c
->argv
[1]);
3576 static void mgetCommand(redisClient
*c
) {
3579 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3580 for (j
= 1; j
< c
->argc
; j
++) {
3581 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3583 addReply(c
,shared
.nullbulk
);
3585 if (o
->type
!= REDIS_STRING
) {
3586 addReply(c
,shared
.nullbulk
);
3588 addReplyBulkLen(c
,o
);
3590 addReply(c
,shared
.crlf
);
3596 static void msetGenericCommand(redisClient
*c
, int nx
) {
3597 int j
, busykeys
= 0;
3599 if ((c
->argc
% 2) == 0) {
3600 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3603 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3604 * set nothing at all if at least one already key exists. */
3606 for (j
= 1; j
< c
->argc
; j
+= 2) {
3607 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3613 addReply(c
, shared
.czero
);
3617 for (j
= 1; j
< c
->argc
; j
+= 2) {
3620 tryObjectEncoding(c
->argv
[j
+1]);
3621 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3622 if (retval
== DICT_ERR
) {
3623 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3624 incrRefCount(c
->argv
[j
+1]);
3626 incrRefCount(c
->argv
[j
]);
3627 incrRefCount(c
->argv
[j
+1]);
3629 removeExpire(c
->db
,c
->argv
[j
]);
3631 server
.dirty
+= (c
->argc
-1)/2;
3632 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3635 static void msetCommand(redisClient
*c
) {
3636 msetGenericCommand(c
,0);
3639 static void msetnxCommand(redisClient
*c
) {
3640 msetGenericCommand(c
,1);
3643 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3648 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3652 if (o
->type
!= REDIS_STRING
) {
3657 if (o
->encoding
== REDIS_ENCODING_RAW
)
3658 value
= strtoll(o
->ptr
, &eptr
, 10);
3659 else if (o
->encoding
== REDIS_ENCODING_INT
)
3660 value
= (long)o
->ptr
;
3662 redisAssert(1 != 1);
3667 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3668 tryObjectEncoding(o
);
3669 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3670 if (retval
== DICT_ERR
) {
3671 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3672 removeExpire(c
->db
,c
->argv
[1]);
3674 incrRefCount(c
->argv
[1]);
3677 addReply(c
,shared
.colon
);
3679 addReply(c
,shared
.crlf
);
3682 static void incrCommand(redisClient
*c
) {
3683 incrDecrCommand(c
,1);
3686 static void decrCommand(redisClient
*c
) {
3687 incrDecrCommand(c
,-1);
3690 static void incrbyCommand(redisClient
*c
) {
3691 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3692 incrDecrCommand(c
,incr
);
3695 static void decrbyCommand(redisClient
*c
) {
3696 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3697 incrDecrCommand(c
,-incr
);
3700 static void appendCommand(redisClient
*c
) {
3705 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3707 /* Create the key */
3708 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3709 incrRefCount(c
->argv
[1]);
3710 incrRefCount(c
->argv
[2]);
3711 totlen
= stringObjectLen(c
->argv
[2]);
3715 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3718 o
= dictGetEntryVal(de
);
3719 if (o
->type
!= REDIS_STRING
) {
3720 addReply(c
,shared
.wrongtypeerr
);
3723 /* If the object is specially encoded or shared we have to make
3725 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3726 robj
*decoded
= getDecodedObject(o
);
3728 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3729 decrRefCount(decoded
);
3730 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3733 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3734 o
->ptr
= sdscatlen(o
->ptr
,
3735 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3737 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3738 (unsigned long) c
->argv
[2]->ptr
);
3740 totlen
= sdslen(o
->ptr
);
3743 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3746 /* ========================= Type agnostic commands ========================= */
3748 static void delCommand(redisClient
*c
) {
3751 for (j
= 1; j
< c
->argc
; j
++) {
3752 if (deleteKey(c
->db
,c
->argv
[j
])) {
3759 addReply(c
,shared
.czero
);
3762 addReply(c
,shared
.cone
);
3765 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3770 static void existsCommand(redisClient
*c
) {
3771 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3774 static void selectCommand(redisClient
*c
) {
3775 int id
= atoi(c
->argv
[1]->ptr
);
3777 if (selectDb(c
,id
) == REDIS_ERR
) {
3778 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3780 addReply(c
,shared
.ok
);
3784 static void randomkeyCommand(redisClient
*c
) {
3788 de
= dictGetRandomKey(c
->db
->dict
);
3789 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3792 addReply(c
,shared
.plus
);
3793 addReply(c
,shared
.crlf
);
3795 addReply(c
,shared
.plus
);
3796 addReply(c
,dictGetEntryKey(de
));
3797 addReply(c
,shared
.crlf
);
3801 static void keysCommand(redisClient
*c
) {
3804 sds pattern
= c
->argv
[1]->ptr
;
3805 int plen
= sdslen(pattern
);
3806 unsigned long numkeys
= 0, keyslen
= 0;
3807 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3809 di
= dictGetIterator(c
->db
->dict
);
3811 decrRefCount(lenobj
);
3812 while((de
= dictNext(di
)) != NULL
) {
3813 robj
*keyobj
= dictGetEntryKey(de
);
3815 sds key
= keyobj
->ptr
;
3816 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3817 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3818 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3820 addReply(c
,shared
.space
);
3823 keyslen
+= sdslen(key
);
3827 dictReleaseIterator(di
);
3828 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3829 addReply(c
,shared
.crlf
);
3832 static void dbsizeCommand(redisClient
*c
) {
3834 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3837 static void lastsaveCommand(redisClient
*c
) {
3839 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3842 static void typeCommand(redisClient
*c
) {
3846 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3851 case REDIS_STRING
: type
= "+string"; break;
3852 case REDIS_LIST
: type
= "+list"; break;
3853 case REDIS_SET
: type
= "+set"; break;
3854 case REDIS_ZSET
: type
= "+zset"; break;
3855 default: type
= "unknown"; break;
3858 addReplySds(c
,sdsnew(type
));
3859 addReply(c
,shared
.crlf
);
3862 static void saveCommand(redisClient
*c
) {
3863 if (server
.bgsavechildpid
!= -1) {
3864 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3867 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3868 addReply(c
,shared
.ok
);
3870 addReply(c
,shared
.err
);
3874 static void bgsaveCommand(redisClient
*c
) {
3875 if (server
.bgsavechildpid
!= -1) {
3876 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3879 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3880 char *status
= "+Background saving started\r\n";
3881 addReplySds(c
,sdsnew(status
));
3883 addReply(c
,shared
.err
);
3887 static void shutdownCommand(redisClient
*c
) {
3888 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3889 /* Kill the saving child if there is a background saving in progress.
3890 We want to avoid race conditions, for instance our saving child may
3891 overwrite the synchronous saving did by SHUTDOWN. */
3892 if (server
.bgsavechildpid
!= -1) {
3893 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3894 kill(server
.bgsavechildpid
,SIGKILL
);
3895 rdbRemoveTempFile(server
.bgsavechildpid
);
3897 if (server
.appendonly
) {
3898 /* Append only file: fsync() the AOF and exit */
3899 fsync(server
.appendfd
);
3900 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3903 /* Snapshotting. Perform a SYNC SAVE and exit */
3904 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3905 if (server
.daemonize
)
3906 unlink(server
.pidfile
);
3907 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3908 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3909 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3912 /* Ooops.. error saving! The best we can do is to continue operating.
3913 * Note that if there was a background saving process, in the next
3914 * cron() Redis will be notified that the background saving aborted,
3915 * handling special stuff like slaves pending for synchronization... */
3916 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3917 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3922 static void renameGenericCommand(redisClient
*c
, int nx
) {
3925 /* To use the same key as src and dst is probably an error */
3926 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3927 addReply(c
,shared
.sameobjecterr
);
3931 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3933 addReply(c
,shared
.nokeyerr
);
3937 deleteIfVolatile(c
->db
,c
->argv
[2]);
3938 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3941 addReply(c
,shared
.czero
);
3944 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3946 incrRefCount(c
->argv
[2]);
3948 deleteKey(c
->db
,c
->argv
[1]);
3950 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3953 static void renameCommand(redisClient
*c
) {
3954 renameGenericCommand(c
,0);
3957 static void renamenxCommand(redisClient
*c
) {
3958 renameGenericCommand(c
,1);
3961 static void moveCommand(redisClient
*c
) {
3966 /* Obtain source and target DB pointers */
3969 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3970 addReply(c
,shared
.outofrangeerr
);
3974 selectDb(c
,srcid
); /* Back to the source DB */
3976 /* If the user is moving using as target the same
3977 * DB as the source DB it is probably an error. */
3979 addReply(c
,shared
.sameobjecterr
);
3983 /* Check if the element exists and get a reference */
3984 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3986 addReply(c
,shared
.czero
);
3990 /* Try to add the element to the target DB */
3991 deleteIfVolatile(dst
,c
->argv
[1]);
3992 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3993 addReply(c
,shared
.czero
);
3996 incrRefCount(c
->argv
[1]);
3999 /* OK! key moved, free the entry in the source DB */
4000 deleteKey(src
,c
->argv
[1]);
4002 addReply(c
,shared
.cone
);
4005 /* =================================== Lists ================================ */
4006 static void pushGenericCommand(redisClient
*c
, int where
) {
4010 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4012 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4013 addReply(c
,shared
.ok
);
4016 lobj
= createListObject();
4018 if (where
== REDIS_HEAD
) {
4019 listAddNodeHead(list
,c
->argv
[2]);
4021 listAddNodeTail(list
,c
->argv
[2]);
4023 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4024 incrRefCount(c
->argv
[1]);
4025 incrRefCount(c
->argv
[2]);
4027 if (lobj
->type
!= REDIS_LIST
) {
4028 addReply(c
,shared
.wrongtypeerr
);
4031 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4032 addReply(c
,shared
.ok
);
4036 if (where
== REDIS_HEAD
) {
4037 listAddNodeHead(list
,c
->argv
[2]);
4039 listAddNodeTail(list
,c
->argv
[2]);
4041 incrRefCount(c
->argv
[2]);
4044 addReply(c
,shared
.ok
);
4047 static void lpushCommand(redisClient
*c
) {
4048 pushGenericCommand(c
,REDIS_HEAD
);
4051 static void rpushCommand(redisClient
*c
) {
4052 pushGenericCommand(c
,REDIS_TAIL
);
4055 static void llenCommand(redisClient
*c
) {
4059 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4061 addReply(c
,shared
.czero
);
4064 if (o
->type
!= REDIS_LIST
) {
4065 addReply(c
,shared
.wrongtypeerr
);
4068 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4073 static void lindexCommand(redisClient
*c
) {
4075 int index
= atoi(c
->argv
[2]->ptr
);
4077 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4079 addReply(c
,shared
.nullbulk
);
4081 if (o
->type
!= REDIS_LIST
) {
4082 addReply(c
,shared
.wrongtypeerr
);
4084 list
*list
= o
->ptr
;
4087 ln
= listIndex(list
, index
);
4089 addReply(c
,shared
.nullbulk
);
4091 robj
*ele
= listNodeValue(ln
);
4092 addReplyBulkLen(c
,ele
);
4094 addReply(c
,shared
.crlf
);
4100 static void lsetCommand(redisClient
*c
) {
4102 int index
= atoi(c
->argv
[2]->ptr
);
4104 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4106 addReply(c
,shared
.nokeyerr
);
4108 if (o
->type
!= REDIS_LIST
) {
4109 addReply(c
,shared
.wrongtypeerr
);
4111 list
*list
= o
->ptr
;
4114 ln
= listIndex(list
, index
);
4116 addReply(c
,shared
.outofrangeerr
);
4118 robj
*ele
= listNodeValue(ln
);
4121 listNodeValue(ln
) = c
->argv
[3];
4122 incrRefCount(c
->argv
[3]);
4123 addReply(c
,shared
.ok
);
4130 static void popGenericCommand(redisClient
*c
, int where
) {
4133 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4135 addReply(c
,shared
.nullbulk
);
4137 if (o
->type
!= REDIS_LIST
) {
4138 addReply(c
,shared
.wrongtypeerr
);
4140 list
*list
= o
->ptr
;
4143 if (where
== REDIS_HEAD
)
4144 ln
= listFirst(list
);
4146 ln
= listLast(list
);
4149 addReply(c
,shared
.nullbulk
);
4151 robj
*ele
= listNodeValue(ln
);
4152 addReplyBulkLen(c
,ele
);
4154 addReply(c
,shared
.crlf
);
4155 listDelNode(list
,ln
);
4162 static void lpopCommand(redisClient
*c
) {
4163 popGenericCommand(c
,REDIS_HEAD
);
4166 static void rpopCommand(redisClient
*c
) {
4167 popGenericCommand(c
,REDIS_TAIL
);
4170 static void lrangeCommand(redisClient
*c
) {
4172 int start
= atoi(c
->argv
[2]->ptr
);
4173 int end
= atoi(c
->argv
[3]->ptr
);
4175 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4177 addReply(c
,shared
.nullmultibulk
);
4179 if (o
->type
!= REDIS_LIST
) {
4180 addReply(c
,shared
.wrongtypeerr
);
4182 list
*list
= o
->ptr
;
4184 int llen
= listLength(list
);
4188 /* convert negative indexes */
4189 if (start
< 0) start
= llen
+start
;
4190 if (end
< 0) end
= llen
+end
;
4191 if (start
< 0) start
= 0;
4192 if (end
< 0) end
= 0;
4194 /* indexes sanity checks */
4195 if (start
> end
|| start
>= llen
) {
4196 /* Out of range start or start > end result in empty list */
4197 addReply(c
,shared
.emptymultibulk
);
4200 if (end
>= llen
) end
= llen
-1;
4201 rangelen
= (end
-start
)+1;
4203 /* Return the result in form of a multi-bulk reply */
4204 ln
= listIndex(list
, start
);
4205 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4206 for (j
= 0; j
< rangelen
; j
++) {
4207 ele
= listNodeValue(ln
);
4208 addReplyBulkLen(c
,ele
);
4210 addReply(c
,shared
.crlf
);
4217 static void ltrimCommand(redisClient
*c
) {
4219 int start
= atoi(c
->argv
[2]->ptr
);
4220 int end
= atoi(c
->argv
[3]->ptr
);
4222 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4224 addReply(c
,shared
.ok
);
4226 if (o
->type
!= REDIS_LIST
) {
4227 addReply(c
,shared
.wrongtypeerr
);
4229 list
*list
= o
->ptr
;
4231 int llen
= listLength(list
);
4232 int j
, ltrim
, rtrim
;
4234 /* convert negative indexes */
4235 if (start
< 0) start
= llen
+start
;
4236 if (end
< 0) end
= llen
+end
;
4237 if (start
< 0) start
= 0;
4238 if (end
< 0) end
= 0;
4240 /* indexes sanity checks */
4241 if (start
> end
|| start
>= llen
) {
4242 /* Out of range start or start > end result in empty list */
4246 if (end
>= llen
) end
= llen
-1;
4251 /* Remove list elements to perform the trim */
4252 for (j
= 0; j
< ltrim
; j
++) {
4253 ln
= listFirst(list
);
4254 listDelNode(list
,ln
);
4256 for (j
= 0; j
< rtrim
; j
++) {
4257 ln
= listLast(list
);
4258 listDelNode(list
,ln
);
4261 addReply(c
,shared
.ok
);
4266 static void lremCommand(redisClient
*c
) {
4269 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4271 addReply(c
,shared
.czero
);
4273 if (o
->type
!= REDIS_LIST
) {
4274 addReply(c
,shared
.wrongtypeerr
);
4276 list
*list
= o
->ptr
;
4277 listNode
*ln
, *next
;
4278 int toremove
= atoi(c
->argv
[2]->ptr
);
4283 toremove
= -toremove
;
4286 ln
= fromtail
? list
->tail
: list
->head
;
4288 robj
*ele
= listNodeValue(ln
);
4290 next
= fromtail
? ln
->prev
: ln
->next
;
4291 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4292 listDelNode(list
,ln
);
4295 if (toremove
&& removed
== toremove
) break;
4299 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4304 /* This is the semantic of this command:
4305 * RPOPLPUSH srclist dstlist:
4306 * IF LLEN(srclist) > 0
4307 * element = RPOP srclist
4308 * LPUSH dstlist element
4315 * The idea is to be able to get an element from a list in a reliable way
4316 * since the element is not just returned but pushed against another list
4317 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4319 static void rpoplpushcommand(redisClient
*c
) {
4322 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4324 addReply(c
,shared
.nullbulk
);
4326 if (sobj
->type
!= REDIS_LIST
) {
4327 addReply(c
,shared
.wrongtypeerr
);
4329 list
*srclist
= sobj
->ptr
;
4330 listNode
*ln
= listLast(srclist
);
4333 addReply(c
,shared
.nullbulk
);
4335 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4336 robj
*ele
= listNodeValue(ln
);
4339 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4340 addReply(c
,shared
.wrongtypeerr
);
4344 /* Add the element to the target list (unless it's directly
4345 * passed to some BLPOP-ing client */
4346 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4348 /* Create the list if the key does not exist */
4349 dobj
= createListObject();
4350 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4351 incrRefCount(c
->argv
[2]);
4353 dstlist
= dobj
->ptr
;
4354 listAddNodeHead(dstlist
,ele
);
4358 /* Send the element to the client as reply as well */
4359 addReplyBulkLen(c
,ele
);
4361 addReply(c
,shared
.crlf
);
4363 /* Finally remove the element from the source list */
4364 listDelNode(srclist
,ln
);
4372 /* ==================================== Sets ================================ */
4374 static void saddCommand(redisClient
*c
) {
4377 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4379 set
= createSetObject();
4380 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4381 incrRefCount(c
->argv
[1]);
4383 if (set
->type
!= REDIS_SET
) {
4384 addReply(c
,shared
.wrongtypeerr
);
4388 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4389 incrRefCount(c
->argv
[2]);
4391 addReply(c
,shared
.cone
);
4393 addReply(c
,shared
.czero
);
4397 static void sremCommand(redisClient
*c
) {
4400 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4402 addReply(c
,shared
.czero
);
4404 if (set
->type
!= REDIS_SET
) {
4405 addReply(c
,shared
.wrongtypeerr
);
4408 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4410 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4411 addReply(c
,shared
.cone
);
4413 addReply(c
,shared
.czero
);
4418 static void smoveCommand(redisClient
*c
) {
4419 robj
*srcset
, *dstset
;
4421 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4422 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4424 /* If the source key does not exist return 0, if it's of the wrong type
4426 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4427 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4430 /* Error if the destination key is not a set as well */
4431 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4432 addReply(c
,shared
.wrongtypeerr
);
4435 /* Remove the element from the source set */
4436 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4437 /* Key not found in the src set! return zero */
4438 addReply(c
,shared
.czero
);
4442 /* Add the element to the destination set */
4444 dstset
= createSetObject();
4445 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4446 incrRefCount(c
->argv
[2]);
4448 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4449 incrRefCount(c
->argv
[3]);
4450 addReply(c
,shared
.cone
);
4453 static void sismemberCommand(redisClient
*c
) {
4456 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4458 addReply(c
,shared
.czero
);
4460 if (set
->type
!= REDIS_SET
) {
4461 addReply(c
,shared
.wrongtypeerr
);
4464 if (dictFind(set
->ptr
,c
->argv
[2]))
4465 addReply(c
,shared
.cone
);
4467 addReply(c
,shared
.czero
);
4471 static void scardCommand(redisClient
*c
) {
4475 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4477 addReply(c
,shared
.czero
);
4480 if (o
->type
!= REDIS_SET
) {
4481 addReply(c
,shared
.wrongtypeerr
);
4484 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4490 static void spopCommand(redisClient
*c
) {
4494 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4496 addReply(c
,shared
.nullbulk
);
4498 if (set
->type
!= REDIS_SET
) {
4499 addReply(c
,shared
.wrongtypeerr
);
4502 de
= dictGetRandomKey(set
->ptr
);
4504 addReply(c
,shared
.nullbulk
);
4506 robj
*ele
= dictGetEntryKey(de
);
4508 addReplyBulkLen(c
,ele
);
4510 addReply(c
,shared
.crlf
);
4511 dictDelete(set
->ptr
,ele
);
4512 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4518 static void srandmemberCommand(redisClient
*c
) {
4522 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4524 addReply(c
,shared
.nullbulk
);
4526 if (set
->type
!= REDIS_SET
) {
4527 addReply(c
,shared
.wrongtypeerr
);
4530 de
= dictGetRandomKey(set
->ptr
);
4532 addReply(c
,shared
.nullbulk
);
4534 robj
*ele
= dictGetEntryKey(de
);
4536 addReplyBulkLen(c
,ele
);
4538 addReply(c
,shared
.crlf
);
4543 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4544 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4546 return dictSize(*d1
)-dictSize(*d2
);
4549 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4550 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4553 robj
*lenobj
= NULL
, *dstset
= NULL
;
4554 unsigned long j
, cardinality
= 0;
4556 for (j
= 0; j
< setsnum
; j
++) {
4560 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4561 lookupKeyRead(c
->db
,setskeys
[j
]);
4565 if (deleteKey(c
->db
,dstkey
))
4567 addReply(c
,shared
.czero
);
4569 addReply(c
,shared
.nullmultibulk
);
4573 if (setobj
->type
!= REDIS_SET
) {
4575 addReply(c
,shared
.wrongtypeerr
);
4578 dv
[j
] = setobj
->ptr
;
4580 /* Sort sets from the smallest to largest, this will improve our
4581 * algorithm's performace */
4582 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4584 /* The first thing we should output is the total number of elements...
4585 * since this is a multi-bulk write, but at this stage we don't know
4586 * the intersection set size, so we use a trick, append an empty object
4587 * to the output list and save the pointer to later modify it with the
4590 lenobj
= createObject(REDIS_STRING
,NULL
);
4592 decrRefCount(lenobj
);
4594 /* If we have a target key where to store the resulting set
4595 * create this key with an empty set inside */
4596 dstset
= createSetObject();
4599 /* Iterate all the elements of the first (smallest) set, and test
4600 * the element against all the other sets, if at least one set does
4601 * not include the element it is discarded */
4602 di
= dictGetIterator(dv
[0]);
4604 while((de
= dictNext(di
)) != NULL
) {
4607 for (j
= 1; j
< setsnum
; j
++)
4608 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4610 continue; /* at least one set does not contain the member */
4611 ele
= dictGetEntryKey(de
);
4613 addReplyBulkLen(c
,ele
);
4615 addReply(c
,shared
.crlf
);
4618 dictAdd(dstset
->ptr
,ele
,NULL
);
4622 dictReleaseIterator(di
);
4625 /* Store the resulting set into the target */
4626 deleteKey(c
->db
,dstkey
);
4627 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4628 incrRefCount(dstkey
);
4632 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4634 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4635 dictSize((dict
*)dstset
->ptr
)));
4641 static void sinterCommand(redisClient
*c
) {
4642 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4645 static void sinterstoreCommand(redisClient
*c
) {
4646 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4649 #define REDIS_OP_UNION 0
4650 #define REDIS_OP_DIFF 1
4652 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4653 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4656 robj
*dstset
= NULL
;
4657 int j
, cardinality
= 0;
4659 for (j
= 0; j
< setsnum
; j
++) {
4663 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4664 lookupKeyRead(c
->db
,setskeys
[j
]);
4669 if (setobj
->type
!= REDIS_SET
) {
4671 addReply(c
,shared
.wrongtypeerr
);
4674 dv
[j
] = setobj
->ptr
;
4677 /* We need a temp set object to store our union. If the dstkey
4678 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4679 * this set object will be the resulting object to set into the target key*/
4680 dstset
= createSetObject();
4682 /* Iterate all the elements of all the sets, add every element a single
4683 * time to the result set */
4684 for (j
= 0; j
< setsnum
; j
++) {
4685 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4686 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4688 di
= dictGetIterator(dv
[j
]);
4690 while((de
= dictNext(di
)) != NULL
) {
4693 /* dictAdd will not add the same element multiple times */
4694 ele
= dictGetEntryKey(de
);
4695 if (op
== REDIS_OP_UNION
|| j
== 0) {
4696 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4700 } else if (op
== REDIS_OP_DIFF
) {
4701 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4706 dictReleaseIterator(di
);
4708 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4711 /* Output the content of the resulting set, if not in STORE mode */
4713 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4714 di
= dictGetIterator(dstset
->ptr
);
4715 while((de
= dictNext(di
)) != NULL
) {
4718 ele
= dictGetEntryKey(de
);
4719 addReplyBulkLen(c
,ele
);
4721 addReply(c
,shared
.crlf
);
4723 dictReleaseIterator(di
);
4725 /* If we have a target key where to store the resulting set
4726 * create this key with the result set inside */
4727 deleteKey(c
->db
,dstkey
);
4728 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4729 incrRefCount(dstkey
);
4734 decrRefCount(dstset
);
4736 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4737 dictSize((dict
*)dstset
->ptr
)));
4743 static void sunionCommand(redisClient
*c
) {
4744 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4747 static void sunionstoreCommand(redisClient
*c
) {
4748 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4751 static void sdiffCommand(redisClient
*c
) {
4752 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4755 static void sdiffstoreCommand(redisClient
*c
) {
4756 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4759 /* ==================================== ZSets =============================== */
4761 /* ZSETs are ordered sets using two data structures to hold the same elements
4762 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4765 * The elements are added to an hash table mapping Redis objects to scores.
4766 * At the same time the elements are added to a skip list mapping scores
4767 * to Redis objects (so objects are sorted by scores in this "view"). */
4769 /* This skiplist implementation is almost a C translation of the original
4770 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4771 * Alternative to Balanced Trees", modified in three ways:
4772 * a) this implementation allows for repeated values.
4773 * b) the comparison is not just by key (our 'score') but by satellite data.
4774 * c) there is a back pointer, so it's a doubly linked list with the back
4775 * pointers being only at "level 1". This allows to traverse the list
4776 * from tail to head, useful for ZREVRANGE. */
4778 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4779 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4781 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4787 static zskiplist
*zslCreate(void) {
4791 zsl
= zmalloc(sizeof(*zsl
));
4794 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4795 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4796 zsl
->header
->forward
[j
] = NULL
;
4797 zsl
->header
->backward
= NULL
;
4802 static void zslFreeNode(zskiplistNode
*node
) {
4803 decrRefCount(node
->obj
);
4804 zfree(node
->forward
);
4808 static void zslFree(zskiplist
*zsl
) {
4809 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4811 zfree(zsl
->header
->forward
);
4814 next
= node
->forward
[0];
4821 static int zslRandomLevel(void) {
4823 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4828 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4829 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4833 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4834 while (x
->forward
[i
] &&
4835 (x
->forward
[i
]->score
< score
||
4836 (x
->forward
[i
]->score
== score
&&
4837 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4841 /* we assume the key is not already inside, since we allow duplicated
4842 * scores, and the re-insertion of score and redis object should never
4843 * happpen since the caller of zslInsert() should test in the hash table
4844 * if the element is already inside or not. */
4845 level
= zslRandomLevel();
4846 if (level
> zsl
->level
) {
4847 for (i
= zsl
->level
; i
< level
; i
++)
4848 update
[i
] = zsl
->header
;
4851 x
= zslCreateNode(level
,score
,obj
);
4852 for (i
= 0; i
< level
; i
++) {
4853 x
->forward
[i
] = update
[i
]->forward
[i
];
4854 update
[i
]->forward
[i
] = x
;
4856 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4858 x
->forward
[0]->backward
= x
;
4864 /* Delete an element with matching score/object from the skiplist. */
4865 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4866 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4870 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4871 while (x
->forward
[i
] &&
4872 (x
->forward
[i
]->score
< score
||
4873 (x
->forward
[i
]->score
== score
&&
4874 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4878 /* We may have multiple elements with the same score, what we need
4879 * is to find the element with both the right score and object. */
4881 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4882 for (i
= 0; i
< zsl
->level
; i
++) {
4883 if (update
[i
]->forward
[i
] != x
) break;
4884 update
[i
]->forward
[i
] = x
->forward
[i
];
4886 if (x
->forward
[0]) {
4887 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4890 zsl
->tail
= x
->backward
;
4893 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4898 return 0; /* not found */
4900 return 0; /* not found */
4903 /* Delete all the elements with score between min and max from the skiplist.
4904 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4905 * Note that this function takes the reference to the hash table view of the
4906 * sorted set, in order to remove the elements from the hash table too. */
4907 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4908 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4909 unsigned long removed
= 0;
4913 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4914 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4918 /* We may have multiple elements with the same score, what we need
4919 * is to find the element with both the right score and object. */
4921 while (x
&& x
->score
<= max
) {
4922 zskiplistNode
*next
;
4924 for (i
= 0; i
< zsl
->level
; i
++) {
4925 if (update
[i
]->forward
[i
] != x
) break;
4926 update
[i
]->forward
[i
] = x
->forward
[i
];
4928 if (x
->forward
[0]) {
4929 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4932 zsl
->tail
= x
->backward
;
4934 next
= x
->forward
[0];
4935 dictDelete(dict
,x
->obj
);
4937 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4943 return removed
; /* not found */
4946 /* Find the first node having a score equal or greater than the specified one.
4947 * Returns NULL if there is no match. */
4948 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4953 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4954 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4957 /* We may have multiple elements with the same score, what we need
4958 * is to find the element with both the right score and object. */
4959 return x
->forward
[0];
4962 /* The actual Z-commands implementations */
4964 /* This generic command implements both ZADD and ZINCRBY.
4965 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4966 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4967 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4972 zsetobj
= lookupKeyWrite(c
->db
,key
);
4973 if (zsetobj
== NULL
) {
4974 zsetobj
= createZsetObject();
4975 dictAdd(c
->db
->dict
,key
,zsetobj
);
4978 if (zsetobj
->type
!= REDIS_ZSET
) {
4979 addReply(c
,shared
.wrongtypeerr
);
4985 /* Ok now since we implement both ZADD and ZINCRBY here the code
4986 * needs to handle the two different conditions. It's all about setting
4987 * '*score', that is, the new score to set, to the right value. */
4988 score
= zmalloc(sizeof(double));
4992 /* Read the old score. If the element was not present starts from 0 */
4993 de
= dictFind(zs
->dict
,ele
);
4995 double *oldscore
= dictGetEntryVal(de
);
4996 *score
= *oldscore
+ scoreval
;
5004 /* What follows is a simple remove and re-insert operation that is common
5005 * to both ZADD and ZINCRBY... */
5006 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5007 /* case 1: New element */
5008 incrRefCount(ele
); /* added to hash */
5009 zslInsert(zs
->zsl
,*score
,ele
);
5010 incrRefCount(ele
); /* added to skiplist */
5013 addReplyDouble(c
,*score
);
5015 addReply(c
,shared
.cone
);
5020 /* case 2: Score update operation */
5021 de
= dictFind(zs
->dict
,ele
);
5022 redisAssert(de
!= NULL
);
5023 oldscore
= dictGetEntryVal(de
);
5024 if (*score
!= *oldscore
) {
5027 /* Remove and insert the element in the skip list with new score */
5028 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5029 redisAssert(deleted
!= 0);
5030 zslInsert(zs
->zsl
,*score
,ele
);
5032 /* Update the score in the hash table */
5033 dictReplace(zs
->dict
,ele
,score
);
5039 addReplyDouble(c
,*score
);
5041 addReply(c
,shared
.czero
);
5045 static void zaddCommand(redisClient
*c
) {
5048 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5049 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5052 static void zincrbyCommand(redisClient
*c
) {
5055 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5056 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5059 static void zremCommand(redisClient
*c
) {
5063 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5064 if (zsetobj
== NULL
) {
5065 addReply(c
,shared
.czero
);
5071 if (zsetobj
->type
!= REDIS_ZSET
) {
5072 addReply(c
,shared
.wrongtypeerr
);
5076 de
= dictFind(zs
->dict
,c
->argv
[2]);
5078 addReply(c
,shared
.czero
);
5081 /* Delete from the skiplist */
5082 oldscore
= dictGetEntryVal(de
);
5083 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5084 redisAssert(deleted
!= 0);
5086 /* Delete from the hash table */
5087 dictDelete(zs
->dict
,c
->argv
[2]);
5088 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5090 addReply(c
,shared
.cone
);
5094 static void zremrangebyscoreCommand(redisClient
*c
) {
5095 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5096 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5100 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5101 if (zsetobj
== NULL
) {
5102 addReply(c
,shared
.czero
);
5106 if (zsetobj
->type
!= REDIS_ZSET
) {
5107 addReply(c
,shared
.wrongtypeerr
);
5111 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5112 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5113 server
.dirty
+= deleted
;
5114 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5118 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5120 int start
= atoi(c
->argv
[2]->ptr
);
5121 int end
= atoi(c
->argv
[3]->ptr
);
5124 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5126 } else if (c
->argc
>= 5) {
5127 addReply(c
,shared
.syntaxerr
);
5131 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5133 addReply(c
,shared
.nullmultibulk
);
5135 if (o
->type
!= REDIS_ZSET
) {
5136 addReply(c
,shared
.wrongtypeerr
);
5138 zset
*zsetobj
= o
->ptr
;
5139 zskiplist
*zsl
= zsetobj
->zsl
;
5142 int llen
= zsl
->length
;
5146 /* convert negative indexes */
5147 if (start
< 0) start
= llen
+start
;
5148 if (end
< 0) end
= llen
+end
;
5149 if (start
< 0) start
= 0;
5150 if (end
< 0) end
= 0;
5152 /* indexes sanity checks */
5153 if (start
> end
|| start
>= llen
) {
5154 /* Out of range start or start > end result in empty list */
5155 addReply(c
,shared
.emptymultibulk
);
5158 if (end
>= llen
) end
= llen
-1;
5159 rangelen
= (end
-start
)+1;
5161 /* Return the result in form of a multi-bulk reply */
5167 ln
= zsl
->header
->forward
[0];
5169 ln
= ln
->forward
[0];
5172 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5173 withscores
? (rangelen
*2) : rangelen
));
5174 for (j
= 0; j
< rangelen
; j
++) {
5176 addReplyBulkLen(c
,ele
);
5178 addReply(c
,shared
.crlf
);
5180 addReplyDouble(c
,ln
->score
);
5181 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5187 static void zrangeCommand(redisClient
*c
) {
5188 zrangeGenericCommand(c
,0);
5191 static void zrevrangeCommand(redisClient
*c
) {
5192 zrangeGenericCommand(c
,1);
5195 static void zrangebyscoreCommand(redisClient
*c
) {
5197 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5198 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5199 int offset
= 0, limit
= -1;
5201 if (c
->argc
!= 4 && c
->argc
!= 7) {
5203 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5205 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5206 addReply(c
,shared
.syntaxerr
);
5208 } else if (c
->argc
== 7) {
5209 offset
= atoi(c
->argv
[5]->ptr
);
5210 limit
= atoi(c
->argv
[6]->ptr
);
5211 if (offset
< 0) offset
= 0;
5214 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5216 addReply(c
,shared
.nullmultibulk
);
5218 if (o
->type
!= REDIS_ZSET
) {
5219 addReply(c
,shared
.wrongtypeerr
);
5221 zset
*zsetobj
= o
->ptr
;
5222 zskiplist
*zsl
= zsetobj
->zsl
;
5225 unsigned int rangelen
= 0;
5227 /* Get the first node with the score >= min */
5228 ln
= zslFirstWithScore(zsl
,min
);
5230 /* No element matching the speciifed interval */
5231 addReply(c
,shared
.emptymultibulk
);
5235 /* We don't know in advance how many matching elements there
5236 * are in the list, so we push this object that will represent
5237 * the multi-bulk length in the output buffer, and will "fix"
5239 lenobj
= createObject(REDIS_STRING
,NULL
);
5241 decrRefCount(lenobj
);
5243 while(ln
&& ln
->score
<= max
) {
5246 ln
= ln
->forward
[0];
5249 if (limit
== 0) break;
5251 addReplyBulkLen(c
,ele
);
5253 addReply(c
,shared
.crlf
);
5254 ln
= ln
->forward
[0];
5256 if (limit
> 0) limit
--;
5258 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
5263 static void zcardCommand(redisClient
*c
) {
5267 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5269 addReply(c
,shared
.czero
);
5272 if (o
->type
!= REDIS_ZSET
) {
5273 addReply(c
,shared
.wrongtypeerr
);
5276 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5281 static void zscoreCommand(redisClient
*c
) {
5285 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5287 addReply(c
,shared
.nullbulk
);
5290 if (o
->type
!= REDIS_ZSET
) {
5291 addReply(c
,shared
.wrongtypeerr
);
5296 de
= dictFind(zs
->dict
,c
->argv
[2]);
5298 addReply(c
,shared
.nullbulk
);
5300 double *score
= dictGetEntryVal(de
);
5302 addReplyDouble(c
,*score
);
5308 /* ========================= Non type-specific commands ==================== */
5310 static void flushdbCommand(redisClient
*c
) {
5311 server
.dirty
+= dictSize(c
->db
->dict
);
5312 dictEmpty(c
->db
->dict
);
5313 dictEmpty(c
->db
->expires
);
5314 addReply(c
,shared
.ok
);
5317 static void flushallCommand(redisClient
*c
) {
5318 server
.dirty
+= emptyDb();
5319 addReply(c
,shared
.ok
);
5320 rdbSave(server
.dbfilename
);
5324 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5325 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5327 so
->pattern
= pattern
;
5331 /* Return the value associated to the key with a name obtained
5332 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5333 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5337 int prefixlen
, sublen
, postfixlen
;
5338 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5342 char buf
[REDIS_SORTKEY_MAX
+1];
5345 /* If the pattern is "#" return the substitution object itself in order
5346 * to implement the "SORT ... GET #" feature. */
5347 spat
= pattern
->ptr
;
5348 if (spat
[0] == '#' && spat
[1] == '\0') {
5352 /* The substitution object may be specially encoded. If so we create
5353 * a decoded object on the fly. Otherwise getDecodedObject will just
5354 * increment the ref count, that we'll decrement later. */
5355 subst
= getDecodedObject(subst
);
5358 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5359 p
= strchr(spat
,'*');
5361 decrRefCount(subst
);
5366 sublen
= sdslen(ssub
);
5367 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5368 memcpy(keyname
.buf
,spat
,prefixlen
);
5369 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5370 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5371 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5372 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5374 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5375 decrRefCount(subst
);
5377 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5378 return lookupKeyRead(db
,&keyobj
);
5381 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5382 * the additional parameter is not standard but a BSD-specific we have to
5383 * pass sorting parameters via the global 'server' structure */
5384 static int sortCompare(const void *s1
, const void *s2
) {
5385 const redisSortObject
*so1
= s1
, *so2
= s2
;
5388 if (!server
.sort_alpha
) {
5389 /* Numeric sorting. Here it's trivial as we precomputed scores */
5390 if (so1
->u
.score
> so2
->u
.score
) {
5392 } else if (so1
->u
.score
< so2
->u
.score
) {
5398 /* Alphanumeric sorting */
5399 if (server
.sort_bypattern
) {
5400 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5401 /* At least one compare object is NULL */
5402 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5404 else if (so1
->u
.cmpobj
== NULL
)
5409 /* We have both the objects, use strcoll */
5410 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5413 /* Compare elements directly */
5416 dec1
= getDecodedObject(so1
->obj
);
5417 dec2
= getDecodedObject(so2
->obj
);
5418 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5423 return server
.sort_desc
? -cmp
: cmp
;
5426 /* The SORT command is the most complex command in Redis. Warning: this code
5427 * is optimized for speed and a bit less for readability */
5428 static void sortCommand(redisClient
*c
) {
5431 int desc
= 0, alpha
= 0;
5432 int limit_start
= 0, limit_count
= -1, start
, end
;
5433 int j
, dontsort
= 0, vectorlen
;
5434 int getop
= 0; /* GET operation counter */
5435 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5436 redisSortObject
*vector
; /* Resulting vector to sort */
5438 /* Lookup the key to sort. It must be of the right types */
5439 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5440 if (sortval
== NULL
) {
5441 addReply(c
,shared
.nullmultibulk
);
5444 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5445 sortval
->type
!= REDIS_ZSET
)
5447 addReply(c
,shared
.wrongtypeerr
);
5451 /* Create a list of operations to perform for every sorted element.
5452 * Operations can be GET/DEL/INCR/DECR */
5453 operations
= listCreate();
5454 listSetFreeMethod(operations
,zfree
);
5457 /* Now we need to protect sortval incrementing its count, in the future
5458 * SORT may have options able to overwrite/delete keys during the sorting
5459 * and the sorted key itself may get destroied */
5460 incrRefCount(sortval
);
5462 /* The SORT command has an SQL-alike syntax, parse it */
5463 while(j
< c
->argc
) {
5464 int leftargs
= c
->argc
-j
-1;
5465 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5467 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5469 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5471 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5472 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5473 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5475 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5476 storekey
= c
->argv
[j
+1];
5478 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5479 sortby
= c
->argv
[j
+1];
5480 /* If the BY pattern does not contain '*', i.e. it is constant,
5481 * we don't need to sort nor to lookup the weight keys. */
5482 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5484 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5485 listAddNodeTail(operations
,createSortOperation(
5486 REDIS_SORT_GET
,c
->argv
[j
+1]));
5490 decrRefCount(sortval
);
5491 listRelease(operations
);
5492 addReply(c
,shared
.syntaxerr
);
5498 /* Load the sorting vector with all the objects to sort */
5499 switch(sortval
->type
) {
5500 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5501 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5502 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5503 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5505 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5508 if (sortval
->type
== REDIS_LIST
) {
5509 list
*list
= sortval
->ptr
;
5513 listRewind(list
,&li
);
5514 while((ln
= listNext(&li
))) {
5515 robj
*ele
= ln
->value
;
5516 vector
[j
].obj
= ele
;
5517 vector
[j
].u
.score
= 0;
5518 vector
[j
].u
.cmpobj
= NULL
;
5526 if (sortval
->type
== REDIS_SET
) {
5529 zset
*zs
= sortval
->ptr
;
5533 di
= dictGetIterator(set
);
5534 while((setele
= dictNext(di
)) != NULL
) {
5535 vector
[j
].obj
= dictGetEntryKey(setele
);
5536 vector
[j
].u
.score
= 0;
5537 vector
[j
].u
.cmpobj
= NULL
;
5540 dictReleaseIterator(di
);
5542 redisAssert(j
== vectorlen
);
5544 /* Now it's time to load the right scores in the sorting vector */
5545 if (dontsort
== 0) {
5546 for (j
= 0; j
< vectorlen
; j
++) {
5550 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5551 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5553 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5555 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5556 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5558 /* Don't need to decode the object if it's
5559 * integer-encoded (the only encoding supported) so
5560 * far. We can just cast it */
5561 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5562 vector
[j
].u
.score
= (long)byval
->ptr
;
5564 redisAssert(1 != 1);
5569 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5570 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5572 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5573 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5575 redisAssert(1 != 1);
5582 /* We are ready to sort the vector... perform a bit of sanity check
5583 * on the LIMIT option too. We'll use a partial version of quicksort. */
5584 start
= (limit_start
< 0) ? 0 : limit_start
;
5585 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5586 if (start
>= vectorlen
) {
5587 start
= vectorlen
-1;
5590 if (end
>= vectorlen
) end
= vectorlen
-1;
5592 if (dontsort
== 0) {
5593 server
.sort_desc
= desc
;
5594 server
.sort_alpha
= alpha
;
5595 server
.sort_bypattern
= sortby
? 1 : 0;
5596 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5597 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5599 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5602 /* Send command output to the output buffer, performing the specified
5603 * GET/DEL/INCR/DECR operations if any. */
5604 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5605 if (storekey
== NULL
) {
5606 /* STORE option not specified, sent the sorting result to client */
5607 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5608 for (j
= start
; j
<= end
; j
++) {
5613 addReplyBulkLen(c
,vector
[j
].obj
);
5614 addReply(c
,vector
[j
].obj
);
5615 addReply(c
,shared
.crlf
);
5617 listRewind(operations
,&li
);
5618 while((ln
= listNext(&li
))) {
5619 redisSortOperation
*sop
= ln
->value
;
5620 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5623 if (sop
->type
== REDIS_SORT_GET
) {
5624 if (!val
|| val
->type
!= REDIS_STRING
) {
5625 addReply(c
,shared
.nullbulk
);
5627 addReplyBulkLen(c
,val
);
5629 addReply(c
,shared
.crlf
);
5632 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5637 robj
*listObject
= createListObject();
5638 list
*listPtr
= (list
*) listObject
->ptr
;
5640 /* STORE option specified, set the sorting result as a List object */
5641 for (j
= start
; j
<= end
; j
++) {
5646 listAddNodeTail(listPtr
,vector
[j
].obj
);
5647 incrRefCount(vector
[j
].obj
);
5649 listRewind(operations
,&li
);
5650 while((ln
= listNext(&li
))) {
5651 redisSortOperation
*sop
= ln
->value
;
5652 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5655 if (sop
->type
== REDIS_SORT_GET
) {
5656 if (!val
|| val
->type
!= REDIS_STRING
) {
5657 listAddNodeTail(listPtr
,createStringObject("",0));
5659 listAddNodeTail(listPtr
,val
);
5663 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5667 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5668 incrRefCount(storekey
);
5670 /* Note: we add 1 because the DB is dirty anyway since even if the
5671 * SORT result is empty a new key is set and maybe the old content
5673 server
.dirty
+= 1+outputlen
;
5674 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5678 decrRefCount(sortval
);
5679 listRelease(operations
);
5680 for (j
= 0; j
< vectorlen
; j
++) {
5681 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5682 decrRefCount(vector
[j
].u
.cmpobj
);
5687 /* Convert an amount of bytes into a human readable string in the form
5688 * of 100B, 2G, 100M, 4K, and so forth. */
5689 static void bytesToHuman(char *s
, unsigned long long n
) {
5694 sprintf(s
,"%lluB",n
);
5696 } else if (n
< (1024*1024)) {
5697 d
= (double)n
/(1024);
5698 sprintf(s
,"%.2fK",d
);
5699 } else if (n
< (1024LL*1024*1024)) {
5700 d
= (double)n
/(1024*1024);
5701 sprintf(s
,"%.2fM",d
);
5702 } else if (n
< (1024LL*1024*1024*1024)) {
5703 d
= (double)n
/(1024LL*1024*1024);
5704 sprintf(s
,"%.2fG",d
);
5708 /* Create the string returned by the INFO command. This is decoupled
5709 * by the INFO command itself as we need to report the same information
5710 * on memory corruption problems. */
5711 static sds
genRedisInfoString(void) {
5713 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5717 bytesToHuman(hmem
,zmalloc_used_memory());
5718 info
= sdscatprintf(sdsempty(),
5719 "redis_version:%s\r\n"
5721 "multiplexing_api:%s\r\n"
5722 "process_id:%ld\r\n"
5723 "uptime_in_seconds:%ld\r\n"
5724 "uptime_in_days:%ld\r\n"
5725 "connected_clients:%d\r\n"
5726 "connected_slaves:%d\r\n"
5727 "blocked_clients:%d\r\n"
5728 "used_memory:%zu\r\n"
5729 "used_memory_human:%s\r\n"
5730 "changes_since_last_save:%lld\r\n"
5731 "bgsave_in_progress:%d\r\n"
5732 "last_save_time:%ld\r\n"
5733 "bgrewriteaof_in_progress:%d\r\n"
5734 "total_connections_received:%lld\r\n"
5735 "total_commands_processed:%lld\r\n"
5739 (sizeof(long) == 8) ? "64" : "32",
5744 listLength(server
.clients
)-listLength(server
.slaves
),
5745 listLength(server
.slaves
),
5746 server
.blpop_blocked_clients
,
5747 zmalloc_used_memory(),
5750 server
.bgsavechildpid
!= -1,
5752 server
.bgrewritechildpid
!= -1,
5753 server
.stat_numconnections
,
5754 server
.stat_numcommands
,
5755 server
.vm_enabled
!= 0,
5756 server
.masterhost
== NULL
? "master" : "slave"
5758 if (server
.masterhost
) {
5759 info
= sdscatprintf(info
,
5760 "master_host:%s\r\n"
5761 "master_port:%d\r\n"
5762 "master_link_status:%s\r\n"
5763 "master_last_io_seconds_ago:%d\r\n"
5766 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5768 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5771 if (server
.vm_enabled
) {
5773 info
= sdscatprintf(info
,
5774 "vm_conf_max_memory:%llu\r\n"
5775 "vm_conf_page_size:%llu\r\n"
5776 "vm_conf_pages:%llu\r\n"
5777 "vm_stats_used_pages:%llu\r\n"
5778 "vm_stats_swapped_objects:%llu\r\n"
5779 "vm_stats_swappin_count:%llu\r\n"
5780 "vm_stats_swappout_count:%llu\r\n"
5781 "vm_stats_io_newjobs_len:%lu\r\n"
5782 "vm_stats_io_processing_len:%lu\r\n"
5783 "vm_stats_io_processed_len:%lu\r\n"
5784 "vm_stats_io_active_threads:%lu\r\n"
5785 "vm_stats_blocked_clients:%lu\r\n"
5786 ,(unsigned long long) server
.vm_max_memory
,
5787 (unsigned long long) server
.vm_page_size
,
5788 (unsigned long long) server
.vm_pages
,
5789 (unsigned long long) server
.vm_stats_used_pages
,
5790 (unsigned long long) server
.vm_stats_swapped_objects
,
5791 (unsigned long long) server
.vm_stats_swapins
,
5792 (unsigned long long) server
.vm_stats_swapouts
,
5793 (unsigned long) listLength(server
.io_newjobs
),
5794 (unsigned long) listLength(server
.io_processing
),
5795 (unsigned long) listLength(server
.io_processed
),
5796 (unsigned long) server
.io_active_threads
,
5797 (unsigned long) server
.vm_blocked_clients
5801 for (j
= 0; j
< server
.dbnum
; j
++) {
5802 long long keys
, vkeys
;
5804 keys
= dictSize(server
.db
[j
].dict
);
5805 vkeys
= dictSize(server
.db
[j
].expires
);
5806 if (keys
|| vkeys
) {
5807 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5814 static void infoCommand(redisClient
*c
) {
5815 sds info
= genRedisInfoString();
5816 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5817 (unsigned long)sdslen(info
)));
5818 addReplySds(c
,info
);
5819 addReply(c
,shared
.crlf
);
5822 static void monitorCommand(redisClient
*c
) {
5823 /* ignore MONITOR if aleady slave or in monitor mode */
5824 if (c
->flags
& REDIS_SLAVE
) return;
5826 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5828 listAddNodeTail(server
.monitors
,c
);
5829 addReply(c
,shared
.ok
);
5832 /* ================================= Expire ================================= */
5833 static int removeExpire(redisDb
*db
, robj
*key
) {
5834 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5841 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5842 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5850 /* Return the expire time of the specified key, or -1 if no expire
5851 * is associated with this key (i.e. the key is non volatile) */
5852 static time_t getExpire(redisDb
*db
, robj
*key
) {
5855 /* No expire? return ASAP */
5856 if (dictSize(db
->expires
) == 0 ||
5857 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5859 return (time_t) dictGetEntryVal(de
);
5862 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5866 /* No expire? return ASAP */
5867 if (dictSize(db
->expires
) == 0 ||
5868 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5870 /* Lookup the expire */
5871 when
= (time_t) dictGetEntryVal(de
);
5872 if (time(NULL
) <= when
) return 0;
5874 /* Delete the key */
5875 dictDelete(db
->expires
,key
);
5876 return dictDelete(db
->dict
,key
) == DICT_OK
;
5879 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5882 /* No expire? return ASAP */
5883 if (dictSize(db
->expires
) == 0 ||
5884 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5886 /* Delete the key */
5888 dictDelete(db
->expires
,key
);
5889 return dictDelete(db
->dict
,key
) == DICT_OK
;
5892 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5895 de
= dictFind(c
->db
->dict
,key
);
5897 addReply(c
,shared
.czero
);
5901 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5902 addReply(c
, shared
.cone
);
5905 time_t when
= time(NULL
)+seconds
;
5906 if (setExpire(c
->db
,key
,when
)) {
5907 addReply(c
,shared
.cone
);
5910 addReply(c
,shared
.czero
);
5916 static void expireCommand(redisClient
*c
) {
5917 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5920 static void expireatCommand(redisClient
*c
) {
5921 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5924 static void ttlCommand(redisClient
*c
) {
5928 expire
= getExpire(c
->db
,c
->argv
[1]);
5930 ttl
= (int) (expire
-time(NULL
));
5931 if (ttl
< 0) ttl
= -1;
5933 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5936 /* ================================ MULTI/EXEC ============================== */
5938 /* Client state initialization for MULTI/EXEC */
5939 static void initClientMultiState(redisClient
*c
) {
5940 c
->mstate
.commands
= NULL
;
5941 c
->mstate
.count
= 0;
5944 /* Release all the resources associated with MULTI/EXEC state */
5945 static void freeClientMultiState(redisClient
*c
) {
5948 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5950 multiCmd
*mc
= c
->mstate
.commands
+j
;
5952 for (i
= 0; i
< mc
->argc
; i
++)
5953 decrRefCount(mc
->argv
[i
]);
5956 zfree(c
->mstate
.commands
);
5959 /* Add a new command into the MULTI commands queue */
5960 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5964 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5965 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5966 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5969 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5970 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5971 for (j
= 0; j
< c
->argc
; j
++)
5972 incrRefCount(mc
->argv
[j
]);
5976 static void multiCommand(redisClient
*c
) {
5977 c
->flags
|= REDIS_MULTI
;
5978 addReply(c
,shared
.ok
);
5981 static void execCommand(redisClient
*c
) {
5986 if (!(c
->flags
& REDIS_MULTI
)) {
5987 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5991 orig_argv
= c
->argv
;
5992 orig_argc
= c
->argc
;
5993 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5994 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5995 c
->argc
= c
->mstate
.commands
[j
].argc
;
5996 c
->argv
= c
->mstate
.commands
[j
].argv
;
5997 call(c
,c
->mstate
.commands
[j
].cmd
);
5999 c
->argv
= orig_argv
;
6000 c
->argc
= orig_argc
;
6001 freeClientMultiState(c
);
6002 initClientMultiState(c
);
6003 c
->flags
&= (~REDIS_MULTI
);
6006 /* =========================== Blocking Operations ========================= */
6008 /* Currently Redis blocking operations support is limited to list POP ops,
6009 * so the current implementation is not fully generic, but it is also not
6010 * completely specific so it will not require a rewrite to support new
6011 * kind of blocking operations in the future.
6013 * Still it's important to note that list blocking operations can be already
6014 * used as a notification mechanism in order to implement other blocking
6015 * operations at application level, so there must be a very strong evidence
6016 * of usefulness and generality before new blocking operations are implemented.
6018 * This is how the current blocking POP works, we use BLPOP as example:
6019 * - If the user calls BLPOP and the key exists and contains a non empty list
6020 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6021 * if there is not to block.
6022 * - If instead BLPOP is called and the key does not exists or the list is
6023 * empty we need to block. In order to do so we remove the notification for
6024 * new data to read in the client socket (so that we'll not serve new
6025 * requests if the blocking request is not served). Also we put the client
6026 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6027 * blocking for this keys.
6028 * - If a PUSH operation against a key with blocked clients waiting is
6029 * performed, we serve the first in the list: basically instead to push
6030 * the new element inside the list we return it to the (first / oldest)
6031 * blocking client, unblock the client, and remove it form the list.
6033 * The above comment and the source code should be enough in order to understand
6034 * the implementation and modify / fix it later.
6037 /* Set a client in blocking mode for the specified key, with the specified
6039 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6044 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6045 c
->blockingkeysnum
= numkeys
;
6046 c
->blockingto
= timeout
;
6047 for (j
= 0; j
< numkeys
; j
++) {
6048 /* Add the key in the client structure, to map clients -> keys */
6049 c
->blockingkeys
[j
] = keys
[j
];
6050 incrRefCount(keys
[j
]);
6052 /* And in the other "side", to map keys -> clients */
6053 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6057 /* For every key we take a list of clients blocked for it */
6059 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6060 incrRefCount(keys
[j
]);
6061 assert(retval
== DICT_OK
);
6063 l
= dictGetEntryVal(de
);
6065 listAddNodeTail(l
,c
);
6067 /* Mark the client as a blocked client */
6068 c
->flags
|= REDIS_BLOCKED
;
6069 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
6070 server
.blpop_blocked_clients
++;
6073 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6074 static void unblockClientWaitingData(redisClient
*c
) {
6079 assert(c
->blockingkeys
!= NULL
);
6080 /* The client may wait for multiple keys, so unblock it for every key. */
6081 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6082 /* Remove this client from the list of clients waiting for this key. */
6083 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6085 l
= dictGetEntryVal(de
);
6086 listDelNode(l
,listSearchKey(l
,c
));
6087 /* If the list is empty we need to remove it to avoid wasting memory */
6088 if (listLength(l
) == 0)
6089 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6090 decrRefCount(c
->blockingkeys
[j
]);
6092 /* Cleanup the client structure */
6093 zfree(c
->blockingkeys
);
6094 c
->blockingkeys
= NULL
;
6095 c
->flags
&= (~REDIS_BLOCKED
);
6096 server
.blpop_blocked_clients
--;
6097 /* Ok now we are ready to get read events from socket, note that we
6098 * can't trap errors here as it's possible that unblockClientWaitingDatas() is
6099 * called from freeClient() itself, and the only thing we can do
6100 * if we failed to register the READABLE event is to kill the client.
6101 * Still the following function should never fail in the real world as
6102 * we are sure the file descriptor is sane, and we exit on out of mem. */
6103 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
6104 /* As a final step we want to process data if there is some command waiting
6105 * in the input buffer. Note that this is safe even if
6106 * unblockClientWaitingData() gets called from freeClient() because
6107 * freeClient() will be smart enough to call this function
6108 * *after* c->querybuf was set to NULL. */
6109 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6112 /* This should be called from any function PUSHing into lists.
6113 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6114 * 'ele' is the element pushed.
6116 * If the function returns 0 there was no client waiting for a list push
6119 * If the function returns 1 there was a client waiting for a list push
6120 * against this key, the element was passed to this client thus it's not
6121 * needed to actually add it to the list and the caller should return asap. */
6122 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6123 struct dictEntry
*de
;
6124 redisClient
*receiver
;
6128 de
= dictFind(c
->db
->blockingkeys
,key
);
6129 if (de
== NULL
) return 0;
6130 l
= dictGetEntryVal(de
);
6133 receiver
= ln
->value
;
6135 addReplySds(receiver
,sdsnew("*2\r\n"));
6136 addReplyBulkLen(receiver
,key
);
6137 addReply(receiver
,key
);
6138 addReply(receiver
,shared
.crlf
);
6139 addReplyBulkLen(receiver
,ele
);
6140 addReply(receiver
,ele
);
6141 addReply(receiver
,shared
.crlf
);
6142 unblockClientWaitingData(receiver
);
6146 /* Blocking RPOP/LPOP */
6147 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6152 for (j
= 1; j
< c
->argc
-1; j
++) {
6153 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6155 if (o
->type
!= REDIS_LIST
) {
6156 addReply(c
,shared
.wrongtypeerr
);
6159 list
*list
= o
->ptr
;
6160 if (listLength(list
) != 0) {
6161 /* If the list contains elements fall back to the usual
6162 * non-blocking POP operation */
6163 robj
*argv
[2], **orig_argv
;
6166 /* We need to alter the command arguments before to call
6167 * popGenericCommand() as the command takes a single key. */
6168 orig_argv
= c
->argv
;
6169 orig_argc
= c
->argc
;
6170 argv
[1] = c
->argv
[j
];
6174 /* Also the return value is different, we need to output
6175 * the multi bulk reply header and the key name. The
6176 * "real" command will add the last element (the value)
6177 * for us. If this souds like an hack to you it's just
6178 * because it is... */
6179 addReplySds(c
,sdsnew("*2\r\n"));
6180 addReplyBulkLen(c
,argv
[1]);
6181 addReply(c
,argv
[1]);
6182 addReply(c
,shared
.crlf
);
6183 popGenericCommand(c
,where
);
6185 /* Fix the client structure with the original stuff */
6186 c
->argv
= orig_argv
;
6187 c
->argc
= orig_argc
;
6193 /* If the list is empty or the key does not exists we must block */
6194 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6195 if (timeout
> 0) timeout
+= time(NULL
);
6196 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6199 static void blpopCommand(redisClient
*c
) {
6200 blockingPopGenericCommand(c
,REDIS_HEAD
);
6203 static void brpopCommand(redisClient
*c
) {
6204 blockingPopGenericCommand(c
,REDIS_TAIL
);
6207 /* =============================== Replication ============================= */
6209 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6210 ssize_t nwritten
, ret
= size
;
6211 time_t start
= time(NULL
);
6215 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6216 nwritten
= write(fd
,ptr
,size
);
6217 if (nwritten
== -1) return -1;
6221 if ((time(NULL
)-start
) > timeout
) {
6229 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6230 ssize_t nread
, totread
= 0;
6231 time_t start
= time(NULL
);
6235 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6236 nread
= read(fd
,ptr
,size
);
6237 if (nread
== -1) return -1;
6242 if ((time(NULL
)-start
) > timeout
) {
6250 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6257 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6260 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6271 static void syncCommand(redisClient
*c
) {
6272 /* ignore SYNC if aleady slave or in monitor mode */
6273 if (c
->flags
& REDIS_SLAVE
) return;
6275 /* SYNC can't be issued when the server has pending data to send to
6276 * the client about already issued commands. We need a fresh reply
6277 * buffer registering the differences between the BGSAVE and the current
6278 * dataset, so that we can copy to other slaves if needed. */
6279 if (listLength(c
->reply
) != 0) {
6280 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6284 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6285 /* Here we need to check if there is a background saving operation
6286 * in progress, or if it is required to start one */
6287 if (server
.bgsavechildpid
!= -1) {
6288 /* Ok a background save is in progress. Let's check if it is a good
6289 * one for replication, i.e. if there is another slave that is
6290 * registering differences since the server forked to save */
6295 listRewind(server
.slaves
,&li
);
6296 while((ln
= listNext(&li
))) {
6298 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6301 /* Perfect, the server is already registering differences for
6302 * another slave. Set the right state, and copy the buffer. */
6303 listRelease(c
->reply
);
6304 c
->reply
= listDup(slave
->reply
);
6305 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6306 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6308 /* No way, we need to wait for the next BGSAVE in order to
6309 * register differences */
6310 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6311 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6314 /* Ok we don't have a BGSAVE in progress, let's start one */
6315 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6316 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6317 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6318 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6321 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6324 c
->flags
|= REDIS_SLAVE
;
6326 listAddNodeTail(server
.slaves
,c
);
6330 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6331 redisClient
*slave
= privdata
;
6333 REDIS_NOTUSED(mask
);
6334 char buf
[REDIS_IOBUF_LEN
];
6335 ssize_t nwritten
, buflen
;
6337 if (slave
->repldboff
== 0) {
6338 /* Write the bulk write count before to transfer the DB. In theory here
6339 * we don't know how much room there is in the output buffer of the
6340 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6341 * operations) will never be smaller than the few bytes we need. */
6344 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6346 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6354 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6355 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6357 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6358 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6362 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6363 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6368 slave
->repldboff
+= nwritten
;
6369 if (slave
->repldboff
== slave
->repldbsize
) {
6370 close(slave
->repldbfd
);
6371 slave
->repldbfd
= -1;
6372 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6373 slave
->replstate
= REDIS_REPL_ONLINE
;
6374 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6375 sendReplyToClient
, slave
) == AE_ERR
) {
6379 addReplySds(slave
,sdsempty());
6380 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6384 /* This function is called at the end of every backgrond saving.
6385 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6386 * otherwise REDIS_ERR is passed to the function.
6388 * The goal of this function is to handle slaves waiting for a successful
6389 * background saving in order to perform non-blocking synchronization. */
6390 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6392 int startbgsave
= 0;
6395 listRewind(server
.slaves
,&li
);
6396 while((ln
= listNext(&li
))) {
6397 redisClient
*slave
= ln
->value
;
6399 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6401 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6402 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6403 struct redis_stat buf
;
6405 if (bgsaveerr
!= REDIS_OK
) {
6407 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6410 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6411 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6413 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6416 slave
->repldboff
= 0;
6417 slave
->repldbsize
= buf
.st_size
;
6418 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6419 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6420 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6427 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6430 listRewind(server
.slaves
,&li
);
6431 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6432 while((ln
= listNext(&li
))) {
6433 redisClient
*slave
= ln
->value
;
6435 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6442 static int syncWithMaster(void) {
6443 char buf
[1024], tmpfile
[256], authcmd
[1024];
6445 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6449 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6454 /* AUTH with the master if required. */
6455 if(server
.masterauth
) {
6456 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6457 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6459 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6463 /* Read the AUTH result. */
6464 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6466 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6470 if (buf
[0] != '+') {
6472 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6477 /* Issue the SYNC command */
6478 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6480 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6484 /* Read the bulk write count */
6485 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6487 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6491 if (buf
[0] != '$') {
6493 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6496 dumpsize
= atoi(buf
+1);
6497 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6498 /* Read the bulk write data on a temp file */
6499 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6500 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6503 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6507 int nread
, nwritten
;
6509 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6511 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6517 nwritten
= write(dfd
,buf
,nread
);
6518 if (nwritten
== -1) {
6519 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6527 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6528 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6534 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6535 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6539 server
.master
= createClient(fd
);
6540 server
.master
->flags
|= REDIS_MASTER
;
6541 server
.master
->authenticated
= 1;
6542 server
.replstate
= REDIS_REPL_CONNECTED
;
6546 static void slaveofCommand(redisClient
*c
) {
6547 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6548 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6549 if (server
.masterhost
) {
6550 sdsfree(server
.masterhost
);
6551 server
.masterhost
= NULL
;
6552 if (server
.master
) freeClient(server
.master
);
6553 server
.replstate
= REDIS_REPL_NONE
;
6554 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6557 sdsfree(server
.masterhost
);
6558 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6559 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6560 if (server
.master
) freeClient(server
.master
);
6561 server
.replstate
= REDIS_REPL_CONNECT
;
6562 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6563 server
.masterhost
, server
.masterport
);
6565 addReply(c
,shared
.ok
);
6568 /* ============================ Maxmemory directive ======================== */
6570 /* Try to free one object form the pre-allocated objects free list.
6571 * This is useful under low mem conditions as by default we take 1 million
6572 * free objects allocated. On success REDIS_OK is returned, otherwise
6574 static int tryFreeOneObjectFromFreelist(void) {
6577 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6578 if (listLength(server
.objfreelist
)) {
6579 listNode
*head
= listFirst(server
.objfreelist
);
6580 o
= listNodeValue(head
);
6581 listDelNode(server
.objfreelist
,head
);
6582 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6586 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6591 /* This function gets called when 'maxmemory' is set on the config file to limit
6592 * the max memory used by the server, and we are out of memory.
6593 * This function will try to, in order:
6595 * - Free objects from the free list
6596 * - Try to remove keys with an EXPIRE set
6598 * It is not possible to free enough memory to reach used-memory < maxmemory
6599 * the server will start refusing commands that will enlarge even more the
6602 static void freeMemoryIfNeeded(void) {
6603 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6604 int j
, k
, freed
= 0;
6606 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6607 for (j
= 0; j
< server
.dbnum
; j
++) {
6609 robj
*minkey
= NULL
;
6610 struct dictEntry
*de
;
6612 if (dictSize(server
.db
[j
].expires
)) {
6614 /* From a sample of three keys drop the one nearest to
6615 * the natural expire */
6616 for (k
= 0; k
< 3; k
++) {
6619 de
= dictGetRandomKey(server
.db
[j
].expires
);
6620 t
= (time_t) dictGetEntryVal(de
);
6621 if (minttl
== -1 || t
< minttl
) {
6622 minkey
= dictGetEntryKey(de
);
6626 deleteKey(server
.db
+j
,minkey
);
6629 if (!freed
) return; /* nothing to free... */
6633 /* ============================== Append Only file ========================== */
6635 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6636 sds buf
= sdsempty();
6642 /* The DB this command was targetting is not the same as the last command
6643 * we appendend. To issue a SELECT command is needed. */
6644 if (dictid
!= server
.appendseldb
) {
6647 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6648 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6649 (unsigned long)strlen(seldb
),seldb
);
6650 server
.appendseldb
= dictid
;
6653 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6654 * EXPIREs into EXPIREATs calls */
6655 if (cmd
->proc
== expireCommand
) {
6658 tmpargv
[0] = createStringObject("EXPIREAT",8);
6659 tmpargv
[1] = argv
[1];
6660 incrRefCount(argv
[1]);
6661 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6662 tmpargv
[2] = createObject(REDIS_STRING
,
6663 sdscatprintf(sdsempty(),"%ld",when
));
6667 /* Append the actual command */
6668 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6669 for (j
= 0; j
< argc
; j
++) {
6672 o
= getDecodedObject(o
);
6673 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6674 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6675 buf
= sdscatlen(buf
,"\r\n",2);
6679 /* Free the objects from the modified argv for EXPIREAT */
6680 if (cmd
->proc
== expireCommand
) {
6681 for (j
= 0; j
< 3; j
++)
6682 decrRefCount(argv
[j
]);
6685 /* We want to perform a single write. This should be guaranteed atomic
6686 * at least if the filesystem we are writing is a real physical one.
6687 * While this will save us against the server being killed I don't think
6688 * there is much to do about the whole server stopping for power problems
6690 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6691 if (nwritten
!= (signed)sdslen(buf
)) {
6692 /* Ooops, we are in troubles. The best thing to do for now is
6693 * to simply exit instead to give the illusion that everything is
6694 * working as expected. */
6695 if (nwritten
== -1) {
6696 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6698 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6702 /* If a background append only file rewriting is in progress we want to
6703 * accumulate the differences between the child DB and the current one
6704 * in a buffer, so that when the child process will do its work we
6705 * can append the differences to the new append only file. */
6706 if (server
.bgrewritechildpid
!= -1)
6707 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6711 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6712 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6713 now
-server
.lastfsync
> 1))
6715 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6716 server
.lastfsync
= now
;
6720 /* In Redis commands are always executed in the context of a client, so in
6721 * order to load the append only file we need to create a fake client. */
6722 static struct redisClient
*createFakeClient(void) {
6723 struct redisClient
*c
= zmalloc(sizeof(*c
));
6727 c
->querybuf
= sdsempty();
6731 /* We set the fake client as a slave waiting for the synchronization
6732 * so that Redis will not try to send replies to this client. */
6733 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6734 c
->reply
= listCreate();
6735 listSetFreeMethod(c
->reply
,decrRefCount
);
6736 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6740 static void freeFakeClient(struct redisClient
*c
) {
6741 sdsfree(c
->querybuf
);
6742 listRelease(c
->reply
);
6746 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6747 * error (the append only file is zero-length) REDIS_ERR is returned. On
6748 * fatal error an error message is logged and the program exists. */
6749 int loadAppendOnlyFile(char *filename
) {
6750 struct redisClient
*fakeClient
;
6751 FILE *fp
= fopen(filename
,"r");
6752 struct redis_stat sb
;
6753 unsigned long long loadedkeys
= 0;
6755 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6759 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6763 fakeClient
= createFakeClient();
6770 struct redisCommand
*cmd
;
6772 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6778 if (buf
[0] != '*') goto fmterr
;
6780 argv
= zmalloc(sizeof(robj
*)*argc
);
6781 for (j
= 0; j
< argc
; j
++) {
6782 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6783 if (buf
[0] != '$') goto fmterr
;
6784 len
= strtol(buf
+1,NULL
,10);
6785 argsds
= sdsnewlen(NULL
,len
);
6786 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6787 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6788 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6791 /* Command lookup */
6792 cmd
= lookupCommand(argv
[0]->ptr
);
6794 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6797 /* Try object sharing and encoding */
6798 if (server
.shareobjects
) {
6800 for(j
= 1; j
< argc
; j
++)
6801 argv
[j
] = tryObjectSharing(argv
[j
]);
6803 if (cmd
->flags
& REDIS_CMD_BULK
)
6804 tryObjectEncoding(argv
[argc
-1]);
6805 /* Run the command in the context of a fake client */
6806 fakeClient
->argc
= argc
;
6807 fakeClient
->argv
= argv
;
6808 cmd
->proc(fakeClient
);
6809 /* Discard the reply objects list from the fake client */
6810 while(listLength(fakeClient
->reply
))
6811 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6812 /* Clean up, ready for the next command */
6813 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6815 /* Handle swapping while loading big datasets when VM is on */
6817 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6818 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6819 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6824 freeFakeClient(fakeClient
);
6829 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6831 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6835 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6839 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6840 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6844 /* Avoid the incr/decr ref count business if possible to help
6845 * copy-on-write (we are often in a child process when this function
6847 * Also makes sure that key objects don't get incrRefCount-ed when VM
6849 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6850 obj
= getDecodedObject(obj
);
6853 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6854 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6855 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6857 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6858 if (decrrc
) decrRefCount(obj
);
6861 if (decrrc
) decrRefCount(obj
);
6865 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6866 static int fwriteBulkDouble(FILE *fp
, double d
) {
6867 char buf
[128], dbuf
[128];
6869 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6870 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6871 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6872 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6876 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6877 static int fwriteBulkLong(FILE *fp
, long l
) {
6878 char buf
[128], lbuf
[128];
6880 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6881 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6882 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6883 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6887 /* Write a sequence of commands able to fully rebuild the dataset into
6888 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6889 static int rewriteAppendOnlyFile(char *filename
) {
6890 dictIterator
*di
= NULL
;
6895 time_t now
= time(NULL
);
6897 /* Note that we have to use a different temp name here compared to the
6898 * one used by rewriteAppendOnlyFileBackground() function. */
6899 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6900 fp
= fopen(tmpfile
,"w");
6902 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6905 for (j
= 0; j
< server
.dbnum
; j
++) {
6906 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6907 redisDb
*db
= server
.db
+j
;
6909 if (dictSize(d
) == 0) continue;
6910 di
= dictGetIterator(d
);
6916 /* SELECT the new DB */
6917 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6918 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6920 /* Iterate this DB writing every entry */
6921 while((de
= dictNext(di
)) != NULL
) {
6926 key
= dictGetEntryKey(de
);
6927 /* If the value for this key is swapped, load a preview in memory.
6928 * We use a "swapped" flag to remember if we need to free the
6929 * value object instead to just increment the ref count anyway
6930 * in order to avoid copy-on-write of pages if we are forked() */
6931 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6932 key
->storage
== REDIS_VM_SWAPPING
) {
6933 o
= dictGetEntryVal(de
);
6936 o
= vmPreviewObject(key
);
6939 expiretime
= getExpire(db
,key
);
6941 /* Save the key and associated value */
6942 if (o
->type
== REDIS_STRING
) {
6943 /* Emit a SET command */
6944 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6945 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6947 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6948 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6949 } else if (o
->type
== REDIS_LIST
) {
6950 /* Emit the RPUSHes needed to rebuild the list */
6951 list
*list
= o
->ptr
;
6955 listRewind(list
,&li
);
6956 while((ln
= listNext(&li
))) {
6957 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6958 robj
*eleobj
= listNodeValue(ln
);
6960 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6961 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6962 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6964 } else if (o
->type
== REDIS_SET
) {
6965 /* Emit the SADDs needed to rebuild the set */
6967 dictIterator
*di
= dictGetIterator(set
);
6970 while((de
= dictNext(di
)) != NULL
) {
6971 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6972 robj
*eleobj
= dictGetEntryKey(de
);
6974 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6975 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6976 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6978 dictReleaseIterator(di
);
6979 } else if (o
->type
== REDIS_ZSET
) {
6980 /* Emit the ZADDs needed to rebuild the sorted set */
6982 dictIterator
*di
= dictGetIterator(zs
->dict
);
6985 while((de
= dictNext(di
)) != NULL
) {
6986 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6987 robj
*eleobj
= dictGetEntryKey(de
);
6988 double *score
= dictGetEntryVal(de
);
6990 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6991 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6992 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6993 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6995 dictReleaseIterator(di
);
6997 redisAssert(0 != 0);
6999 /* Save the expire time */
7000 if (expiretime
!= -1) {
7001 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7002 /* If this key is already expired skip it */
7003 if (expiretime
< now
) continue;
7004 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7005 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7006 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7008 if (swapped
) decrRefCount(o
);
7010 dictReleaseIterator(di
);
7013 /* Make sure data will not remain on the OS's output buffers */
7018 /* Use RENAME to make sure the DB file is changed atomically only
7019 * if the generate DB file is ok. */
7020 if (rename(tmpfile
,filename
) == -1) {
7021 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7025 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7031 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7032 if (di
) dictReleaseIterator(di
);
7036 /* This is how rewriting of the append only file in background works:
7038 * 1) The user calls BGREWRITEAOF
7039 * 2) Redis calls this function, that forks():
7040 * 2a) the child rewrite the append only file in a temp file.
7041 * 2b) the parent accumulates differences in server.bgrewritebuf.
7042 * 3) When the child finished '2a' exists.
7043 * 4) The parent will trap the exit code, if it's OK, will append the
7044 * data accumulated into server.bgrewritebuf into the temp file, and
7045 * finally will rename(2) the temp file in the actual file name.
7046 * The the new file is reopened as the new append only file. Profit!
7048 static int rewriteAppendOnlyFileBackground(void) {
7051 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7052 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7053 if ((childpid
= fork()) == 0) {
7057 if (server
.vm_enabled
) vmReopenSwapFile();
7059 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7060 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7067 if (childpid
== -1) {
7068 redisLog(REDIS_WARNING
,
7069 "Can't rewrite append only file in background: fork: %s",
7073 redisLog(REDIS_NOTICE
,
7074 "Background append only file rewriting started by pid %d",childpid
);
7075 server
.bgrewritechildpid
= childpid
;
7076 /* We set appendseldb to -1 in order to force the next call to the
7077 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7078 * accumulated by the parent into server.bgrewritebuf will start
7079 * with a SELECT statement and it will be safe to merge. */
7080 server
.appendseldb
= -1;
7083 return REDIS_OK
; /* unreached */
7086 static void bgrewriteaofCommand(redisClient
*c
) {
7087 if (server
.bgrewritechildpid
!= -1) {
7088 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7091 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7092 char *status
= "+Background append only file rewriting started\r\n";
7093 addReplySds(c
,sdsnew(status
));
7095 addReply(c
,shared
.err
);
7099 static void aofRemoveTempFile(pid_t childpid
) {
7102 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7106 /* Virtual Memory is composed mainly of two subsystems:
7107 * - Blocking Virutal Memory
7108 * - Threaded Virtual Memory I/O
7109 * The two parts are not fully decoupled, but functions are split among two
7110 * different sections of the source code (delimited by comments) in order to
7111 * make more clear what functionality is about the blocking VM and what about
7112 * the threaded (not blocking) VM.
7116 * Redis VM is a blocking VM (one that blocks reading swapped values from
7117 * disk into memory when a value swapped out is needed in memory) that is made
7118 * unblocking by trying to examine the command argument vector in order to
7119 * load in background values that will likely be needed in order to exec
7120 * the command. The command is executed only once all the relevant keys
7121 * are loaded into memory.
7123 * This basically is almost as simple of a blocking VM, but almost as parallel
7124 * as a fully non-blocking VM.
7127 /* =================== Virtual Memory - Blocking Side ====================== */
7129 /* substitute the first occurrence of '%p' with the process pid in the
7130 * swap file name. */
7131 static void expandVmSwapFilename(void) {
7132 char *p
= strstr(server
.vm_swap_file
,"%p");
7138 new = sdscat(new,server
.vm_swap_file
);
7139 new = sdscatprintf(new,"%ld",(long) getpid());
7140 new = sdscat(new,p
+2);
7141 zfree(server
.vm_swap_file
);
7142 server
.vm_swap_file
= new;
7145 static void vmInit(void) {
7150 if (server
.vm_max_threads
!= 0)
7151 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7153 expandVmSwapFilename();
7154 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7155 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7156 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7158 if (server
.vm_fp
== NULL
) {
7159 redisLog(REDIS_WARNING
,
7160 "Impossible to open the swap file: %s. Exiting.",
7164 server
.vm_fd
= fileno(server
.vm_fp
);
7165 server
.vm_next_page
= 0;
7166 server
.vm_near_pages
= 0;
7167 server
.vm_stats_used_pages
= 0;
7168 server
.vm_stats_swapped_objects
= 0;
7169 server
.vm_stats_swapouts
= 0;
7170 server
.vm_stats_swapins
= 0;
7171 totsize
= server
.vm_pages
*server
.vm_page_size
;
7172 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7173 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7174 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7178 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7180 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7181 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7182 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7183 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7185 /* Initialize threaded I/O (used by Virtual Memory) */
7186 server
.io_newjobs
= listCreate();
7187 server
.io_processing
= listCreate();
7188 server
.io_processed
= listCreate();
7189 server
.io_ready_clients
= listCreate();
7190 pthread_mutex_init(&server
.io_mutex
,NULL
);
7191 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7192 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7193 server
.io_active_threads
= 0;
7194 if (pipe(pipefds
) == -1) {
7195 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7199 server
.io_ready_pipe_read
= pipefds
[0];
7200 server
.io_ready_pipe_write
= pipefds
[1];
7201 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7202 /* LZF requires a lot of stack */
7203 pthread_attr_init(&server
.io_threads_attr
);
7204 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7205 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7206 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7207 /* Listen for events in the threaded I/O pipe */
7208 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7209 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7210 oom("creating file event");
7213 /* Mark the page as used */
7214 static void vmMarkPageUsed(off_t page
) {
7215 off_t byte
= page
/8;
7217 redisAssert(vmFreePage(page
) == 1);
7218 server
.vm_bitmap
[byte
] |= 1<<bit
;
7219 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7220 (long long)page
, (long long)byte
, bit
);
7223 /* Mark N contiguous pages as used, with 'page' being the first. */
7224 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7227 for (j
= 0; j
< count
; j
++)
7228 vmMarkPageUsed(page
+j
);
7229 server
.vm_stats_used_pages
+= count
;
7232 /* Mark the page as free */
7233 static void vmMarkPageFree(off_t page
) {
7234 off_t byte
= page
/8;
7236 redisAssert(vmFreePage(page
) == 0);
7237 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7238 redisLog(REDIS_DEBUG
,"Mark free: %lld (byte:%lld bit:%d)\n",
7239 (long long)page
, (long long)byte
, bit
);
7242 /* Mark N contiguous pages as free, with 'page' being the first. */
7243 static void vmMarkPagesFree(off_t page
, off_t count
) {
7246 for (j
= 0; j
< count
; j
++)
7247 vmMarkPageFree(page
+j
);
7248 server
.vm_stats_used_pages
-= count
;
7249 if (server
.vm_stats_used_pages
> 100000000) {
7254 /* Test if the page is free */
7255 static int vmFreePage(off_t page
) {
7256 off_t byte
= page
/8;
7258 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7261 /* Find N contiguous free pages storing the first page of the cluster in *first.
7262 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7263 * REDIS_ERR is returned.
7265 * This function uses a simple algorithm: we try to allocate
7266 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7267 * again from the start of the swap file searching for free spaces.
7269 * If it looks pretty clear that there are no free pages near our offset
7270 * we try to find less populated places doing a forward jump of
7271 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7272 * without hurry, and then we jump again and so forth...
7274 * This function can be improved using a free list to avoid to guess
7275 * too much, since we could collect data about freed pages.
7277 * note: I implemented this function just after watching an episode of
7278 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7280 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7281 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7283 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7284 server
.vm_near_pages
= 0;
7285 server
.vm_next_page
= 0;
7287 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7288 base
= server
.vm_next_page
;
7290 while(offset
< server
.vm_pages
) {
7291 off_t
this = base
+offset
;
7293 /* If we overflow, restart from page zero */
7294 if (this >= server
.vm_pages
) {
7295 this -= server
.vm_pages
;
7297 /* Just overflowed, what we found on tail is no longer
7298 * interesting, as it's no longer contiguous. */
7302 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7303 if (vmFreePage(this)) {
7304 /* This is a free page */
7306 /* Already got N free pages? Return to the caller, with success */
7308 *first
= this-(n
-1);
7309 server
.vm_next_page
= this+1;
7313 /* The current one is not a free page */
7317 /* Fast-forward if the current page is not free and we already
7318 * searched enough near this place. */
7320 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7321 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7323 /* Note that even if we rewind after the jump, we are don't need
7324 * to make sure numfree is set to zero as we only jump *if* it
7325 * is set to zero. */
7327 /* Otherwise just check the next page */
7334 /* Write the specified object at the specified page of the swap file */
7335 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7336 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7337 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7338 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7339 redisLog(REDIS_WARNING
,
7340 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7344 rdbSaveObject(server
.vm_fp
,o
);
7345 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7349 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7350 * needed to later retrieve the object into the key object.
7351 * If we can't find enough contiguous empty pages to swap the object on disk
7352 * REDIS_ERR is returned. */
7353 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7354 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7357 assert(key
->storage
== REDIS_VM_MEMORY
);
7358 assert(key
->refcount
== 1);
7359 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7360 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7361 key
->vm
.page
= page
;
7362 key
->vm
.usedpages
= pages
;
7363 key
->storage
= REDIS_VM_SWAPPED
;
7364 key
->vtype
= val
->type
;
7365 decrRefCount(val
); /* Deallocate the object from memory. */
7366 vmMarkPagesUsed(page
,pages
);
7367 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7368 (unsigned char*) key
->ptr
,
7369 (unsigned long long) page
, (unsigned long long) pages
);
7370 server
.vm_stats_swapped_objects
++;
7371 server
.vm_stats_swapouts
++;
7372 fflush(server
.vm_fp
);
7376 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7379 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7380 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7381 redisLog(REDIS_WARNING
,
7382 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7386 o
= rdbLoadObject(type
,server
.vm_fp
);
7388 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7391 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7395 /* Load the value object relative to the 'key' object from swap to memory.
7396 * The newly allocated object is returned.
7398 * If preview is true the unserialized object is returned to the caller but
7399 * no changes are made to the key object, nor the pages are marked as freed */
7400 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7403 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7404 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7406 key
->storage
= REDIS_VM_MEMORY
;
7407 key
->vm
.atime
= server
.unixtime
;
7408 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7409 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7410 (unsigned char*) key
->ptr
);
7411 server
.vm_stats_swapped_objects
--;
7413 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7414 (unsigned char*) key
->ptr
);
7416 server
.vm_stats_swapins
++;
7420 /* Plain object loading, from swap to memory */
7421 static robj
*vmLoadObject(robj
*key
) {
7422 /* If we are loading the object in background, stop it, we
7423 * need to load this object synchronously ASAP. */
7424 if (key
->storage
== REDIS_VM_LOADING
)
7425 vmCancelThreadedIOJob(key
);
7426 return vmGenericLoadObject(key
,0);
7429 /* Just load the value on disk, without to modify the key.
7430 * This is useful when we want to perform some operation on the value
7431 * without to really bring it from swap to memory, like while saving the
7432 * dataset or rewriting the append only log. */
7433 static robj
*vmPreviewObject(robj
*key
) {
7434 return vmGenericLoadObject(key
,1);
7437 /* How a good candidate is this object for swapping?
7438 * The better candidate it is, the greater the returned value.
7440 * Currently we try to perform a fast estimation of the object size in
7441 * memory, and combine it with aging informations.
7443 * Basically swappability = idle-time * log(estimated size)
7445 * Bigger objects are preferred over smaller objects, but not
7446 * proportionally, this is why we use the logarithm. This algorithm is
7447 * just a first try and will probably be tuned later. */
7448 static double computeObjectSwappability(robj
*o
) {
7449 time_t age
= server
.unixtime
- o
->vm
.atime
;
7453 struct dictEntry
*de
;
7456 if (age
<= 0) return 0;
7459 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7462 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7467 listNode
*ln
= listFirst(l
);
7469 asize
= sizeof(list
);
7471 robj
*ele
= ln
->value
;
7474 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7475 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7477 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7482 z
= (o
->type
== REDIS_ZSET
);
7483 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7485 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7486 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7491 de
= dictGetRandomKey(d
);
7492 ele
= dictGetEntryKey(de
);
7493 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7494 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7496 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7497 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7501 return (double)asize
*log(1+asize
);
7504 /* Try to swap an object that's a good candidate for swapping.
7505 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7506 * to swap any object at all.
7508 * If 'usethreaded' is true, Redis will try to swap the object in background
7509 * using I/O threads. */
7510 static int vmSwapOneObject(int usethreads
) {
7512 struct dictEntry
*best
= NULL
;
7513 double best_swappability
= 0;
7514 redisDb
*best_db
= NULL
;
7517 for (j
= 0; j
< server
.dbnum
; j
++) {
7518 redisDb
*db
= server
.db
+j
;
7519 /* Why maxtries is set to 100?
7520 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7521 * are swappable objects */
7524 if (dictSize(db
->dict
) == 0) continue;
7525 for (i
= 0; i
< 5; i
++) {
7527 double swappability
;
7529 if (maxtries
) maxtries
--;
7530 de
= dictGetRandomKey(db
->dict
);
7531 key
= dictGetEntryKey(de
);
7532 val
= dictGetEntryVal(de
);
7533 /* Only swap objects that are currently in memory.
7535 * Also don't swap shared objects if threaded VM is on, as we
7536 * try to ensure that the main thread does not touch the
7537 * object while the I/O thread is using it, but we can't
7538 * control other keys without adding additional mutex. */
7539 if (key
->storage
!= REDIS_VM_MEMORY
||
7540 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7541 if (maxtries
) i
--; /* don't count this try */
7544 swappability
= computeObjectSwappability(val
);
7545 if (!best
|| swappability
> best_swappability
) {
7547 best_swappability
= swappability
;
7553 redisLog(REDIS_DEBUG
,"No swappable key found!");
7556 key
= dictGetEntryKey(best
);
7557 val
= dictGetEntryVal(best
);
7559 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7560 key
->ptr
, best_swappability
);
7562 /* Unshare the key if needed */
7563 if (key
->refcount
> 1) {
7564 robj
*newkey
= dupStringObject(key
);
7566 key
= dictGetEntryKey(best
) = newkey
;
7570 vmSwapObjectThreaded(key
,val
,best_db
);
7573 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7574 dictGetEntryVal(best
) = NULL
;
7582 static int vmSwapOneObjectBlocking() {
7583 return vmSwapOneObject(0);
7586 static int vmSwapOneObjectThreaded() {
7587 return vmSwapOneObject(1);
7590 /* Return true if it's safe to swap out objects in a given moment.
7591 * Basically we don't want to swap objects out while there is a BGSAVE
7592 * or a BGAEOREWRITE running in backgroud. */
7593 static int vmCanSwapOut(void) {
7594 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7597 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7598 * and was deleted. Otherwise 0 is returned. */
7599 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7603 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7604 foundkey
= dictGetEntryKey(de
);
7605 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7610 /* =================== Virtual Memory - Threaded I/O ======================= */
7612 static void freeIOJob(iojob
*j
) {
7613 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7614 j
->type
== REDIS_IOJOB_DO_SWAP
||
7615 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7616 decrRefCount(j
->val
);
7617 decrRefCount(j
->key
);
7621 /* Every time a thread finished a Job, it writes a byte into the write side
7622 * of an unix pipe in order to "awake" the main thread, and this function
7624 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7628 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7630 REDIS_NOTUSED(mask
);
7631 REDIS_NOTUSED(privdata
);
7633 /* For every byte we read in the read side of the pipe, there is one
7634 * I/O job completed to process. */
7635 while((retval
= read(fd
,buf
,1)) == 1) {
7639 struct dictEntry
*de
;
7641 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7643 /* Get the processed element (the oldest one) */
7645 assert(listLength(server
.io_processed
) != 0);
7646 if (toprocess
== -1) {
7647 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7648 if (toprocess
<= 0) toprocess
= 1;
7650 ln
= listFirst(server
.io_processed
);
7652 listDelNode(server
.io_processed
,ln
);
7654 /* If this job is marked as canceled, just ignore it */
7659 /* Post process it in the main thread, as there are things we
7660 * can do just here to avoid race conditions and/or invasive locks */
7661 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
);
7662 de
= dictFind(j
->db
->dict
,j
->key
);
7664 key
= dictGetEntryKey(de
);
7665 if (j
->type
== REDIS_IOJOB_LOAD
) {
7668 /* Key loaded, bring it at home */
7669 key
->storage
= REDIS_VM_MEMORY
;
7670 key
->vm
.atime
= server
.unixtime
;
7671 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7672 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7673 (unsigned char*) key
->ptr
);
7674 server
.vm_stats_swapped_objects
--;
7675 server
.vm_stats_swapins
++;
7676 dictGetEntryVal(de
) = j
->val
;
7677 incrRefCount(j
->val
);
7680 /* Handle clients waiting for this key to be loaded. */
7681 handleClientsBlockedOnSwappedKey(db
,key
);
7682 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7683 /* Now we know the amount of pages required to swap this object.
7684 * Let's find some space for it, and queue this task again
7685 * rebranded as REDIS_IOJOB_DO_SWAP. */
7686 if (!vmCanSwapOut() ||
7687 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7689 /* Ooops... no space or we can't swap as there is
7690 * a fork()ed Redis trying to save stuff on disk. */
7692 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7694 /* Note that we need to mark this pages as used now,
7695 * if the job will be canceled, we'll mark them as freed
7697 vmMarkPagesUsed(j
->page
,j
->pages
);
7698 j
->type
= REDIS_IOJOB_DO_SWAP
;
7703 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7706 /* Key swapped. We can finally free some memory. */
7707 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7708 printf("key->storage: %d\n",key
->storage
);
7709 printf("key->name: %s\n",(char*)key
->ptr
);
7710 printf("key->refcount: %d\n",key
->refcount
);
7711 printf("val: %p\n",(void*)j
->val
);
7712 printf("val->type: %d\n",j
->val
->type
);
7713 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7715 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7716 val
= dictGetEntryVal(de
);
7717 key
->vm
.page
= j
->page
;
7718 key
->vm
.usedpages
= j
->pages
;
7719 key
->storage
= REDIS_VM_SWAPPED
;
7720 key
->vtype
= j
->val
->type
;
7721 decrRefCount(val
); /* Deallocate the object from memory. */
7722 dictGetEntryVal(de
) = NULL
;
7723 redisLog(REDIS_DEBUG
,
7724 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7725 (unsigned char*) key
->ptr
,
7726 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7727 server
.vm_stats_swapped_objects
++;
7728 server
.vm_stats_swapouts
++;
7730 /* Put a few more swap requests in queue if we are still
7732 if (trytoswap
&& vmCanSwapOut() &&
7733 zmalloc_used_memory() > server
.vm_max_memory
)
7738 more
= listLength(server
.io_newjobs
) <
7739 (unsigned) server
.vm_max_threads
;
7741 /* Don't waste CPU time if swappable objects are rare. */
7742 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
7750 if (processed
== toprocess
) return;
7752 if (retval
< 0 && errno
!= EAGAIN
) {
7753 redisLog(REDIS_WARNING
,
7754 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7759 static void lockThreadedIO(void) {
7760 pthread_mutex_lock(&server
.io_mutex
);
7763 static void unlockThreadedIO(void) {
7764 pthread_mutex_unlock(&server
.io_mutex
);
7767 /* Remove the specified object from the threaded I/O queue if still not
7768 * processed, otherwise make sure to flag it as canceled. */
7769 static void vmCancelThreadedIOJob(robj
*o
) {
7771 server
.io_newjobs
, /* 0 */
7772 server
.io_processing
, /* 1 */
7773 server
.io_processed
/* 2 */
7777 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7780 /* Search for a matching key in one of the queues */
7781 for (i
= 0; i
< 3; i
++) {
7785 listRewind(lists
[i
],&li
);
7786 while ((ln
= listNext(&li
)) != NULL
) {
7787 iojob
*job
= ln
->value
;
7789 if (job
->canceled
) continue; /* Skip this, already canceled. */
7790 if (compareStringObjects(job
->key
,o
) == 0) {
7791 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7792 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
7793 /* Mark the pages as free since the swap didn't happened
7794 * or happened but is now discarded. */
7795 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
7796 vmMarkPagesFree(job
->page
,job
->pages
);
7797 /* Cancel the job. It depends on the list the job is
7800 case 0: /* io_newjobs */
7801 /* If the job was yet not processed the best thing to do
7802 * is to remove it from the queue at all */
7804 listDelNode(lists
[i
],ln
);
7806 case 1: /* io_processing */
7807 /* Oh Shi- the thread is messing with the Job:
7809 * Probably it's accessing the object if this is a
7810 * PREPARE_SWAP or DO_SWAP job.
7811 * If it's a LOAD job it may be reading from disk and
7812 * if we don't wait for the job to terminate before to
7813 * cancel it, maybe in a few microseconds data can be
7814 * corrupted in this pages. So the short story is:
7816 * Better to wait for the job to move into the
7817 * next queue (processed)... */
7819 /* We try again and again until the job is completed. */
7821 /* But let's wait some time for the I/O thread
7822 * to finish with this job. After all this condition
7823 * should be very rare. */
7826 case 2: /* io_processed */
7827 /* The job was already processed, that's easy...
7828 * just mark it as canceled so that we'll ignore it
7829 * when processing completed jobs. */
7833 /* Finally we have to adjust the storage type of the object
7834 * in order to "UNDO" the operaiton. */
7835 if (o
->storage
== REDIS_VM_LOADING
)
7836 o
->storage
= REDIS_VM_SWAPPED
;
7837 else if (o
->storage
== REDIS_VM_SWAPPING
)
7838 o
->storage
= REDIS_VM_MEMORY
;
7845 assert(1 != 1); /* We should never reach this */
7848 static void *IOThreadEntryPoint(void *arg
) {
7853 pthread_detach(pthread_self());
7855 /* Get a new job to process */
7857 if (listLength(server
.io_newjobs
) == 0) {
7858 /* No new jobs in queue, exit. */
7859 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7860 (long long) pthread_self());
7861 server
.io_active_threads
--;
7865 ln
= listFirst(server
.io_newjobs
);
7867 listDelNode(server
.io_newjobs
,ln
);
7868 /* Add the job in the processing queue */
7869 j
->thread
= pthread_self();
7870 listAddNodeTail(server
.io_processing
,j
);
7871 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7873 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7874 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7876 /* Process the Job */
7877 if (j
->type
== REDIS_IOJOB_LOAD
) {
7878 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
7879 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7880 FILE *fp
= fopen("/dev/null","w+");
7881 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7883 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7884 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7888 /* Done: insert the job into the processed queue */
7889 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7890 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7892 listDelNode(server
.io_processing
,ln
);
7893 listAddNodeTail(server
.io_processed
,j
);
7896 /* Signal the main thread there is new stuff to process */
7897 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7899 return NULL
; /* never reached */
7902 static void spawnIOThread(void) {
7904 sigset_t mask
, omask
;
7907 sigaddset(&mask
,SIGCHLD
);
7908 sigaddset(&mask
,SIGHUP
);
7909 sigaddset(&mask
,SIGPIPE
);
7910 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
7911 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7912 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
7913 server
.io_active_threads
++;
7916 /* We need to wait for the last thread to exit before we are able to
7917 * fork() in order to BGSAVE or BGREWRITEAOF. */
7918 static void waitEmptyIOJobsQueue(void) {
7920 int io_processed_len
;
7923 if (listLength(server
.io_newjobs
) == 0 &&
7924 listLength(server
.io_processing
) == 0 &&
7925 server
.io_active_threads
== 0)
7930 /* While waiting for empty jobs queue condition we post-process some
7931 * finshed job, as I/O threads may be hanging trying to write against
7932 * the io_ready_pipe_write FD but there are so much pending jobs that
7934 io_processed_len
= listLength(server
.io_processed
);
7936 if (io_processed_len
) {
7937 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
7938 usleep(1000); /* 1 millisecond */
7940 usleep(10000); /* 10 milliseconds */
7945 static void vmReopenSwapFile(void) {
7946 /* Note: we don't close the old one as we are in the child process
7947 * and don't want to mess at all with the original file object. */
7948 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
7949 if (server
.vm_fp
== NULL
) {
7950 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
7951 server
.vm_swap_file
);
7954 server
.vm_fd
= fileno(server
.vm_fp
);
7957 /* This function must be called while with threaded IO locked */
7958 static void queueIOJob(iojob
*j
) {
7959 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
7960 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
7961 listAddNodeTail(server
.io_newjobs
,j
);
7962 if (server
.io_active_threads
< server
.vm_max_threads
)
7966 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
7969 assert(key
->storage
== REDIS_VM_MEMORY
);
7970 assert(key
->refcount
== 1);
7972 j
= zmalloc(sizeof(*j
));
7973 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
7975 j
->key
= dupStringObject(key
);
7979 j
->thread
= (pthread_t
) -1;
7980 key
->storage
= REDIS_VM_SWAPPING
;
7988 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
7990 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
7991 * If there is not already a job loading the key, it is craeted.
7992 * The key is added to the io_keys list in the client structure, and also
7993 * in the hash table mapping swapped keys to waiting clients, that is,
7994 * server.io_waited_keys. */
7995 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
7996 struct dictEntry
*de
;
8000 /* If the key does not exist or is already in RAM we don't need to
8001 * block the client at all. */
8002 de
= dictFind(c
->db
->dict
,key
);
8003 if (de
== NULL
) return 0;
8004 o
= dictGetEntryKey(de
);
8005 if (o
->storage
== REDIS_VM_MEMORY
) {
8007 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8008 /* We were swapping the key, undo it! */
8009 vmCancelThreadedIOJob(o
);
8013 /* OK: the key is either swapped, or being loaded just now. */
8015 /* Add the key to the list of keys this client is waiting for.
8016 * This maps clients to keys they are waiting for. */
8017 listAddNodeTail(c
->io_keys
,key
);
8020 /* Add the client to the swapped keys => clients waiting map. */
8021 de
= dictFind(c
->db
->io_keys
,key
);
8025 /* For every key we take a list of clients blocked for it */
8027 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8029 assert(retval
== DICT_OK
);
8031 l
= dictGetEntryVal(de
);
8033 listAddNodeTail(l
,c
);
8035 /* Are we already loading the key from disk? If not create a job */
8036 if (o
->storage
== REDIS_VM_SWAPPED
) {
8039 o
->storage
= REDIS_VM_LOADING
;
8040 j
= zmalloc(sizeof(*j
));
8041 j
->type
= REDIS_IOJOB_LOAD
;
8043 j
->key
= dupStringObject(key
);
8044 j
->key
->vtype
= o
->vtype
;
8045 j
->page
= o
->vm
.page
;
8048 j
->thread
= (pthread_t
) -1;
8056 /* Is this client attempting to run a command against swapped keys?
8057 * If so, block it ASAP, load the keys in background, then resume it.
8059 * The important idea about this function is that it can fail! If keys will
8060 * still be swapped when the client is resumed, this key lookups will
8061 * just block loading keys from disk. In practical terms this should only
8062 * happen with SORT BY command or if there is a bug in this function.
8064 * Return 1 if the client is marked as blocked, 0 if the client can
8065 * continue as the keys it is going to access appear to be in memory. */
8066 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8067 if (cmd
->proc
== getCommand
) {
8068 waitForSwappedKey(c
,c
->argv
[1]);
8070 /* If the client was blocked for at least one key, mark it as blocked. */
8071 if (listLength(c
->io_keys
)) {
8072 c
->flags
|= REDIS_IO_WAIT
;
8073 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8074 server
.vm_blocked_clients
++;
8081 /* Remove the 'key' from the list of blocked keys for a given client.
8083 * The function returns 1 when there are no longer blocking keys after
8084 * the current one was removed (and the client can be unblocked). */
8085 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8089 struct dictEntry
*de
;
8091 /* Remove the key from the list of keys this client is waiting for. */
8092 listRewind(c
->io_keys
,&li
);
8093 while ((ln
= listNext(&li
)) != NULL
) {
8094 if (compareStringObjects(ln
->value
,key
) == 0) {
8095 listDelNode(c
->io_keys
,ln
);
8101 /* Remove the client form the key => waiting clients map. */
8102 de
= dictFind(c
->db
->io_keys
,key
);
8104 l
= dictGetEntryVal(de
);
8105 ln
= listSearchKey(l
,c
);
8108 if (listLength(l
) == 0)
8109 dictDelete(c
->db
->io_keys
,key
);
8111 return listLength(c
->io_keys
) == 0;
8114 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8115 struct dictEntry
*de
;
8120 de
= dictFind(db
->io_keys
,key
);
8123 l
= dictGetEntryVal(de
);
8124 len
= listLength(l
);
8125 /* Note: we can't use something like while(listLength(l)) as the list
8126 * can be freed by the calling function when we remove the last element. */
8129 redisClient
*c
= ln
->value
;
8131 if (dontWaitForSwappedKey(c
,key
)) {
8132 /* Put the client in the list of clients ready to go as we
8133 * loaded all the keys about it. */
8134 listAddNodeTail(server
.io_ready_clients
,c
);
8139 /* ================================= Debugging ============================== */
8141 static void debugCommand(redisClient
*c
) {
8142 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8144 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8145 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8146 addReply(c
,shared
.err
);
8150 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8151 addReply(c
,shared
.err
);
8154 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8155 addReply(c
,shared
.ok
);
8156 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8158 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8159 addReply(c
,shared
.err
);
8162 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8163 addReply(c
,shared
.ok
);
8164 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8165 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8169 addReply(c
,shared
.nokeyerr
);
8172 key
= dictGetEntryKey(de
);
8173 val
= dictGetEntryVal(de
);
8174 if (server
.vm_enabled
&& (key
->storage
== REDIS_VM_MEMORY
||
8175 key
->storage
== REDIS_VM_SWAPPING
)) {
8176 addReplySds(c
,sdscatprintf(sdsempty(),
8177 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8178 "encoding:%d serializedlength:%lld\r\n",
8179 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8180 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8182 addReplySds(c
,sdscatprintf(sdsempty(),
8183 "+Key at:%p refcount:%d, value swapped at: page %llu "
8184 "using %llu pages\r\n",
8185 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8186 (unsigned long long) key
->vm
.usedpages
));
8188 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8189 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8192 if (!server
.vm_enabled
) {
8193 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8197 addReply(c
,shared
.nokeyerr
);
8200 key
= dictGetEntryKey(de
);
8201 val
= dictGetEntryVal(de
);
8202 /* If the key is shared we want to create a copy */
8203 if (key
->refcount
> 1) {
8204 robj
*newkey
= dupStringObject(key
);
8206 key
= dictGetEntryKey(de
) = newkey
;
8209 if (key
->storage
!= REDIS_VM_MEMORY
) {
8210 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8211 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8212 dictGetEntryVal(de
) = NULL
;
8213 addReply(c
,shared
.ok
);
8215 addReply(c
,shared
.err
);
8218 addReplySds(c
,sdsnew(
8219 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8223 static void _redisAssert(char *estr
, char *file
, int line
) {
8224 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8225 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8226 #ifdef HAVE_BACKTRACE
8227 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8232 /* =================================== Main! ================================ */
8235 int linuxOvercommitMemoryValue(void) {
8236 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8240 if (fgets(buf
,64,fp
) == NULL
) {
8249 void linuxOvercommitMemoryWarning(void) {
8250 if (linuxOvercommitMemoryValue() == 0) {
8251 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.");
8254 #endif /* __linux__ */
8256 static void daemonize(void) {
8260 if (fork() != 0) exit(0); /* parent exits */
8261 setsid(); /* create a new session */
8263 /* Every output goes to /dev/null. If Redis is daemonized but
8264 * the 'logfile' is set to 'stdout' in the configuration file
8265 * it will not log at all. */
8266 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8267 dup2(fd
, STDIN_FILENO
);
8268 dup2(fd
, STDOUT_FILENO
);
8269 dup2(fd
, STDERR_FILENO
);
8270 if (fd
> STDERR_FILENO
) close(fd
);
8272 /* Try to write the pid file */
8273 fp
= fopen(server
.pidfile
,"w");
8275 fprintf(fp
,"%d\n",getpid());
8280 int main(int argc
, char **argv
) {
8285 resetServerSaveParams();
8286 loadServerConfig(argv
[1]);
8287 } else if (argc
> 2) {
8288 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8291 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'");
8293 if (server
.daemonize
) daemonize();
8295 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8297 linuxOvercommitMemoryWarning();
8300 if (server
.appendonly
) {
8301 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8302 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8304 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8305 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8307 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8308 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8310 aeDeleteEventLoop(server
.el
);
8314 /* ============================= Backtrace support ========================= */
8316 #ifdef HAVE_BACKTRACE
8317 static char *findFuncName(void *pointer
, unsigned long *offset
);
8319 static void *getMcontextEip(ucontext_t
*uc
) {
8320 #if defined(__FreeBSD__)
8321 return (void*) uc
->uc_mcontext
.mc_eip
;
8322 #elif defined(__dietlibc__)
8323 return (void*) uc
->uc_mcontext
.eip
;
8324 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8326 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8328 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8330 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8331 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8332 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8334 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8336 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8337 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8338 #elif defined(__ia64__) /* Linux IA64 */
8339 return (void*) uc
->uc_mcontext
.sc_ip
;
8345 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8347 char **messages
= NULL
;
8348 int i
, trace_size
= 0;
8349 unsigned long offset
=0;
8350 ucontext_t
*uc
= (ucontext_t
*) secret
;
8352 REDIS_NOTUSED(info
);
8354 redisLog(REDIS_WARNING
,
8355 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8356 infostring
= genRedisInfoString();
8357 redisLog(REDIS_WARNING
, "%s",infostring
);
8358 /* It's not safe to sdsfree() the returned string under memory
8359 * corruption conditions. Let it leak as we are going to abort */
8361 trace_size
= backtrace(trace
, 100);
8362 /* overwrite sigaction with caller's address */
8363 if (getMcontextEip(uc
) != NULL
) {
8364 trace
[1] = getMcontextEip(uc
);
8366 messages
= backtrace_symbols(trace
, trace_size
);
8368 for (i
=1; i
<trace_size
; ++i
) {
8369 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8371 p
= strchr(messages
[i
],'+');
8372 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8373 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8375 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8378 /* free(messages); Don't call free() with possibly corrupted memory. */
8382 static void setupSigSegvAction(void) {
8383 struct sigaction act
;
8385 sigemptyset (&act
.sa_mask
);
8386 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8387 * is used. Otherwise, sa_handler is used */
8388 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8389 act
.sa_sigaction
= segvHandler
;
8390 sigaction (SIGSEGV
, &act
, NULL
);
8391 sigaction (SIGBUS
, &act
, NULL
);
8392 sigaction (SIGFPE
, &act
, NULL
);
8393 sigaction (SIGILL
, &act
, NULL
);
8394 sigaction (SIGBUS
, &act
, NULL
);
8398 #include "staticsymbols.h"
8399 /* This function try to convert a pointer into a function name. It's used in
8400 * oreder to provide a backtrace under segmentation fault that's able to
8401 * display functions declared as static (otherwise the backtrace is useless). */
8402 static char *findFuncName(void *pointer
, unsigned long *offset
){
8404 unsigned long off
, minoff
= 0;
8406 /* Try to match against the Symbol with the smallest offset */
8407 for (i
=0; symsTable
[i
].pointer
; i
++) {
8408 unsigned long lp
= (unsigned long) pointer
;
8410 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8411 off
=lp
-symsTable
[i
].pointer
;
8412 if (ret
< 0 || off
< minoff
) {
8418 if (ret
== -1) return NULL
;
8420 return symsTable
[ret
].name
;
8422 #else /* HAVE_BACKTRACE */
8423 static void setupSigSegvAction(void) {
8425 #endif /* HAVE_BACKTRACE */