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
);
654 /*================================= Globals ================================= */
657 static struct redisServer server
; /* server global state */
658 static struct redisCommand cmdTable
[] = {
659 {"get",getCommand
,2,REDIS_CMD_INLINE
},
660 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
661 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
662 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
663 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
664 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
665 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
666 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
667 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
668 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
669 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
670 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
671 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
672 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
673 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
674 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
675 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
676 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
677 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
678 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
679 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
680 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
681 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
682 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
683 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
684 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
685 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
686 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
687 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
688 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
689 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
690 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
691 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
692 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
693 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
694 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
695 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
696 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
697 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
698 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
699 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
700 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
701 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
702 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
703 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
704 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
705 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
706 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
707 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
708 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
709 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
710 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
711 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
712 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
713 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
714 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
715 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
716 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
717 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
718 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
719 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
720 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
721 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
722 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
723 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
724 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
725 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
726 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
727 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
728 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
729 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
730 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
731 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
732 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
733 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
734 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
735 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
736 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
740 /*============================ Utility functions ============================ */
742 /* Glob-style pattern matching. */
743 int stringmatchlen(const char *pattern
, int patternLen
,
744 const char *string
, int stringLen
, int nocase
)
749 while (pattern
[1] == '*') {
754 return 1; /* match */
756 if (stringmatchlen(pattern
+1, patternLen
-1,
757 string
, stringLen
, nocase
))
758 return 1; /* match */
762 return 0; /* no match */
766 return 0; /* no match */
776 not = pattern
[0] == '^';
783 if (pattern
[0] == '\\') {
786 if (pattern
[0] == string
[0])
788 } else if (pattern
[0] == ']') {
790 } else if (patternLen
== 0) {
794 } else if (pattern
[1] == '-' && patternLen
>= 3) {
795 int start
= pattern
[0];
796 int end
= pattern
[2];
804 start
= tolower(start
);
810 if (c
>= start
&& c
<= end
)
814 if (pattern
[0] == string
[0])
817 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
827 return 0; /* no match */
833 if (patternLen
>= 2) {
840 if (pattern
[0] != string
[0])
841 return 0; /* no match */
843 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
844 return 0; /* no match */
852 if (stringLen
== 0) {
853 while(*pattern
== '*') {
860 if (patternLen
== 0 && stringLen
== 0)
865 static void redisLog(int level
, const char *fmt
, ...) {
869 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
873 if (level
>= server
.verbosity
) {
879 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
880 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
881 vfprintf(fp
, fmt
, ap
);
887 if (server
.logfile
) fclose(fp
);
890 /*====================== Hash table type implementation ==================== */
892 /* This is an hash table type that uses the SDS dynamic strings libary as
893 * keys and radis objects as values (objects can hold SDS strings,
896 static void dictVanillaFree(void *privdata
, void *val
)
898 DICT_NOTUSED(privdata
);
902 static void dictListDestructor(void *privdata
, void *val
)
904 DICT_NOTUSED(privdata
);
905 listRelease((list
*)val
);
908 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
912 DICT_NOTUSED(privdata
);
914 l1
= sdslen((sds
)key1
);
915 l2
= sdslen((sds
)key2
);
916 if (l1
!= l2
) return 0;
917 return memcmp(key1
, key2
, l1
) == 0;
920 static void dictRedisObjectDestructor(void *privdata
, void *val
)
922 DICT_NOTUSED(privdata
);
924 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
928 static int dictObjKeyCompare(void *privdata
, const void *key1
,
931 const robj
*o1
= key1
, *o2
= key2
;
932 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
935 static unsigned int dictObjHash(const void *key
) {
937 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
940 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
943 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
946 o1
= getDecodedObject(o1
);
947 o2
= getDecodedObject(o2
);
948 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
954 static unsigned int dictEncObjHash(const void *key
) {
955 robj
*o
= (robj
*) key
;
957 o
= getDecodedObject(o
);
958 unsigned int hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
963 /* Sets type and expires */
964 static dictType setDictType
= {
965 dictEncObjHash
, /* hash function */
968 dictEncObjKeyCompare
, /* key compare */
969 dictRedisObjectDestructor
, /* key destructor */
970 NULL
/* val destructor */
973 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
974 static dictType zsetDictType
= {
975 dictEncObjHash
, /* hash function */
978 dictEncObjKeyCompare
, /* key compare */
979 dictRedisObjectDestructor
, /* key destructor */
980 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
984 static dictType hashDictType
= {
985 dictObjHash
, /* hash function */
988 dictObjKeyCompare
, /* key compare */
989 dictRedisObjectDestructor
, /* key destructor */
990 dictRedisObjectDestructor
/* val destructor */
994 static dictType keyptrDictType
= {
995 dictObjHash
, /* hash function */
998 dictObjKeyCompare
, /* key compare */
999 dictRedisObjectDestructor
, /* key destructor */
1000 NULL
/* val destructor */
1003 /* Keylist hash table type has unencoded redis objects as keys and
1004 * lists as values. It's used for blocking operations (BLPOP) and to
1005 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1006 static dictType keylistDictType
= {
1007 dictObjHash
, /* hash function */
1010 dictObjKeyCompare
, /* key compare */
1011 dictRedisObjectDestructor
, /* key destructor */
1012 dictListDestructor
/* val destructor */
1015 /* ========================= Random utility functions ======================= */
1017 /* Redis generally does not try to recover from out of memory conditions
1018 * when allocating objects or strings, it is not clear if it will be possible
1019 * to report this condition to the client since the networking layer itself
1020 * is based on heap allocation for send buffers, so we simply abort.
1021 * At least the code will be simpler to read... */
1022 static void oom(const char *msg
) {
1023 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1028 /* ====================== Redis server networking stuff ===================== */
1029 static void closeTimedoutClients(void) {
1032 time_t now
= time(NULL
);
1035 listRewind(server
.clients
,&li
);
1036 while ((ln
= listNext(&li
)) != NULL
) {
1037 c
= listNodeValue(ln
);
1038 if (server
.maxidletime
&&
1039 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1040 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1041 (now
- c
->lastinteraction
> server
.maxidletime
))
1043 redisLog(REDIS_VERBOSE
,"Closing idle client");
1045 } else if (c
->flags
& REDIS_BLOCKED
) {
1046 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1047 addReply(c
,shared
.nullmultibulk
);
1048 unblockClientWaitingData(c
);
1054 static int htNeedsResize(dict
*dict
) {
1055 long long size
, used
;
1057 size
= dictSlots(dict
);
1058 used
= dictSize(dict
);
1059 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1060 (used
*100/size
< REDIS_HT_MINFILL
));
1063 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1064 * we resize the hash table to save memory */
1065 static void tryResizeHashTables(void) {
1068 for (j
= 0; j
< server
.dbnum
; j
++) {
1069 if (htNeedsResize(server
.db
[j
].dict
)) {
1070 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1071 dictResize(server
.db
[j
].dict
);
1072 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1074 if (htNeedsResize(server
.db
[j
].expires
))
1075 dictResize(server
.db
[j
].expires
);
1079 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1080 void backgroundSaveDoneHandler(int statloc
) {
1081 int exitcode
= WEXITSTATUS(statloc
);
1082 int bysignal
= WIFSIGNALED(statloc
);
1084 if (!bysignal
&& exitcode
== 0) {
1085 redisLog(REDIS_NOTICE
,
1086 "Background saving terminated with success");
1088 server
.lastsave
= time(NULL
);
1089 } else if (!bysignal
&& exitcode
!= 0) {
1090 redisLog(REDIS_WARNING
, "Background saving error");
1092 redisLog(REDIS_WARNING
,
1093 "Background saving terminated by signal");
1094 rdbRemoveTempFile(server
.bgsavechildpid
);
1096 server
.bgsavechildpid
= -1;
1097 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1098 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1099 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1102 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1104 void backgroundRewriteDoneHandler(int statloc
) {
1105 int exitcode
= WEXITSTATUS(statloc
);
1106 int bysignal
= WIFSIGNALED(statloc
);
1108 if (!bysignal
&& exitcode
== 0) {
1112 redisLog(REDIS_NOTICE
,
1113 "Background append only file rewriting terminated with success");
1114 /* Now it's time to flush the differences accumulated by the parent */
1115 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1116 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1118 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1121 /* Flush our data... */
1122 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1123 (signed) sdslen(server
.bgrewritebuf
)) {
1124 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
));
1128 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1129 /* Now our work is to rename the temp file into the stable file. And
1130 * switch the file descriptor used by the server for append only. */
1131 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1132 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1136 /* Mission completed... almost */
1137 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1138 if (server
.appendfd
!= -1) {
1139 /* If append only is actually enabled... */
1140 close(server
.appendfd
);
1141 server
.appendfd
= fd
;
1143 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1144 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1146 /* If append only is disabled we just generate a dump in this
1147 * format. Why not? */
1150 } else if (!bysignal
&& exitcode
!= 0) {
1151 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1153 redisLog(REDIS_WARNING
,
1154 "Background append only file rewriting terminated by signal");
1157 sdsfree(server
.bgrewritebuf
);
1158 server
.bgrewritebuf
= sdsempty();
1159 aofRemoveTempFile(server
.bgrewritechildpid
);
1160 server
.bgrewritechildpid
= -1;
1163 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1164 int j
, loops
= server
.cronloops
++;
1165 REDIS_NOTUSED(eventLoop
);
1167 REDIS_NOTUSED(clientData
);
1169 /* We take a cached value of the unix time in the global state because
1170 * with virtual memory and aging there is to store the current time
1171 * in objects at every object access, and accuracy is not needed.
1172 * To access a global var is faster than calling time(NULL) */
1173 server
.unixtime
= time(NULL
);
1175 /* Show some info about non-empty databases */
1176 for (j
= 0; j
< server
.dbnum
; j
++) {
1177 long long size
, used
, vkeys
;
1179 size
= dictSlots(server
.db
[j
].dict
);
1180 used
= dictSize(server
.db
[j
].dict
);
1181 vkeys
= dictSize(server
.db
[j
].expires
);
1182 if (!(loops
% 5) && (used
|| vkeys
)) {
1183 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1184 /* dictPrintStats(server.dict); */
1188 /* We don't want to resize the hash tables while a bacground saving
1189 * is in progress: the saving child is created using fork() that is
1190 * implemented with a copy-on-write semantic in most modern systems, so
1191 * if we resize the HT while there is the saving child at work actually
1192 * a lot of memory movements in the parent will cause a lot of pages
1194 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1196 /* Show information about connected clients */
1198 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1199 listLength(server
.clients
)-listLength(server
.slaves
),
1200 listLength(server
.slaves
),
1201 zmalloc_used_memory(),
1202 dictSize(server
.sharingpool
));
1205 /* Close connections of timedout clients */
1206 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1207 closeTimedoutClients();
1209 /* Check if a background saving or AOF rewrite in progress terminated */
1210 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1214 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1215 if (pid
== server
.bgsavechildpid
) {
1216 backgroundSaveDoneHandler(statloc
);
1218 backgroundRewriteDoneHandler(statloc
);
1222 /* If there is not a background saving in progress check if
1223 * we have to save now */
1224 time_t now
= time(NULL
);
1225 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1226 struct saveparam
*sp
= server
.saveparams
+j
;
1228 if (server
.dirty
>= sp
->changes
&&
1229 now
-server
.lastsave
> sp
->seconds
) {
1230 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1231 sp
->changes
, sp
->seconds
);
1232 rdbSaveBackground(server
.dbfilename
);
1238 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1239 * will use few CPU cycles if there are few expiring keys, otherwise
1240 * it will get more aggressive to avoid that too much memory is used by
1241 * keys that can be removed from the keyspace. */
1242 for (j
= 0; j
< server
.dbnum
; j
++) {
1244 redisDb
*db
= server
.db
+j
;
1246 /* Continue to expire if at the end of the cycle more than 25%
1247 * of the keys were expired. */
1249 long num
= dictSize(db
->expires
);
1250 time_t now
= time(NULL
);
1253 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1254 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1259 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1260 t
= (time_t) dictGetEntryVal(de
);
1262 deleteKey(db
,dictGetEntryKey(de
));
1266 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1269 /* Swap a few keys on disk if we are over the memory limit and VM
1270 * is enbled. Try to free objects from the free list first. */
1271 if (vmCanSwapOut()) {
1272 while (server
.vm_enabled
&& zmalloc_used_memory() >
1273 server
.vm_max_memory
)
1277 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1278 retval
= (server
.vm_max_threads
== 0) ?
1279 vmSwapOneObjectBlocking() :
1280 vmSwapOneObjectThreaded();
1281 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1282 zmalloc_used_memory() >
1283 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1285 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1287 /* Note that when using threade I/O we free just one object,
1288 * because anyway when the I/O thread in charge to swap this
1289 * object out will finish, the handler of completed jobs
1290 * will try to swap more objects if we are still out of memory. */
1291 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1295 /* Check if we should connect to a MASTER */
1296 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1297 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1298 if (syncWithMaster() == REDIS_OK
) {
1299 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1305 /* This function gets called every time Redis is entering the
1306 * main loop of the event driven library, that is, before to sleep
1307 * for ready file descriptors. */
1308 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1309 REDIS_NOTUSED(eventLoop
);
1311 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1315 listRewind(server
.io_ready_clients
,&li
);
1316 while((ln
= listNext(&li
))) {
1317 redisClient
*c
= ln
->value
;
1318 struct redisCommand
*cmd
;
1320 /* Resume the client. */
1321 listDelNode(server
.io_ready_clients
,ln
);
1322 c
->flags
&= (~REDIS_IO_WAIT
);
1323 server
.vm_blocked_clients
--;
1324 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1325 readQueryFromClient
, c
);
1326 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1327 assert(cmd
!= NULL
);
1330 /* There may be more data to process in the input buffer. */
1331 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1332 processInputBuffer(c
);
1337 static void createSharedObjects(void) {
1338 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1339 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1340 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1341 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1342 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1343 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1344 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1345 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1346 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1347 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1348 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1349 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1350 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1351 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1352 "-ERR no such key\r\n"));
1353 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1354 "-ERR syntax error\r\n"));
1355 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1356 "-ERR source and destination objects are the same\r\n"));
1357 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1358 "-ERR index out of range\r\n"));
1359 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1360 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1361 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1362 shared
.select0
= createStringObject("select 0\r\n",10);
1363 shared
.select1
= createStringObject("select 1\r\n",10);
1364 shared
.select2
= createStringObject("select 2\r\n",10);
1365 shared
.select3
= createStringObject("select 3\r\n",10);
1366 shared
.select4
= createStringObject("select 4\r\n",10);
1367 shared
.select5
= createStringObject("select 5\r\n",10);
1368 shared
.select6
= createStringObject("select 6\r\n",10);
1369 shared
.select7
= createStringObject("select 7\r\n",10);
1370 shared
.select8
= createStringObject("select 8\r\n",10);
1371 shared
.select9
= createStringObject("select 9\r\n",10);
1374 static void appendServerSaveParams(time_t seconds
, int changes
) {
1375 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1376 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1377 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1378 server
.saveparamslen
++;
1381 static void resetServerSaveParams() {
1382 zfree(server
.saveparams
);
1383 server
.saveparams
= NULL
;
1384 server
.saveparamslen
= 0;
1387 static void initServerConfig() {
1388 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1389 server
.port
= REDIS_SERVERPORT
;
1390 server
.verbosity
= REDIS_VERBOSE
;
1391 server
.maxidletime
= REDIS_MAXIDLETIME
;
1392 server
.saveparams
= NULL
;
1393 server
.logfile
= NULL
; /* NULL = log on standard output */
1394 server
.bindaddr
= NULL
;
1395 server
.glueoutputbuf
= 1;
1396 server
.daemonize
= 0;
1397 server
.appendonly
= 0;
1398 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1399 server
.lastfsync
= time(NULL
);
1400 server
.appendfd
= -1;
1401 server
.appendseldb
= -1; /* Make sure the first time will not match */
1402 server
.pidfile
= "/var/run/redis.pid";
1403 server
.dbfilename
= "dump.rdb";
1404 server
.appendfilename
= "appendonly.aof";
1405 server
.requirepass
= NULL
;
1406 server
.shareobjects
= 0;
1407 server
.rdbcompression
= 1;
1408 server
.sharingpoolsize
= 1024;
1409 server
.maxclients
= 0;
1410 server
.blpop_blocked_clients
= 0;
1411 server
.maxmemory
= 0;
1412 server
.vm_enabled
= 0;
1413 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1414 server
.vm_page_size
= 256; /* 256 bytes per page */
1415 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1416 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1417 server
.vm_max_threads
= 4;
1418 server
.vm_blocked_clients
= 0;
1420 resetServerSaveParams();
1422 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1423 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1424 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1425 /* Replication related */
1427 server
.masterauth
= NULL
;
1428 server
.masterhost
= NULL
;
1429 server
.masterport
= 6379;
1430 server
.master
= NULL
;
1431 server
.replstate
= REDIS_REPL_NONE
;
1433 /* Double constants initialization */
1435 R_PosInf
= 1.0/R_Zero
;
1436 R_NegInf
= -1.0/R_Zero
;
1437 R_Nan
= R_Zero
/R_Zero
;
1440 static void initServer() {
1443 signal(SIGHUP
, SIG_IGN
);
1444 signal(SIGPIPE
, SIG_IGN
);
1445 setupSigSegvAction();
1447 server
.devnull
= fopen("/dev/null","w");
1448 if (server
.devnull
== NULL
) {
1449 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1452 server
.clients
= listCreate();
1453 server
.slaves
= listCreate();
1454 server
.monitors
= listCreate();
1455 server
.objfreelist
= listCreate();
1456 createSharedObjects();
1457 server
.el
= aeCreateEventLoop();
1458 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1459 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1460 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1461 if (server
.fd
== -1) {
1462 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1465 for (j
= 0; j
< server
.dbnum
; j
++) {
1466 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1467 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1468 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1469 if (server
.vm_enabled
)
1470 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1471 server
.db
[j
].id
= j
;
1473 server
.cronloops
= 0;
1474 server
.bgsavechildpid
= -1;
1475 server
.bgrewritechildpid
= -1;
1476 server
.bgrewritebuf
= sdsempty();
1477 server
.lastsave
= time(NULL
);
1479 server
.stat_numcommands
= 0;
1480 server
.stat_numconnections
= 0;
1481 server
.stat_starttime
= time(NULL
);
1482 server
.unixtime
= time(NULL
);
1483 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1484 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1485 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1487 if (server
.appendonly
) {
1488 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1489 if (server
.appendfd
== -1) {
1490 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1496 if (server
.vm_enabled
) vmInit();
1499 /* Empty the whole database */
1500 static long long emptyDb() {
1502 long long removed
= 0;
1504 for (j
= 0; j
< server
.dbnum
; j
++) {
1505 removed
+= dictSize(server
.db
[j
].dict
);
1506 dictEmpty(server
.db
[j
].dict
);
1507 dictEmpty(server
.db
[j
].expires
);
1512 static int yesnotoi(char *s
) {
1513 if (!strcasecmp(s
,"yes")) return 1;
1514 else if (!strcasecmp(s
,"no")) return 0;
1518 /* I agree, this is a very rudimental way to load a configuration...
1519 will improve later if the config gets more complex */
1520 static void loadServerConfig(char *filename
) {
1522 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1526 if (filename
[0] == '-' && filename
[1] == '\0')
1529 if ((fp
= fopen(filename
,"r")) == NULL
) {
1530 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1535 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1541 line
= sdstrim(line
," \t\r\n");
1543 /* Skip comments and blank lines*/
1544 if (line
[0] == '#' || line
[0] == '\0') {
1549 /* Split into arguments */
1550 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1551 sdstolower(argv
[0]);
1553 /* Execute config directives */
1554 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1555 server
.maxidletime
= atoi(argv
[1]);
1556 if (server
.maxidletime
< 0) {
1557 err
= "Invalid timeout value"; goto loaderr
;
1559 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1560 server
.port
= atoi(argv
[1]);
1561 if (server
.port
< 1 || server
.port
> 65535) {
1562 err
= "Invalid port"; goto loaderr
;
1564 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1565 server
.bindaddr
= zstrdup(argv
[1]);
1566 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1567 int seconds
= atoi(argv
[1]);
1568 int changes
= atoi(argv
[2]);
1569 if (seconds
< 1 || changes
< 0) {
1570 err
= "Invalid save parameters"; goto loaderr
;
1572 appendServerSaveParams(seconds
,changes
);
1573 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1574 if (chdir(argv
[1]) == -1) {
1575 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1576 argv
[1], strerror(errno
));
1579 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1580 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1581 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1582 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1583 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1585 err
= "Invalid log level. Must be one of debug, notice, warning";
1588 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1591 server
.logfile
= zstrdup(argv
[1]);
1592 if (!strcasecmp(server
.logfile
,"stdout")) {
1593 zfree(server
.logfile
);
1594 server
.logfile
= NULL
;
1596 if (server
.logfile
) {
1597 /* Test if we are able to open the file. The server will not
1598 * be able to abort just for this problem later... */
1599 logfp
= fopen(server
.logfile
,"a");
1600 if (logfp
== NULL
) {
1601 err
= sdscatprintf(sdsempty(),
1602 "Can't open the log file: %s", strerror(errno
));
1607 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1608 server
.dbnum
= atoi(argv
[1]);
1609 if (server
.dbnum
< 1) {
1610 err
= "Invalid number of databases"; goto loaderr
;
1612 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1613 server
.maxclients
= atoi(argv
[1]);
1614 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1615 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1616 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1617 server
.masterhost
= sdsnew(argv
[1]);
1618 server
.masterport
= atoi(argv
[2]);
1619 server
.replstate
= REDIS_REPL_CONNECT
;
1620 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1621 server
.masterauth
= zstrdup(argv
[1]);
1622 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1623 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1624 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1626 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1627 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1628 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1630 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1631 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1632 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1634 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1635 server
.sharingpoolsize
= atoi(argv
[1]);
1636 if (server
.sharingpoolsize
< 1) {
1637 err
= "invalid object sharing pool size"; goto loaderr
;
1639 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1640 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1641 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1643 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1644 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1645 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1647 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1648 if (!strcasecmp(argv
[1],"no")) {
1649 server
.appendfsync
= APPENDFSYNC_NO
;
1650 } else if (!strcasecmp(argv
[1],"always")) {
1651 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1652 } else if (!strcasecmp(argv
[1],"everysec")) {
1653 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1655 err
= "argument must be 'no', 'always' or 'everysec'";
1658 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1659 server
.requirepass
= zstrdup(argv
[1]);
1660 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1661 server
.pidfile
= zstrdup(argv
[1]);
1662 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1663 server
.dbfilename
= zstrdup(argv
[1]);
1664 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1665 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1666 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1668 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1669 zfree(server
.vm_swap_file
);
1670 server
.vm_swap_file
= zstrdup(argv
[1]);
1671 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1672 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1673 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1674 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1675 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1676 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1677 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1678 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1680 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1682 for (j
= 0; j
< argc
; j
++)
1687 if (fp
!= stdin
) fclose(fp
);
1691 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1692 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1693 fprintf(stderr
, ">>> '%s'\n", line
);
1694 fprintf(stderr
, "%s\n", err
);
1698 static void freeClientArgv(redisClient
*c
) {
1701 for (j
= 0; j
< c
->argc
; j
++)
1702 decrRefCount(c
->argv
[j
]);
1703 for (j
= 0; j
< c
->mbargc
; j
++)
1704 decrRefCount(c
->mbargv
[j
]);
1709 static void freeClient(redisClient
*c
) {
1712 /* Note that if the client we are freeing is blocked into a blocking
1713 * call, we have to set querybuf to NULL *before* to call
1714 * unblockClientWaitingData() to avoid processInputBuffer() will get
1715 * called. Also it is important to remove the file events after
1716 * this, because this call adds the READABLE event. */
1717 sdsfree(c
->querybuf
);
1719 if (c
->flags
& REDIS_BLOCKED
)
1720 unblockClientWaitingData(c
);
1722 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1723 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1724 listRelease(c
->reply
);
1727 /* Remove from the list of clients */
1728 ln
= listSearchKey(server
.clients
,c
);
1729 redisAssert(ln
!= NULL
);
1730 listDelNode(server
.clients
,ln
);
1731 /* Remove from the list of clients waiting for swapped keys */
1732 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1733 ln
= listSearchKey(server
.io_ready_clients
,c
);
1735 listDelNode(server
.io_ready_clients
,ln
);
1736 server
.vm_blocked_clients
--;
1739 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1740 ln
= listFirst(c
->io_keys
);
1741 dontWaitForSwappedKey(c
,ln
->value
);
1743 listRelease(c
->io_keys
);
1745 if (c
->flags
& REDIS_SLAVE
) {
1746 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1748 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1749 ln
= listSearchKey(l
,c
);
1750 redisAssert(ln
!= NULL
);
1753 if (c
->flags
& REDIS_MASTER
) {
1754 server
.master
= NULL
;
1755 server
.replstate
= REDIS_REPL_CONNECT
;
1759 freeClientMultiState(c
);
1763 #define GLUEREPLY_UP_TO (1024)
1764 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1766 char buf
[GLUEREPLY_UP_TO
];
1771 listRewind(c
->reply
,&li
);
1772 while((ln
= listNext(&li
))) {
1776 objlen
= sdslen(o
->ptr
);
1777 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1778 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1780 listDelNode(c
->reply
,ln
);
1782 if (copylen
== 0) return;
1786 /* Now the output buffer is empty, add the new single element */
1787 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1788 listAddNodeHead(c
->reply
,o
);
1791 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1792 redisClient
*c
= privdata
;
1793 int nwritten
= 0, totwritten
= 0, objlen
;
1796 REDIS_NOTUSED(mask
);
1798 /* Use writev() if we have enough buffers to send */
1799 if (!server
.glueoutputbuf
&&
1800 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1801 !(c
->flags
& REDIS_MASTER
))
1803 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1807 while(listLength(c
->reply
)) {
1808 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1809 glueReplyBuffersIfNeeded(c
);
1811 o
= listNodeValue(listFirst(c
->reply
));
1812 objlen
= sdslen(o
->ptr
);
1815 listDelNode(c
->reply
,listFirst(c
->reply
));
1819 if (c
->flags
& REDIS_MASTER
) {
1820 /* Don't reply to a master */
1821 nwritten
= objlen
- c
->sentlen
;
1823 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1824 if (nwritten
<= 0) break;
1826 c
->sentlen
+= nwritten
;
1827 totwritten
+= nwritten
;
1828 /* If we fully sent the object on head go to the next one */
1829 if (c
->sentlen
== objlen
) {
1830 listDelNode(c
->reply
,listFirst(c
->reply
));
1833 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1834 * bytes, in a single threaded server it's a good idea to serve
1835 * other clients as well, even if a very large request comes from
1836 * super fast link that is always able to accept data (in real world
1837 * scenario think about 'KEYS *' against the loopback interfae) */
1838 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1840 if (nwritten
== -1) {
1841 if (errno
== EAGAIN
) {
1844 redisLog(REDIS_VERBOSE
,
1845 "Error writing to client: %s", strerror(errno
));
1850 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1851 if (listLength(c
->reply
) == 0) {
1853 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1857 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1859 redisClient
*c
= privdata
;
1860 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1862 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1863 int offset
, ion
= 0;
1865 REDIS_NOTUSED(mask
);
1868 while (listLength(c
->reply
)) {
1869 offset
= c
->sentlen
;
1873 /* fill-in the iov[] array */
1874 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1875 o
= listNodeValue(node
);
1876 objlen
= sdslen(o
->ptr
);
1878 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1881 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1882 break; /* no more iovecs */
1884 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1885 iov
[ion
].iov_len
= objlen
- offset
;
1886 willwrite
+= objlen
- offset
;
1887 offset
= 0; /* just for the first item */
1894 /* write all collected blocks at once */
1895 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1896 if (errno
!= EAGAIN
) {
1897 redisLog(REDIS_VERBOSE
,
1898 "Error writing to client: %s", strerror(errno
));
1905 totwritten
+= nwritten
;
1906 offset
= c
->sentlen
;
1908 /* remove written robjs from c->reply */
1909 while (nwritten
&& listLength(c
->reply
)) {
1910 o
= listNodeValue(listFirst(c
->reply
));
1911 objlen
= sdslen(o
->ptr
);
1913 if(nwritten
>= objlen
- offset
) {
1914 listDelNode(c
->reply
, listFirst(c
->reply
));
1915 nwritten
-= objlen
- offset
;
1919 c
->sentlen
+= nwritten
;
1927 c
->lastinteraction
= time(NULL
);
1929 if (listLength(c
->reply
) == 0) {
1931 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1935 static struct redisCommand
*lookupCommand(char *name
) {
1937 while(cmdTable
[j
].name
!= NULL
) {
1938 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1944 /* resetClient prepare the client to process the next command */
1945 static void resetClient(redisClient
*c
) {
1951 /* Call() is the core of Redis execution of a command */
1952 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1955 dirty
= server
.dirty
;
1957 if (server
.appendonly
&& server
.dirty
-dirty
)
1958 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1959 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1960 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1961 if (listLength(server
.monitors
))
1962 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1963 server
.stat_numcommands
++;
1966 /* If this function gets called we already read a whole
1967 * command, argments are in the client argv/argc fields.
1968 * processCommand() execute the command or prepare the
1969 * server for a bulk read from the client.
1971 * If 1 is returned the client is still alive and valid and
1972 * and other operations can be performed by the caller. Otherwise
1973 * if 0 is returned the client was destroied (i.e. after QUIT). */
1974 static int processCommand(redisClient
*c
) {
1975 struct redisCommand
*cmd
;
1977 /* Free some memory if needed (maxmemory setting) */
1978 if (server
.maxmemory
) freeMemoryIfNeeded();
1980 /* Handle the multi bulk command type. This is an alternative protocol
1981 * supported by Redis in order to receive commands that are composed of
1982 * multiple binary-safe "bulk" arguments. The latency of processing is
1983 * a bit higher but this allows things like multi-sets, so if this
1984 * protocol is used only for MSET and similar commands this is a big win. */
1985 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
1986 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1987 if (c
->multibulk
<= 0) {
1991 decrRefCount(c
->argv
[c
->argc
-1]);
1995 } else if (c
->multibulk
) {
1996 if (c
->bulklen
== -1) {
1997 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
1998 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2002 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2003 decrRefCount(c
->argv
[0]);
2004 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2006 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2011 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2015 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2016 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2020 if (c
->multibulk
== 0) {
2024 /* Here we need to swap the multi-bulk argc/argv with the
2025 * normal argc/argv of the client structure. */
2027 c
->argv
= c
->mbargv
;
2028 c
->mbargv
= auxargv
;
2031 c
->argc
= c
->mbargc
;
2032 c
->mbargc
= auxargc
;
2034 /* We need to set bulklen to something different than -1
2035 * in order for the code below to process the command without
2036 * to try to read the last argument of a bulk command as
2037 * a special argument. */
2039 /* continue below and process the command */
2046 /* -- end of multi bulk commands processing -- */
2048 /* The QUIT command is handled as a special case. Normal command
2049 * procs are unable to close the client connection safely */
2050 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2055 /* Now lookup the command and check ASAP about trivial error conditions
2056 * such wrong arity, bad command name and so forth. */
2057 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2060 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2061 (char*)c
->argv
[0]->ptr
));
2064 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2065 (c
->argc
< -cmd
->arity
)) {
2067 sdscatprintf(sdsempty(),
2068 "-ERR wrong number of arguments for '%s' command\r\n",
2072 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2073 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2076 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2077 /* This is a bulk command, we have to read the last argument yet. */
2078 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2080 decrRefCount(c
->argv
[c
->argc
-1]);
2081 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2083 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2088 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2089 /* It is possible that the bulk read is already in the
2090 * buffer. Check this condition and handle it accordingly.
2091 * This is just a fast path, alternative to call processInputBuffer().
2092 * It's a good idea since the code is small and this condition
2093 * happens most of the times. */
2094 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2095 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2097 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2099 /* Otherwise return... there is to read the last argument
2100 * from the socket. */
2104 /* Let's try to share objects on the command arguments vector */
2105 if (server
.shareobjects
) {
2107 for(j
= 1; j
< c
->argc
; j
++)
2108 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2110 /* Let's try to encode the bulk object to save space. */
2111 if (cmd
->flags
& REDIS_CMD_BULK
)
2112 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2114 /* Check if the user is authenticated */
2115 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2116 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2121 /* Exec the command */
2122 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2123 queueMultiCommand(c
,cmd
);
2124 addReply(c
,shared
.queued
);
2126 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2127 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2131 /* Prepare the client for the next command */
2136 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2141 /* (args*2)+1 is enough room for args, spaces, newlines */
2142 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2144 if (argc
<= REDIS_STATIC_ARGS
) {
2147 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2150 for (j
= 0; j
< argc
; j
++) {
2151 if (j
!= 0) outv
[outc
++] = shared
.space
;
2152 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2155 lenobj
= createObject(REDIS_STRING
,
2156 sdscatprintf(sdsempty(),"%lu\r\n",
2157 (unsigned long) stringObjectLen(argv
[j
])));
2158 lenobj
->refcount
= 0;
2159 outv
[outc
++] = lenobj
;
2161 outv
[outc
++] = argv
[j
];
2163 outv
[outc
++] = shared
.crlf
;
2165 /* Increment all the refcounts at start and decrement at end in order to
2166 * be sure to free objects if there is no slave in a replication state
2167 * able to be feed with commands */
2168 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2169 listRewind(slaves
,&li
);
2170 while((ln
= listNext(&li
))) {
2171 redisClient
*slave
= ln
->value
;
2173 /* Don't feed slaves that are still waiting for BGSAVE to start */
2174 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2176 /* Feed all the other slaves, MONITORs and so on */
2177 if (slave
->slaveseldb
!= dictid
) {
2181 case 0: selectcmd
= shared
.select0
; break;
2182 case 1: selectcmd
= shared
.select1
; break;
2183 case 2: selectcmd
= shared
.select2
; break;
2184 case 3: selectcmd
= shared
.select3
; break;
2185 case 4: selectcmd
= shared
.select4
; break;
2186 case 5: selectcmd
= shared
.select5
; break;
2187 case 6: selectcmd
= shared
.select6
; break;
2188 case 7: selectcmd
= shared
.select7
; break;
2189 case 8: selectcmd
= shared
.select8
; break;
2190 case 9: selectcmd
= shared
.select9
; break;
2192 selectcmd
= createObject(REDIS_STRING
,
2193 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2194 selectcmd
->refcount
= 0;
2197 addReply(slave
,selectcmd
);
2198 slave
->slaveseldb
= dictid
;
2200 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2202 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2203 if (outv
!= static_outv
) zfree(outv
);
2206 static void processInputBuffer(redisClient
*c
) {
2208 /* Before to process the input buffer, make sure the client is not
2209 * waitig for a blocking operation such as BLPOP. Note that the first
2210 * iteration the client is never blocked, otherwise the processInputBuffer
2211 * would not be called at all, but after the execution of the first commands
2212 * in the input buffer the client may be blocked, and the "goto again"
2213 * will try to reiterate. The following line will make it return asap. */
2214 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2215 if (c
->bulklen
== -1) {
2216 /* Read the first line of the query */
2217 char *p
= strchr(c
->querybuf
,'\n');
2224 query
= c
->querybuf
;
2225 c
->querybuf
= sdsempty();
2226 querylen
= 1+(p
-(query
));
2227 if (sdslen(query
) > querylen
) {
2228 /* leave data after the first line of the query in the buffer */
2229 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2231 *p
= '\0'; /* remove "\n" */
2232 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2233 sdsupdatelen(query
);
2235 /* Now we can split the query in arguments */
2236 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2239 if (c
->argv
) zfree(c
->argv
);
2240 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2242 for (j
= 0; j
< argc
; j
++) {
2243 if (sdslen(argv
[j
])) {
2244 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2252 /* Execute the command. If the client is still valid
2253 * after processCommand() return and there is something
2254 * on the query buffer try to process the next command. */
2255 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2257 /* Nothing to process, argc == 0. Just process the query
2258 * buffer if it's not empty or return to the caller */
2259 if (sdslen(c
->querybuf
)) goto again
;
2262 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2263 redisLog(REDIS_VERBOSE
, "Client protocol error");
2268 /* Bulk read handling. Note that if we are at this point
2269 the client already sent a command terminated with a newline,
2270 we are reading the bulk data that is actually the last
2271 argument of the command. */
2272 int qbl
= sdslen(c
->querybuf
);
2274 if (c
->bulklen
<= qbl
) {
2275 /* Copy everything but the final CRLF as final argument */
2276 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2278 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2279 /* Process the command. If the client is still valid after
2280 * the processing and there is more data in the buffer
2281 * try to parse it. */
2282 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2288 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2289 redisClient
*c
= (redisClient
*) privdata
;
2290 char buf
[REDIS_IOBUF_LEN
];
2293 REDIS_NOTUSED(mask
);
2295 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2297 if (errno
== EAGAIN
) {
2300 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2304 } else if (nread
== 0) {
2305 redisLog(REDIS_VERBOSE
, "Client closed connection");
2310 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2311 c
->lastinteraction
= time(NULL
);
2315 processInputBuffer(c
);
2318 static int selectDb(redisClient
*c
, int id
) {
2319 if (id
< 0 || id
>= server
.dbnum
)
2321 c
->db
= &server
.db
[id
];
2325 static void *dupClientReplyValue(void *o
) {
2326 incrRefCount((robj
*)o
);
2330 static redisClient
*createClient(int fd
) {
2331 redisClient
*c
= zmalloc(sizeof(*c
));
2333 anetNonBlock(NULL
,fd
);
2334 anetTcpNoDelay(NULL
,fd
);
2335 if (!c
) return NULL
;
2338 c
->querybuf
= sdsempty();
2347 c
->lastinteraction
= time(NULL
);
2348 c
->authenticated
= 0;
2349 c
->replstate
= REDIS_REPL_NONE
;
2350 c
->reply
= listCreate();
2351 listSetFreeMethod(c
->reply
,decrRefCount
);
2352 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2353 c
->blockingkeys
= NULL
;
2354 c
->blockingkeysnum
= 0;
2355 c
->io_keys
= listCreate();
2356 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2357 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2358 readQueryFromClient
, c
) == AE_ERR
) {
2362 listAddNodeTail(server
.clients
,c
);
2363 initClientMultiState(c
);
2367 static void addReply(redisClient
*c
, robj
*obj
) {
2368 if (listLength(c
->reply
) == 0 &&
2369 (c
->replstate
== REDIS_REPL_NONE
||
2370 c
->replstate
== REDIS_REPL_ONLINE
) &&
2371 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2372 sendReplyToClient
, c
) == AE_ERR
) return;
2374 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2375 obj
= dupStringObject(obj
);
2376 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2378 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2381 static void addReplySds(redisClient
*c
, sds s
) {
2382 robj
*o
= createObject(REDIS_STRING
,s
);
2387 static void addReplyDouble(redisClient
*c
, double d
) {
2390 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2391 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2392 (unsigned long) strlen(buf
),buf
));
2395 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2398 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2399 len
= sdslen(obj
->ptr
);
2401 long n
= (long)obj
->ptr
;
2403 /* Compute how many bytes will take this integer as a radix 10 string */
2409 while((n
= n
/10) != 0) {
2413 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2416 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2421 REDIS_NOTUSED(mask
);
2422 REDIS_NOTUSED(privdata
);
2424 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2425 if (cfd
== AE_ERR
) {
2426 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2429 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2430 if ((c
= createClient(cfd
)) == NULL
) {
2431 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2432 close(cfd
); /* May be already closed, just ingore errors */
2435 /* If maxclient directive is set and this is one client more... close the
2436 * connection. Note that we create the client instead to check before
2437 * for this condition, since now the socket is already set in nonblocking
2438 * mode and we can send an error for free using the Kernel I/O */
2439 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2440 char *err
= "-ERR max number of clients reached\r\n";
2442 /* That's a best effort error message, don't check write errors */
2443 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2444 /* Nothing to do, Just to avoid the warning... */
2449 server
.stat_numconnections
++;
2452 /* ======================= Redis objects implementation ===================== */
2454 static robj
*createObject(int type
, void *ptr
) {
2457 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2458 if (listLength(server
.objfreelist
)) {
2459 listNode
*head
= listFirst(server
.objfreelist
);
2460 o
= listNodeValue(head
);
2461 listDelNode(server
.objfreelist
,head
);
2462 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2464 if (server
.vm_enabled
) {
2465 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2466 o
= zmalloc(sizeof(*o
));
2468 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2472 o
->encoding
= REDIS_ENCODING_RAW
;
2475 if (server
.vm_enabled
) {
2476 /* Note that this code may run in the context of an I/O thread
2477 * and accessing to server.unixtime in theory is an error
2478 * (no locks). But in practice this is safe, and even if we read
2479 * garbage Redis will not fail, as it's just a statistical info */
2480 o
->vm
.atime
= server
.unixtime
;
2481 o
->storage
= REDIS_VM_MEMORY
;
2486 static robj
*createStringObject(char *ptr
, size_t len
) {
2487 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2490 static robj
*dupStringObject(robj
*o
) {
2491 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2492 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2495 static robj
*createListObject(void) {
2496 list
*l
= listCreate();
2498 listSetFreeMethod(l
,decrRefCount
);
2499 return createObject(REDIS_LIST
,l
);
2502 static robj
*createSetObject(void) {
2503 dict
*d
= dictCreate(&setDictType
,NULL
);
2504 return createObject(REDIS_SET
,d
);
2507 static robj
*createZsetObject(void) {
2508 zset
*zs
= zmalloc(sizeof(*zs
));
2510 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2511 zs
->zsl
= zslCreate();
2512 return createObject(REDIS_ZSET
,zs
);
2515 static void freeStringObject(robj
*o
) {
2516 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2521 static void freeListObject(robj
*o
) {
2522 listRelease((list
*) o
->ptr
);
2525 static void freeSetObject(robj
*o
) {
2526 dictRelease((dict
*) o
->ptr
);
2529 static void freeZsetObject(robj
*o
) {
2532 dictRelease(zs
->dict
);
2537 static void freeHashObject(robj
*o
) {
2538 dictRelease((dict
*) o
->ptr
);
2541 static void incrRefCount(robj
*o
) {
2542 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2546 static void decrRefCount(void *obj
) {
2549 /* Object is a key of a swapped out value, or in the process of being
2551 if (server
.vm_enabled
&&
2552 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2554 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2555 redisAssert(o
->refcount
== 1);
2557 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2558 redisAssert(o
->type
== REDIS_STRING
);
2559 freeStringObject(o
);
2560 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2561 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2562 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2563 !listAddNodeHead(server
.objfreelist
,o
))
2565 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2566 server
.vm_stats_swapped_objects
--;
2569 /* Object is in memory, or in the process of being swapped out. */
2570 if (--(o
->refcount
) == 0) {
2571 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2572 vmCancelThreadedIOJob(obj
);
2574 case REDIS_STRING
: freeStringObject(o
); break;
2575 case REDIS_LIST
: freeListObject(o
); break;
2576 case REDIS_SET
: freeSetObject(o
); break;
2577 case REDIS_ZSET
: freeZsetObject(o
); break;
2578 case REDIS_HASH
: freeHashObject(o
); break;
2579 default: redisAssert(0 != 0); break;
2581 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2582 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2583 !listAddNodeHead(server
.objfreelist
,o
))
2585 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2589 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2590 dictEntry
*de
= dictFind(db
->dict
,key
);
2592 robj
*key
= dictGetEntryKey(de
);
2593 robj
*val
= dictGetEntryVal(de
);
2595 if (server
.vm_enabled
) {
2596 if (key
->storage
== REDIS_VM_MEMORY
||
2597 key
->storage
== REDIS_VM_SWAPPING
)
2599 /* If we were swapping the object out, stop it, this key
2601 if (key
->storage
== REDIS_VM_SWAPPING
)
2602 vmCancelThreadedIOJob(key
);
2603 /* Update the access time of the key for the aging algorithm. */
2604 key
->vm
.atime
= server
.unixtime
;
2606 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2608 /* Our value was swapped on disk. Bring it at home. */
2609 redisAssert(val
== NULL
);
2610 val
= vmLoadObject(key
);
2611 dictGetEntryVal(de
) = val
;
2613 /* Clients blocked by the VM subsystem may be waiting for
2615 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2624 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2625 expireIfNeeded(db
,key
);
2626 return lookupKey(db
,key
);
2629 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2630 deleteIfVolatile(db
,key
);
2631 return lookupKey(db
,key
);
2634 static int deleteKey(redisDb
*db
, robj
*key
) {
2637 /* We need to protect key from destruction: after the first dictDelete()
2638 * it may happen that 'key' is no longer valid if we don't increment
2639 * it's count. This may happen when we get the object reference directly
2640 * from the hash table with dictRandomKey() or dict iterators */
2642 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2643 retval
= dictDelete(db
->dict
,key
);
2646 return retval
== DICT_OK
;
2649 /* Try to share an object against the shared objects pool */
2650 static robj
*tryObjectSharing(robj
*o
) {
2651 struct dictEntry
*de
;
2654 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2656 redisAssert(o
->type
== REDIS_STRING
);
2657 de
= dictFind(server
.sharingpool
,o
);
2659 robj
*shared
= dictGetEntryKey(de
);
2661 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2662 dictGetEntryVal(de
) = (void*) c
;
2663 incrRefCount(shared
);
2667 /* Here we are using a stream algorihtm: Every time an object is
2668 * shared we increment its count, everytime there is a miss we
2669 * recrement the counter of a random object. If this object reaches
2670 * zero we remove the object and put the current object instead. */
2671 if (dictSize(server
.sharingpool
) >=
2672 server
.sharingpoolsize
) {
2673 de
= dictGetRandomKey(server
.sharingpool
);
2674 redisAssert(de
!= NULL
);
2675 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2676 dictGetEntryVal(de
) = (void*) c
;
2678 dictDelete(server
.sharingpool
,de
->key
);
2681 c
= 0; /* If the pool is empty we want to add this object */
2686 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2687 redisAssert(retval
== DICT_OK
);
2694 /* Check if the nul-terminated string 's' can be represented by a long
2695 * (that is, is a number that fits into long without any other space or
2696 * character before or after the digits).
2698 * If so, the function returns REDIS_OK and *longval is set to the value
2699 * of the number. Otherwise REDIS_ERR is returned */
2700 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2701 char buf
[32], *endptr
;
2705 value
= strtol(s
, &endptr
, 10);
2706 if (endptr
[0] != '\0') return REDIS_ERR
;
2707 slen
= snprintf(buf
,32,"%ld",value
);
2709 /* If the number converted back into a string is not identical
2710 * then it's not possible to encode the string as integer */
2711 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2712 if (longval
) *longval
= value
;
2716 /* Try to encode a string object in order to save space */
2717 static int tryObjectEncoding(robj
*o
) {
2721 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2722 return REDIS_ERR
; /* Already encoded */
2724 /* It's not save to encode shared objects: shared objects can be shared
2725 * everywhere in the "object space" of Redis. Encoded objects can only
2726 * appear as "values" (and not, for instance, as keys) */
2727 if (o
->refcount
> 1) return REDIS_ERR
;
2729 /* Currently we try to encode only strings */
2730 redisAssert(o
->type
== REDIS_STRING
);
2732 /* Check if we can represent this string as a long integer */
2733 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2735 /* Ok, this object can be encoded */
2736 o
->encoding
= REDIS_ENCODING_INT
;
2738 o
->ptr
= (void*) value
;
2742 /* Get a decoded version of an encoded object (returned as a new object).
2743 * If the object is already raw-encoded just increment the ref count. */
2744 static robj
*getDecodedObject(robj
*o
) {
2747 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2751 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2754 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2755 dec
= createStringObject(buf
,strlen(buf
));
2758 redisAssert(1 != 1);
2762 /* Compare two string objects via strcmp() or alike.
2763 * Note that the objects may be integer-encoded. In such a case we
2764 * use snprintf() to get a string representation of the numbers on the stack
2765 * and compare the strings, it's much faster than calling getDecodedObject().
2767 * Important note: if objects are not integer encoded, but binary-safe strings,
2768 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2770 static int compareStringObjects(robj
*a
, robj
*b
) {
2771 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2772 char bufa
[128], bufb
[128], *astr
, *bstr
;
2775 if (a
== b
) return 0;
2776 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2777 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2783 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2784 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2790 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2793 static size_t stringObjectLen(robj
*o
) {
2794 redisAssert(o
->type
== REDIS_STRING
);
2795 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2796 return sdslen(o
->ptr
);
2800 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2804 /*============================ RDB saving/loading =========================== */
2806 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2807 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2811 static int rdbSaveTime(FILE *fp
, time_t t
) {
2812 int32_t t32
= (int32_t) t
;
2813 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2817 /* check rdbLoadLen() comments for more info */
2818 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2819 unsigned char buf
[2];
2822 /* Save a 6 bit len */
2823 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2824 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2825 } else if (len
< (1<<14)) {
2826 /* Save a 14 bit len */
2827 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2829 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2831 /* Save a 32 bit len */
2832 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2833 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2835 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2840 /* String objects in the form "2391" "-100" without any space and with a
2841 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2842 * encoded as integers to save space */
2843 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2845 char *endptr
, buf
[32];
2847 /* Check if it's possible to encode this value as a number */
2848 value
= strtoll(s
, &endptr
, 10);
2849 if (endptr
[0] != '\0') return 0;
2850 snprintf(buf
,32,"%lld",value
);
2852 /* If the number converted back into a string is not identical
2853 * then it's not possible to encode the string as integer */
2854 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2856 /* Finally check if it fits in our ranges */
2857 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2858 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2859 enc
[1] = value
&0xFF;
2861 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2862 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2863 enc
[1] = value
&0xFF;
2864 enc
[2] = (value
>>8)&0xFF;
2866 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2867 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2868 enc
[1] = value
&0xFF;
2869 enc
[2] = (value
>>8)&0xFF;
2870 enc
[3] = (value
>>16)&0xFF;
2871 enc
[4] = (value
>>24)&0xFF;
2878 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2879 unsigned int comprlen
, outlen
;
2883 /* We require at least four bytes compression for this to be worth it */
2884 outlen
= sdslen(obj
->ptr
)-4;
2885 if (outlen
<= 0) return 0;
2886 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2887 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2888 if (comprlen
== 0) {
2892 /* Data compressed! Let's save it on disk */
2893 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2894 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2895 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2896 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2897 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2906 /* Save a string objet as [len][data] on disk. If the object is a string
2907 * representation of an integer value we try to safe it in a special form */
2908 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2912 len
= sdslen(obj
->ptr
);
2914 /* Try integer encoding */
2916 unsigned char buf
[5];
2917 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2918 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2923 /* Try LZF compression - under 20 bytes it's unable to compress even
2924 * aaaaaaaaaaaaaaaaaa so skip it */
2925 if (server
.rdbcompression
&& len
> 20) {
2928 retval
= rdbSaveLzfStringObject(fp
,obj
);
2929 if (retval
== -1) return -1;
2930 if (retval
> 0) return 0;
2931 /* retval == 0 means data can't be compressed, save the old way */
2934 /* Store verbatim */
2935 if (rdbSaveLen(fp
,len
) == -1) return -1;
2936 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2940 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2941 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2944 /* Avoid incr/decr ref count business when possible.
2945 * This plays well with copy-on-write given that we are probably
2946 * in a child process (BGSAVE). Also this makes sure key objects
2947 * of swapped objects are not incRefCount-ed (an assert does not allow
2948 * this in order to avoid bugs) */
2949 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2950 obj
= getDecodedObject(obj
);
2951 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2954 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2959 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2960 * 8 bit integer specifing the length of the representation.
2961 * This 8 bit integer has special values in order to specify the following
2967 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2968 unsigned char buf
[128];
2974 } else if (!isfinite(val
)) {
2976 buf
[0] = (val
< 0) ? 255 : 254;
2978 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2979 buf
[0] = strlen((char*)buf
+1);
2982 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
2986 /* Save a Redis object. */
2987 static int rdbSaveObject(FILE *fp
, robj
*o
) {
2988 if (o
->type
== REDIS_STRING
) {
2989 /* Save a string value */
2990 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
2991 } else if (o
->type
== REDIS_LIST
) {
2992 /* Save a list value */
2993 list
*list
= o
->ptr
;
2997 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
2998 listRewind(list
,&li
);
2999 while((ln
= listNext(&li
))) {
3000 robj
*eleobj
= listNodeValue(ln
);
3002 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3004 } else if (o
->type
== REDIS_SET
) {
3005 /* Save a set value */
3007 dictIterator
*di
= dictGetIterator(set
);
3010 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3011 while((de
= dictNext(di
)) != NULL
) {
3012 robj
*eleobj
= dictGetEntryKey(de
);
3014 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3016 dictReleaseIterator(di
);
3017 } else if (o
->type
== REDIS_ZSET
) {
3018 /* Save a set value */
3020 dictIterator
*di
= dictGetIterator(zs
->dict
);
3023 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3024 while((de
= dictNext(di
)) != NULL
) {
3025 robj
*eleobj
= dictGetEntryKey(de
);
3026 double *score
= dictGetEntryVal(de
);
3028 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3029 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3031 dictReleaseIterator(di
);
3033 redisAssert(0 != 0);
3038 /* Return the length the object will have on disk if saved with
3039 * the rdbSaveObject() function. Currently we use a trick to get
3040 * this length with very little changes to the code. In the future
3041 * we could switch to a faster solution. */
3042 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3043 if (fp
== NULL
) fp
= server
.devnull
;
3045 assert(rdbSaveObject(fp
,o
) != 1);
3049 /* Return the number of pages required to save this object in the swap file */
3050 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3051 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3053 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3056 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3057 static int rdbSave(char *filename
) {
3058 dictIterator
*di
= NULL
;
3063 time_t now
= time(NULL
);
3065 /* Wait for I/O therads to terminate, just in case this is a
3066 * foreground-saving, to avoid seeking the swap file descriptor at the
3068 if (server
.vm_enabled
)
3069 waitEmptyIOJobsQueue();
3071 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3072 fp
= fopen(tmpfile
,"w");
3074 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3077 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3078 for (j
= 0; j
< server
.dbnum
; j
++) {
3079 redisDb
*db
= server
.db
+j
;
3081 if (dictSize(d
) == 0) continue;
3082 di
= dictGetIterator(d
);
3088 /* Write the SELECT DB opcode */
3089 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3090 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3092 /* Iterate this DB writing every entry */
3093 while((de
= dictNext(di
)) != NULL
) {
3094 robj
*key
= dictGetEntryKey(de
);
3095 robj
*o
= dictGetEntryVal(de
);
3096 time_t expiretime
= getExpire(db
,key
);
3098 /* Save the expire time */
3099 if (expiretime
!= -1) {
3100 /* If this key is already expired skip it */
3101 if (expiretime
< now
) continue;
3102 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3103 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3105 /* Save the key and associated value. This requires special
3106 * handling if the value is swapped out. */
3107 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3108 key
->storage
== REDIS_VM_SWAPPING
) {
3109 /* Save type, key, value */
3110 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3111 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3112 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3114 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3116 /* Get a preview of the object in memory */
3117 po
= vmPreviewObject(key
);
3118 /* Save type, key, value */
3119 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3120 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3121 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3122 /* Remove the loaded object from memory */
3126 dictReleaseIterator(di
);
3129 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3131 /* Make sure data will not remain on the OS's output buffers */
3136 /* Use RENAME to make sure the DB file is changed atomically only
3137 * if the generate DB file is ok. */
3138 if (rename(tmpfile
,filename
) == -1) {
3139 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3143 redisLog(REDIS_NOTICE
,"DB saved on disk");
3145 server
.lastsave
= time(NULL
);
3151 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3152 if (di
) dictReleaseIterator(di
);
3156 static int rdbSaveBackground(char *filename
) {
3159 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3160 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3161 if ((childpid
= fork()) == 0) {
3163 if (server
.vm_enabled
) vmReopenSwapFile();
3165 if (rdbSave(filename
) == REDIS_OK
) {
3172 if (childpid
== -1) {
3173 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3177 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3178 server
.bgsavechildpid
= childpid
;
3181 return REDIS_OK
; /* unreached */
3184 static void rdbRemoveTempFile(pid_t childpid
) {
3187 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3191 static int rdbLoadType(FILE *fp
) {
3193 if (fread(&type
,1,1,fp
) == 0) return -1;
3197 static time_t rdbLoadTime(FILE *fp
) {
3199 if (fread(&t32
,4,1,fp
) == 0) return -1;
3200 return (time_t) t32
;
3203 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3204 * of this file for a description of how this are stored on disk.
3206 * isencoded is set to 1 if the readed length is not actually a length but
3207 * an "encoding type", check the above comments for more info */
3208 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3209 unsigned char buf
[2];
3213 if (isencoded
) *isencoded
= 0;
3214 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3215 type
= (buf
[0]&0xC0)>>6;
3216 if (type
== REDIS_RDB_6BITLEN
) {
3217 /* Read a 6 bit len */
3219 } else if (type
== REDIS_RDB_ENCVAL
) {
3220 /* Read a 6 bit len encoding type */
3221 if (isencoded
) *isencoded
= 1;
3223 } else if (type
== REDIS_RDB_14BITLEN
) {
3224 /* Read a 14 bit len */
3225 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3226 return ((buf
[0]&0x3F)<<8)|buf
[1];
3228 /* Read a 32 bit len */
3229 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3234 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3235 unsigned char enc
[4];
3238 if (enctype
== REDIS_RDB_ENC_INT8
) {
3239 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3240 val
= (signed char)enc
[0];
3241 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3243 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3244 v
= enc
[0]|(enc
[1]<<8);
3246 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3248 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3249 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3252 val
= 0; /* anti-warning */
3255 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3258 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3259 unsigned int len
, clen
;
3260 unsigned char *c
= NULL
;
3263 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3264 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3265 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3266 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3267 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3268 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3270 return createObject(REDIS_STRING
,val
);
3277 static robj
*rdbLoadStringObject(FILE*fp
) {
3282 len
= rdbLoadLen(fp
,&isencoded
);
3285 case REDIS_RDB_ENC_INT8
:
3286 case REDIS_RDB_ENC_INT16
:
3287 case REDIS_RDB_ENC_INT32
:
3288 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3289 case REDIS_RDB_ENC_LZF
:
3290 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3296 if (len
== REDIS_RDB_LENERR
) return NULL
;
3297 val
= sdsnewlen(NULL
,len
);
3298 if (len
&& fread(val
,len
,1,fp
) == 0) {
3302 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3305 /* For information about double serialization check rdbSaveDoubleValue() */
3306 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3310 if (fread(&len
,1,1,fp
) == 0) return -1;
3312 case 255: *val
= R_NegInf
; return 0;
3313 case 254: *val
= R_PosInf
; return 0;
3314 case 253: *val
= R_Nan
; return 0;
3316 if (fread(buf
,len
,1,fp
) == 0) return -1;
3318 sscanf(buf
, "%lg", val
);
3323 /* Load a Redis object of the specified type from the specified file.
3324 * On success a newly allocated object is returned, otherwise NULL. */
3325 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3328 if (type
== REDIS_STRING
) {
3329 /* Read string value */
3330 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3331 tryObjectEncoding(o
);
3332 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3333 /* Read list/set value */
3336 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3337 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3338 /* Load every single element of the list/set */
3342 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3343 tryObjectEncoding(ele
);
3344 if (type
== REDIS_LIST
) {
3345 listAddNodeTail((list
*)o
->ptr
,ele
);
3347 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3350 } else if (type
== REDIS_ZSET
) {
3351 /* Read list/set value */
3355 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3356 o
= createZsetObject();
3358 /* Load every single element of the list/set */
3361 double *score
= zmalloc(sizeof(double));
3363 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3364 tryObjectEncoding(ele
);
3365 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3366 dictAdd(zs
->dict
,ele
,score
);
3367 zslInsert(zs
->zsl
,*score
,ele
);
3368 incrRefCount(ele
); /* added to skiplist */
3371 redisAssert(0 != 0);
3376 static int rdbLoad(char *filename
) {
3378 robj
*keyobj
= NULL
;
3380 int type
, retval
, rdbver
;
3381 dict
*d
= server
.db
[0].dict
;
3382 redisDb
*db
= server
.db
+0;
3384 time_t expiretime
= -1, now
= time(NULL
);
3385 long long loadedkeys
= 0;
3387 fp
= fopen(filename
,"r");
3388 if (!fp
) return REDIS_ERR
;
3389 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3391 if (memcmp(buf
,"REDIS",5) != 0) {
3393 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3396 rdbver
= atoi(buf
+5);
3399 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3406 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3407 if (type
== REDIS_EXPIRETIME
) {
3408 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3409 /* We read the time so we need to read the object type again */
3410 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3412 if (type
== REDIS_EOF
) break;
3413 /* Handle SELECT DB opcode as a special case */
3414 if (type
== REDIS_SELECTDB
) {
3415 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3417 if (dbid
>= (unsigned)server
.dbnum
) {
3418 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3421 db
= server
.db
+dbid
;
3426 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3428 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3429 /* Add the new object in the hash table */
3430 retval
= dictAdd(d
,keyobj
,o
);
3431 if (retval
== DICT_ERR
) {
3432 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3435 /* Set the expire time if needed */
3436 if (expiretime
!= -1) {
3437 setExpire(db
,keyobj
,expiretime
);
3438 /* Delete this key if already expired */
3439 if (expiretime
< now
) deleteKey(db
,keyobj
);
3443 /* Handle swapping while loading big datasets when VM is on */
3445 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3446 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3447 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3454 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3455 if (keyobj
) decrRefCount(keyobj
);
3456 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3458 return REDIS_ERR
; /* Just to avoid warning */
3461 /*================================== Commands =============================== */
3463 static void authCommand(redisClient
*c
) {
3464 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3465 c
->authenticated
= 1;
3466 addReply(c
,shared
.ok
);
3468 c
->authenticated
= 0;
3469 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3473 static void pingCommand(redisClient
*c
) {
3474 addReply(c
,shared
.pong
);
3477 static void echoCommand(redisClient
*c
) {
3478 addReplyBulkLen(c
,c
->argv
[1]);
3479 addReply(c
,c
->argv
[1]);
3480 addReply(c
,shared
.crlf
);
3483 /*=================================== Strings =============================== */
3485 static void setGenericCommand(redisClient
*c
, int nx
) {
3488 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3489 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3490 if (retval
== DICT_ERR
) {
3492 /* If the key is about a swapped value, we want a new key object
3493 * to overwrite the old. So we delete the old key in the database.
3494 * This will also make sure that swap pages about the old object
3495 * will be marked as free. */
3496 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3497 incrRefCount(c
->argv
[1]);
3498 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3499 incrRefCount(c
->argv
[2]);
3501 addReply(c
,shared
.czero
);
3505 incrRefCount(c
->argv
[1]);
3506 incrRefCount(c
->argv
[2]);
3509 removeExpire(c
->db
,c
->argv
[1]);
3510 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3513 static void setCommand(redisClient
*c
) {
3514 setGenericCommand(c
,0);
3517 static void setnxCommand(redisClient
*c
) {
3518 setGenericCommand(c
,1);
3521 static int getGenericCommand(redisClient
*c
) {
3522 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3525 addReply(c
,shared
.nullbulk
);
3528 if (o
->type
!= REDIS_STRING
) {
3529 addReply(c
,shared
.wrongtypeerr
);
3532 addReplyBulkLen(c
,o
);
3534 addReply(c
,shared
.crlf
);
3540 static void getCommand(redisClient
*c
) {
3541 getGenericCommand(c
);
3544 static void getsetCommand(redisClient
*c
) {
3545 if (getGenericCommand(c
) == REDIS_ERR
) return;
3546 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3547 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3549 incrRefCount(c
->argv
[1]);
3551 incrRefCount(c
->argv
[2]);
3553 removeExpire(c
->db
,c
->argv
[1]);
3556 static void mgetCommand(redisClient
*c
) {
3559 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3560 for (j
= 1; j
< c
->argc
; j
++) {
3561 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3563 addReply(c
,shared
.nullbulk
);
3565 if (o
->type
!= REDIS_STRING
) {
3566 addReply(c
,shared
.nullbulk
);
3568 addReplyBulkLen(c
,o
);
3570 addReply(c
,shared
.crlf
);
3576 static void msetGenericCommand(redisClient
*c
, int nx
) {
3577 int j
, busykeys
= 0;
3579 if ((c
->argc
% 2) == 0) {
3580 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3583 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3584 * set nothing at all if at least one already key exists. */
3586 for (j
= 1; j
< c
->argc
; j
+= 2) {
3587 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3593 addReply(c
, shared
.czero
);
3597 for (j
= 1; j
< c
->argc
; j
+= 2) {
3600 tryObjectEncoding(c
->argv
[j
+1]);
3601 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3602 if (retval
== DICT_ERR
) {
3603 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3604 incrRefCount(c
->argv
[j
+1]);
3606 incrRefCount(c
->argv
[j
]);
3607 incrRefCount(c
->argv
[j
+1]);
3609 removeExpire(c
->db
,c
->argv
[j
]);
3611 server
.dirty
+= (c
->argc
-1)/2;
3612 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3615 static void msetCommand(redisClient
*c
) {
3616 msetGenericCommand(c
,0);
3619 static void msetnxCommand(redisClient
*c
) {
3620 msetGenericCommand(c
,1);
3623 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3628 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3632 if (o
->type
!= REDIS_STRING
) {
3637 if (o
->encoding
== REDIS_ENCODING_RAW
)
3638 value
= strtoll(o
->ptr
, &eptr
, 10);
3639 else if (o
->encoding
== REDIS_ENCODING_INT
)
3640 value
= (long)o
->ptr
;
3642 redisAssert(1 != 1);
3647 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3648 tryObjectEncoding(o
);
3649 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3650 if (retval
== DICT_ERR
) {
3651 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3652 removeExpire(c
->db
,c
->argv
[1]);
3654 incrRefCount(c
->argv
[1]);
3657 addReply(c
,shared
.colon
);
3659 addReply(c
,shared
.crlf
);
3662 static void incrCommand(redisClient
*c
) {
3663 incrDecrCommand(c
,1);
3666 static void decrCommand(redisClient
*c
) {
3667 incrDecrCommand(c
,-1);
3670 static void incrbyCommand(redisClient
*c
) {
3671 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3672 incrDecrCommand(c
,incr
);
3675 static void decrbyCommand(redisClient
*c
) {
3676 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3677 incrDecrCommand(c
,-incr
);
3680 /* ========================= Type agnostic commands ========================= */
3682 static void delCommand(redisClient
*c
) {
3685 for (j
= 1; j
< c
->argc
; j
++) {
3686 if (deleteKey(c
->db
,c
->argv
[j
])) {
3693 addReply(c
,shared
.czero
);
3696 addReply(c
,shared
.cone
);
3699 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3704 static void existsCommand(redisClient
*c
) {
3705 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3708 static void selectCommand(redisClient
*c
) {
3709 int id
= atoi(c
->argv
[1]->ptr
);
3711 if (selectDb(c
,id
) == REDIS_ERR
) {
3712 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3714 addReply(c
,shared
.ok
);
3718 static void randomkeyCommand(redisClient
*c
) {
3722 de
= dictGetRandomKey(c
->db
->dict
);
3723 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3726 addReply(c
,shared
.plus
);
3727 addReply(c
,shared
.crlf
);
3729 addReply(c
,shared
.plus
);
3730 addReply(c
,dictGetEntryKey(de
));
3731 addReply(c
,shared
.crlf
);
3735 static void keysCommand(redisClient
*c
) {
3738 sds pattern
= c
->argv
[1]->ptr
;
3739 int plen
= sdslen(pattern
);
3740 unsigned long numkeys
= 0, keyslen
= 0;
3741 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3743 di
= dictGetIterator(c
->db
->dict
);
3745 decrRefCount(lenobj
);
3746 while((de
= dictNext(di
)) != NULL
) {
3747 robj
*keyobj
= dictGetEntryKey(de
);
3749 sds key
= keyobj
->ptr
;
3750 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3751 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3752 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3754 addReply(c
,shared
.space
);
3757 keyslen
+= sdslen(key
);
3761 dictReleaseIterator(di
);
3762 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3763 addReply(c
,shared
.crlf
);
3766 static void dbsizeCommand(redisClient
*c
) {
3768 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3771 static void lastsaveCommand(redisClient
*c
) {
3773 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3776 static void typeCommand(redisClient
*c
) {
3780 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3785 case REDIS_STRING
: type
= "+string"; break;
3786 case REDIS_LIST
: type
= "+list"; break;
3787 case REDIS_SET
: type
= "+set"; break;
3788 case REDIS_ZSET
: type
= "+zset"; break;
3789 default: type
= "unknown"; break;
3792 addReplySds(c
,sdsnew(type
));
3793 addReply(c
,shared
.crlf
);
3796 static void saveCommand(redisClient
*c
) {
3797 if (server
.bgsavechildpid
!= -1) {
3798 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3801 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3802 addReply(c
,shared
.ok
);
3804 addReply(c
,shared
.err
);
3808 static void bgsaveCommand(redisClient
*c
) {
3809 if (server
.bgsavechildpid
!= -1) {
3810 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3813 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3814 char *status
= "+Background saving started\r\n";
3815 addReplySds(c
,sdsnew(status
));
3817 addReply(c
,shared
.err
);
3821 static void shutdownCommand(redisClient
*c
) {
3822 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3823 /* Kill the saving child if there is a background saving in progress.
3824 We want to avoid race conditions, for instance our saving child may
3825 overwrite the synchronous saving did by SHUTDOWN. */
3826 if (server
.bgsavechildpid
!= -1) {
3827 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3828 kill(server
.bgsavechildpid
,SIGKILL
);
3829 rdbRemoveTempFile(server
.bgsavechildpid
);
3831 if (server
.appendonly
) {
3832 /* Append only file: fsync() the AOF and exit */
3833 fsync(server
.appendfd
);
3834 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3837 /* Snapshotting. Perform a SYNC SAVE and exit */
3838 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3839 if (server
.daemonize
)
3840 unlink(server
.pidfile
);
3841 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3842 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3843 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3846 /* Ooops.. error saving! The best we can do is to continue operating.
3847 * Note that if there was a background saving process, in the next
3848 * cron() Redis will be notified that the background saving aborted,
3849 * handling special stuff like slaves pending for synchronization... */
3850 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3851 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3856 static void renameGenericCommand(redisClient
*c
, int nx
) {
3859 /* To use the same key as src and dst is probably an error */
3860 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3861 addReply(c
,shared
.sameobjecterr
);
3865 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3867 addReply(c
,shared
.nokeyerr
);
3871 deleteIfVolatile(c
->db
,c
->argv
[2]);
3872 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3875 addReply(c
,shared
.czero
);
3878 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3880 incrRefCount(c
->argv
[2]);
3882 deleteKey(c
->db
,c
->argv
[1]);
3884 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3887 static void renameCommand(redisClient
*c
) {
3888 renameGenericCommand(c
,0);
3891 static void renamenxCommand(redisClient
*c
) {
3892 renameGenericCommand(c
,1);
3895 static void moveCommand(redisClient
*c
) {
3900 /* Obtain source and target DB pointers */
3903 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3904 addReply(c
,shared
.outofrangeerr
);
3908 selectDb(c
,srcid
); /* Back to the source DB */
3910 /* If the user is moving using as target the same
3911 * DB as the source DB it is probably an error. */
3913 addReply(c
,shared
.sameobjecterr
);
3917 /* Check if the element exists and get a reference */
3918 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3920 addReply(c
,shared
.czero
);
3924 /* Try to add the element to the target DB */
3925 deleteIfVolatile(dst
,c
->argv
[1]);
3926 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3927 addReply(c
,shared
.czero
);
3930 incrRefCount(c
->argv
[1]);
3933 /* OK! key moved, free the entry in the source DB */
3934 deleteKey(src
,c
->argv
[1]);
3936 addReply(c
,shared
.cone
);
3939 /* =================================== Lists ================================ */
3940 static void pushGenericCommand(redisClient
*c
, int where
) {
3944 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3946 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3947 addReply(c
,shared
.ok
);
3950 lobj
= createListObject();
3952 if (where
== REDIS_HEAD
) {
3953 listAddNodeHead(list
,c
->argv
[2]);
3955 listAddNodeTail(list
,c
->argv
[2]);
3957 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
3958 incrRefCount(c
->argv
[1]);
3959 incrRefCount(c
->argv
[2]);
3961 if (lobj
->type
!= REDIS_LIST
) {
3962 addReply(c
,shared
.wrongtypeerr
);
3965 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3966 addReply(c
,shared
.ok
);
3970 if (where
== REDIS_HEAD
) {
3971 listAddNodeHead(list
,c
->argv
[2]);
3973 listAddNodeTail(list
,c
->argv
[2]);
3975 incrRefCount(c
->argv
[2]);
3978 addReply(c
,shared
.ok
);
3981 static void lpushCommand(redisClient
*c
) {
3982 pushGenericCommand(c
,REDIS_HEAD
);
3985 static void rpushCommand(redisClient
*c
) {
3986 pushGenericCommand(c
,REDIS_TAIL
);
3989 static void llenCommand(redisClient
*c
) {
3993 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3995 addReply(c
,shared
.czero
);
3998 if (o
->type
!= REDIS_LIST
) {
3999 addReply(c
,shared
.wrongtypeerr
);
4002 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4007 static void lindexCommand(redisClient
*c
) {
4009 int index
= atoi(c
->argv
[2]->ptr
);
4011 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4013 addReply(c
,shared
.nullbulk
);
4015 if (o
->type
!= REDIS_LIST
) {
4016 addReply(c
,shared
.wrongtypeerr
);
4018 list
*list
= o
->ptr
;
4021 ln
= listIndex(list
, index
);
4023 addReply(c
,shared
.nullbulk
);
4025 robj
*ele
= listNodeValue(ln
);
4026 addReplyBulkLen(c
,ele
);
4028 addReply(c
,shared
.crlf
);
4034 static void lsetCommand(redisClient
*c
) {
4036 int index
= atoi(c
->argv
[2]->ptr
);
4038 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4040 addReply(c
,shared
.nokeyerr
);
4042 if (o
->type
!= REDIS_LIST
) {
4043 addReply(c
,shared
.wrongtypeerr
);
4045 list
*list
= o
->ptr
;
4048 ln
= listIndex(list
, index
);
4050 addReply(c
,shared
.outofrangeerr
);
4052 robj
*ele
= listNodeValue(ln
);
4055 listNodeValue(ln
) = c
->argv
[3];
4056 incrRefCount(c
->argv
[3]);
4057 addReply(c
,shared
.ok
);
4064 static void popGenericCommand(redisClient
*c
, int where
) {
4067 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4069 addReply(c
,shared
.nullbulk
);
4071 if (o
->type
!= REDIS_LIST
) {
4072 addReply(c
,shared
.wrongtypeerr
);
4074 list
*list
= o
->ptr
;
4077 if (where
== REDIS_HEAD
)
4078 ln
= listFirst(list
);
4080 ln
= listLast(list
);
4083 addReply(c
,shared
.nullbulk
);
4085 robj
*ele
= listNodeValue(ln
);
4086 addReplyBulkLen(c
,ele
);
4088 addReply(c
,shared
.crlf
);
4089 listDelNode(list
,ln
);
4096 static void lpopCommand(redisClient
*c
) {
4097 popGenericCommand(c
,REDIS_HEAD
);
4100 static void rpopCommand(redisClient
*c
) {
4101 popGenericCommand(c
,REDIS_TAIL
);
4104 static void lrangeCommand(redisClient
*c
) {
4106 int start
= atoi(c
->argv
[2]->ptr
);
4107 int end
= atoi(c
->argv
[3]->ptr
);
4109 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4111 addReply(c
,shared
.nullmultibulk
);
4113 if (o
->type
!= REDIS_LIST
) {
4114 addReply(c
,shared
.wrongtypeerr
);
4116 list
*list
= o
->ptr
;
4118 int llen
= listLength(list
);
4122 /* convert negative indexes */
4123 if (start
< 0) start
= llen
+start
;
4124 if (end
< 0) end
= llen
+end
;
4125 if (start
< 0) start
= 0;
4126 if (end
< 0) end
= 0;
4128 /* indexes sanity checks */
4129 if (start
> end
|| start
>= llen
) {
4130 /* Out of range start or start > end result in empty list */
4131 addReply(c
,shared
.emptymultibulk
);
4134 if (end
>= llen
) end
= llen
-1;
4135 rangelen
= (end
-start
)+1;
4137 /* Return the result in form of a multi-bulk reply */
4138 ln
= listIndex(list
, start
);
4139 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4140 for (j
= 0; j
< rangelen
; j
++) {
4141 ele
= listNodeValue(ln
);
4142 addReplyBulkLen(c
,ele
);
4144 addReply(c
,shared
.crlf
);
4151 static void ltrimCommand(redisClient
*c
) {
4153 int start
= atoi(c
->argv
[2]->ptr
);
4154 int end
= atoi(c
->argv
[3]->ptr
);
4156 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4158 addReply(c
,shared
.ok
);
4160 if (o
->type
!= REDIS_LIST
) {
4161 addReply(c
,shared
.wrongtypeerr
);
4163 list
*list
= o
->ptr
;
4165 int llen
= listLength(list
);
4166 int j
, ltrim
, rtrim
;
4168 /* convert negative indexes */
4169 if (start
< 0) start
= llen
+start
;
4170 if (end
< 0) end
= llen
+end
;
4171 if (start
< 0) start
= 0;
4172 if (end
< 0) end
= 0;
4174 /* indexes sanity checks */
4175 if (start
> end
|| start
>= llen
) {
4176 /* Out of range start or start > end result in empty list */
4180 if (end
>= llen
) end
= llen
-1;
4185 /* Remove list elements to perform the trim */
4186 for (j
= 0; j
< ltrim
; j
++) {
4187 ln
= listFirst(list
);
4188 listDelNode(list
,ln
);
4190 for (j
= 0; j
< rtrim
; j
++) {
4191 ln
= listLast(list
);
4192 listDelNode(list
,ln
);
4195 addReply(c
,shared
.ok
);
4200 static void lremCommand(redisClient
*c
) {
4203 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4205 addReply(c
,shared
.czero
);
4207 if (o
->type
!= REDIS_LIST
) {
4208 addReply(c
,shared
.wrongtypeerr
);
4210 list
*list
= o
->ptr
;
4211 listNode
*ln
, *next
;
4212 int toremove
= atoi(c
->argv
[2]->ptr
);
4217 toremove
= -toremove
;
4220 ln
= fromtail
? list
->tail
: list
->head
;
4222 robj
*ele
= listNodeValue(ln
);
4224 next
= fromtail
? ln
->prev
: ln
->next
;
4225 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4226 listDelNode(list
,ln
);
4229 if (toremove
&& removed
== toremove
) break;
4233 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4238 /* This is the semantic of this command:
4239 * RPOPLPUSH srclist dstlist:
4240 * IF LLEN(srclist) > 0
4241 * element = RPOP srclist
4242 * LPUSH dstlist element
4249 * The idea is to be able to get an element from a list in a reliable way
4250 * since the element is not just returned but pushed against another list
4251 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4253 static void rpoplpushcommand(redisClient
*c
) {
4256 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4258 addReply(c
,shared
.nullbulk
);
4260 if (sobj
->type
!= REDIS_LIST
) {
4261 addReply(c
,shared
.wrongtypeerr
);
4263 list
*srclist
= sobj
->ptr
;
4264 listNode
*ln
= listLast(srclist
);
4267 addReply(c
,shared
.nullbulk
);
4269 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4270 robj
*ele
= listNodeValue(ln
);
4273 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4274 addReply(c
,shared
.wrongtypeerr
);
4278 /* Add the element to the target list (unless it's directly
4279 * passed to some BLPOP-ing client */
4280 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4282 /* Create the list if the key does not exist */
4283 dobj
= createListObject();
4284 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4285 incrRefCount(c
->argv
[2]);
4287 dstlist
= dobj
->ptr
;
4288 listAddNodeHead(dstlist
,ele
);
4292 /* Send the element to the client as reply as well */
4293 addReplyBulkLen(c
,ele
);
4295 addReply(c
,shared
.crlf
);
4297 /* Finally remove the element from the source list */
4298 listDelNode(srclist
,ln
);
4306 /* ==================================== Sets ================================ */
4308 static void saddCommand(redisClient
*c
) {
4311 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4313 set
= createSetObject();
4314 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4315 incrRefCount(c
->argv
[1]);
4317 if (set
->type
!= REDIS_SET
) {
4318 addReply(c
,shared
.wrongtypeerr
);
4322 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4323 incrRefCount(c
->argv
[2]);
4325 addReply(c
,shared
.cone
);
4327 addReply(c
,shared
.czero
);
4331 static void sremCommand(redisClient
*c
) {
4334 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4336 addReply(c
,shared
.czero
);
4338 if (set
->type
!= REDIS_SET
) {
4339 addReply(c
,shared
.wrongtypeerr
);
4342 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4344 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4345 addReply(c
,shared
.cone
);
4347 addReply(c
,shared
.czero
);
4352 static void smoveCommand(redisClient
*c
) {
4353 robj
*srcset
, *dstset
;
4355 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4356 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4358 /* If the source key does not exist return 0, if it's of the wrong type
4360 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4361 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4364 /* Error if the destination key is not a set as well */
4365 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4366 addReply(c
,shared
.wrongtypeerr
);
4369 /* Remove the element from the source set */
4370 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4371 /* Key not found in the src set! return zero */
4372 addReply(c
,shared
.czero
);
4376 /* Add the element to the destination set */
4378 dstset
= createSetObject();
4379 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4380 incrRefCount(c
->argv
[2]);
4382 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4383 incrRefCount(c
->argv
[3]);
4384 addReply(c
,shared
.cone
);
4387 static void sismemberCommand(redisClient
*c
) {
4390 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4392 addReply(c
,shared
.czero
);
4394 if (set
->type
!= REDIS_SET
) {
4395 addReply(c
,shared
.wrongtypeerr
);
4398 if (dictFind(set
->ptr
,c
->argv
[2]))
4399 addReply(c
,shared
.cone
);
4401 addReply(c
,shared
.czero
);
4405 static void scardCommand(redisClient
*c
) {
4409 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4411 addReply(c
,shared
.czero
);
4414 if (o
->type
!= REDIS_SET
) {
4415 addReply(c
,shared
.wrongtypeerr
);
4418 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4424 static void spopCommand(redisClient
*c
) {
4428 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4430 addReply(c
,shared
.nullbulk
);
4432 if (set
->type
!= REDIS_SET
) {
4433 addReply(c
,shared
.wrongtypeerr
);
4436 de
= dictGetRandomKey(set
->ptr
);
4438 addReply(c
,shared
.nullbulk
);
4440 robj
*ele
= dictGetEntryKey(de
);
4442 addReplyBulkLen(c
,ele
);
4444 addReply(c
,shared
.crlf
);
4445 dictDelete(set
->ptr
,ele
);
4446 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4452 static void srandmemberCommand(redisClient
*c
) {
4456 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4458 addReply(c
,shared
.nullbulk
);
4460 if (set
->type
!= REDIS_SET
) {
4461 addReply(c
,shared
.wrongtypeerr
);
4464 de
= dictGetRandomKey(set
->ptr
);
4466 addReply(c
,shared
.nullbulk
);
4468 robj
*ele
= dictGetEntryKey(de
);
4470 addReplyBulkLen(c
,ele
);
4472 addReply(c
,shared
.crlf
);
4477 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4478 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4480 return dictSize(*d1
)-dictSize(*d2
);
4483 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4484 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4487 robj
*lenobj
= NULL
, *dstset
= NULL
;
4488 unsigned long j
, cardinality
= 0;
4490 for (j
= 0; j
< setsnum
; j
++) {
4494 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4495 lookupKeyRead(c
->db
,setskeys
[j
]);
4499 if (deleteKey(c
->db
,dstkey
))
4501 addReply(c
,shared
.czero
);
4503 addReply(c
,shared
.nullmultibulk
);
4507 if (setobj
->type
!= REDIS_SET
) {
4509 addReply(c
,shared
.wrongtypeerr
);
4512 dv
[j
] = setobj
->ptr
;
4514 /* Sort sets from the smallest to largest, this will improve our
4515 * algorithm's performace */
4516 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4518 /* The first thing we should output is the total number of elements...
4519 * since this is a multi-bulk write, but at this stage we don't know
4520 * the intersection set size, so we use a trick, append an empty object
4521 * to the output list and save the pointer to later modify it with the
4524 lenobj
= createObject(REDIS_STRING
,NULL
);
4526 decrRefCount(lenobj
);
4528 /* If we have a target key where to store the resulting set
4529 * create this key with an empty set inside */
4530 dstset
= createSetObject();
4533 /* Iterate all the elements of the first (smallest) set, and test
4534 * the element against all the other sets, if at least one set does
4535 * not include the element it is discarded */
4536 di
= dictGetIterator(dv
[0]);
4538 while((de
= dictNext(di
)) != NULL
) {
4541 for (j
= 1; j
< setsnum
; j
++)
4542 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4544 continue; /* at least one set does not contain the member */
4545 ele
= dictGetEntryKey(de
);
4547 addReplyBulkLen(c
,ele
);
4549 addReply(c
,shared
.crlf
);
4552 dictAdd(dstset
->ptr
,ele
,NULL
);
4556 dictReleaseIterator(di
);
4559 /* Store the resulting set into the target */
4560 deleteKey(c
->db
,dstkey
);
4561 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4562 incrRefCount(dstkey
);
4566 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4568 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4569 dictSize((dict
*)dstset
->ptr
)));
4575 static void sinterCommand(redisClient
*c
) {
4576 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4579 static void sinterstoreCommand(redisClient
*c
) {
4580 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4583 #define REDIS_OP_UNION 0
4584 #define REDIS_OP_DIFF 1
4586 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4587 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4590 robj
*dstset
= NULL
;
4591 int j
, cardinality
= 0;
4593 for (j
= 0; j
< setsnum
; j
++) {
4597 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4598 lookupKeyRead(c
->db
,setskeys
[j
]);
4603 if (setobj
->type
!= REDIS_SET
) {
4605 addReply(c
,shared
.wrongtypeerr
);
4608 dv
[j
] = setobj
->ptr
;
4611 /* We need a temp set object to store our union. If the dstkey
4612 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4613 * this set object will be the resulting object to set into the target key*/
4614 dstset
= createSetObject();
4616 /* Iterate all the elements of all the sets, add every element a single
4617 * time to the result set */
4618 for (j
= 0; j
< setsnum
; j
++) {
4619 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4620 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4622 di
= dictGetIterator(dv
[j
]);
4624 while((de
= dictNext(di
)) != NULL
) {
4627 /* dictAdd will not add the same element multiple times */
4628 ele
= dictGetEntryKey(de
);
4629 if (op
== REDIS_OP_UNION
|| j
== 0) {
4630 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4634 } else if (op
== REDIS_OP_DIFF
) {
4635 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4640 dictReleaseIterator(di
);
4642 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4645 /* Output the content of the resulting set, if not in STORE mode */
4647 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4648 di
= dictGetIterator(dstset
->ptr
);
4649 while((de
= dictNext(di
)) != NULL
) {
4652 ele
= dictGetEntryKey(de
);
4653 addReplyBulkLen(c
,ele
);
4655 addReply(c
,shared
.crlf
);
4657 dictReleaseIterator(di
);
4659 /* If we have a target key where to store the resulting set
4660 * create this key with the result set inside */
4661 deleteKey(c
->db
,dstkey
);
4662 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4663 incrRefCount(dstkey
);
4668 decrRefCount(dstset
);
4670 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4671 dictSize((dict
*)dstset
->ptr
)));
4677 static void sunionCommand(redisClient
*c
) {
4678 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4681 static void sunionstoreCommand(redisClient
*c
) {
4682 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4685 static void sdiffCommand(redisClient
*c
) {
4686 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4689 static void sdiffstoreCommand(redisClient
*c
) {
4690 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4693 /* ==================================== ZSets =============================== */
4695 /* ZSETs are ordered sets using two data structures to hold the same elements
4696 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4699 * The elements are added to an hash table mapping Redis objects to scores.
4700 * At the same time the elements are added to a skip list mapping scores
4701 * to Redis objects (so objects are sorted by scores in this "view"). */
4703 /* This skiplist implementation is almost a C translation of the original
4704 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4705 * Alternative to Balanced Trees", modified in three ways:
4706 * a) this implementation allows for repeated values.
4707 * b) the comparison is not just by key (our 'score') but by satellite data.
4708 * c) there is a back pointer, so it's a doubly linked list with the back
4709 * pointers being only at "level 1". This allows to traverse the list
4710 * from tail to head, useful for ZREVRANGE. */
4712 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4713 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4715 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4721 static zskiplist
*zslCreate(void) {
4725 zsl
= zmalloc(sizeof(*zsl
));
4728 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4729 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4730 zsl
->header
->forward
[j
] = NULL
;
4731 zsl
->header
->backward
= NULL
;
4736 static void zslFreeNode(zskiplistNode
*node
) {
4737 decrRefCount(node
->obj
);
4738 zfree(node
->forward
);
4742 static void zslFree(zskiplist
*zsl
) {
4743 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4745 zfree(zsl
->header
->forward
);
4748 next
= node
->forward
[0];
4755 static int zslRandomLevel(void) {
4757 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4762 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4763 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4767 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4768 while (x
->forward
[i
] &&
4769 (x
->forward
[i
]->score
< score
||
4770 (x
->forward
[i
]->score
== score
&&
4771 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4775 /* we assume the key is not already inside, since we allow duplicated
4776 * scores, and the re-insertion of score and redis object should never
4777 * happpen since the caller of zslInsert() should test in the hash table
4778 * if the element is already inside or not. */
4779 level
= zslRandomLevel();
4780 if (level
> zsl
->level
) {
4781 for (i
= zsl
->level
; i
< level
; i
++)
4782 update
[i
] = zsl
->header
;
4785 x
= zslCreateNode(level
,score
,obj
);
4786 for (i
= 0; i
< level
; i
++) {
4787 x
->forward
[i
] = update
[i
]->forward
[i
];
4788 update
[i
]->forward
[i
] = x
;
4790 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4792 x
->forward
[0]->backward
= x
;
4798 /* Delete an element with matching score/object from the skiplist. */
4799 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4800 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4804 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4805 while (x
->forward
[i
] &&
4806 (x
->forward
[i
]->score
< score
||
4807 (x
->forward
[i
]->score
== score
&&
4808 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4812 /* We may have multiple elements with the same score, what we need
4813 * is to find the element with both the right score and object. */
4815 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4816 for (i
= 0; i
< zsl
->level
; i
++) {
4817 if (update
[i
]->forward
[i
] != x
) break;
4818 update
[i
]->forward
[i
] = x
->forward
[i
];
4820 if (x
->forward
[0]) {
4821 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4824 zsl
->tail
= x
->backward
;
4827 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4832 return 0; /* not found */
4834 return 0; /* not found */
4837 /* Delete all the elements with score between min and max from the skiplist.
4838 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4839 * Note that this function takes the reference to the hash table view of the
4840 * sorted set, in order to remove the elements from the hash table too. */
4841 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4842 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4843 unsigned long removed
= 0;
4847 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4848 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4852 /* We may have multiple elements with the same score, what we need
4853 * is to find the element with both the right score and object. */
4855 while (x
&& x
->score
<= max
) {
4856 zskiplistNode
*next
;
4858 for (i
= 0; i
< zsl
->level
; i
++) {
4859 if (update
[i
]->forward
[i
] != x
) break;
4860 update
[i
]->forward
[i
] = x
->forward
[i
];
4862 if (x
->forward
[0]) {
4863 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4866 zsl
->tail
= x
->backward
;
4868 next
= x
->forward
[0];
4869 dictDelete(dict
,x
->obj
);
4871 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4877 return removed
; /* not found */
4880 /* Find the first node having a score equal or greater than the specified one.
4881 * Returns NULL if there is no match. */
4882 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4887 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4888 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4891 /* We may have multiple elements with the same score, what we need
4892 * is to find the element with both the right score and object. */
4893 return x
->forward
[0];
4896 /* The actual Z-commands implementations */
4898 /* This generic command implements both ZADD and ZINCRBY.
4899 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4900 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4901 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4906 zsetobj
= lookupKeyWrite(c
->db
,key
);
4907 if (zsetobj
== NULL
) {
4908 zsetobj
= createZsetObject();
4909 dictAdd(c
->db
->dict
,key
,zsetobj
);
4912 if (zsetobj
->type
!= REDIS_ZSET
) {
4913 addReply(c
,shared
.wrongtypeerr
);
4919 /* Ok now since we implement both ZADD and ZINCRBY here the code
4920 * needs to handle the two different conditions. It's all about setting
4921 * '*score', that is, the new score to set, to the right value. */
4922 score
= zmalloc(sizeof(double));
4926 /* Read the old score. If the element was not present starts from 0 */
4927 de
= dictFind(zs
->dict
,ele
);
4929 double *oldscore
= dictGetEntryVal(de
);
4930 *score
= *oldscore
+ scoreval
;
4938 /* What follows is a simple remove and re-insert operation that is common
4939 * to both ZADD and ZINCRBY... */
4940 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
4941 /* case 1: New element */
4942 incrRefCount(ele
); /* added to hash */
4943 zslInsert(zs
->zsl
,*score
,ele
);
4944 incrRefCount(ele
); /* added to skiplist */
4947 addReplyDouble(c
,*score
);
4949 addReply(c
,shared
.cone
);
4954 /* case 2: Score update operation */
4955 de
= dictFind(zs
->dict
,ele
);
4956 redisAssert(de
!= NULL
);
4957 oldscore
= dictGetEntryVal(de
);
4958 if (*score
!= *oldscore
) {
4961 /* Remove and insert the element in the skip list with new score */
4962 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
4963 redisAssert(deleted
!= 0);
4964 zslInsert(zs
->zsl
,*score
,ele
);
4966 /* Update the score in the hash table */
4967 dictReplace(zs
->dict
,ele
,score
);
4973 addReplyDouble(c
,*score
);
4975 addReply(c
,shared
.czero
);
4979 static void zaddCommand(redisClient
*c
) {
4982 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4983 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
4986 static void zincrbyCommand(redisClient
*c
) {
4989 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4990 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
4993 static void zremCommand(redisClient
*c
) {
4997 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4998 if (zsetobj
== NULL
) {
4999 addReply(c
,shared
.czero
);
5005 if (zsetobj
->type
!= REDIS_ZSET
) {
5006 addReply(c
,shared
.wrongtypeerr
);
5010 de
= dictFind(zs
->dict
,c
->argv
[2]);
5012 addReply(c
,shared
.czero
);
5015 /* Delete from the skiplist */
5016 oldscore
= dictGetEntryVal(de
);
5017 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5018 redisAssert(deleted
!= 0);
5020 /* Delete from the hash table */
5021 dictDelete(zs
->dict
,c
->argv
[2]);
5022 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5024 addReply(c
,shared
.cone
);
5028 static void zremrangebyscoreCommand(redisClient
*c
) {
5029 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5030 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5034 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5035 if (zsetobj
== NULL
) {
5036 addReply(c
,shared
.czero
);
5040 if (zsetobj
->type
!= REDIS_ZSET
) {
5041 addReply(c
,shared
.wrongtypeerr
);
5045 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5046 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5047 server
.dirty
+= deleted
;
5048 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5052 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5054 int start
= atoi(c
->argv
[2]->ptr
);
5055 int end
= atoi(c
->argv
[3]->ptr
);
5058 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5060 } else if (c
->argc
>= 5) {
5061 addReply(c
,shared
.syntaxerr
);
5065 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5067 addReply(c
,shared
.nullmultibulk
);
5069 if (o
->type
!= REDIS_ZSET
) {
5070 addReply(c
,shared
.wrongtypeerr
);
5072 zset
*zsetobj
= o
->ptr
;
5073 zskiplist
*zsl
= zsetobj
->zsl
;
5076 int llen
= zsl
->length
;
5080 /* convert negative indexes */
5081 if (start
< 0) start
= llen
+start
;
5082 if (end
< 0) end
= llen
+end
;
5083 if (start
< 0) start
= 0;
5084 if (end
< 0) end
= 0;
5086 /* indexes sanity checks */
5087 if (start
> end
|| start
>= llen
) {
5088 /* Out of range start or start > end result in empty list */
5089 addReply(c
,shared
.emptymultibulk
);
5092 if (end
>= llen
) end
= llen
-1;
5093 rangelen
= (end
-start
)+1;
5095 /* Return the result in form of a multi-bulk reply */
5101 ln
= zsl
->header
->forward
[0];
5103 ln
= ln
->forward
[0];
5106 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5107 withscores
? (rangelen
*2) : rangelen
));
5108 for (j
= 0; j
< rangelen
; j
++) {
5110 addReplyBulkLen(c
,ele
);
5112 addReply(c
,shared
.crlf
);
5114 addReplyDouble(c
,ln
->score
);
5115 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5121 static void zrangeCommand(redisClient
*c
) {
5122 zrangeGenericCommand(c
,0);
5125 static void zrevrangeCommand(redisClient
*c
) {
5126 zrangeGenericCommand(c
,1);
5129 static void zrangebyscoreCommand(redisClient
*c
) {
5131 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5132 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5133 int offset
= 0, limit
= -1;
5135 if (c
->argc
!= 4 && c
->argc
!= 7) {
5137 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5139 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5140 addReply(c
,shared
.syntaxerr
);
5142 } else if (c
->argc
== 7) {
5143 offset
= atoi(c
->argv
[5]->ptr
);
5144 limit
= atoi(c
->argv
[6]->ptr
);
5145 if (offset
< 0) offset
= 0;
5148 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5150 addReply(c
,shared
.nullmultibulk
);
5152 if (o
->type
!= REDIS_ZSET
) {
5153 addReply(c
,shared
.wrongtypeerr
);
5155 zset
*zsetobj
= o
->ptr
;
5156 zskiplist
*zsl
= zsetobj
->zsl
;
5159 unsigned int rangelen
= 0;
5161 /* Get the first node with the score >= min */
5162 ln
= zslFirstWithScore(zsl
,min
);
5164 /* No element matching the speciifed interval */
5165 addReply(c
,shared
.emptymultibulk
);
5169 /* We don't know in advance how many matching elements there
5170 * are in the list, so we push this object that will represent
5171 * the multi-bulk length in the output buffer, and will "fix"
5173 lenobj
= createObject(REDIS_STRING
,NULL
);
5175 decrRefCount(lenobj
);
5177 while(ln
&& ln
->score
<= max
) {
5180 ln
= ln
->forward
[0];
5183 if (limit
== 0) break;
5185 addReplyBulkLen(c
,ele
);
5187 addReply(c
,shared
.crlf
);
5188 ln
= ln
->forward
[0];
5190 if (limit
> 0) limit
--;
5192 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
5197 static void zcardCommand(redisClient
*c
) {
5201 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5203 addReply(c
,shared
.czero
);
5206 if (o
->type
!= REDIS_ZSET
) {
5207 addReply(c
,shared
.wrongtypeerr
);
5210 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5215 static void zscoreCommand(redisClient
*c
) {
5219 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5221 addReply(c
,shared
.nullbulk
);
5224 if (o
->type
!= REDIS_ZSET
) {
5225 addReply(c
,shared
.wrongtypeerr
);
5230 de
= dictFind(zs
->dict
,c
->argv
[2]);
5232 addReply(c
,shared
.nullbulk
);
5234 double *score
= dictGetEntryVal(de
);
5236 addReplyDouble(c
,*score
);
5242 /* ========================= Non type-specific commands ==================== */
5244 static void flushdbCommand(redisClient
*c
) {
5245 server
.dirty
+= dictSize(c
->db
->dict
);
5246 dictEmpty(c
->db
->dict
);
5247 dictEmpty(c
->db
->expires
);
5248 addReply(c
,shared
.ok
);
5251 static void flushallCommand(redisClient
*c
) {
5252 server
.dirty
+= emptyDb();
5253 addReply(c
,shared
.ok
);
5254 rdbSave(server
.dbfilename
);
5258 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5259 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5261 so
->pattern
= pattern
;
5265 /* Return the value associated to the key with a name obtained
5266 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5267 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5271 int prefixlen
, sublen
, postfixlen
;
5272 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5276 char buf
[REDIS_SORTKEY_MAX
+1];
5279 /* If the pattern is "#" return the substitution object itself in order
5280 * to implement the "SORT ... GET #" feature. */
5281 spat
= pattern
->ptr
;
5282 if (spat
[0] == '#' && spat
[1] == '\0') {
5286 /* The substitution object may be specially encoded. If so we create
5287 * a decoded object on the fly. Otherwise getDecodedObject will just
5288 * increment the ref count, that we'll decrement later. */
5289 subst
= getDecodedObject(subst
);
5292 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5293 p
= strchr(spat
,'*');
5295 decrRefCount(subst
);
5300 sublen
= sdslen(ssub
);
5301 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5302 memcpy(keyname
.buf
,spat
,prefixlen
);
5303 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5304 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5305 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5306 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5308 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5309 decrRefCount(subst
);
5311 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5312 return lookupKeyRead(db
,&keyobj
);
5315 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5316 * the additional parameter is not standard but a BSD-specific we have to
5317 * pass sorting parameters via the global 'server' structure */
5318 static int sortCompare(const void *s1
, const void *s2
) {
5319 const redisSortObject
*so1
= s1
, *so2
= s2
;
5322 if (!server
.sort_alpha
) {
5323 /* Numeric sorting. Here it's trivial as we precomputed scores */
5324 if (so1
->u
.score
> so2
->u
.score
) {
5326 } else if (so1
->u
.score
< so2
->u
.score
) {
5332 /* Alphanumeric sorting */
5333 if (server
.sort_bypattern
) {
5334 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5335 /* At least one compare object is NULL */
5336 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5338 else if (so1
->u
.cmpobj
== NULL
)
5343 /* We have both the objects, use strcoll */
5344 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5347 /* Compare elements directly */
5350 dec1
= getDecodedObject(so1
->obj
);
5351 dec2
= getDecodedObject(so2
->obj
);
5352 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5357 return server
.sort_desc
? -cmp
: cmp
;
5360 /* The SORT command is the most complex command in Redis. Warning: this code
5361 * is optimized for speed and a bit less for readability */
5362 static void sortCommand(redisClient
*c
) {
5365 int desc
= 0, alpha
= 0;
5366 int limit_start
= 0, limit_count
= -1, start
, end
;
5367 int j
, dontsort
= 0, vectorlen
;
5368 int getop
= 0; /* GET operation counter */
5369 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5370 redisSortObject
*vector
; /* Resulting vector to sort */
5372 /* Lookup the key to sort. It must be of the right types */
5373 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5374 if (sortval
== NULL
) {
5375 addReply(c
,shared
.nullmultibulk
);
5378 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5379 sortval
->type
!= REDIS_ZSET
)
5381 addReply(c
,shared
.wrongtypeerr
);
5385 /* Create a list of operations to perform for every sorted element.
5386 * Operations can be GET/DEL/INCR/DECR */
5387 operations
= listCreate();
5388 listSetFreeMethod(operations
,zfree
);
5391 /* Now we need to protect sortval incrementing its count, in the future
5392 * SORT may have options able to overwrite/delete keys during the sorting
5393 * and the sorted key itself may get destroied */
5394 incrRefCount(sortval
);
5396 /* The SORT command has an SQL-alike syntax, parse it */
5397 while(j
< c
->argc
) {
5398 int leftargs
= c
->argc
-j
-1;
5399 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5401 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5403 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5405 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5406 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5407 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5409 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5410 storekey
= c
->argv
[j
+1];
5412 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5413 sortby
= c
->argv
[j
+1];
5414 /* If the BY pattern does not contain '*', i.e. it is constant,
5415 * we don't need to sort nor to lookup the weight keys. */
5416 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5418 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5419 listAddNodeTail(operations
,createSortOperation(
5420 REDIS_SORT_GET
,c
->argv
[j
+1]));
5424 decrRefCount(sortval
);
5425 listRelease(operations
);
5426 addReply(c
,shared
.syntaxerr
);
5432 /* Load the sorting vector with all the objects to sort */
5433 switch(sortval
->type
) {
5434 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5435 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5436 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5437 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5439 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5442 if (sortval
->type
== REDIS_LIST
) {
5443 list
*list
= sortval
->ptr
;
5447 listRewind(list
,&li
);
5448 while((ln
= listNext(&li
))) {
5449 robj
*ele
= ln
->value
;
5450 vector
[j
].obj
= ele
;
5451 vector
[j
].u
.score
= 0;
5452 vector
[j
].u
.cmpobj
= NULL
;
5460 if (sortval
->type
== REDIS_SET
) {
5463 zset
*zs
= sortval
->ptr
;
5467 di
= dictGetIterator(set
);
5468 while((setele
= dictNext(di
)) != NULL
) {
5469 vector
[j
].obj
= dictGetEntryKey(setele
);
5470 vector
[j
].u
.score
= 0;
5471 vector
[j
].u
.cmpobj
= NULL
;
5474 dictReleaseIterator(di
);
5476 redisAssert(j
== vectorlen
);
5478 /* Now it's time to load the right scores in the sorting vector */
5479 if (dontsort
== 0) {
5480 for (j
= 0; j
< vectorlen
; j
++) {
5484 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5485 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5487 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5489 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5490 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5492 /* Don't need to decode the object if it's
5493 * integer-encoded (the only encoding supported) so
5494 * far. We can just cast it */
5495 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5496 vector
[j
].u
.score
= (long)byval
->ptr
;
5498 redisAssert(1 != 1);
5503 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5504 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5506 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5507 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5509 redisAssert(1 != 1);
5516 /* We are ready to sort the vector... perform a bit of sanity check
5517 * on the LIMIT option too. We'll use a partial version of quicksort. */
5518 start
= (limit_start
< 0) ? 0 : limit_start
;
5519 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5520 if (start
>= vectorlen
) {
5521 start
= vectorlen
-1;
5524 if (end
>= vectorlen
) end
= vectorlen
-1;
5526 if (dontsort
== 0) {
5527 server
.sort_desc
= desc
;
5528 server
.sort_alpha
= alpha
;
5529 server
.sort_bypattern
= sortby
? 1 : 0;
5530 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5531 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5533 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5536 /* Send command output to the output buffer, performing the specified
5537 * GET/DEL/INCR/DECR operations if any. */
5538 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5539 if (storekey
== NULL
) {
5540 /* STORE option not specified, sent the sorting result to client */
5541 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5542 for (j
= start
; j
<= end
; j
++) {
5547 addReplyBulkLen(c
,vector
[j
].obj
);
5548 addReply(c
,vector
[j
].obj
);
5549 addReply(c
,shared
.crlf
);
5551 listRewind(operations
,&li
);
5552 while((ln
= listNext(&li
))) {
5553 redisSortOperation
*sop
= ln
->value
;
5554 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5557 if (sop
->type
== REDIS_SORT_GET
) {
5558 if (!val
|| val
->type
!= REDIS_STRING
) {
5559 addReply(c
,shared
.nullbulk
);
5561 addReplyBulkLen(c
,val
);
5563 addReply(c
,shared
.crlf
);
5566 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5571 robj
*listObject
= createListObject();
5572 list
*listPtr
= (list
*) listObject
->ptr
;
5574 /* STORE option specified, set the sorting result as a List object */
5575 for (j
= start
; j
<= end
; j
++) {
5580 listAddNodeTail(listPtr
,vector
[j
].obj
);
5581 incrRefCount(vector
[j
].obj
);
5583 listRewind(operations
,&li
);
5584 while((ln
= listNext(&li
))) {
5585 redisSortOperation
*sop
= ln
->value
;
5586 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5589 if (sop
->type
== REDIS_SORT_GET
) {
5590 if (!val
|| val
->type
!= REDIS_STRING
) {
5591 listAddNodeTail(listPtr
,createStringObject("",0));
5593 listAddNodeTail(listPtr
,val
);
5597 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5601 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5602 incrRefCount(storekey
);
5604 /* Note: we add 1 because the DB is dirty anyway since even if the
5605 * SORT result is empty a new key is set and maybe the old content
5607 server
.dirty
+= 1+outputlen
;
5608 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5612 decrRefCount(sortval
);
5613 listRelease(operations
);
5614 for (j
= 0; j
< vectorlen
; j
++) {
5615 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5616 decrRefCount(vector
[j
].u
.cmpobj
);
5621 /* Convert an amount of bytes into a human readable string in the form
5622 * of 100B, 2G, 100M, 4K, and so forth. */
5623 static void bytesToHuman(char *s
, unsigned long long n
) {
5628 sprintf(s
,"%lluB",n
);
5630 } else if (n
< (1024*1024)) {
5631 d
= (double)n
/(1024);
5632 sprintf(s
,"%.2fK",d
);
5633 } else if (n
< (1024LL*1024*1024)) {
5634 d
= (double)n
/(1024*1024);
5635 sprintf(s
,"%.2fM",d
);
5636 } else if (n
< (1024LL*1024*1024*1024)) {
5637 d
= (double)n
/(1024LL*1024*1024);
5638 sprintf(s
,"%.2fG",d
);
5642 /* Create the string returned by the INFO command. This is decoupled
5643 * by the INFO command itself as we need to report the same information
5644 * on memory corruption problems. */
5645 static sds
genRedisInfoString(void) {
5647 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5651 bytesToHuman(hmem
,zmalloc_used_memory());
5652 info
= sdscatprintf(sdsempty(),
5653 "redis_version:%s\r\n"
5655 "multiplexing_api:%s\r\n"
5656 "process_id:%ld\r\n"
5657 "uptime_in_seconds:%ld\r\n"
5658 "uptime_in_days:%ld\r\n"
5659 "connected_clients:%d\r\n"
5660 "connected_slaves:%d\r\n"
5661 "blocked_clients:%d\r\n"
5662 "used_memory:%zu\r\n"
5663 "used_memory_human:%s\r\n"
5664 "changes_since_last_save:%lld\r\n"
5665 "bgsave_in_progress:%d\r\n"
5666 "last_save_time:%ld\r\n"
5667 "bgrewriteaof_in_progress:%d\r\n"
5668 "total_connections_received:%lld\r\n"
5669 "total_commands_processed:%lld\r\n"
5673 (sizeof(long) == 8) ? "64" : "32",
5678 listLength(server
.clients
)-listLength(server
.slaves
),
5679 listLength(server
.slaves
),
5680 server
.blpop_blocked_clients
,
5681 zmalloc_used_memory(),
5684 server
.bgsavechildpid
!= -1,
5686 server
.bgrewritechildpid
!= -1,
5687 server
.stat_numconnections
,
5688 server
.stat_numcommands
,
5689 server
.vm_enabled
!= 0,
5690 server
.masterhost
== NULL
? "master" : "slave"
5692 if (server
.masterhost
) {
5693 info
= sdscatprintf(info
,
5694 "master_host:%s\r\n"
5695 "master_port:%d\r\n"
5696 "master_link_status:%s\r\n"
5697 "master_last_io_seconds_ago:%d\r\n"
5700 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5702 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5705 if (server
.vm_enabled
) {
5707 info
= sdscatprintf(info
,
5708 "vm_conf_max_memory:%llu\r\n"
5709 "vm_conf_page_size:%llu\r\n"
5710 "vm_conf_pages:%llu\r\n"
5711 "vm_stats_used_pages:%llu\r\n"
5712 "vm_stats_swapped_objects:%llu\r\n"
5713 "vm_stats_swappin_count:%llu\r\n"
5714 "vm_stats_swappout_count:%llu\r\n"
5715 "vm_stats_io_newjobs_len:%lu\r\n"
5716 "vm_stats_io_processing_len:%lu\r\n"
5717 "vm_stats_io_processed_len:%lu\r\n"
5718 "vm_stats_io_active_threads:%lu\r\n"
5719 "vm_stats_blocked_clients:%lu\r\n"
5720 ,(unsigned long long) server
.vm_max_memory
,
5721 (unsigned long long) server
.vm_page_size
,
5722 (unsigned long long) server
.vm_pages
,
5723 (unsigned long long) server
.vm_stats_used_pages
,
5724 (unsigned long long) server
.vm_stats_swapped_objects
,
5725 (unsigned long long) server
.vm_stats_swapins
,
5726 (unsigned long long) server
.vm_stats_swapouts
,
5727 (unsigned long) listLength(server
.io_newjobs
),
5728 (unsigned long) listLength(server
.io_processing
),
5729 (unsigned long) listLength(server
.io_processed
),
5730 (unsigned long) server
.io_active_threads
,
5731 (unsigned long) server
.vm_blocked_clients
5735 for (j
= 0; j
< server
.dbnum
; j
++) {
5736 long long keys
, vkeys
;
5738 keys
= dictSize(server
.db
[j
].dict
);
5739 vkeys
= dictSize(server
.db
[j
].expires
);
5740 if (keys
|| vkeys
) {
5741 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5748 static void infoCommand(redisClient
*c
) {
5749 sds info
= genRedisInfoString();
5750 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5751 (unsigned long)sdslen(info
)));
5752 addReplySds(c
,info
);
5753 addReply(c
,shared
.crlf
);
5756 static void monitorCommand(redisClient
*c
) {
5757 /* ignore MONITOR if aleady slave or in monitor mode */
5758 if (c
->flags
& REDIS_SLAVE
) return;
5760 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5762 listAddNodeTail(server
.monitors
,c
);
5763 addReply(c
,shared
.ok
);
5766 /* ================================= Expire ================================= */
5767 static int removeExpire(redisDb
*db
, robj
*key
) {
5768 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5775 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5776 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5784 /* Return the expire time of the specified key, or -1 if no expire
5785 * is associated with this key (i.e. the key is non volatile) */
5786 static time_t getExpire(redisDb
*db
, robj
*key
) {
5789 /* No expire? return ASAP */
5790 if (dictSize(db
->expires
) == 0 ||
5791 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5793 return (time_t) dictGetEntryVal(de
);
5796 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5800 /* No expire? return ASAP */
5801 if (dictSize(db
->expires
) == 0 ||
5802 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5804 /* Lookup the expire */
5805 when
= (time_t) dictGetEntryVal(de
);
5806 if (time(NULL
) <= when
) return 0;
5808 /* Delete the key */
5809 dictDelete(db
->expires
,key
);
5810 return dictDelete(db
->dict
,key
) == DICT_OK
;
5813 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5816 /* No expire? return ASAP */
5817 if (dictSize(db
->expires
) == 0 ||
5818 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5820 /* Delete the key */
5822 dictDelete(db
->expires
,key
);
5823 return dictDelete(db
->dict
,key
) == DICT_OK
;
5826 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5829 de
= dictFind(c
->db
->dict
,key
);
5831 addReply(c
,shared
.czero
);
5835 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5836 addReply(c
, shared
.cone
);
5839 time_t when
= time(NULL
)+seconds
;
5840 if (setExpire(c
->db
,key
,when
)) {
5841 addReply(c
,shared
.cone
);
5844 addReply(c
,shared
.czero
);
5850 static void expireCommand(redisClient
*c
) {
5851 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5854 static void expireatCommand(redisClient
*c
) {
5855 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5858 static void ttlCommand(redisClient
*c
) {
5862 expire
= getExpire(c
->db
,c
->argv
[1]);
5864 ttl
= (int) (expire
-time(NULL
));
5865 if (ttl
< 0) ttl
= -1;
5867 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5870 /* ================================ MULTI/EXEC ============================== */
5872 /* Client state initialization for MULTI/EXEC */
5873 static void initClientMultiState(redisClient
*c
) {
5874 c
->mstate
.commands
= NULL
;
5875 c
->mstate
.count
= 0;
5878 /* Release all the resources associated with MULTI/EXEC state */
5879 static void freeClientMultiState(redisClient
*c
) {
5882 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5884 multiCmd
*mc
= c
->mstate
.commands
+j
;
5886 for (i
= 0; i
< mc
->argc
; i
++)
5887 decrRefCount(mc
->argv
[i
]);
5890 zfree(c
->mstate
.commands
);
5893 /* Add a new command into the MULTI commands queue */
5894 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5898 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5899 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5900 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5903 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5904 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5905 for (j
= 0; j
< c
->argc
; j
++)
5906 incrRefCount(mc
->argv
[j
]);
5910 static void multiCommand(redisClient
*c
) {
5911 c
->flags
|= REDIS_MULTI
;
5912 addReply(c
,shared
.ok
);
5915 static void execCommand(redisClient
*c
) {
5920 if (!(c
->flags
& REDIS_MULTI
)) {
5921 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5925 orig_argv
= c
->argv
;
5926 orig_argc
= c
->argc
;
5927 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5928 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5929 c
->argc
= c
->mstate
.commands
[j
].argc
;
5930 c
->argv
= c
->mstate
.commands
[j
].argv
;
5931 call(c
,c
->mstate
.commands
[j
].cmd
);
5933 c
->argv
= orig_argv
;
5934 c
->argc
= orig_argc
;
5935 freeClientMultiState(c
);
5936 initClientMultiState(c
);
5937 c
->flags
&= (~REDIS_MULTI
);
5940 /* =========================== Blocking Operations ========================= */
5942 /* Currently Redis blocking operations support is limited to list POP ops,
5943 * so the current implementation is not fully generic, but it is also not
5944 * completely specific so it will not require a rewrite to support new
5945 * kind of blocking operations in the future.
5947 * Still it's important to note that list blocking operations can be already
5948 * used as a notification mechanism in order to implement other blocking
5949 * operations at application level, so there must be a very strong evidence
5950 * of usefulness and generality before new blocking operations are implemented.
5952 * This is how the current blocking POP works, we use BLPOP as example:
5953 * - If the user calls BLPOP and the key exists and contains a non empty list
5954 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
5955 * if there is not to block.
5956 * - If instead BLPOP is called and the key does not exists or the list is
5957 * empty we need to block. In order to do so we remove the notification for
5958 * new data to read in the client socket (so that we'll not serve new
5959 * requests if the blocking request is not served). Also we put the client
5960 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
5961 * blocking for this keys.
5962 * - If a PUSH operation against a key with blocked clients waiting is
5963 * performed, we serve the first in the list: basically instead to push
5964 * the new element inside the list we return it to the (first / oldest)
5965 * blocking client, unblock the client, and remove it form the list.
5967 * The above comment and the source code should be enough in order to understand
5968 * the implementation and modify / fix it later.
5971 /* Set a client in blocking mode for the specified key, with the specified
5973 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
5978 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
5979 c
->blockingkeysnum
= numkeys
;
5980 c
->blockingto
= timeout
;
5981 for (j
= 0; j
< numkeys
; j
++) {
5982 /* Add the key in the client structure, to map clients -> keys */
5983 c
->blockingkeys
[j
] = keys
[j
];
5984 incrRefCount(keys
[j
]);
5986 /* And in the other "side", to map keys -> clients */
5987 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
5991 /* For every key we take a list of clients blocked for it */
5993 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
5994 incrRefCount(keys
[j
]);
5995 assert(retval
== DICT_OK
);
5997 l
= dictGetEntryVal(de
);
5999 listAddNodeTail(l
,c
);
6001 /* Mark the client as a blocked client */
6002 c
->flags
|= REDIS_BLOCKED
;
6003 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
6004 server
.blpop_blocked_clients
++;
6007 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6008 static void unblockClientWaitingData(redisClient
*c
) {
6013 assert(c
->blockingkeys
!= NULL
);
6014 /* The client may wait for multiple keys, so unblock it for every key. */
6015 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6016 /* Remove this client from the list of clients waiting for this key. */
6017 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6019 l
= dictGetEntryVal(de
);
6020 listDelNode(l
,listSearchKey(l
,c
));
6021 /* If the list is empty we need to remove it to avoid wasting memory */
6022 if (listLength(l
) == 0)
6023 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6024 decrRefCount(c
->blockingkeys
[j
]);
6026 /* Cleanup the client structure */
6027 zfree(c
->blockingkeys
);
6028 c
->blockingkeys
= NULL
;
6029 c
->flags
&= (~REDIS_BLOCKED
);
6030 server
.blpop_blocked_clients
--;
6031 /* Ok now we are ready to get read events from socket, note that we
6032 * can't trap errors here as it's possible that unblockClientWaitingDatas() is
6033 * called from freeClient() itself, and the only thing we can do
6034 * if we failed to register the READABLE event is to kill the client.
6035 * Still the following function should never fail in the real world as
6036 * we are sure the file descriptor is sane, and we exit on out of mem. */
6037 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
6038 /* As a final step we want to process data if there is some command waiting
6039 * in the input buffer. Note that this is safe even if
6040 * unblockClientWaitingData() gets called from freeClient() because
6041 * freeClient() will be smart enough to call this function
6042 * *after* c->querybuf was set to NULL. */
6043 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6046 /* This should be called from any function PUSHing into lists.
6047 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6048 * 'ele' is the element pushed.
6050 * If the function returns 0 there was no client waiting for a list push
6053 * If the function returns 1 there was a client waiting for a list push
6054 * against this key, the element was passed to this client thus it's not
6055 * needed to actually add it to the list and the caller should return asap. */
6056 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6057 struct dictEntry
*de
;
6058 redisClient
*receiver
;
6062 de
= dictFind(c
->db
->blockingkeys
,key
);
6063 if (de
== NULL
) return 0;
6064 l
= dictGetEntryVal(de
);
6067 receiver
= ln
->value
;
6069 addReplySds(receiver
,sdsnew("*2\r\n"));
6070 addReplyBulkLen(receiver
,key
);
6071 addReply(receiver
,key
);
6072 addReply(receiver
,shared
.crlf
);
6073 addReplyBulkLen(receiver
,ele
);
6074 addReply(receiver
,ele
);
6075 addReply(receiver
,shared
.crlf
);
6076 unblockClientWaitingData(receiver
);
6080 /* Blocking RPOP/LPOP */
6081 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6086 for (j
= 1; j
< c
->argc
-1; j
++) {
6087 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6089 if (o
->type
!= REDIS_LIST
) {
6090 addReply(c
,shared
.wrongtypeerr
);
6093 list
*list
= o
->ptr
;
6094 if (listLength(list
) != 0) {
6095 /* If the list contains elements fall back to the usual
6096 * non-blocking POP operation */
6097 robj
*argv
[2], **orig_argv
;
6100 /* We need to alter the command arguments before to call
6101 * popGenericCommand() as the command takes a single key. */
6102 orig_argv
= c
->argv
;
6103 orig_argc
= c
->argc
;
6104 argv
[1] = c
->argv
[j
];
6108 /* Also the return value is different, we need to output
6109 * the multi bulk reply header and the key name. The
6110 * "real" command will add the last element (the value)
6111 * for us. If this souds like an hack to you it's just
6112 * because it is... */
6113 addReplySds(c
,sdsnew("*2\r\n"));
6114 addReplyBulkLen(c
,argv
[1]);
6115 addReply(c
,argv
[1]);
6116 addReply(c
,shared
.crlf
);
6117 popGenericCommand(c
,where
);
6119 /* Fix the client structure with the original stuff */
6120 c
->argv
= orig_argv
;
6121 c
->argc
= orig_argc
;
6127 /* If the list is empty or the key does not exists we must block */
6128 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6129 if (timeout
> 0) timeout
+= time(NULL
);
6130 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6133 static void blpopCommand(redisClient
*c
) {
6134 blockingPopGenericCommand(c
,REDIS_HEAD
);
6137 static void brpopCommand(redisClient
*c
) {
6138 blockingPopGenericCommand(c
,REDIS_TAIL
);
6141 /* =============================== Replication ============================= */
6143 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6144 ssize_t nwritten
, ret
= size
;
6145 time_t start
= time(NULL
);
6149 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6150 nwritten
= write(fd
,ptr
,size
);
6151 if (nwritten
== -1) return -1;
6155 if ((time(NULL
)-start
) > timeout
) {
6163 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6164 ssize_t nread
, totread
= 0;
6165 time_t start
= time(NULL
);
6169 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6170 nread
= read(fd
,ptr
,size
);
6171 if (nread
== -1) return -1;
6176 if ((time(NULL
)-start
) > timeout
) {
6184 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6191 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6194 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6205 static void syncCommand(redisClient
*c
) {
6206 /* ignore SYNC if aleady slave or in monitor mode */
6207 if (c
->flags
& REDIS_SLAVE
) return;
6209 /* SYNC can't be issued when the server has pending data to send to
6210 * the client about already issued commands. We need a fresh reply
6211 * buffer registering the differences between the BGSAVE and the current
6212 * dataset, so that we can copy to other slaves if needed. */
6213 if (listLength(c
->reply
) != 0) {
6214 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6218 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6219 /* Here we need to check if there is a background saving operation
6220 * in progress, or if it is required to start one */
6221 if (server
.bgsavechildpid
!= -1) {
6222 /* Ok a background save is in progress. Let's check if it is a good
6223 * one for replication, i.e. if there is another slave that is
6224 * registering differences since the server forked to save */
6229 listRewind(server
.slaves
,&li
);
6230 while((ln
= listNext(&li
))) {
6232 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6235 /* Perfect, the server is already registering differences for
6236 * another slave. Set the right state, and copy the buffer. */
6237 listRelease(c
->reply
);
6238 c
->reply
= listDup(slave
->reply
);
6239 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6240 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6242 /* No way, we need to wait for the next BGSAVE in order to
6243 * register differences */
6244 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6245 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6248 /* Ok we don't have a BGSAVE in progress, let's start one */
6249 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6250 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6251 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6252 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6255 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6258 c
->flags
|= REDIS_SLAVE
;
6260 listAddNodeTail(server
.slaves
,c
);
6264 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6265 redisClient
*slave
= privdata
;
6267 REDIS_NOTUSED(mask
);
6268 char buf
[REDIS_IOBUF_LEN
];
6269 ssize_t nwritten
, buflen
;
6271 if (slave
->repldboff
== 0) {
6272 /* Write the bulk write count before to transfer the DB. In theory here
6273 * we don't know how much room there is in the output buffer of the
6274 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6275 * operations) will never be smaller than the few bytes we need. */
6278 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6280 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6288 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6289 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6291 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6292 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6296 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6297 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6302 slave
->repldboff
+= nwritten
;
6303 if (slave
->repldboff
== slave
->repldbsize
) {
6304 close(slave
->repldbfd
);
6305 slave
->repldbfd
= -1;
6306 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6307 slave
->replstate
= REDIS_REPL_ONLINE
;
6308 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6309 sendReplyToClient
, slave
) == AE_ERR
) {
6313 addReplySds(slave
,sdsempty());
6314 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6318 /* This function is called at the end of every backgrond saving.
6319 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6320 * otherwise REDIS_ERR is passed to the function.
6322 * The goal of this function is to handle slaves waiting for a successful
6323 * background saving in order to perform non-blocking synchronization. */
6324 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6326 int startbgsave
= 0;
6329 listRewind(server
.slaves
,&li
);
6330 while((ln
= listNext(&li
))) {
6331 redisClient
*slave
= ln
->value
;
6333 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6335 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6336 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6337 struct redis_stat buf
;
6339 if (bgsaveerr
!= REDIS_OK
) {
6341 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6344 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6345 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6347 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6350 slave
->repldboff
= 0;
6351 slave
->repldbsize
= buf
.st_size
;
6352 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6353 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6354 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6361 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6364 listRewind(server
.slaves
,&li
);
6365 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6366 while((ln
= listNext(&li
))) {
6367 redisClient
*slave
= ln
->value
;
6369 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6376 static int syncWithMaster(void) {
6377 char buf
[1024], tmpfile
[256], authcmd
[1024];
6379 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6383 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6388 /* AUTH with the master if required. */
6389 if(server
.masterauth
) {
6390 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6391 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6393 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6397 /* Read the AUTH result. */
6398 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6400 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6404 if (buf
[0] != '+') {
6406 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6411 /* Issue the SYNC command */
6412 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6414 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6418 /* Read the bulk write count */
6419 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6421 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6425 if (buf
[0] != '$') {
6427 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6430 dumpsize
= atoi(buf
+1);
6431 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6432 /* Read the bulk write data on a temp file */
6433 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6434 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6437 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6441 int nread
, nwritten
;
6443 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6445 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6451 nwritten
= write(dfd
,buf
,nread
);
6452 if (nwritten
== -1) {
6453 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6461 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6462 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6468 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6469 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6473 server
.master
= createClient(fd
);
6474 server
.master
->flags
|= REDIS_MASTER
;
6475 server
.master
->authenticated
= 1;
6476 server
.replstate
= REDIS_REPL_CONNECTED
;
6480 static void slaveofCommand(redisClient
*c
) {
6481 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6482 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6483 if (server
.masterhost
) {
6484 sdsfree(server
.masterhost
);
6485 server
.masterhost
= NULL
;
6486 if (server
.master
) freeClient(server
.master
);
6487 server
.replstate
= REDIS_REPL_NONE
;
6488 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6491 sdsfree(server
.masterhost
);
6492 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6493 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6494 if (server
.master
) freeClient(server
.master
);
6495 server
.replstate
= REDIS_REPL_CONNECT
;
6496 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6497 server
.masterhost
, server
.masterport
);
6499 addReply(c
,shared
.ok
);
6502 /* ============================ Maxmemory directive ======================== */
6504 /* Try to free one object form the pre-allocated objects free list.
6505 * This is useful under low mem conditions as by default we take 1 million
6506 * free objects allocated. On success REDIS_OK is returned, otherwise
6508 static int tryFreeOneObjectFromFreelist(void) {
6511 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6512 if (listLength(server
.objfreelist
)) {
6513 listNode
*head
= listFirst(server
.objfreelist
);
6514 o
= listNodeValue(head
);
6515 listDelNode(server
.objfreelist
,head
);
6516 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6520 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6525 /* This function gets called when 'maxmemory' is set on the config file to limit
6526 * the max memory used by the server, and we are out of memory.
6527 * This function will try to, in order:
6529 * - Free objects from the free list
6530 * - Try to remove keys with an EXPIRE set
6532 * It is not possible to free enough memory to reach used-memory < maxmemory
6533 * the server will start refusing commands that will enlarge even more the
6536 static void freeMemoryIfNeeded(void) {
6537 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6538 int j
, k
, freed
= 0;
6540 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6541 for (j
= 0; j
< server
.dbnum
; j
++) {
6543 robj
*minkey
= NULL
;
6544 struct dictEntry
*de
;
6546 if (dictSize(server
.db
[j
].expires
)) {
6548 /* From a sample of three keys drop the one nearest to
6549 * the natural expire */
6550 for (k
= 0; k
< 3; k
++) {
6553 de
= dictGetRandomKey(server
.db
[j
].expires
);
6554 t
= (time_t) dictGetEntryVal(de
);
6555 if (minttl
== -1 || t
< minttl
) {
6556 minkey
= dictGetEntryKey(de
);
6560 deleteKey(server
.db
+j
,minkey
);
6563 if (!freed
) return; /* nothing to free... */
6567 /* ============================== Append Only file ========================== */
6569 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6570 sds buf
= sdsempty();
6576 /* The DB this command was targetting is not the same as the last command
6577 * we appendend. To issue a SELECT command is needed. */
6578 if (dictid
!= server
.appendseldb
) {
6581 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6582 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6583 (unsigned long)strlen(seldb
),seldb
);
6584 server
.appendseldb
= dictid
;
6587 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6588 * EXPIREs into EXPIREATs calls */
6589 if (cmd
->proc
== expireCommand
) {
6592 tmpargv
[0] = createStringObject("EXPIREAT",8);
6593 tmpargv
[1] = argv
[1];
6594 incrRefCount(argv
[1]);
6595 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6596 tmpargv
[2] = createObject(REDIS_STRING
,
6597 sdscatprintf(sdsempty(),"%ld",when
));
6601 /* Append the actual command */
6602 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6603 for (j
= 0; j
< argc
; j
++) {
6606 o
= getDecodedObject(o
);
6607 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6608 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6609 buf
= sdscatlen(buf
,"\r\n",2);
6613 /* Free the objects from the modified argv for EXPIREAT */
6614 if (cmd
->proc
== expireCommand
) {
6615 for (j
= 0; j
< 3; j
++)
6616 decrRefCount(argv
[j
]);
6619 /* We want to perform a single write. This should be guaranteed atomic
6620 * at least if the filesystem we are writing is a real physical one.
6621 * While this will save us against the server being killed I don't think
6622 * there is much to do about the whole server stopping for power problems
6624 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6625 if (nwritten
!= (signed)sdslen(buf
)) {
6626 /* Ooops, we are in troubles. The best thing to do for now is
6627 * to simply exit instead to give the illusion that everything is
6628 * working as expected. */
6629 if (nwritten
== -1) {
6630 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6632 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6636 /* If a background append only file rewriting is in progress we want to
6637 * accumulate the differences between the child DB and the current one
6638 * in a buffer, so that when the child process will do its work we
6639 * can append the differences to the new append only file. */
6640 if (server
.bgrewritechildpid
!= -1)
6641 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6645 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6646 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6647 now
-server
.lastfsync
> 1))
6649 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6650 server
.lastfsync
= now
;
6654 /* In Redis commands are always executed in the context of a client, so in
6655 * order to load the append only file we need to create a fake client. */
6656 static struct redisClient
*createFakeClient(void) {
6657 struct redisClient
*c
= zmalloc(sizeof(*c
));
6661 c
->querybuf
= sdsempty();
6665 /* We set the fake client as a slave waiting for the synchronization
6666 * so that Redis will not try to send replies to this client. */
6667 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6668 c
->reply
= listCreate();
6669 listSetFreeMethod(c
->reply
,decrRefCount
);
6670 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6674 static void freeFakeClient(struct redisClient
*c
) {
6675 sdsfree(c
->querybuf
);
6676 listRelease(c
->reply
);
6680 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6681 * error (the append only file is zero-length) REDIS_ERR is returned. On
6682 * fatal error an error message is logged and the program exists. */
6683 int loadAppendOnlyFile(char *filename
) {
6684 struct redisClient
*fakeClient
;
6685 FILE *fp
= fopen(filename
,"r");
6686 struct redis_stat sb
;
6687 unsigned long long loadedkeys
= 0;
6689 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6693 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6697 fakeClient
= createFakeClient();
6704 struct redisCommand
*cmd
;
6706 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6712 if (buf
[0] != '*') goto fmterr
;
6714 argv
= zmalloc(sizeof(robj
*)*argc
);
6715 for (j
= 0; j
< argc
; j
++) {
6716 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6717 if (buf
[0] != '$') goto fmterr
;
6718 len
= strtol(buf
+1,NULL
,10);
6719 argsds
= sdsnewlen(NULL
,len
);
6720 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6721 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6722 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6725 /* Command lookup */
6726 cmd
= lookupCommand(argv
[0]->ptr
);
6728 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6731 /* Try object sharing and encoding */
6732 if (server
.shareobjects
) {
6734 for(j
= 1; j
< argc
; j
++)
6735 argv
[j
] = tryObjectSharing(argv
[j
]);
6737 if (cmd
->flags
& REDIS_CMD_BULK
)
6738 tryObjectEncoding(argv
[argc
-1]);
6739 /* Run the command in the context of a fake client */
6740 fakeClient
->argc
= argc
;
6741 fakeClient
->argv
= argv
;
6742 cmd
->proc(fakeClient
);
6743 /* Discard the reply objects list from the fake client */
6744 while(listLength(fakeClient
->reply
))
6745 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6746 /* Clean up, ready for the next command */
6747 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6749 /* Handle swapping while loading big datasets when VM is on */
6751 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6752 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6753 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6758 freeFakeClient(fakeClient
);
6763 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6765 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6769 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6773 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6774 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6778 /* Avoid the incr/decr ref count business if possible to help
6779 * copy-on-write (we are often in a child process when this function
6781 * Also makes sure that key objects don't get incrRefCount-ed when VM
6783 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6784 obj
= getDecodedObject(obj
);
6787 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6788 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6789 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6791 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6792 if (decrrc
) decrRefCount(obj
);
6795 if (decrrc
) decrRefCount(obj
);
6799 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6800 static int fwriteBulkDouble(FILE *fp
, double d
) {
6801 char buf
[128], dbuf
[128];
6803 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6804 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6805 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6806 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6810 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6811 static int fwriteBulkLong(FILE *fp
, long l
) {
6812 char buf
[128], lbuf
[128];
6814 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6815 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6816 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6817 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6821 /* Write a sequence of commands able to fully rebuild the dataset into
6822 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6823 static int rewriteAppendOnlyFile(char *filename
) {
6824 dictIterator
*di
= NULL
;
6829 time_t now
= time(NULL
);
6831 /* Note that we have to use a different temp name here compared to the
6832 * one used by rewriteAppendOnlyFileBackground() function. */
6833 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6834 fp
= fopen(tmpfile
,"w");
6836 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6839 for (j
= 0; j
< server
.dbnum
; j
++) {
6840 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6841 redisDb
*db
= server
.db
+j
;
6843 if (dictSize(d
) == 0) continue;
6844 di
= dictGetIterator(d
);
6850 /* SELECT the new DB */
6851 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6852 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6854 /* Iterate this DB writing every entry */
6855 while((de
= dictNext(di
)) != NULL
) {
6860 key
= dictGetEntryKey(de
);
6861 /* If the value for this key is swapped, load a preview in memory.
6862 * We use a "swapped" flag to remember if we need to free the
6863 * value object instead to just increment the ref count anyway
6864 * in order to avoid copy-on-write of pages if we are forked() */
6865 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6866 key
->storage
== REDIS_VM_SWAPPING
) {
6867 o
= dictGetEntryVal(de
);
6870 o
= vmPreviewObject(key
);
6873 expiretime
= getExpire(db
,key
);
6875 /* Save the key and associated value */
6876 if (o
->type
== REDIS_STRING
) {
6877 /* Emit a SET command */
6878 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6879 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6881 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6882 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6883 } else if (o
->type
== REDIS_LIST
) {
6884 /* Emit the RPUSHes needed to rebuild the list */
6885 list
*list
= o
->ptr
;
6889 listRewind(list
,&li
);
6890 while((ln
= listNext(&li
))) {
6891 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6892 robj
*eleobj
= listNodeValue(ln
);
6894 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6895 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6896 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6898 } else if (o
->type
== REDIS_SET
) {
6899 /* Emit the SADDs needed to rebuild the set */
6901 dictIterator
*di
= dictGetIterator(set
);
6904 while((de
= dictNext(di
)) != NULL
) {
6905 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6906 robj
*eleobj
= dictGetEntryKey(de
);
6908 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6909 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6910 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6912 dictReleaseIterator(di
);
6913 } else if (o
->type
== REDIS_ZSET
) {
6914 /* Emit the ZADDs needed to rebuild the sorted set */
6916 dictIterator
*di
= dictGetIterator(zs
->dict
);
6919 while((de
= dictNext(di
)) != NULL
) {
6920 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6921 robj
*eleobj
= dictGetEntryKey(de
);
6922 double *score
= dictGetEntryVal(de
);
6924 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6925 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6926 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6927 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6929 dictReleaseIterator(di
);
6931 redisAssert(0 != 0);
6933 /* Save the expire time */
6934 if (expiretime
!= -1) {
6935 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
6936 /* If this key is already expired skip it */
6937 if (expiretime
< now
) continue;
6938 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6939 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6940 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
6942 if (swapped
) decrRefCount(o
);
6944 dictReleaseIterator(di
);
6947 /* Make sure data will not remain on the OS's output buffers */
6952 /* Use RENAME to make sure the DB file is changed atomically only
6953 * if the generate DB file is ok. */
6954 if (rename(tmpfile
,filename
) == -1) {
6955 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
6959 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
6965 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
6966 if (di
) dictReleaseIterator(di
);
6970 /* This is how rewriting of the append only file in background works:
6972 * 1) The user calls BGREWRITEAOF
6973 * 2) Redis calls this function, that forks():
6974 * 2a) the child rewrite the append only file in a temp file.
6975 * 2b) the parent accumulates differences in server.bgrewritebuf.
6976 * 3) When the child finished '2a' exists.
6977 * 4) The parent will trap the exit code, if it's OK, will append the
6978 * data accumulated into server.bgrewritebuf into the temp file, and
6979 * finally will rename(2) the temp file in the actual file name.
6980 * The the new file is reopened as the new append only file. Profit!
6982 static int rewriteAppendOnlyFileBackground(void) {
6985 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
6986 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
6987 if ((childpid
= fork()) == 0) {
6991 if (server
.vm_enabled
) vmReopenSwapFile();
6993 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
6994 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7001 if (childpid
== -1) {
7002 redisLog(REDIS_WARNING
,
7003 "Can't rewrite append only file in background: fork: %s",
7007 redisLog(REDIS_NOTICE
,
7008 "Background append only file rewriting started by pid %d",childpid
);
7009 server
.bgrewritechildpid
= childpid
;
7010 /* We set appendseldb to -1 in order to force the next call to the
7011 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7012 * accumulated by the parent into server.bgrewritebuf will start
7013 * with a SELECT statement and it will be safe to merge. */
7014 server
.appendseldb
= -1;
7017 return REDIS_OK
; /* unreached */
7020 static void bgrewriteaofCommand(redisClient
*c
) {
7021 if (server
.bgrewritechildpid
!= -1) {
7022 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7025 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7026 char *status
= "+Background append only file rewriting started\r\n";
7027 addReplySds(c
,sdsnew(status
));
7029 addReply(c
,shared
.err
);
7033 static void aofRemoveTempFile(pid_t childpid
) {
7036 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7040 /* Virtual Memory is composed mainly of two subsystems:
7041 * - Blocking Virutal Memory
7042 * - Threaded Virtual Memory I/O
7043 * The two parts are not fully decoupled, but functions are split among two
7044 * different sections of the source code (delimited by comments) in order to
7045 * make more clear what functionality is about the blocking VM and what about
7046 * the threaded (not blocking) VM.
7050 * Redis VM is a blocking VM (one that blocks reading swapped values from
7051 * disk into memory when a value swapped out is needed in memory) that is made
7052 * unblocking by trying to examine the command argument vector in order to
7053 * load in background values that will likely be needed in order to exec
7054 * the command. The command is executed only once all the relevant keys
7055 * are loaded into memory.
7057 * This basically is almost as simple of a blocking VM, but almost as parallel
7058 * as a fully non-blocking VM.
7061 /* =================== Virtual Memory - Blocking Side ====================== */
7063 /* substitute the first occurrence of '%p' with the process pid in the
7064 * swap file name. */
7065 static void expandVmSwapFilename(void) {
7066 char *p
= strstr(server
.vm_swap_file
,"%p");
7072 new = sdscat(new,server
.vm_swap_file
);
7073 new = sdscatprintf(new,"%ld",(long) getpid());
7074 new = sdscat(new,p
+2);
7075 zfree(server
.vm_swap_file
);
7076 server
.vm_swap_file
= new;
7079 static void vmInit(void) {
7084 if (server
.vm_max_threads
!= 0)
7085 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7087 expandVmSwapFilename();
7088 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7089 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7090 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7092 if (server
.vm_fp
== NULL
) {
7093 redisLog(REDIS_WARNING
,
7094 "Impossible to open the swap file: %s. Exiting.",
7098 server
.vm_fd
= fileno(server
.vm_fp
);
7099 server
.vm_next_page
= 0;
7100 server
.vm_near_pages
= 0;
7101 server
.vm_stats_used_pages
= 0;
7102 server
.vm_stats_swapped_objects
= 0;
7103 server
.vm_stats_swapouts
= 0;
7104 server
.vm_stats_swapins
= 0;
7105 totsize
= server
.vm_pages
*server
.vm_page_size
;
7106 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7107 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7108 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7112 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7114 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7115 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7116 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7117 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7119 /* Initialize threaded I/O (used by Virtual Memory) */
7120 server
.io_newjobs
= listCreate();
7121 server
.io_processing
= listCreate();
7122 server
.io_processed
= listCreate();
7123 server
.io_ready_clients
= listCreate();
7124 pthread_mutex_init(&server
.io_mutex
,NULL
);
7125 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7126 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7127 server
.io_active_threads
= 0;
7128 if (pipe(pipefds
) == -1) {
7129 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7133 server
.io_ready_pipe_read
= pipefds
[0];
7134 server
.io_ready_pipe_write
= pipefds
[1];
7135 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7136 /* LZF requires a lot of stack */
7137 pthread_attr_init(&server
.io_threads_attr
);
7138 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7139 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7140 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7141 /* Listen for events in the threaded I/O pipe */
7142 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7143 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7144 oom("creating file event");
7147 /* Mark the page as used */
7148 static void vmMarkPageUsed(off_t page
) {
7149 off_t byte
= page
/8;
7151 redisAssert(vmFreePage(page
) == 1);
7152 server
.vm_bitmap
[byte
] |= 1<<bit
;
7153 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7154 (long long)page
, (long long)byte
, bit
);
7157 /* Mark N contiguous pages as used, with 'page' being the first. */
7158 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7161 for (j
= 0; j
< count
; j
++)
7162 vmMarkPageUsed(page
+j
);
7163 server
.vm_stats_used_pages
+= count
;
7166 /* Mark the page as free */
7167 static void vmMarkPageFree(off_t page
) {
7168 off_t byte
= page
/8;
7170 redisAssert(vmFreePage(page
) == 0);
7171 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7172 redisLog(REDIS_DEBUG
,"Mark free: %lld (byte:%lld bit:%d)\n",
7173 (long long)page
, (long long)byte
, bit
);
7176 /* Mark N contiguous pages as free, with 'page' being the first. */
7177 static void vmMarkPagesFree(off_t page
, off_t count
) {
7180 for (j
= 0; j
< count
; j
++)
7181 vmMarkPageFree(page
+j
);
7182 server
.vm_stats_used_pages
-= count
;
7183 if (server
.vm_stats_used_pages
> 100000000) {
7188 /* Test if the page is free */
7189 static int vmFreePage(off_t page
) {
7190 off_t byte
= page
/8;
7192 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7195 /* Find N contiguous free pages storing the first page of the cluster in *first.
7196 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7197 * REDIS_ERR is returned.
7199 * This function uses a simple algorithm: we try to allocate
7200 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7201 * again from the start of the swap file searching for free spaces.
7203 * If it looks pretty clear that there are no free pages near our offset
7204 * we try to find less populated places doing a forward jump of
7205 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7206 * without hurry, and then we jump again and so forth...
7208 * This function can be improved using a free list to avoid to guess
7209 * too much, since we could collect data about freed pages.
7211 * note: I implemented this function just after watching an episode of
7212 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7214 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7215 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7217 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7218 server
.vm_near_pages
= 0;
7219 server
.vm_next_page
= 0;
7221 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7222 base
= server
.vm_next_page
;
7224 while(offset
< server
.vm_pages
) {
7225 off_t
this = base
+offset
;
7227 /* If we overflow, restart from page zero */
7228 if (this >= server
.vm_pages
) {
7229 this -= server
.vm_pages
;
7231 /* Just overflowed, what we found on tail is no longer
7232 * interesting, as it's no longer contiguous. */
7236 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7237 if (vmFreePage(this)) {
7238 /* This is a free page */
7240 /* Already got N free pages? Return to the caller, with success */
7242 *first
= this-(n
-1);
7243 server
.vm_next_page
= this+1;
7247 /* The current one is not a free page */
7251 /* Fast-forward if the current page is not free and we already
7252 * searched enough near this place. */
7254 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7255 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7257 /* Note that even if we rewind after the jump, we are don't need
7258 * to make sure numfree is set to zero as we only jump *if* it
7259 * is set to zero. */
7261 /* Otherwise just check the next page */
7268 /* Write the specified object at the specified page of the swap file */
7269 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7270 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7271 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7272 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7273 redisLog(REDIS_WARNING
,
7274 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7278 rdbSaveObject(server
.vm_fp
,o
);
7279 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7283 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7284 * needed to later retrieve the object into the key object.
7285 * If we can't find enough contiguous empty pages to swap the object on disk
7286 * REDIS_ERR is returned. */
7287 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7288 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7291 assert(key
->storage
== REDIS_VM_MEMORY
);
7292 assert(key
->refcount
== 1);
7293 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7294 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7295 key
->vm
.page
= page
;
7296 key
->vm
.usedpages
= pages
;
7297 key
->storage
= REDIS_VM_SWAPPED
;
7298 key
->vtype
= val
->type
;
7299 decrRefCount(val
); /* Deallocate the object from memory. */
7300 vmMarkPagesUsed(page
,pages
);
7301 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7302 (unsigned char*) key
->ptr
,
7303 (unsigned long long) page
, (unsigned long long) pages
);
7304 server
.vm_stats_swapped_objects
++;
7305 server
.vm_stats_swapouts
++;
7306 fflush(server
.vm_fp
);
7310 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7313 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7314 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7315 redisLog(REDIS_WARNING
,
7316 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7320 o
= rdbLoadObject(type
,server
.vm_fp
);
7322 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7325 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7329 /* Load the value object relative to the 'key' object from swap to memory.
7330 * The newly allocated object is returned.
7332 * If preview is true the unserialized object is returned to the caller but
7333 * no changes are made to the key object, nor the pages are marked as freed */
7334 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7337 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7338 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7340 key
->storage
= REDIS_VM_MEMORY
;
7341 key
->vm
.atime
= server
.unixtime
;
7342 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7343 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7344 (unsigned char*) key
->ptr
);
7345 server
.vm_stats_swapped_objects
--;
7347 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7348 (unsigned char*) key
->ptr
);
7350 server
.vm_stats_swapins
++;
7354 /* Plain object loading, from swap to memory */
7355 static robj
*vmLoadObject(robj
*key
) {
7356 /* If we are loading the object in background, stop it, we
7357 * need to load this object synchronously ASAP. */
7358 if (key
->storage
== REDIS_VM_LOADING
)
7359 vmCancelThreadedIOJob(key
);
7360 return vmGenericLoadObject(key
,0);
7363 /* Just load the value on disk, without to modify the key.
7364 * This is useful when we want to perform some operation on the value
7365 * without to really bring it from swap to memory, like while saving the
7366 * dataset or rewriting the append only log. */
7367 static robj
*vmPreviewObject(robj
*key
) {
7368 return vmGenericLoadObject(key
,1);
7371 /* How a good candidate is this object for swapping?
7372 * The better candidate it is, the greater the returned value.
7374 * Currently we try to perform a fast estimation of the object size in
7375 * memory, and combine it with aging informations.
7377 * Basically swappability = idle-time * log(estimated size)
7379 * Bigger objects are preferred over smaller objects, but not
7380 * proportionally, this is why we use the logarithm. This algorithm is
7381 * just a first try and will probably be tuned later. */
7382 static double computeObjectSwappability(robj
*o
) {
7383 time_t age
= server
.unixtime
- o
->vm
.atime
;
7387 struct dictEntry
*de
;
7390 if (age
<= 0) return 0;
7393 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7396 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7401 listNode
*ln
= listFirst(l
);
7403 asize
= sizeof(list
);
7405 robj
*ele
= ln
->value
;
7408 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7409 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7411 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7416 z
= (o
->type
== REDIS_ZSET
);
7417 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7419 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7420 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7425 de
= dictGetRandomKey(d
);
7426 ele
= dictGetEntryKey(de
);
7427 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7428 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7430 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7431 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7435 return (double)asize
*log(1+asize
);
7438 /* Try to swap an object that's a good candidate for swapping.
7439 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7440 * to swap any object at all.
7442 * If 'usethreaded' is true, Redis will try to swap the object in background
7443 * using I/O threads. */
7444 static int vmSwapOneObject(int usethreads
) {
7446 struct dictEntry
*best
= NULL
;
7447 double best_swappability
= 0;
7448 redisDb
*best_db
= NULL
;
7451 for (j
= 0; j
< server
.dbnum
; j
++) {
7452 redisDb
*db
= server
.db
+j
;
7453 /* Why maxtries is set to 100?
7454 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7455 * are swappable objects */
7458 if (dictSize(db
->dict
) == 0) continue;
7459 for (i
= 0; i
< 5; i
++) {
7461 double swappability
;
7463 if (maxtries
) maxtries
--;
7464 de
= dictGetRandomKey(db
->dict
);
7465 key
= dictGetEntryKey(de
);
7466 val
= dictGetEntryVal(de
);
7467 /* Only swap objects that are currently in memory.
7469 * Also don't swap shared objects if threaded VM is on, as we
7470 * try to ensure that the main thread does not touch the
7471 * object while the I/O thread is using it, but we can't
7472 * control other keys without adding additional mutex. */
7473 if (key
->storage
!= REDIS_VM_MEMORY
||
7474 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7475 if (maxtries
) i
--; /* don't count this try */
7478 swappability
= computeObjectSwappability(val
);
7479 if (!best
|| swappability
> best_swappability
) {
7481 best_swappability
= swappability
;
7487 redisLog(REDIS_DEBUG
,"No swappable key found!");
7490 key
= dictGetEntryKey(best
);
7491 val
= dictGetEntryVal(best
);
7493 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7494 key
->ptr
, best_swappability
);
7496 /* Unshare the key if needed */
7497 if (key
->refcount
> 1) {
7498 robj
*newkey
= dupStringObject(key
);
7500 key
= dictGetEntryKey(best
) = newkey
;
7504 vmSwapObjectThreaded(key
,val
,best_db
);
7507 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7508 dictGetEntryVal(best
) = NULL
;
7516 static int vmSwapOneObjectBlocking() {
7517 return vmSwapOneObject(0);
7520 static int vmSwapOneObjectThreaded() {
7521 return vmSwapOneObject(1);
7524 /* Return true if it's safe to swap out objects in a given moment.
7525 * Basically we don't want to swap objects out while there is a BGSAVE
7526 * or a BGAEOREWRITE running in backgroud. */
7527 static int vmCanSwapOut(void) {
7528 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7531 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7532 * and was deleted. Otherwise 0 is returned. */
7533 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7537 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7538 foundkey
= dictGetEntryKey(de
);
7539 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7544 /* =================== Virtual Memory - Threaded I/O ======================= */
7546 static void freeIOJob(iojob
*j
) {
7547 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7548 j
->type
== REDIS_IOJOB_DO_SWAP
||
7549 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7550 decrRefCount(j
->val
);
7551 decrRefCount(j
->key
);
7555 /* Every time a thread finished a Job, it writes a byte into the write side
7556 * of an unix pipe in order to "awake" the main thread, and this function
7558 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7562 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7564 REDIS_NOTUSED(mask
);
7565 REDIS_NOTUSED(privdata
);
7567 /* For every byte we read in the read side of the pipe, there is one
7568 * I/O job completed to process. */
7569 while((retval
= read(fd
,buf
,1)) == 1) {
7573 struct dictEntry
*de
;
7575 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7577 /* Get the processed element (the oldest one) */
7579 assert(listLength(server
.io_processed
) != 0);
7580 if (toprocess
== -1) {
7581 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7582 if (toprocess
<= 0) toprocess
= 1;
7584 ln
= listFirst(server
.io_processed
);
7586 listDelNode(server
.io_processed
,ln
);
7588 /* If this job is marked as canceled, just ignore it */
7593 /* Post process it in the main thread, as there are things we
7594 * can do just here to avoid race conditions and/or invasive locks */
7595 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
);
7596 de
= dictFind(j
->db
->dict
,j
->key
);
7598 key
= dictGetEntryKey(de
);
7599 if (j
->type
== REDIS_IOJOB_LOAD
) {
7602 /* Key loaded, bring it at home */
7603 key
->storage
= REDIS_VM_MEMORY
;
7604 key
->vm
.atime
= server
.unixtime
;
7605 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7606 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7607 (unsigned char*) key
->ptr
);
7608 server
.vm_stats_swapped_objects
--;
7609 server
.vm_stats_swapins
++;
7610 dictGetEntryVal(de
) = j
->val
;
7611 incrRefCount(j
->val
);
7614 /* Handle clients waiting for this key to be loaded. */
7615 handleClientsBlockedOnSwappedKey(db
,key
);
7616 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7617 /* Now we know the amount of pages required to swap this object.
7618 * Let's find some space for it, and queue this task again
7619 * rebranded as REDIS_IOJOB_DO_SWAP. */
7620 if (!vmCanSwapOut() ||
7621 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7623 /* Ooops... no space or we can't swap as there is
7624 * a fork()ed Redis trying to save stuff on disk. */
7626 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7628 /* Note that we need to mark this pages as used now,
7629 * if the job will be canceled, we'll mark them as freed
7631 vmMarkPagesUsed(j
->page
,j
->pages
);
7632 j
->type
= REDIS_IOJOB_DO_SWAP
;
7637 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7640 /* Key swapped. We can finally free some memory. */
7641 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7642 printf("key->storage: %d\n",key
->storage
);
7643 printf("key->name: %s\n",(char*)key
->ptr
);
7644 printf("key->refcount: %d\n",key
->refcount
);
7645 printf("val: %p\n",(void*)j
->val
);
7646 printf("val->type: %d\n",j
->val
->type
);
7647 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7649 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7650 val
= dictGetEntryVal(de
);
7651 key
->vm
.page
= j
->page
;
7652 key
->vm
.usedpages
= j
->pages
;
7653 key
->storage
= REDIS_VM_SWAPPED
;
7654 key
->vtype
= j
->val
->type
;
7655 decrRefCount(val
); /* Deallocate the object from memory. */
7656 dictGetEntryVal(de
) = NULL
;
7657 redisLog(REDIS_DEBUG
,
7658 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7659 (unsigned char*) key
->ptr
,
7660 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7661 server
.vm_stats_swapped_objects
++;
7662 server
.vm_stats_swapouts
++;
7664 /* Put a few more swap requests in queue if we are still
7666 if (trytoswap
&& vmCanSwapOut() &&
7667 zmalloc_used_memory() > server
.vm_max_memory
)
7672 more
= listLength(server
.io_newjobs
) <
7673 (unsigned) server
.vm_max_threads
;
7675 /* Don't waste CPU time if swappable objects are rare. */
7676 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
7684 if (processed
== toprocess
) return;
7686 if (retval
< 0 && errno
!= EAGAIN
) {
7687 redisLog(REDIS_WARNING
,
7688 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7693 static void lockThreadedIO(void) {
7694 pthread_mutex_lock(&server
.io_mutex
);
7697 static void unlockThreadedIO(void) {
7698 pthread_mutex_unlock(&server
.io_mutex
);
7701 /* Remove the specified object from the threaded I/O queue if still not
7702 * processed, otherwise make sure to flag it as canceled. */
7703 static void vmCancelThreadedIOJob(robj
*o
) {
7705 server
.io_newjobs
, /* 0 */
7706 server
.io_processing
, /* 1 */
7707 server
.io_processed
/* 2 */
7711 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7714 /* Search for a matching key in one of the queues */
7715 for (i
= 0; i
< 3; i
++) {
7719 listRewind(lists
[i
],&li
);
7720 while ((ln
= listNext(&li
)) != NULL
) {
7721 iojob
*job
= ln
->value
;
7723 if (job
->canceled
) continue; /* Skip this, already canceled. */
7724 if (compareStringObjects(job
->key
,o
) == 0) {
7725 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7726 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
7727 /* Mark the pages as free since the swap didn't happened
7728 * or happened but is now discarded. */
7729 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
7730 vmMarkPagesFree(job
->page
,job
->pages
);
7731 /* Cancel the job. It depends on the list the job is
7734 case 0: /* io_newjobs */
7735 /* If the job was yet not processed the best thing to do
7736 * is to remove it from the queue at all */
7738 listDelNode(lists
[i
],ln
);
7740 case 1: /* io_processing */
7741 /* Oh Shi- the thread is messing with the Job:
7743 * Probably it's accessing the object if this is a
7744 * PREPARE_SWAP or DO_SWAP job.
7745 * If it's a LOAD job it may be reading from disk and
7746 * if we don't wait for the job to terminate before to
7747 * cancel it, maybe in a few microseconds data can be
7748 * corrupted in this pages. So the short story is:
7750 * Better to wait for the job to move into the
7751 * next queue (processed)... */
7753 /* We try again and again until the job is completed. */
7755 /* But let's wait some time for the I/O thread
7756 * to finish with this job. After all this condition
7757 * should be very rare. */
7760 case 2: /* io_processed */
7761 /* The job was already processed, that's easy...
7762 * just mark it as canceled so that we'll ignore it
7763 * when processing completed jobs. */
7767 /* Finally we have to adjust the storage type of the object
7768 * in order to "UNDO" the operaiton. */
7769 if (o
->storage
== REDIS_VM_LOADING
)
7770 o
->storage
= REDIS_VM_SWAPPED
;
7771 else if (o
->storage
== REDIS_VM_SWAPPING
)
7772 o
->storage
= REDIS_VM_MEMORY
;
7779 assert(1 != 1); /* We should never reach this */
7782 static void *IOThreadEntryPoint(void *arg
) {
7787 pthread_detach(pthread_self());
7789 /* Get a new job to process */
7791 if (listLength(server
.io_newjobs
) == 0) {
7792 /* No new jobs in queue, exit. */
7793 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7794 (long long) pthread_self());
7795 server
.io_active_threads
--;
7799 ln
= listFirst(server
.io_newjobs
);
7801 listDelNode(server
.io_newjobs
,ln
);
7802 /* Add the job in the processing queue */
7803 j
->thread
= pthread_self();
7804 listAddNodeTail(server
.io_processing
,j
);
7805 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7807 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7808 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7810 /* Process the Job */
7811 if (j
->type
== REDIS_IOJOB_LOAD
) {
7812 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
7813 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7814 FILE *fp
= fopen("/dev/null","w+");
7815 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7817 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7818 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7822 /* Done: insert the job into the processed queue */
7823 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7824 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7826 listDelNode(server
.io_processing
,ln
);
7827 listAddNodeTail(server
.io_processed
,j
);
7830 /* Signal the main thread there is new stuff to process */
7831 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7833 return NULL
; /* never reached */
7836 static void spawnIOThread(void) {
7838 sigset_t mask
, omask
;
7841 sigaddset(&mask
,SIGCHLD
);
7842 sigaddset(&mask
,SIGHUP
);
7843 sigaddset(&mask
,SIGPIPE
);
7844 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
7845 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7846 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
7847 server
.io_active_threads
++;
7850 /* We need to wait for the last thread to exit before we are able to
7851 * fork() in order to BGSAVE or BGREWRITEAOF. */
7852 static void waitEmptyIOJobsQueue(void) {
7854 int io_processed_len
;
7857 if (listLength(server
.io_newjobs
) == 0 &&
7858 listLength(server
.io_processing
) == 0 &&
7859 server
.io_active_threads
== 0)
7864 /* While waiting for empty jobs queue condition we post-process some
7865 * finshed job, as I/O threads may be hanging trying to write against
7866 * the io_ready_pipe_write FD but there are so much pending jobs that
7868 io_processed_len
= listLength(server
.io_processed
);
7870 if (io_processed_len
) {
7871 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
7872 usleep(1000); /* 1 millisecond */
7874 usleep(10000); /* 10 milliseconds */
7879 static void vmReopenSwapFile(void) {
7880 /* Note: we don't close the old one as we are in the child process
7881 * and don't want to mess at all with the original file object. */
7882 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
7883 if (server
.vm_fp
== NULL
) {
7884 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
7885 server
.vm_swap_file
);
7888 server
.vm_fd
= fileno(server
.vm_fp
);
7891 /* This function must be called while with threaded IO locked */
7892 static void queueIOJob(iojob
*j
) {
7893 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
7894 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
7895 listAddNodeTail(server
.io_newjobs
,j
);
7896 if (server
.io_active_threads
< server
.vm_max_threads
)
7900 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
7903 assert(key
->storage
== REDIS_VM_MEMORY
);
7904 assert(key
->refcount
== 1);
7906 j
= zmalloc(sizeof(*j
));
7907 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
7909 j
->key
= dupStringObject(key
);
7913 j
->thread
= (pthread_t
) -1;
7914 key
->storage
= REDIS_VM_SWAPPING
;
7922 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
7924 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
7925 * If there is not already a job loading the key, it is craeted.
7926 * The key is added to the io_keys list in the client structure, and also
7927 * in the hash table mapping swapped keys to waiting clients, that is,
7928 * server.io_waited_keys. */
7929 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
7930 struct dictEntry
*de
;
7934 /* If the key does not exist or is already in RAM we don't need to
7935 * block the client at all. */
7936 de
= dictFind(c
->db
->dict
,key
);
7937 if (de
== NULL
) return 0;
7938 o
= dictGetEntryKey(de
);
7939 if (o
->storage
== REDIS_VM_MEMORY
) {
7941 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
7942 /* We were swapping the key, undo it! */
7943 vmCancelThreadedIOJob(o
);
7947 /* OK: the key is either swapped, or being loaded just now. */
7949 /* Add the key to the list of keys this client is waiting for.
7950 * This maps clients to keys they are waiting for. */
7951 listAddNodeTail(c
->io_keys
,key
);
7954 /* Add the client to the swapped keys => clients waiting map. */
7955 de
= dictFind(c
->db
->io_keys
,key
);
7959 /* For every key we take a list of clients blocked for it */
7961 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
7963 assert(retval
== DICT_OK
);
7965 l
= dictGetEntryVal(de
);
7967 listAddNodeTail(l
,c
);
7969 /* Are we already loading the key from disk? If not create a job */
7970 if (o
->storage
== REDIS_VM_SWAPPED
) {
7973 o
->storage
= REDIS_VM_LOADING
;
7974 j
= zmalloc(sizeof(*j
));
7975 j
->type
= REDIS_IOJOB_LOAD
;
7977 j
->key
= dupStringObject(key
);
7978 j
->key
->vtype
= o
->vtype
;
7979 j
->page
= o
->vm
.page
;
7982 j
->thread
= (pthread_t
) -1;
7990 /* Is this client attempting to run a command against swapped keys?
7991 * If so, block it ASAP, load the keys in background, then resume it.
7993 * The important idea about this function is that it can fail! If keys will
7994 * still be swapped when the client is resumed, this key lookups will
7995 * just block loading keys from disk. In practical terms this should only
7996 * happen with SORT BY command or if there is a bug in this function.
7998 * Return 1 if the client is marked as blocked, 0 if the client can
7999 * continue as the keys it is going to access appear to be in memory. */
8000 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8001 if (cmd
->proc
== getCommand
) {
8002 waitForSwappedKey(c
,c
->argv
[1]);
8004 /* If the client was blocked for at least one key, mark it as blocked. */
8005 if (listLength(c
->io_keys
)) {
8006 c
->flags
|= REDIS_IO_WAIT
;
8007 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8008 server
.vm_blocked_clients
++;
8015 /* Remove the 'key' from the list of blocked keys for a given client.
8017 * The function returns 1 when there are no longer blocking keys after
8018 * the current one was removed (and the client can be unblocked). */
8019 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8023 struct dictEntry
*de
;
8025 /* Remove the key from the list of keys this client is waiting for. */
8026 listRewind(c
->io_keys
,&li
);
8027 while ((ln
= listNext(&li
)) != NULL
) {
8028 if (compareStringObjects(ln
->value
,key
) == 0) {
8029 listDelNode(c
->io_keys
,ln
);
8035 /* Remove the client form the key => waiting clients map. */
8036 de
= dictFind(c
->db
->io_keys
,key
);
8038 l
= dictGetEntryVal(de
);
8039 ln
= listSearchKey(l
,c
);
8042 if (listLength(l
) == 0)
8043 dictDelete(c
->db
->io_keys
,key
);
8045 return listLength(c
->io_keys
) == 0;
8048 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8049 struct dictEntry
*de
;
8054 de
= dictFind(db
->io_keys
,key
);
8057 l
= dictGetEntryVal(de
);
8058 len
= listLength(l
);
8059 /* Note: we can't use something like while(listLength(l)) as the list
8060 * can be freed by the calling function when we remove the last element. */
8063 redisClient
*c
= ln
->value
;
8065 if (dontWaitForSwappedKey(c
,key
)) {
8066 /* Put the client in the list of clients ready to go as we
8067 * loaded all the keys about it. */
8068 listAddNodeTail(server
.io_ready_clients
,c
);
8073 /* ================================= Debugging ============================== */
8075 static void debugCommand(redisClient
*c
) {
8076 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8078 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8079 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8080 addReply(c
,shared
.err
);
8084 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8085 addReply(c
,shared
.err
);
8088 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8089 addReply(c
,shared
.ok
);
8090 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8092 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8093 addReply(c
,shared
.err
);
8096 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8097 addReply(c
,shared
.ok
);
8098 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8099 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8103 addReply(c
,shared
.nokeyerr
);
8106 key
= dictGetEntryKey(de
);
8107 val
= dictGetEntryVal(de
);
8108 if (server
.vm_enabled
&& (key
->storage
== REDIS_VM_MEMORY
||
8109 key
->storage
== REDIS_VM_SWAPPING
)) {
8110 addReplySds(c
,sdscatprintf(sdsempty(),
8111 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8112 "encoding:%d serializedlength:%lld\r\n",
8113 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8114 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8116 addReplySds(c
,sdscatprintf(sdsempty(),
8117 "+Key at:%p refcount:%d, value swapped at: page %llu "
8118 "using %llu pages\r\n",
8119 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8120 (unsigned long long) key
->vm
.usedpages
));
8122 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8123 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8126 if (!server
.vm_enabled
) {
8127 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8131 addReply(c
,shared
.nokeyerr
);
8134 key
= dictGetEntryKey(de
);
8135 val
= dictGetEntryVal(de
);
8136 /* If the key is shared we want to create a copy */
8137 if (key
->refcount
> 1) {
8138 robj
*newkey
= dupStringObject(key
);
8140 key
= dictGetEntryKey(de
) = newkey
;
8143 if (key
->storage
!= REDIS_VM_MEMORY
) {
8144 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8145 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8146 dictGetEntryVal(de
) = NULL
;
8147 addReply(c
,shared
.ok
);
8149 addReply(c
,shared
.err
);
8152 addReplySds(c
,sdsnew(
8153 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8157 static void _redisAssert(char *estr
, char *file
, int line
) {
8158 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8159 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8160 #ifdef HAVE_BACKTRACE
8161 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8166 /* =================================== Main! ================================ */
8169 int linuxOvercommitMemoryValue(void) {
8170 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8174 if (fgets(buf
,64,fp
) == NULL
) {
8183 void linuxOvercommitMemoryWarning(void) {
8184 if (linuxOvercommitMemoryValue() == 0) {
8185 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.");
8188 #endif /* __linux__ */
8190 static void daemonize(void) {
8194 if (fork() != 0) exit(0); /* parent exits */
8195 setsid(); /* create a new session */
8197 /* Every output goes to /dev/null. If Redis is daemonized but
8198 * the 'logfile' is set to 'stdout' in the configuration file
8199 * it will not log at all. */
8200 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8201 dup2(fd
, STDIN_FILENO
);
8202 dup2(fd
, STDOUT_FILENO
);
8203 dup2(fd
, STDERR_FILENO
);
8204 if (fd
> STDERR_FILENO
) close(fd
);
8206 /* Try to write the pid file */
8207 fp
= fopen(server
.pidfile
,"w");
8209 fprintf(fp
,"%d\n",getpid());
8214 int main(int argc
, char **argv
) {
8219 resetServerSaveParams();
8220 loadServerConfig(argv
[1]);
8221 } else if (argc
> 2) {
8222 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8225 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'");
8227 if (server
.daemonize
) daemonize();
8229 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8231 linuxOvercommitMemoryWarning();
8234 if (server
.appendonly
) {
8235 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8236 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8238 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8239 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8241 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8242 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8244 aeDeleteEventLoop(server
.el
);
8248 /* ============================= Backtrace support ========================= */
8250 #ifdef HAVE_BACKTRACE
8251 static char *findFuncName(void *pointer
, unsigned long *offset
);
8253 static void *getMcontextEip(ucontext_t
*uc
) {
8254 #if defined(__FreeBSD__)
8255 return (void*) uc
->uc_mcontext
.mc_eip
;
8256 #elif defined(__dietlibc__)
8257 return (void*) uc
->uc_mcontext
.eip
;
8258 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8260 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8262 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8264 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8265 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8266 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8268 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8270 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8271 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8272 #elif defined(__ia64__) /* Linux IA64 */
8273 return (void*) uc
->uc_mcontext
.sc_ip
;
8279 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8281 char **messages
= NULL
;
8282 int i
, trace_size
= 0;
8283 unsigned long offset
=0;
8284 ucontext_t
*uc
= (ucontext_t
*) secret
;
8286 REDIS_NOTUSED(info
);
8288 redisLog(REDIS_WARNING
,
8289 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8290 infostring
= genRedisInfoString();
8291 redisLog(REDIS_WARNING
, "%s",infostring
);
8292 /* It's not safe to sdsfree() the returned string under memory
8293 * corruption conditions. Let it leak as we are going to abort */
8295 trace_size
= backtrace(trace
, 100);
8296 /* overwrite sigaction with caller's address */
8297 if (getMcontextEip(uc
) != NULL
) {
8298 trace
[1] = getMcontextEip(uc
);
8300 messages
= backtrace_symbols(trace
, trace_size
);
8302 for (i
=1; i
<trace_size
; ++i
) {
8303 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8305 p
= strchr(messages
[i
],'+');
8306 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8307 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8309 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8312 /* free(messages); Don't call free() with possibly corrupted memory. */
8316 static void setupSigSegvAction(void) {
8317 struct sigaction act
;
8319 sigemptyset (&act
.sa_mask
);
8320 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8321 * is used. Otherwise, sa_handler is used */
8322 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8323 act
.sa_sigaction
= segvHandler
;
8324 sigaction (SIGSEGV
, &act
, NULL
);
8325 sigaction (SIGBUS
, &act
, NULL
);
8326 sigaction (SIGFPE
, &act
, NULL
);
8327 sigaction (SIGILL
, &act
, NULL
);
8328 sigaction (SIGBUS
, &act
, NULL
);
8332 #include "staticsymbols.h"
8333 /* This function try to convert a pointer into a function name. It's used in
8334 * oreder to provide a backtrace under segmentation fault that's able to
8335 * display functions declared as static (otherwise the backtrace is useless). */
8336 static char *findFuncName(void *pointer
, unsigned long *offset
){
8338 unsigned long off
, minoff
= 0;
8340 /* Try to match against the Symbol with the smallest offset */
8341 for (i
=0; symsTable
[i
].pointer
; i
++) {
8342 unsigned long lp
= (unsigned long) pointer
;
8344 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8345 off
=lp
-symsTable
[i
].pointer
;
8346 if (ret
< 0 || off
< minoff
) {
8352 if (ret
== -1) return NULL
;
8354 return symsTable
[ret
].name
;
8356 #else /* HAVE_BACKTRACE */
8357 static void setupSigSegvAction(void) {
8359 #endif /* HAVE_BACKTRACE */