2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.10"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117 #define REDIS_STRING 0
123 /* Objects encoding. Some kind of objects like Strings and Hashes can be
124 * internally represented in multiple ways. The 'encoding' field of the object
125 * is set to one of this fields for this object. */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
128 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
129 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131 static char* strencoding
[] = {
132 "raw", "int", "zipmap", "hashtable"
135 /* Object types only used for dumping to disk */
136 #define REDIS_EXPIRETIME 253
137 #define REDIS_SELECTDB 254
138 #define REDIS_EOF 255
140 /* Defines related to the dump file format. To store 32 bits lengths for short
141 * keys requires a lot of space, so we check the most significant 2 bits of
142 * the first byte to interpreter the length:
144 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
145 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
146 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
147 * 11|000000 this means: specially encoded object will follow. The six bits
148 * number specify the kind of object that follows.
149 * See the REDIS_RDB_ENC_* defines.
151 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
152 * values, will fit inside. */
153 #define REDIS_RDB_6BITLEN 0
154 #define REDIS_RDB_14BITLEN 1
155 #define REDIS_RDB_32BITLEN 2
156 #define REDIS_RDB_ENCVAL 3
157 #define REDIS_RDB_LENERR UINT_MAX
159 /* When a length of a string object stored on disk has the first two bits
160 * set, the remaining two bits specify a special encoding for the object
161 * accordingly to the following defines: */
162 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
163 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
164 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
165 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167 /* Virtual memory object->where field. */
168 #define REDIS_VM_MEMORY 0 /* The object is on memory */
169 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
170 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
171 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173 /* Virtual memory static configuration stuff.
174 * Check vmFindContiguousPages() to know more about this magic numbers. */
175 #define REDIS_VM_MAX_NEAR_PAGES 65536
176 #define REDIS_VM_MAX_RANDOM_JUMP 4096
177 #define REDIS_VM_MAX_THREADS 32
178 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
179 /* The following is the *percentage* of completed I/O jobs to process when the
180 * handelr is called. While Virtual Memory I/O operations are performed by
181 * threads, this operations must be processed by the main thread when completed
182 * in order to take effect. */
183 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
186 #define REDIS_SLAVE 1 /* This client is a slave server */
187 #define REDIS_MASTER 2 /* This client is a master server */
188 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
189 #define REDIS_MULTI 8 /* This client is in a MULTI context */
190 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
191 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 /* Slave replication state - slave side */
194 #define REDIS_REPL_NONE 0 /* No active replication */
195 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
196 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
198 /* Slave replication state - from the point of view of master
199 * Note that in SEND_BULK and ONLINE state the slave receives new updates
200 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
201 * to start the next background saving in order to send updates to it. */
202 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
203 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
204 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
205 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
207 /* List related stuff */
211 /* Sort operations */
212 #define REDIS_SORT_GET 0
213 #define REDIS_SORT_ASC 1
214 #define REDIS_SORT_DESC 2
215 #define REDIS_SORTKEY_MAX 1024
218 #define REDIS_DEBUG 0
219 #define REDIS_VERBOSE 1
220 #define REDIS_NOTICE 2
221 #define REDIS_WARNING 3
223 /* Anti-warning macro... */
224 #define REDIS_NOTUSED(V) ((void) V)
226 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
227 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
229 /* Append only defines */
230 #define APPENDFSYNC_NO 0
231 #define APPENDFSYNC_ALWAYS 1
232 #define APPENDFSYNC_EVERYSEC 2
234 /* Hashes related defaults */
235 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
236 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
238 /* We can print the stacktrace, so our assert is defined this way: */
239 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
240 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
241 static void _redisAssert(char *estr
, char *file
, int line
);
242 static void _redisPanic(char *msg
, char *file
, int line
);
244 /*================================= Data types ============================== */
246 /* A redis object, that is a type able to hold a string / list / set */
248 /* The VM object structure */
249 struct redisObjectVM
{
250 off_t page
; /* the page at witch the object is stored on disk */
251 off_t usedpages
; /* number of pages used on disk */
252 time_t atime
; /* Last access time */
255 /* The actual Redis Object */
256 typedef struct redisObject
{
259 unsigned char encoding
;
260 unsigned char storage
; /* If this object is a key, where is the value?
261 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
262 unsigned char vtype
; /* If this object is a key, and value is swapped out,
263 * this is the type of the swapped out object. */
265 /* VM fields, this are only allocated if VM is active, otherwise the
266 * object allocation function will just allocate
267 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
268 * Redis without VM active will not have any overhead. */
269 struct redisObjectVM vm
;
272 /* Macro used to initalize a Redis object allocated on the stack.
273 * Note that this macro is taken near the structure definition to make sure
274 * we'll update it when the structure is changed, to avoid bugs like
275 * bug #85 introduced exactly in this way. */
276 #define initStaticStringObject(_var,_ptr) do { \
278 _var.type = REDIS_STRING; \
279 _var.encoding = REDIS_ENCODING_RAW; \
281 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
284 typedef struct redisDb
{
285 dict
*dict
; /* The keyspace for this DB */
286 dict
*expires
; /* Timeout of keys with a timeout set */
287 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
288 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
292 /* Client MULTI/EXEC state */
293 typedef struct multiCmd
{
296 struct redisCommand
*cmd
;
299 typedef struct multiState
{
300 multiCmd
*commands
; /* Array of MULTI commands */
301 int count
; /* Total number of MULTI commands */
304 /* With multiplexing we need to take per-clinet state.
305 * Clients are taken in a liked list. */
306 typedef struct redisClient
{
311 robj
**argv
, **mbargv
;
313 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
314 int multibulk
; /* multi bulk command format active */
317 time_t lastinteraction
; /* time of the last interaction, used for timeout */
318 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
319 int slaveseldb
; /* slave selected db, if this client is a slave */
320 int authenticated
; /* when requirepass is non-NULL */
321 int replstate
; /* replication state if this is a slave */
322 int repldbfd
; /* replication DB file descriptor */
323 long repldboff
; /* replication DB file offset */
324 off_t repldbsize
; /* replication DB file size */
325 multiState mstate
; /* MULTI/EXEC state */
326 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
327 * operation such as BLPOP. Otherwise NULL. */
328 int blockingkeysnum
; /* Number of blocking keys */
329 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
330 * is >= blockingto then the operation timed out. */
331 list
*io_keys
; /* Keys this client is waiting to be loaded from the
332 * swap file in order to continue. */
333 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
334 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
342 /* Global server state structure */
347 long long dirty
; /* changes to DB from the last save */
349 list
*slaves
, *monitors
;
350 char neterr
[ANET_ERR_LEN
];
352 int cronloops
; /* number of times the cron function run */
353 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
354 time_t lastsave
; /* Unix time of last save succeeede */
355 /* Fields used only for stats */
356 time_t stat_starttime
; /* server start time */
357 long long stat_numcommands
; /* number of processed commands */
358 long long stat_numconnections
; /* number of connections received */
359 long long stat_expiredkeys
; /* number of expired keys */
372 pid_t bgsavechildpid
;
373 pid_t bgrewritechildpid
;
374 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
385 /* Replication related */
390 redisClient
*master
; /* client that is master for this slave */
392 unsigned int maxclients
;
393 unsigned long long maxmemory
;
394 unsigned int blpop_blocked_clients
;
395 unsigned int vm_blocked_clients
;
396 /* Sort parameters - qsort_r() is only available under BSD so we
397 * have to take this state global, in order to pass it to sortCompare() */
401 /* Virtual memory configuration */
406 unsigned long long vm_max_memory
;
408 size_t hash_max_zipmap_entries
;
409 size_t hash_max_zipmap_value
;
410 /* Virtual memory state */
413 off_t vm_next_page
; /* Next probably empty page */
414 off_t vm_near_pages
; /* Number of pages allocated sequentially */
415 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
416 time_t unixtime
; /* Unix time sampled every second. */
417 /* Virtual memory I/O threads stuff */
418 /* An I/O thread process an element taken from the io_jobs queue and
419 * put the result of the operation in the io_done list. While the
420 * job is being processed, it's put on io_processing queue. */
421 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
422 list
*io_processing
; /* List of VM I/O jobs being processed */
423 list
*io_processed
; /* List of VM I/O jobs already processed */
424 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
425 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
426 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
427 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
428 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
429 int io_active_threads
; /* Number of running I/O threads */
430 int vm_max_threads
; /* Max number of I/O threads running at the same time */
431 /* Our main thread is blocked on the event loop, locking for sockets ready
432 * to be read or written, so when a threaded I/O operation is ready to be
433 * processed by the main thread, the I/O thread will use a unix pipe to
434 * awake the main thread. The followings are the two pipe FDs. */
435 int io_ready_pipe_read
;
436 int io_ready_pipe_write
;
437 /* Virtual memory stats */
438 unsigned long long vm_stats_used_pages
;
439 unsigned long long vm_stats_swapped_objects
;
440 unsigned long long vm_stats_swapouts
;
441 unsigned long long vm_stats_swapins
;
443 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
444 list
*pubsub_patterns
; /* A list of pubsub_patterns */
449 typedef struct pubsubPattern
{
454 typedef void redisCommandProc(redisClient
*c
);
455 struct redisCommand
{
457 redisCommandProc
*proc
;
460 /* Use a function to determine which keys need to be loaded
461 * in the background prior to executing this command. Takes precedence
462 * over vm_firstkey and others, ignored when NULL */
463 redisCommandProc
*vm_preload_proc
;
464 /* What keys should be loaded in background when calling this command? */
465 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
466 int vm_lastkey
; /* THe last argument that's a key */
467 int vm_keystep
; /* The step between first and last key */
470 struct redisFunctionSym
{
472 unsigned long pointer
;
475 typedef struct _redisSortObject
{
483 typedef struct _redisSortOperation
{
486 } redisSortOperation
;
488 /* ZSETs use a specialized version of Skiplists */
490 typedef struct zskiplistNode
{
491 struct zskiplistNode
**forward
;
492 struct zskiplistNode
*backward
;
498 typedef struct zskiplist
{
499 struct zskiplistNode
*header
, *tail
;
500 unsigned long length
;
504 typedef struct zset
{
509 /* Our shared "common" objects */
511 #define REDIS_SHARED_INTEGERS 10000
512 struct sharedObjectsStruct
{
513 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
514 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
515 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
516 *outofrangeerr
, *plus
,
517 *select0
, *select1
, *select2
, *select3
, *select4
,
518 *select5
, *select6
, *select7
, *select8
, *select9
,
519 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
520 *psubscribebulk
, *punsubscribebulk
, *integers
[REDIS_SHARED_INTEGERS
];
523 /* Global vars that are actally used as constants. The following double
524 * values are used for double on-disk serialization, and are initialized
525 * at runtime to avoid strange compiler optimizations. */
527 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
529 /* VM threaded I/O request message */
530 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
531 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
532 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
533 typedef struct iojob
{
534 int type
; /* Request type, REDIS_IOJOB_* */
535 redisDb
*db
;/* Redis database */
536 robj
*key
; /* This I/O request is about swapping this key */
537 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
538 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
539 off_t page
; /* Swap page where to read/write the object */
540 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
541 int canceled
; /* True if this command was canceled by blocking side of VM */
542 pthread_t thread
; /* ID of the thread processing this entry */
545 /*================================ Prototypes =============================== */
547 static void freeStringObject(robj
*o
);
548 static void freeListObject(robj
*o
);
549 static void freeSetObject(robj
*o
);
550 static void decrRefCount(void *o
);
551 static robj
*createObject(int type
, void *ptr
);
552 static void freeClient(redisClient
*c
);
553 static int rdbLoad(char *filename
);
554 static void addReply(redisClient
*c
, robj
*obj
);
555 static void addReplySds(redisClient
*c
, sds s
);
556 static void incrRefCount(robj
*o
);
557 static int rdbSaveBackground(char *filename
);
558 static robj
*createStringObject(char *ptr
, size_t len
);
559 static robj
*dupStringObject(robj
*o
);
560 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
561 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
562 static int syncWithMaster(void);
563 static robj
*tryObjectEncoding(robj
*o
);
564 static robj
*getDecodedObject(robj
*o
);
565 static int removeExpire(redisDb
*db
, robj
*key
);
566 static int expireIfNeeded(redisDb
*db
, robj
*key
);
567 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
568 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
569 static int deleteKey(redisDb
*db
, robj
*key
);
570 static time_t getExpire(redisDb
*db
, robj
*key
);
571 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
572 static void updateSlavesWaitingBgsave(int bgsaveerr
);
573 static void freeMemoryIfNeeded(void);
574 static int processCommand(redisClient
*c
);
575 static void setupSigSegvAction(void);
576 static void rdbRemoveTempFile(pid_t childpid
);
577 static void aofRemoveTempFile(pid_t childpid
);
578 static size_t stringObjectLen(robj
*o
);
579 static void processInputBuffer(redisClient
*c
);
580 static zskiplist
*zslCreate(void);
581 static void zslFree(zskiplist
*zsl
);
582 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
583 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
584 static void initClientMultiState(redisClient
*c
);
585 static void freeClientMultiState(redisClient
*c
);
586 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
587 static void unblockClientWaitingData(redisClient
*c
);
588 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
589 static void vmInit(void);
590 static void vmMarkPagesFree(off_t page
, off_t count
);
591 static robj
*vmLoadObject(robj
*key
);
592 static robj
*vmPreviewObject(robj
*key
);
593 static int vmSwapOneObjectBlocking(void);
594 static int vmSwapOneObjectThreaded(void);
595 static int vmCanSwapOut(void);
596 static int tryFreeOneObjectFromFreelist(void);
597 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
598 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static void vmCancelThreadedIOJob(robj
*o
);
600 static void lockThreadedIO(void);
601 static void unlockThreadedIO(void);
602 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
603 static void freeIOJob(iojob
*j
);
604 static void queueIOJob(iojob
*j
);
605 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
606 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
607 static void waitEmptyIOJobsQueue(void);
608 static void vmReopenSwapFile(void);
609 static int vmFreePage(off_t page
);
610 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
611 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
612 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
613 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
614 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
615 static struct redisCommand
*lookupCommand(char *name
);
616 static void call(redisClient
*c
, struct redisCommand
*cmd
);
617 static void resetClient(redisClient
*c
);
618 static void convertToRealHash(robj
*o
);
619 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
620 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
621 static void freePubsubPattern(void *p
);
622 static int listMatchPubsubPattern(void *a
, void *b
);
623 static int compareStringObjects(robj
*a
, robj
*b
);
626 static void authCommand(redisClient
*c
);
627 static void pingCommand(redisClient
*c
);
628 static void echoCommand(redisClient
*c
);
629 static void setCommand(redisClient
*c
);
630 static void setnxCommand(redisClient
*c
);
631 static void getCommand(redisClient
*c
);
632 static void delCommand(redisClient
*c
);
633 static void existsCommand(redisClient
*c
);
634 static void incrCommand(redisClient
*c
);
635 static void decrCommand(redisClient
*c
);
636 static void incrbyCommand(redisClient
*c
);
637 static void decrbyCommand(redisClient
*c
);
638 static void selectCommand(redisClient
*c
);
639 static void randomkeyCommand(redisClient
*c
);
640 static void keysCommand(redisClient
*c
);
641 static void dbsizeCommand(redisClient
*c
);
642 static void lastsaveCommand(redisClient
*c
);
643 static void saveCommand(redisClient
*c
);
644 static void bgsaveCommand(redisClient
*c
);
645 static void bgrewriteaofCommand(redisClient
*c
);
646 static void shutdownCommand(redisClient
*c
);
647 static void moveCommand(redisClient
*c
);
648 static void renameCommand(redisClient
*c
);
649 static void renamenxCommand(redisClient
*c
);
650 static void lpushCommand(redisClient
*c
);
651 static void rpushCommand(redisClient
*c
);
652 static void lpopCommand(redisClient
*c
);
653 static void rpopCommand(redisClient
*c
);
654 static void llenCommand(redisClient
*c
);
655 static void lindexCommand(redisClient
*c
);
656 static void lrangeCommand(redisClient
*c
);
657 static void ltrimCommand(redisClient
*c
);
658 static void typeCommand(redisClient
*c
);
659 static void lsetCommand(redisClient
*c
);
660 static void saddCommand(redisClient
*c
);
661 static void sremCommand(redisClient
*c
);
662 static void smoveCommand(redisClient
*c
);
663 static void sismemberCommand(redisClient
*c
);
664 static void scardCommand(redisClient
*c
);
665 static void spopCommand(redisClient
*c
);
666 static void srandmemberCommand(redisClient
*c
);
667 static void sinterCommand(redisClient
*c
);
668 static void sinterstoreCommand(redisClient
*c
);
669 static void sunionCommand(redisClient
*c
);
670 static void sunionstoreCommand(redisClient
*c
);
671 static void sdiffCommand(redisClient
*c
);
672 static void sdiffstoreCommand(redisClient
*c
);
673 static void syncCommand(redisClient
*c
);
674 static void flushdbCommand(redisClient
*c
);
675 static void flushallCommand(redisClient
*c
);
676 static void sortCommand(redisClient
*c
);
677 static void lremCommand(redisClient
*c
);
678 static void rpoplpushcommand(redisClient
*c
);
679 static void infoCommand(redisClient
*c
);
680 static void mgetCommand(redisClient
*c
);
681 static void monitorCommand(redisClient
*c
);
682 static void expireCommand(redisClient
*c
);
683 static void expireatCommand(redisClient
*c
);
684 static void getsetCommand(redisClient
*c
);
685 static void ttlCommand(redisClient
*c
);
686 static void slaveofCommand(redisClient
*c
);
687 static void debugCommand(redisClient
*c
);
688 static void msetCommand(redisClient
*c
);
689 static void msetnxCommand(redisClient
*c
);
690 static void zaddCommand(redisClient
*c
);
691 static void zincrbyCommand(redisClient
*c
);
692 static void zrangeCommand(redisClient
*c
);
693 static void zrangebyscoreCommand(redisClient
*c
);
694 static void zcountCommand(redisClient
*c
);
695 static void zrevrangeCommand(redisClient
*c
);
696 static void zcardCommand(redisClient
*c
);
697 static void zremCommand(redisClient
*c
);
698 static void zscoreCommand(redisClient
*c
);
699 static void zremrangebyscoreCommand(redisClient
*c
);
700 static void multiCommand(redisClient
*c
);
701 static void execCommand(redisClient
*c
);
702 static void discardCommand(redisClient
*c
);
703 static void blpopCommand(redisClient
*c
);
704 static void brpopCommand(redisClient
*c
);
705 static void appendCommand(redisClient
*c
);
706 static void substrCommand(redisClient
*c
);
707 static void zrankCommand(redisClient
*c
);
708 static void zrevrankCommand(redisClient
*c
);
709 static void hsetCommand(redisClient
*c
);
710 static void hsetnxCommand(redisClient
*c
);
711 static void hgetCommand(redisClient
*c
);
712 static void hmsetCommand(redisClient
*c
);
713 static void hmgetCommand(redisClient
*c
);
714 static void hdelCommand(redisClient
*c
);
715 static void hlenCommand(redisClient
*c
);
716 static void zremrangebyrankCommand(redisClient
*c
);
717 static void zunionCommand(redisClient
*c
);
718 static void zinterCommand(redisClient
*c
);
719 static void hkeysCommand(redisClient
*c
);
720 static void hvalsCommand(redisClient
*c
);
721 static void hgetallCommand(redisClient
*c
);
722 static void hexistsCommand(redisClient
*c
);
723 static void configCommand(redisClient
*c
);
724 static void hincrbyCommand(redisClient
*c
);
725 static void subscribeCommand(redisClient
*c
);
726 static void unsubscribeCommand(redisClient
*c
);
727 static void psubscribeCommand(redisClient
*c
);
728 static void punsubscribeCommand(redisClient
*c
);
729 static void publishCommand(redisClient
*c
);
731 /*================================= Globals ================================= */
734 static struct redisServer server
; /* server global state */
735 static struct redisCommand cmdTable
[] = {
736 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
737 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
738 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
739 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
740 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
742 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
743 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
744 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
746 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
747 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
748 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
755 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
759 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
760 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
761 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
762 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
763 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
764 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
765 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
766 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
767 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
768 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
769 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
770 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
771 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
772 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
774 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
775 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
776 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
779 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
780 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
784 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
785 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
786 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
787 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
788 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
789 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
791 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
792 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
795 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
796 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
797 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
798 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
799 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
802 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
803 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
804 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
805 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
806 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
807 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
809 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
810 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
817 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
823 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
825 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
830 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
833 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
836 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
841 {NULL
,NULL
,0,0,NULL
,0,0,0}
844 /*============================ Utility functions ============================ */
846 /* Glob-style pattern matching. */
847 static int stringmatchlen(const char *pattern
, int patternLen
,
848 const char *string
, int stringLen
, int nocase
)
853 while (pattern
[1] == '*') {
858 return 1; /* match */
860 if (stringmatchlen(pattern
+1, patternLen
-1,
861 string
, stringLen
, nocase
))
862 return 1; /* match */
866 return 0; /* no match */
870 return 0; /* no match */
880 not = pattern
[0] == '^';
887 if (pattern
[0] == '\\') {
890 if (pattern
[0] == string
[0])
892 } else if (pattern
[0] == ']') {
894 } else if (patternLen
== 0) {
898 } else if (pattern
[1] == '-' && patternLen
>= 3) {
899 int start
= pattern
[0];
900 int end
= pattern
[2];
908 start
= tolower(start
);
914 if (c
>= start
&& c
<= end
)
918 if (pattern
[0] == string
[0])
921 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
931 return 0; /* no match */
937 if (patternLen
>= 2) {
944 if (pattern
[0] != string
[0])
945 return 0; /* no match */
947 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
948 return 0; /* no match */
956 if (stringLen
== 0) {
957 while(*pattern
== '*') {
964 if (patternLen
== 0 && stringLen
== 0)
969 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
970 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
973 static void redisLog(int level
, const char *fmt
, ...) {
977 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
981 if (level
>= server
.verbosity
) {
987 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
988 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
989 vfprintf(fp
, fmt
, ap
);
995 if (server
.logfile
) fclose(fp
);
998 /*====================== Hash table type implementation ==================== */
1000 /* This is an hash table type that uses the SDS dynamic strings libary as
1001 * keys and radis objects as values (objects can hold SDS strings,
1004 static void dictVanillaFree(void *privdata
, void *val
)
1006 DICT_NOTUSED(privdata
);
1010 static void dictListDestructor(void *privdata
, void *val
)
1012 DICT_NOTUSED(privdata
);
1013 listRelease((list
*)val
);
1016 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1020 DICT_NOTUSED(privdata
);
1022 l1
= sdslen((sds
)key1
);
1023 l2
= sdslen((sds
)key2
);
1024 if (l1
!= l2
) return 0;
1025 return memcmp(key1
, key2
, l1
) == 0;
1028 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1030 DICT_NOTUSED(privdata
);
1032 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1036 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1039 const robj
*o1
= key1
, *o2
= key2
;
1040 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1043 static unsigned int dictObjHash(const void *key
) {
1044 const robj
*o
= key
;
1045 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1048 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1051 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1054 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1055 o2
->encoding
== REDIS_ENCODING_INT
&&
1056 o1
->ptr
== o2
->ptr
) return 1;
1058 o1
= getDecodedObject(o1
);
1059 o2
= getDecodedObject(o2
);
1060 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1066 static unsigned int dictEncObjHash(const void *key
) {
1067 robj
*o
= (robj
*) key
;
1069 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1070 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1072 if (o
->encoding
== REDIS_ENCODING_INT
) {
1076 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1077 return dictGenHashFunction((unsigned char*)buf
, len
);
1081 o
= getDecodedObject(o
);
1082 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1089 /* Sets type and expires */
1090 static dictType setDictType
= {
1091 dictEncObjHash
, /* hash function */
1094 dictEncObjKeyCompare
, /* key compare */
1095 dictRedisObjectDestructor
, /* key destructor */
1096 NULL
/* val destructor */
1099 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1100 static dictType zsetDictType
= {
1101 dictEncObjHash
, /* hash function */
1104 dictEncObjKeyCompare
, /* key compare */
1105 dictRedisObjectDestructor
, /* key destructor */
1106 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1110 static dictType dbDictType
= {
1111 dictObjHash
, /* hash function */
1114 dictObjKeyCompare
, /* key compare */
1115 dictRedisObjectDestructor
, /* key destructor */
1116 dictRedisObjectDestructor
/* val destructor */
1120 static dictType keyptrDictType
= {
1121 dictObjHash
, /* hash function */
1124 dictObjKeyCompare
, /* key compare */
1125 dictRedisObjectDestructor
, /* key destructor */
1126 NULL
/* val destructor */
1129 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1130 static dictType hashDictType
= {
1131 dictEncObjHash
, /* hash function */
1134 dictEncObjKeyCompare
, /* key compare */
1135 dictRedisObjectDestructor
, /* key destructor */
1136 dictRedisObjectDestructor
/* val destructor */
1139 /* Keylist hash table type has unencoded redis objects as keys and
1140 * lists as values. It's used for blocking operations (BLPOP) and to
1141 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1142 static dictType keylistDictType
= {
1143 dictObjHash
, /* hash function */
1146 dictObjKeyCompare
, /* key compare */
1147 dictRedisObjectDestructor
, /* key destructor */
1148 dictListDestructor
/* val destructor */
1151 static void version();
1153 /* ========================= Random utility functions ======================= */
1155 /* Redis generally does not try to recover from out of memory conditions
1156 * when allocating objects or strings, it is not clear if it will be possible
1157 * to report this condition to the client since the networking layer itself
1158 * is based on heap allocation for send buffers, so we simply abort.
1159 * At least the code will be simpler to read... */
1160 static void oom(const char *msg
) {
1161 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1166 /* ====================== Redis server networking stuff ===================== */
1167 static void closeTimedoutClients(void) {
1170 time_t now
= time(NULL
);
1173 listRewind(server
.clients
,&li
);
1174 while ((ln
= listNext(&li
)) != NULL
) {
1175 c
= listNodeValue(ln
);
1176 if (server
.maxidletime
&&
1177 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1178 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1179 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1180 listLength(c
->pubsub_patterns
) == 0 &&
1181 (now
- c
->lastinteraction
> server
.maxidletime
))
1183 redisLog(REDIS_VERBOSE
,"Closing idle client");
1185 } else if (c
->flags
& REDIS_BLOCKED
) {
1186 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1187 addReply(c
,shared
.nullmultibulk
);
1188 unblockClientWaitingData(c
);
1194 static int htNeedsResize(dict
*dict
) {
1195 long long size
, used
;
1197 size
= dictSlots(dict
);
1198 used
= dictSize(dict
);
1199 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1200 (used
*100/size
< REDIS_HT_MINFILL
));
1203 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1204 * we resize the hash table to save memory */
1205 static void tryResizeHashTables(void) {
1208 for (j
= 0; j
< server
.dbnum
; j
++) {
1209 if (htNeedsResize(server
.db
[j
].dict
))
1210 dictResize(server
.db
[j
].dict
);
1211 if (htNeedsResize(server
.db
[j
].expires
))
1212 dictResize(server
.db
[j
].expires
);
1216 /* Our hash table implementation performs rehashing incrementally while
1217 * we write/read from the hash table. Still if the server is idle, the hash
1218 * table will use two tables for a long time. So we try to use 1 millisecond
1219 * of CPU time at every serverCron() loop in order to rehash some key. */
1220 static void incrementallyRehash(void) {
1223 for (j
= 0; j
< server
.dbnum
; j
++) {
1224 if (dictIsRehashing(server
.db
[j
].dict
)) {
1225 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1226 break; /* already used our millisecond for this loop... */
1231 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1232 void backgroundSaveDoneHandler(int statloc
) {
1233 int exitcode
= WEXITSTATUS(statloc
);
1234 int bysignal
= WIFSIGNALED(statloc
);
1236 if (!bysignal
&& exitcode
== 0) {
1237 redisLog(REDIS_NOTICE
,
1238 "Background saving terminated with success");
1240 server
.lastsave
= time(NULL
);
1241 } else if (!bysignal
&& exitcode
!= 0) {
1242 redisLog(REDIS_WARNING
, "Background saving error");
1244 redisLog(REDIS_WARNING
,
1245 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1246 rdbRemoveTempFile(server
.bgsavechildpid
);
1248 server
.bgsavechildpid
= -1;
1249 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1250 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1251 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1254 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1256 void backgroundRewriteDoneHandler(int statloc
) {
1257 int exitcode
= WEXITSTATUS(statloc
);
1258 int bysignal
= WIFSIGNALED(statloc
);
1260 if (!bysignal
&& exitcode
== 0) {
1264 redisLog(REDIS_NOTICE
,
1265 "Background append only file rewriting terminated with success");
1266 /* Now it's time to flush the differences accumulated by the parent */
1267 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1268 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1270 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1273 /* Flush our data... */
1274 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1275 (signed) sdslen(server
.bgrewritebuf
)) {
1276 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
));
1280 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1281 /* Now our work is to rename the temp file into the stable file. And
1282 * switch the file descriptor used by the server for append only. */
1283 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1284 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1288 /* Mission completed... almost */
1289 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1290 if (server
.appendfd
!= -1) {
1291 /* If append only is actually enabled... */
1292 close(server
.appendfd
);
1293 server
.appendfd
= fd
;
1295 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1296 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1298 /* If append only is disabled we just generate a dump in this
1299 * format. Why not? */
1302 } else if (!bysignal
&& exitcode
!= 0) {
1303 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1305 redisLog(REDIS_WARNING
,
1306 "Background append only file rewriting terminated by signal %d",
1310 sdsfree(server
.bgrewritebuf
);
1311 server
.bgrewritebuf
= sdsempty();
1312 aofRemoveTempFile(server
.bgrewritechildpid
);
1313 server
.bgrewritechildpid
= -1;
1316 /* This function is called once a background process of some kind terminates,
1317 * as we want to avoid resizing the hash tables when there is a child in order
1318 * to play well with copy-on-write (otherwise when a resize happens lots of
1319 * memory pages are copied). The goal of this function is to update the ability
1320 * for dict.c to resize the hash tables accordingly to the fact we have o not
1321 * running childs. */
1322 static void updateDictResizePolicy(void) {
1323 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1326 dictDisableResize();
1329 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1330 int j
, loops
= server
.cronloops
++;
1331 REDIS_NOTUSED(eventLoop
);
1333 REDIS_NOTUSED(clientData
);
1335 /* We take a cached value of the unix time in the global state because
1336 * with virtual memory and aging there is to store the current time
1337 * in objects at every object access, and accuracy is not needed.
1338 * To access a global var is faster than calling time(NULL) */
1339 server
.unixtime
= time(NULL
);
1341 /* Show some info about non-empty databases */
1342 for (j
= 0; j
< server
.dbnum
; j
++) {
1343 long long size
, used
, vkeys
;
1345 size
= dictSlots(server
.db
[j
].dict
);
1346 used
= dictSize(server
.db
[j
].dict
);
1347 vkeys
= dictSize(server
.db
[j
].expires
);
1348 if (!(loops
% 50) && (used
|| vkeys
)) {
1349 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1350 /* dictPrintStats(server.dict); */
1354 /* We don't want to resize the hash tables while a bacground saving
1355 * is in progress: the saving child is created using fork() that is
1356 * implemented with a copy-on-write semantic in most modern systems, so
1357 * if we resize the HT while there is the saving child at work actually
1358 * a lot of memory movements in the parent will cause a lot of pages
1360 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1361 if (!(loops
% 10)) tryResizeHashTables();
1362 if (server
.activerehashing
) incrementallyRehash();
1365 /* Show information about connected clients */
1366 if (!(loops
% 50)) {
1367 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1368 listLength(server
.clients
)-listLength(server
.slaves
),
1369 listLength(server
.slaves
),
1370 zmalloc_used_memory());
1373 /* Close connections of timedout clients */
1374 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1375 closeTimedoutClients();
1377 /* Check if a background saving or AOF rewrite in progress terminated */
1378 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1382 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1383 if (pid
== server
.bgsavechildpid
) {
1384 backgroundSaveDoneHandler(statloc
);
1386 backgroundRewriteDoneHandler(statloc
);
1388 updateDictResizePolicy();
1391 /* If there is not a background saving in progress check if
1392 * we have to save now */
1393 time_t now
= time(NULL
);
1394 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1395 struct saveparam
*sp
= server
.saveparams
+j
;
1397 if (server
.dirty
>= sp
->changes
&&
1398 now
-server
.lastsave
> sp
->seconds
) {
1399 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1400 sp
->changes
, sp
->seconds
);
1401 rdbSaveBackground(server
.dbfilename
);
1407 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1408 * will use few CPU cycles if there are few expiring keys, otherwise
1409 * it will get more aggressive to avoid that too much memory is used by
1410 * keys that can be removed from the keyspace. */
1411 for (j
= 0; j
< server
.dbnum
; j
++) {
1413 redisDb
*db
= server
.db
+j
;
1415 /* Continue to expire if at the end of the cycle more than 25%
1416 * of the keys were expired. */
1418 long num
= dictSize(db
->expires
);
1419 time_t now
= time(NULL
);
1422 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1423 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1428 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1429 t
= (time_t) dictGetEntryVal(de
);
1431 deleteKey(db
,dictGetEntryKey(de
));
1433 server
.stat_expiredkeys
++;
1436 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1439 /* Swap a few keys on disk if we are over the memory limit and VM
1440 * is enbled. Try to free objects from the free list first. */
1441 if (vmCanSwapOut()) {
1442 while (server
.vm_enabled
&& zmalloc_used_memory() >
1443 server
.vm_max_memory
)
1447 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1448 retval
= (server
.vm_max_threads
== 0) ?
1449 vmSwapOneObjectBlocking() :
1450 vmSwapOneObjectThreaded();
1451 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1452 zmalloc_used_memory() >
1453 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1455 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1457 /* Note that when using threade I/O we free just one object,
1458 * because anyway when the I/O thread in charge to swap this
1459 * object out will finish, the handler of completed jobs
1460 * will try to swap more objects if we are still out of memory. */
1461 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1465 /* Check if we should connect to a MASTER */
1466 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1467 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1468 if (syncWithMaster() == REDIS_OK
) {
1469 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1475 /* This function gets called every time Redis is entering the
1476 * main loop of the event driven library, that is, before to sleep
1477 * for ready file descriptors. */
1478 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1479 REDIS_NOTUSED(eventLoop
);
1481 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1485 listRewind(server
.io_ready_clients
,&li
);
1486 while((ln
= listNext(&li
))) {
1487 redisClient
*c
= ln
->value
;
1488 struct redisCommand
*cmd
;
1490 /* Resume the client. */
1491 listDelNode(server
.io_ready_clients
,ln
);
1492 c
->flags
&= (~REDIS_IO_WAIT
);
1493 server
.vm_blocked_clients
--;
1494 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1495 readQueryFromClient
, c
);
1496 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1497 assert(cmd
!= NULL
);
1500 /* There may be more data to process in the input buffer. */
1501 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1502 processInputBuffer(c
);
1507 static void createSharedObjects(void) {
1510 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1511 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1512 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1513 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1514 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1515 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1516 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1517 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1518 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1519 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1520 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1521 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1522 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1523 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1524 "-ERR no such key\r\n"));
1525 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1526 "-ERR syntax error\r\n"));
1527 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1528 "-ERR source and destination objects are the same\r\n"));
1529 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1530 "-ERR index out of range\r\n"));
1531 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1532 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1533 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1534 shared
.select0
= createStringObject("select 0\r\n",10);
1535 shared
.select1
= createStringObject("select 1\r\n",10);
1536 shared
.select2
= createStringObject("select 2\r\n",10);
1537 shared
.select3
= createStringObject("select 3\r\n",10);
1538 shared
.select4
= createStringObject("select 4\r\n",10);
1539 shared
.select5
= createStringObject("select 5\r\n",10);
1540 shared
.select6
= createStringObject("select 6\r\n",10);
1541 shared
.select7
= createStringObject("select 7\r\n",10);
1542 shared
.select8
= createStringObject("select 8\r\n",10);
1543 shared
.select9
= createStringObject("select 9\r\n",10);
1544 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1545 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1546 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1547 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1548 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1549 shared
.mbulk3
= createStringObject("*3\r\n",4);
1550 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1551 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1552 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1556 static void appendServerSaveParams(time_t seconds
, int changes
) {
1557 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1558 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1559 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1560 server
.saveparamslen
++;
1563 static void resetServerSaveParams() {
1564 zfree(server
.saveparams
);
1565 server
.saveparams
= NULL
;
1566 server
.saveparamslen
= 0;
1569 static void initServerConfig() {
1570 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1571 server
.port
= REDIS_SERVERPORT
;
1572 server
.verbosity
= REDIS_VERBOSE
;
1573 server
.maxidletime
= REDIS_MAXIDLETIME
;
1574 server
.saveparams
= NULL
;
1575 server
.logfile
= NULL
; /* NULL = log on standard output */
1576 server
.bindaddr
= NULL
;
1577 server
.glueoutputbuf
= 1;
1578 server
.daemonize
= 0;
1579 server
.appendonly
= 0;
1580 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1581 server
.lastfsync
= time(NULL
);
1582 server
.appendfd
= -1;
1583 server
.appendseldb
= -1; /* Make sure the first time will not match */
1584 server
.pidfile
= zstrdup("/var/run/redis.pid");
1585 server
.dbfilename
= zstrdup("dump.rdb");
1586 server
.appendfilename
= zstrdup("appendonly.aof");
1587 server
.requirepass
= NULL
;
1588 server
.shareobjects
= 0;
1589 server
.rdbcompression
= 1;
1590 server
.activerehashing
= 1;
1591 server
.maxclients
= 0;
1592 server
.blpop_blocked_clients
= 0;
1593 server
.maxmemory
= 0;
1594 server
.vm_enabled
= 0;
1595 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1596 server
.vm_page_size
= 256; /* 256 bytes per page */
1597 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1598 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1599 server
.vm_max_threads
= 4;
1600 server
.vm_blocked_clients
= 0;
1601 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1602 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1604 resetServerSaveParams();
1606 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1607 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1608 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1609 /* Replication related */
1611 server
.masterauth
= NULL
;
1612 server
.masterhost
= NULL
;
1613 server
.masterport
= 6379;
1614 server
.master
= NULL
;
1615 server
.replstate
= REDIS_REPL_NONE
;
1617 /* Double constants initialization */
1619 R_PosInf
= 1.0/R_Zero
;
1620 R_NegInf
= -1.0/R_Zero
;
1621 R_Nan
= R_Zero
/R_Zero
;
1624 static void initServer() {
1627 signal(SIGHUP
, SIG_IGN
);
1628 signal(SIGPIPE
, SIG_IGN
);
1629 setupSigSegvAction();
1631 server
.devnull
= fopen("/dev/null","w");
1632 if (server
.devnull
== NULL
) {
1633 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1636 server
.clients
= listCreate();
1637 server
.slaves
= listCreate();
1638 server
.monitors
= listCreate();
1639 server
.objfreelist
= listCreate();
1640 createSharedObjects();
1641 server
.el
= aeCreateEventLoop();
1642 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1643 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1644 if (server
.fd
== -1) {
1645 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1648 for (j
= 0; j
< server
.dbnum
; j
++) {
1649 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1650 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1651 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1652 if (server
.vm_enabled
)
1653 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1654 server
.db
[j
].id
= j
;
1656 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1657 server
.pubsub_patterns
= listCreate();
1658 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1659 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1660 server
.cronloops
= 0;
1661 server
.bgsavechildpid
= -1;
1662 server
.bgrewritechildpid
= -1;
1663 server
.bgrewritebuf
= sdsempty();
1664 server
.lastsave
= time(NULL
);
1666 server
.stat_numcommands
= 0;
1667 server
.stat_numconnections
= 0;
1668 server
.stat_expiredkeys
= 0;
1669 server
.stat_starttime
= time(NULL
);
1670 server
.unixtime
= time(NULL
);
1671 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1672 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1673 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1675 if (server
.appendonly
) {
1676 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1677 if (server
.appendfd
== -1) {
1678 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1684 if (server
.vm_enabled
) vmInit();
1687 /* Empty the whole database */
1688 static long long emptyDb() {
1690 long long removed
= 0;
1692 for (j
= 0; j
< server
.dbnum
; j
++) {
1693 removed
+= dictSize(server
.db
[j
].dict
);
1694 dictEmpty(server
.db
[j
].dict
);
1695 dictEmpty(server
.db
[j
].expires
);
1700 static int yesnotoi(char *s
) {
1701 if (!strcasecmp(s
,"yes")) return 1;
1702 else if (!strcasecmp(s
,"no")) return 0;
1706 /* I agree, this is a very rudimental way to load a configuration...
1707 will improve later if the config gets more complex */
1708 static void loadServerConfig(char *filename
) {
1710 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1714 if (filename
[0] == '-' && filename
[1] == '\0')
1717 if ((fp
= fopen(filename
,"r")) == NULL
) {
1718 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1723 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1729 line
= sdstrim(line
," \t\r\n");
1731 /* Skip comments and blank lines*/
1732 if (line
[0] == '#' || line
[0] == '\0') {
1737 /* Split into arguments */
1738 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1739 sdstolower(argv
[0]);
1741 /* Execute config directives */
1742 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1743 server
.maxidletime
= atoi(argv
[1]);
1744 if (server
.maxidletime
< 0) {
1745 err
= "Invalid timeout value"; goto loaderr
;
1747 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1748 server
.port
= atoi(argv
[1]);
1749 if (server
.port
< 1 || server
.port
> 65535) {
1750 err
= "Invalid port"; goto loaderr
;
1752 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1753 server
.bindaddr
= zstrdup(argv
[1]);
1754 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1755 int seconds
= atoi(argv
[1]);
1756 int changes
= atoi(argv
[2]);
1757 if (seconds
< 1 || changes
< 0) {
1758 err
= "Invalid save parameters"; goto loaderr
;
1760 appendServerSaveParams(seconds
,changes
);
1761 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1762 if (chdir(argv
[1]) == -1) {
1763 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1764 argv
[1], strerror(errno
));
1767 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1768 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1769 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1770 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1771 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1773 err
= "Invalid log level. Must be one of debug, notice, warning";
1776 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1779 server
.logfile
= zstrdup(argv
[1]);
1780 if (!strcasecmp(server
.logfile
,"stdout")) {
1781 zfree(server
.logfile
);
1782 server
.logfile
= NULL
;
1784 if (server
.logfile
) {
1785 /* Test if we are able to open the file. The server will not
1786 * be able to abort just for this problem later... */
1787 logfp
= fopen(server
.logfile
,"a");
1788 if (logfp
== NULL
) {
1789 err
= sdscatprintf(sdsempty(),
1790 "Can't open the log file: %s", strerror(errno
));
1795 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1796 server
.dbnum
= atoi(argv
[1]);
1797 if (server
.dbnum
< 1) {
1798 err
= "Invalid number of databases"; goto loaderr
;
1800 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1801 loadServerConfig(argv
[1]);
1802 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1803 server
.maxclients
= atoi(argv
[1]);
1804 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1805 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1806 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1807 server
.masterhost
= sdsnew(argv
[1]);
1808 server
.masterport
= atoi(argv
[2]);
1809 server
.replstate
= REDIS_REPL_CONNECT
;
1810 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1811 server
.masterauth
= zstrdup(argv
[1]);
1812 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1813 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1814 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1816 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1817 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1818 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1820 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1821 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1822 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1824 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1825 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1826 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1828 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1829 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1830 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1832 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1833 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1834 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1836 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1837 if (!strcasecmp(argv
[1],"no")) {
1838 server
.appendfsync
= APPENDFSYNC_NO
;
1839 } else if (!strcasecmp(argv
[1],"always")) {
1840 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1841 } else if (!strcasecmp(argv
[1],"everysec")) {
1842 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1844 err
= "argument must be 'no', 'always' or 'everysec'";
1847 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1848 server
.requirepass
= zstrdup(argv
[1]);
1849 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1850 zfree(server
.pidfile
);
1851 server
.pidfile
= zstrdup(argv
[1]);
1852 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1853 zfree(server
.dbfilename
);
1854 server
.dbfilename
= zstrdup(argv
[1]);
1855 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1856 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1857 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1859 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1860 zfree(server
.vm_swap_file
);
1861 server
.vm_swap_file
= zstrdup(argv
[1]);
1862 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1863 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1864 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1865 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1866 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1867 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1868 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1869 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1870 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1871 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1872 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1873 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1874 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1875 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1877 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1879 for (j
= 0; j
< argc
; j
++)
1884 if (fp
!= stdin
) fclose(fp
);
1888 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1889 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1890 fprintf(stderr
, ">>> '%s'\n", line
);
1891 fprintf(stderr
, "%s\n", err
);
1895 static void freeClientArgv(redisClient
*c
) {
1898 for (j
= 0; j
< c
->argc
; j
++)
1899 decrRefCount(c
->argv
[j
]);
1900 for (j
= 0; j
< c
->mbargc
; j
++)
1901 decrRefCount(c
->mbargv
[j
]);
1906 static void freeClient(redisClient
*c
) {
1909 /* Note that if the client we are freeing is blocked into a blocking
1910 * call, we have to set querybuf to NULL *before* to call
1911 * unblockClientWaitingData() to avoid processInputBuffer() will get
1912 * called. Also it is important to remove the file events after
1913 * this, because this call adds the READABLE event. */
1914 sdsfree(c
->querybuf
);
1916 if (c
->flags
& REDIS_BLOCKED
)
1917 unblockClientWaitingData(c
);
1919 /* Unsubscribe from all the pubsub channels */
1920 pubsubUnsubscribeAllChannels(c
,0);
1921 pubsubUnsubscribeAllPatterns(c
,0);
1922 dictRelease(c
->pubsub_channels
);
1923 listRelease(c
->pubsub_patterns
);
1924 /* Obvious cleanup */
1925 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1926 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1927 listRelease(c
->reply
);
1930 /* Remove from the list of clients */
1931 ln
= listSearchKey(server
.clients
,c
);
1932 redisAssert(ln
!= NULL
);
1933 listDelNode(server
.clients
,ln
);
1934 /* Remove from the list of clients waiting for swapped keys */
1935 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1936 ln
= listSearchKey(server
.io_ready_clients
,c
);
1938 listDelNode(server
.io_ready_clients
,ln
);
1939 server
.vm_blocked_clients
--;
1942 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1943 ln
= listFirst(c
->io_keys
);
1944 dontWaitForSwappedKey(c
,ln
->value
);
1946 listRelease(c
->io_keys
);
1947 /* Master/slave cleanup */
1948 if (c
->flags
& REDIS_SLAVE
) {
1949 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1951 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1952 ln
= listSearchKey(l
,c
);
1953 redisAssert(ln
!= NULL
);
1956 if (c
->flags
& REDIS_MASTER
) {
1957 server
.master
= NULL
;
1958 server
.replstate
= REDIS_REPL_CONNECT
;
1960 /* Release memory */
1963 freeClientMultiState(c
);
1967 #define GLUEREPLY_UP_TO (1024)
1968 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1970 char buf
[GLUEREPLY_UP_TO
];
1975 listRewind(c
->reply
,&li
);
1976 while((ln
= listNext(&li
))) {
1980 objlen
= sdslen(o
->ptr
);
1981 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1982 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1984 listDelNode(c
->reply
,ln
);
1986 if (copylen
== 0) return;
1990 /* Now the output buffer is empty, add the new single element */
1991 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1992 listAddNodeHead(c
->reply
,o
);
1995 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1996 redisClient
*c
= privdata
;
1997 int nwritten
= 0, totwritten
= 0, objlen
;
2000 REDIS_NOTUSED(mask
);
2002 /* Use writev() if we have enough buffers to send */
2003 if (!server
.glueoutputbuf
&&
2004 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2005 !(c
->flags
& REDIS_MASTER
))
2007 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2011 while(listLength(c
->reply
)) {
2012 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2013 glueReplyBuffersIfNeeded(c
);
2015 o
= listNodeValue(listFirst(c
->reply
));
2016 objlen
= sdslen(o
->ptr
);
2019 listDelNode(c
->reply
,listFirst(c
->reply
));
2023 if (c
->flags
& REDIS_MASTER
) {
2024 /* Don't reply to a master */
2025 nwritten
= objlen
- c
->sentlen
;
2027 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2028 if (nwritten
<= 0) break;
2030 c
->sentlen
+= nwritten
;
2031 totwritten
+= nwritten
;
2032 /* If we fully sent the object on head go to the next one */
2033 if (c
->sentlen
== objlen
) {
2034 listDelNode(c
->reply
,listFirst(c
->reply
));
2037 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2038 * bytes, in a single threaded server it's a good idea to serve
2039 * other clients as well, even if a very large request comes from
2040 * super fast link that is always able to accept data (in real world
2041 * scenario think about 'KEYS *' against the loopback interfae) */
2042 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2044 if (nwritten
== -1) {
2045 if (errno
== EAGAIN
) {
2048 redisLog(REDIS_VERBOSE
,
2049 "Error writing to client: %s", strerror(errno
));
2054 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2055 if (listLength(c
->reply
) == 0) {
2057 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2061 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2063 redisClient
*c
= privdata
;
2064 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2066 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2067 int offset
, ion
= 0;
2069 REDIS_NOTUSED(mask
);
2072 while (listLength(c
->reply
)) {
2073 offset
= c
->sentlen
;
2077 /* fill-in the iov[] array */
2078 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2079 o
= listNodeValue(node
);
2080 objlen
= sdslen(o
->ptr
);
2082 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2085 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2086 break; /* no more iovecs */
2088 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2089 iov
[ion
].iov_len
= objlen
- offset
;
2090 willwrite
+= objlen
- offset
;
2091 offset
= 0; /* just for the first item */
2098 /* write all collected blocks at once */
2099 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2100 if (errno
!= EAGAIN
) {
2101 redisLog(REDIS_VERBOSE
,
2102 "Error writing to client: %s", strerror(errno
));
2109 totwritten
+= nwritten
;
2110 offset
= c
->sentlen
;
2112 /* remove written robjs from c->reply */
2113 while (nwritten
&& listLength(c
->reply
)) {
2114 o
= listNodeValue(listFirst(c
->reply
));
2115 objlen
= sdslen(o
->ptr
);
2117 if(nwritten
>= objlen
- offset
) {
2118 listDelNode(c
->reply
, listFirst(c
->reply
));
2119 nwritten
-= objlen
- offset
;
2123 c
->sentlen
+= nwritten
;
2131 c
->lastinteraction
= time(NULL
);
2133 if (listLength(c
->reply
) == 0) {
2135 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2139 static struct redisCommand
*lookupCommand(char *name
) {
2141 while(cmdTable
[j
].name
!= NULL
) {
2142 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2148 /* resetClient prepare the client to process the next command */
2149 static void resetClient(redisClient
*c
) {
2155 /* Call() is the core of Redis execution of a command */
2156 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2159 dirty
= server
.dirty
;
2161 dirty
= server
.dirty
-dirty
;
2163 if (server
.appendonly
&& dirty
)
2164 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2165 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2166 listLength(server
.slaves
))
2167 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2168 if (listLength(server
.monitors
))
2169 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2170 server
.stat_numcommands
++;
2173 /* If this function gets called we already read a whole
2174 * command, argments are in the client argv/argc fields.
2175 * processCommand() execute the command or prepare the
2176 * server for a bulk read from the client.
2178 * If 1 is returned the client is still alive and valid and
2179 * and other operations can be performed by the caller. Otherwise
2180 * if 0 is returned the client was destroied (i.e. after QUIT). */
2181 static int processCommand(redisClient
*c
) {
2182 struct redisCommand
*cmd
;
2184 /* Free some memory if needed (maxmemory setting) */
2185 if (server
.maxmemory
) freeMemoryIfNeeded();
2187 /* Handle the multi bulk command type. This is an alternative protocol
2188 * supported by Redis in order to receive commands that are composed of
2189 * multiple binary-safe "bulk" arguments. The latency of processing is
2190 * a bit higher but this allows things like multi-sets, so if this
2191 * protocol is used only for MSET and similar commands this is a big win. */
2192 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2193 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2194 if (c
->multibulk
<= 0) {
2198 decrRefCount(c
->argv
[c
->argc
-1]);
2202 } else if (c
->multibulk
) {
2203 if (c
->bulklen
== -1) {
2204 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2205 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2209 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2210 decrRefCount(c
->argv
[0]);
2211 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2213 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2218 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2222 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2223 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2227 if (c
->multibulk
== 0) {
2231 /* Here we need to swap the multi-bulk argc/argv with the
2232 * normal argc/argv of the client structure. */
2234 c
->argv
= c
->mbargv
;
2235 c
->mbargv
= auxargv
;
2238 c
->argc
= c
->mbargc
;
2239 c
->mbargc
= auxargc
;
2241 /* We need to set bulklen to something different than -1
2242 * in order for the code below to process the command without
2243 * to try to read the last argument of a bulk command as
2244 * a special argument. */
2246 /* continue below and process the command */
2253 /* -- end of multi bulk commands processing -- */
2255 /* The QUIT command is handled as a special case. Normal command
2256 * procs are unable to close the client connection safely */
2257 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2262 /* Now lookup the command and check ASAP about trivial error conditions
2263 * such wrong arity, bad command name and so forth. */
2264 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2267 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2268 (char*)c
->argv
[0]->ptr
));
2271 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2272 (c
->argc
< -cmd
->arity
)) {
2274 sdscatprintf(sdsempty(),
2275 "-ERR wrong number of arguments for '%s' command\r\n",
2279 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2280 /* This is a bulk command, we have to read the last argument yet. */
2281 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2283 decrRefCount(c
->argv
[c
->argc
-1]);
2284 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2286 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2291 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2292 /* It is possible that the bulk read is already in the
2293 * buffer. Check this condition and handle it accordingly.
2294 * This is just a fast path, alternative to call processInputBuffer().
2295 * It's a good idea since the code is small and this condition
2296 * happens most of the times. */
2297 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2298 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2300 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2302 /* Otherwise return... there is to read the last argument
2303 * from the socket. */
2307 /* Let's try to encode the bulk object to save space. */
2308 if (cmd
->flags
& REDIS_CMD_BULK
)
2309 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2311 /* Check if the user is authenticated */
2312 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2313 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2318 /* Handle the maxmemory directive */
2319 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2320 zmalloc_used_memory() > server
.maxmemory
)
2322 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2327 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2328 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2330 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2331 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2332 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2337 /* Exec the command */
2338 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2339 queueMultiCommand(c
,cmd
);
2340 addReply(c
,shared
.queued
);
2342 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2343 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2347 /* Prepare the client for the next command */
2352 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2357 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2358 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2359 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2360 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2363 if (argc
<= REDIS_STATIC_ARGS
) {
2366 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2369 lenobj
= createObject(REDIS_STRING
,
2370 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2371 lenobj
->refcount
= 0;
2372 outv
[outc
++] = lenobj
;
2373 for (j
= 0; j
< argc
; j
++) {
2374 lenobj
= createObject(REDIS_STRING
,
2375 sdscatprintf(sdsempty(),"$%lu\r\n",
2376 (unsigned long) stringObjectLen(argv
[j
])));
2377 lenobj
->refcount
= 0;
2378 outv
[outc
++] = lenobj
;
2379 outv
[outc
++] = argv
[j
];
2380 outv
[outc
++] = shared
.crlf
;
2383 /* Increment all the refcounts at start and decrement at end in order to
2384 * be sure to free objects if there is no slave in a replication state
2385 * able to be feed with commands */
2386 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2387 listRewind(slaves
,&li
);
2388 while((ln
= listNext(&li
))) {
2389 redisClient
*slave
= ln
->value
;
2391 /* Don't feed slaves that are still waiting for BGSAVE to start */
2392 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2394 /* Feed all the other slaves, MONITORs and so on */
2395 if (slave
->slaveseldb
!= dictid
) {
2399 case 0: selectcmd
= shared
.select0
; break;
2400 case 1: selectcmd
= shared
.select1
; break;
2401 case 2: selectcmd
= shared
.select2
; break;
2402 case 3: selectcmd
= shared
.select3
; break;
2403 case 4: selectcmd
= shared
.select4
; break;
2404 case 5: selectcmd
= shared
.select5
; break;
2405 case 6: selectcmd
= shared
.select6
; break;
2406 case 7: selectcmd
= shared
.select7
; break;
2407 case 8: selectcmd
= shared
.select8
; break;
2408 case 9: selectcmd
= shared
.select9
; break;
2410 selectcmd
= createObject(REDIS_STRING
,
2411 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2412 selectcmd
->refcount
= 0;
2415 addReply(slave
,selectcmd
);
2416 slave
->slaveseldb
= dictid
;
2418 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2420 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2421 if (outv
!= static_outv
) zfree(outv
);
2424 static void processInputBuffer(redisClient
*c
) {
2426 /* Before to process the input buffer, make sure the client is not
2427 * waitig for a blocking operation such as BLPOP. Note that the first
2428 * iteration the client is never blocked, otherwise the processInputBuffer
2429 * would not be called at all, but after the execution of the first commands
2430 * in the input buffer the client may be blocked, and the "goto again"
2431 * will try to reiterate. The following line will make it return asap. */
2432 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2433 if (c
->bulklen
== -1) {
2434 /* Read the first line of the query */
2435 char *p
= strchr(c
->querybuf
,'\n');
2442 query
= c
->querybuf
;
2443 c
->querybuf
= sdsempty();
2444 querylen
= 1+(p
-(query
));
2445 if (sdslen(query
) > querylen
) {
2446 /* leave data after the first line of the query in the buffer */
2447 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2449 *p
= '\0'; /* remove "\n" */
2450 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2451 sdsupdatelen(query
);
2453 /* Now we can split the query in arguments */
2454 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2457 if (c
->argv
) zfree(c
->argv
);
2458 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2460 for (j
= 0; j
< argc
; j
++) {
2461 if (sdslen(argv
[j
])) {
2462 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2470 /* Execute the command. If the client is still valid
2471 * after processCommand() return and there is something
2472 * on the query buffer try to process the next command. */
2473 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2475 /* Nothing to process, argc == 0. Just process the query
2476 * buffer if it's not empty or return to the caller */
2477 if (sdslen(c
->querybuf
)) goto again
;
2480 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2481 redisLog(REDIS_VERBOSE
, "Client protocol error");
2486 /* Bulk read handling. Note that if we are at this point
2487 the client already sent a command terminated with a newline,
2488 we are reading the bulk data that is actually the last
2489 argument of the command. */
2490 int qbl
= sdslen(c
->querybuf
);
2492 if (c
->bulklen
<= qbl
) {
2493 /* Copy everything but the final CRLF as final argument */
2494 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2496 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2497 /* Process the command. If the client is still valid after
2498 * the processing and there is more data in the buffer
2499 * try to parse it. */
2500 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2506 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2507 redisClient
*c
= (redisClient
*) privdata
;
2508 char buf
[REDIS_IOBUF_LEN
];
2511 REDIS_NOTUSED(mask
);
2513 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2515 if (errno
== EAGAIN
) {
2518 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2522 } else if (nread
== 0) {
2523 redisLog(REDIS_VERBOSE
, "Client closed connection");
2528 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2529 c
->lastinteraction
= time(NULL
);
2533 processInputBuffer(c
);
2536 static int selectDb(redisClient
*c
, int id
) {
2537 if (id
< 0 || id
>= server
.dbnum
)
2539 c
->db
= &server
.db
[id
];
2543 static void *dupClientReplyValue(void *o
) {
2544 incrRefCount((robj
*)o
);
2548 static int listMatchObjects(void *a
, void *b
) {
2549 return compareStringObjects(a
,b
) == 0;
2552 static redisClient
*createClient(int fd
) {
2553 redisClient
*c
= zmalloc(sizeof(*c
));
2555 anetNonBlock(NULL
,fd
);
2556 anetTcpNoDelay(NULL
,fd
);
2557 if (!c
) return NULL
;
2560 c
->querybuf
= sdsempty();
2569 c
->lastinteraction
= time(NULL
);
2570 c
->authenticated
= 0;
2571 c
->replstate
= REDIS_REPL_NONE
;
2572 c
->reply
= listCreate();
2573 listSetFreeMethod(c
->reply
,decrRefCount
);
2574 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2575 c
->blockingkeys
= NULL
;
2576 c
->blockingkeysnum
= 0;
2577 c
->io_keys
= listCreate();
2578 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2579 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2580 c
->pubsub_patterns
= listCreate();
2581 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2582 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2583 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2584 readQueryFromClient
, c
) == AE_ERR
) {
2588 listAddNodeTail(server
.clients
,c
);
2589 initClientMultiState(c
);
2593 static void addReply(redisClient
*c
, robj
*obj
) {
2594 if (listLength(c
->reply
) == 0 &&
2595 (c
->replstate
== REDIS_REPL_NONE
||
2596 c
->replstate
== REDIS_REPL_ONLINE
) &&
2597 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2598 sendReplyToClient
, c
) == AE_ERR
) return;
2600 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2601 obj
= dupStringObject(obj
);
2602 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2604 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2607 static void addReplySds(redisClient
*c
, sds s
) {
2608 robj
*o
= createObject(REDIS_STRING
,s
);
2613 static void addReplyDouble(redisClient
*c
, double d
) {
2616 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2617 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2618 (unsigned long) strlen(buf
),buf
));
2621 static void addReplyLong(redisClient
*c
, long l
) {
2626 addReply(c
,shared
.czero
);
2628 } else if (l
== 1) {
2629 addReply(c
,shared
.cone
);
2632 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2633 addReplySds(c
,sdsnewlen(buf
,len
));
2636 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2641 addReply(c
,shared
.czero
);
2643 } else if (ll
== 1) {
2644 addReply(c
,shared
.cone
);
2647 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2648 addReplySds(c
,sdsnewlen(buf
,len
));
2651 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2656 addReply(c
,shared
.czero
);
2658 } else if (ul
== 1) {
2659 addReply(c
,shared
.cone
);
2662 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2663 addReplySds(c
,sdsnewlen(buf
,len
));
2666 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2669 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2670 len
= sdslen(obj
->ptr
);
2672 long n
= (long)obj
->ptr
;
2674 /* Compute how many bytes will take this integer as a radix 10 string */
2680 while((n
= n
/10) != 0) {
2684 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2687 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2688 addReplyBulkLen(c
,obj
);
2690 addReply(c
,shared
.crlf
);
2693 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2694 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2696 addReply(c
,shared
.nullbulk
);
2698 robj
*o
= createStringObject(s
,strlen(s
));
2704 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2709 REDIS_NOTUSED(mask
);
2710 REDIS_NOTUSED(privdata
);
2712 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2713 if (cfd
== AE_ERR
) {
2714 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2717 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2718 if ((c
= createClient(cfd
)) == NULL
) {
2719 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2720 close(cfd
); /* May be already closed, just ingore errors */
2723 /* If maxclient directive is set and this is one client more... close the
2724 * connection. Note that we create the client instead to check before
2725 * for this condition, since now the socket is already set in nonblocking
2726 * mode and we can send an error for free using the Kernel I/O */
2727 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2728 char *err
= "-ERR max number of clients reached\r\n";
2730 /* That's a best effort error message, don't check write errors */
2731 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2732 /* Nothing to do, Just to avoid the warning... */
2737 server
.stat_numconnections
++;
2740 /* ======================= Redis objects implementation ===================== */
2742 static robj
*createObject(int type
, void *ptr
) {
2745 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2746 if (listLength(server
.objfreelist
)) {
2747 listNode
*head
= listFirst(server
.objfreelist
);
2748 o
= listNodeValue(head
);
2749 listDelNode(server
.objfreelist
,head
);
2750 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2752 if (server
.vm_enabled
) {
2753 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2754 o
= zmalloc(sizeof(*o
));
2756 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2760 o
->encoding
= REDIS_ENCODING_RAW
;
2763 if (server
.vm_enabled
) {
2764 /* Note that this code may run in the context of an I/O thread
2765 * and accessing to server.unixtime in theory is an error
2766 * (no locks). But in practice this is safe, and even if we read
2767 * garbage Redis will not fail, as it's just a statistical info */
2768 o
->vm
.atime
= server
.unixtime
;
2769 o
->storage
= REDIS_VM_MEMORY
;
2774 static robj
*createStringObject(char *ptr
, size_t len
) {
2775 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2778 static robj
*createStringObjectFromLongLong(long long value
) {
2780 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2781 incrRefCount(shared
.integers
[value
]);
2782 o
= shared
.integers
[value
];
2784 o
= createObject(REDIS_STRING
, NULL
);
2785 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2786 o
->encoding
= REDIS_ENCODING_INT
;
2787 o
->ptr
= (void*)((long)value
);
2789 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2795 static robj
*dupStringObject(robj
*o
) {
2796 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2797 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2800 static robj
*createListObject(void) {
2801 list
*l
= listCreate();
2803 listSetFreeMethod(l
,decrRefCount
);
2804 return createObject(REDIS_LIST
,l
);
2807 static robj
*createSetObject(void) {
2808 dict
*d
= dictCreate(&setDictType
,NULL
);
2809 return createObject(REDIS_SET
,d
);
2812 static robj
*createHashObject(void) {
2813 /* All the Hashes start as zipmaps. Will be automatically converted
2814 * into hash tables if there are enough elements or big elements
2816 unsigned char *zm
= zipmapNew();
2817 robj
*o
= createObject(REDIS_HASH
,zm
);
2818 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2822 static robj
*createZsetObject(void) {
2823 zset
*zs
= zmalloc(sizeof(*zs
));
2825 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2826 zs
->zsl
= zslCreate();
2827 return createObject(REDIS_ZSET
,zs
);
2830 static void freeStringObject(robj
*o
) {
2831 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2836 static void freeListObject(robj
*o
) {
2837 listRelease((list
*) o
->ptr
);
2840 static void freeSetObject(robj
*o
) {
2841 dictRelease((dict
*) o
->ptr
);
2844 static void freeZsetObject(robj
*o
) {
2847 dictRelease(zs
->dict
);
2852 static void freeHashObject(robj
*o
) {
2853 switch (o
->encoding
) {
2854 case REDIS_ENCODING_HT
:
2855 dictRelease((dict
*) o
->ptr
);
2857 case REDIS_ENCODING_ZIPMAP
:
2861 redisPanic("Unknown hash encoding type");
2866 static void incrRefCount(robj
*o
) {
2870 static void decrRefCount(void *obj
) {
2873 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2874 /* Object is a key of a swapped out value, or in the process of being
2876 if (server
.vm_enabled
&&
2877 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2879 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2880 redisAssert(o
->type
== REDIS_STRING
);
2881 freeStringObject(o
);
2882 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2883 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2884 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2885 !listAddNodeHead(server
.objfreelist
,o
))
2887 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2888 server
.vm_stats_swapped_objects
--;
2891 /* Object is in memory, or in the process of being swapped out. */
2892 if (--(o
->refcount
) == 0) {
2893 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2894 vmCancelThreadedIOJob(obj
);
2896 case REDIS_STRING
: freeStringObject(o
); break;
2897 case REDIS_LIST
: freeListObject(o
); break;
2898 case REDIS_SET
: freeSetObject(o
); break;
2899 case REDIS_ZSET
: freeZsetObject(o
); break;
2900 case REDIS_HASH
: freeHashObject(o
); break;
2901 default: redisPanic("Unknown object type"); break;
2903 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2904 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2905 !listAddNodeHead(server
.objfreelist
,o
))
2907 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2911 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2912 dictEntry
*de
= dictFind(db
->dict
,key
);
2914 robj
*key
= dictGetEntryKey(de
);
2915 robj
*val
= dictGetEntryVal(de
);
2917 if (server
.vm_enabled
) {
2918 if (key
->storage
== REDIS_VM_MEMORY
||
2919 key
->storage
== REDIS_VM_SWAPPING
)
2921 /* If we were swapping the object out, stop it, this key
2923 if (key
->storage
== REDIS_VM_SWAPPING
)
2924 vmCancelThreadedIOJob(key
);
2925 /* Update the access time of the key for the aging algorithm. */
2926 key
->vm
.atime
= server
.unixtime
;
2928 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2930 /* Our value was swapped on disk. Bring it at home. */
2931 redisAssert(val
== NULL
);
2932 val
= vmLoadObject(key
);
2933 dictGetEntryVal(de
) = val
;
2935 /* Clients blocked by the VM subsystem may be waiting for
2937 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2946 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2947 expireIfNeeded(db
,key
);
2948 return lookupKey(db
,key
);
2951 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2952 deleteIfVolatile(db
,key
);
2953 return lookupKey(db
,key
);
2956 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2957 robj
*o
= lookupKeyRead(c
->db
, key
);
2958 if (!o
) addReply(c
,reply
);
2962 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2963 robj
*o
= lookupKeyWrite(c
->db
, key
);
2964 if (!o
) addReply(c
,reply
);
2968 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2969 if (o
->type
!= type
) {
2970 addReply(c
,shared
.wrongtypeerr
);
2976 static int deleteKey(redisDb
*db
, robj
*key
) {
2979 /* We need to protect key from destruction: after the first dictDelete()
2980 * it may happen that 'key' is no longer valid if we don't increment
2981 * it's count. This may happen when we get the object reference directly
2982 * from the hash table with dictRandomKey() or dict iterators */
2984 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2985 retval
= dictDelete(db
->dict
,key
);
2988 return retval
== DICT_OK
;
2991 /* Check if the nul-terminated string 's' can be represented by a long
2992 * (that is, is a number that fits into long without any other space or
2993 * character before or after the digits).
2995 * If so, the function returns REDIS_OK and *longval is set to the value
2996 * of the number. Otherwise REDIS_ERR is returned */
2997 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2998 char buf
[32], *endptr
;
3002 value
= strtol(s
, &endptr
, 10);
3003 if (endptr
[0] != '\0') return REDIS_ERR
;
3004 slen
= snprintf(buf
,32,"%ld",value
);
3006 /* If the number converted back into a string is not identical
3007 * then it's not possible to encode the string as integer */
3008 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3009 if (longval
) *longval
= value
;
3013 /* Try to encode a string object in order to save space */
3014 static robj
*tryObjectEncoding(robj
*o
) {
3018 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3019 return o
; /* Already encoded */
3021 /* It's not safe to encode shared objects: shared objects can be shared
3022 * everywhere in the "object space" of Redis. Encoded objects can only
3023 * appear as "values" (and not, for instance, as keys) */
3024 if (o
->refcount
> 1) return o
;
3026 /* Currently we try to encode only strings */
3027 redisAssert(o
->type
== REDIS_STRING
);
3029 /* Check if we can represent this string as a long integer */
3030 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3032 /* Ok, this object can be encoded */
3033 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3035 incrRefCount(shared
.integers
[value
]);
3036 return shared
.integers
[value
];
3038 o
->encoding
= REDIS_ENCODING_INT
;
3040 o
->ptr
= (void*) value
;
3045 /* Get a decoded version of an encoded object (returned as a new object).
3046 * If the object is already raw-encoded just increment the ref count. */
3047 static robj
*getDecodedObject(robj
*o
) {
3050 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3054 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3057 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3058 dec
= createStringObject(buf
,strlen(buf
));
3061 redisPanic("Unknown encoding type");
3065 /* Compare two string objects via strcmp() or alike.
3066 * Note that the objects may be integer-encoded. In such a case we
3067 * use snprintf() to get a string representation of the numbers on the stack
3068 * and compare the strings, it's much faster than calling getDecodedObject().
3070 * Important note: if objects are not integer encoded, but binary-safe strings,
3071 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3073 static int compareStringObjects(robj
*a
, robj
*b
) {
3074 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3075 char bufa
[128], bufb
[128], *astr
, *bstr
;
3078 if (a
== b
) return 0;
3079 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3080 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3086 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3087 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3093 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3096 static size_t stringObjectLen(robj
*o
) {
3097 redisAssert(o
->type
== REDIS_STRING
);
3098 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3099 return sdslen(o
->ptr
);
3103 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3107 static int getDoubleFromObject(robj
*o
, double *target
) {
3114 redisAssert(o
->type
== REDIS_STRING
);
3115 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3116 value
= strtod(o
->ptr
, &eptr
);
3117 if (eptr
[0] != '\0') return REDIS_ERR
;
3118 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3119 value
= (long)o
->ptr
;
3121 redisAssert(1 != 1);
3129 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3131 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3133 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3135 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3144 static int getLongLongFromObject(robj
*o
, long long *target
) {
3151 redisAssert(o
->type
== REDIS_STRING
);
3152 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3153 value
= strtoll(o
->ptr
, &eptr
, 10);
3154 if (eptr
[0] != '\0') return REDIS_ERR
;
3155 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3156 value
= (long)o
->ptr
;
3158 redisAssert(1 != 1);
3166 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3168 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3170 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3172 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3181 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3184 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3185 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3187 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3189 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3198 /*============================ RDB saving/loading =========================== */
3200 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3201 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3205 static int rdbSaveTime(FILE *fp
, time_t t
) {
3206 int32_t t32
= (int32_t) t
;
3207 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3211 /* check rdbLoadLen() comments for more info */
3212 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3213 unsigned char buf
[2];
3216 /* Save a 6 bit len */
3217 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3218 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3219 } else if (len
< (1<<14)) {
3220 /* Save a 14 bit len */
3221 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3223 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3225 /* Save a 32 bit len */
3226 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3227 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3229 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3234 /* String objects in the form "2391" "-100" without any space and with a
3235 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3236 * encoded as integers to save space */
3237 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3239 char *endptr
, buf
[32];
3241 /* Check if it's possible to encode this value as a number */
3242 value
= strtoll(s
, &endptr
, 10);
3243 if (endptr
[0] != '\0') return 0;
3244 snprintf(buf
,32,"%lld",value
);
3246 /* If the number converted back into a string is not identical
3247 * then it's not possible to encode the string as integer */
3248 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3250 /* Finally check if it fits in our ranges */
3251 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3252 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3253 enc
[1] = value
&0xFF;
3255 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3256 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3257 enc
[1] = value
&0xFF;
3258 enc
[2] = (value
>>8)&0xFF;
3260 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3261 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3262 enc
[1] = value
&0xFF;
3263 enc
[2] = (value
>>8)&0xFF;
3264 enc
[3] = (value
>>16)&0xFF;
3265 enc
[4] = (value
>>24)&0xFF;
3272 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3273 size_t comprlen
, outlen
;
3277 /* We require at least four bytes compression for this to be worth it */
3278 if (len
<= 4) return 0;
3280 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3281 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3282 if (comprlen
== 0) {
3286 /* Data compressed! Let's save it on disk */
3287 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3288 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3289 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3290 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3291 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3300 /* Save a string objet as [len][data] on disk. If the object is a string
3301 * representation of an integer value we try to safe it in a special form */
3302 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3305 /* Try integer encoding */
3307 unsigned char buf
[5];
3308 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3309 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3314 /* Try LZF compression - under 20 bytes it's unable to compress even
3315 * aaaaaaaaaaaaaaaaaa so skip it */
3316 if (server
.rdbcompression
&& len
> 20) {
3319 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3320 if (retval
== -1) return -1;
3321 if (retval
> 0) return 0;
3322 /* retval == 0 means data can't be compressed, save the old way */
3325 /* Store verbatim */
3326 if (rdbSaveLen(fp
,len
) == -1) return -1;
3327 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3331 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3332 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3335 /* Avoid incr/decr ref count business when possible.
3336 * This plays well with copy-on-write given that we are probably
3337 * in a child process (BGSAVE). Also this makes sure key objects
3338 * of swapped objects are not incRefCount-ed (an assert does not allow
3339 * this in order to avoid bugs) */
3340 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3341 obj
= getDecodedObject(obj
);
3342 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3345 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3350 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3351 * 8 bit integer specifing the length of the representation.
3352 * This 8 bit integer has special values in order to specify the following
3358 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3359 unsigned char buf
[128];
3365 } else if (!isfinite(val
)) {
3367 buf
[0] = (val
< 0) ? 255 : 254;
3369 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3370 buf
[0] = strlen((char*)buf
+1);
3373 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3377 /* Save a Redis object. */
3378 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3379 if (o
->type
== REDIS_STRING
) {
3380 /* Save a string value */
3381 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3382 } else if (o
->type
== REDIS_LIST
) {
3383 /* Save a list value */
3384 list
*list
= o
->ptr
;
3388 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3389 listRewind(list
,&li
);
3390 while((ln
= listNext(&li
))) {
3391 robj
*eleobj
= listNodeValue(ln
);
3393 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3395 } else if (o
->type
== REDIS_SET
) {
3396 /* Save a set value */
3398 dictIterator
*di
= dictGetIterator(set
);
3401 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3402 while((de
= dictNext(di
)) != NULL
) {
3403 robj
*eleobj
= dictGetEntryKey(de
);
3405 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3407 dictReleaseIterator(di
);
3408 } else if (o
->type
== REDIS_ZSET
) {
3409 /* Save a set value */
3411 dictIterator
*di
= dictGetIterator(zs
->dict
);
3414 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3415 while((de
= dictNext(di
)) != NULL
) {
3416 robj
*eleobj
= dictGetEntryKey(de
);
3417 double *score
= dictGetEntryVal(de
);
3419 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3420 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3422 dictReleaseIterator(di
);
3423 } else if (o
->type
== REDIS_HASH
) {
3424 /* Save a hash value */
3425 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3426 unsigned char *p
= zipmapRewind(o
->ptr
);
3427 unsigned int count
= zipmapLen(o
->ptr
);
3428 unsigned char *key
, *val
;
3429 unsigned int klen
, vlen
;
3431 if (rdbSaveLen(fp
,count
) == -1) return -1;
3432 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3433 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3434 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3437 dictIterator
*di
= dictGetIterator(o
->ptr
);
3440 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3441 while((de
= dictNext(di
)) != NULL
) {
3442 robj
*key
= dictGetEntryKey(de
);
3443 robj
*val
= dictGetEntryVal(de
);
3445 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3446 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3448 dictReleaseIterator(di
);
3451 redisPanic("Unknown object type");
3456 /* Return the length the object will have on disk if saved with
3457 * the rdbSaveObject() function. Currently we use a trick to get
3458 * this length with very little changes to the code. In the future
3459 * we could switch to a faster solution. */
3460 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3461 if (fp
== NULL
) fp
= server
.devnull
;
3463 assert(rdbSaveObject(fp
,o
) != 1);
3467 /* Return the number of pages required to save this object in the swap file */
3468 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3469 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3471 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3474 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3475 static int rdbSave(char *filename
) {
3476 dictIterator
*di
= NULL
;
3481 time_t now
= time(NULL
);
3483 /* Wait for I/O therads to terminate, just in case this is a
3484 * foreground-saving, to avoid seeking the swap file descriptor at the
3486 if (server
.vm_enabled
)
3487 waitEmptyIOJobsQueue();
3489 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3490 fp
= fopen(tmpfile
,"w");
3492 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3495 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3496 for (j
= 0; j
< server
.dbnum
; j
++) {
3497 redisDb
*db
= server
.db
+j
;
3499 if (dictSize(d
) == 0) continue;
3500 di
= dictGetIterator(d
);
3506 /* Write the SELECT DB opcode */
3507 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3508 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3510 /* Iterate this DB writing every entry */
3511 while((de
= dictNext(di
)) != NULL
) {
3512 robj
*key
= dictGetEntryKey(de
);
3513 robj
*o
= dictGetEntryVal(de
);
3514 time_t expiretime
= getExpire(db
,key
);
3516 /* Save the expire time */
3517 if (expiretime
!= -1) {
3518 /* If this key is already expired skip it */
3519 if (expiretime
< now
) continue;
3520 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3521 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3523 /* Save the key and associated value. This requires special
3524 * handling if the value is swapped out. */
3525 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3526 key
->storage
== REDIS_VM_SWAPPING
) {
3527 /* Save type, key, value */
3528 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3529 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3530 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3532 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3534 /* Get a preview of the object in memory */
3535 po
= vmPreviewObject(key
);
3536 /* Save type, key, value */
3537 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3538 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3539 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3540 /* Remove the loaded object from memory */
3544 dictReleaseIterator(di
);
3547 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3549 /* Make sure data will not remain on the OS's output buffers */
3554 /* Use RENAME to make sure the DB file is changed atomically only
3555 * if the generate DB file is ok. */
3556 if (rename(tmpfile
,filename
) == -1) {
3557 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3561 redisLog(REDIS_NOTICE
,"DB saved on disk");
3563 server
.lastsave
= time(NULL
);
3569 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3570 if (di
) dictReleaseIterator(di
);
3574 static int rdbSaveBackground(char *filename
) {
3577 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3578 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3579 if ((childpid
= fork()) == 0) {
3581 if (server
.vm_enabled
) vmReopenSwapFile();
3583 if (rdbSave(filename
) == REDIS_OK
) {
3590 if (childpid
== -1) {
3591 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3595 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3596 server
.bgsavechildpid
= childpid
;
3597 updateDictResizePolicy();
3600 return REDIS_OK
; /* unreached */
3603 static void rdbRemoveTempFile(pid_t childpid
) {
3606 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3610 static int rdbLoadType(FILE *fp
) {
3612 if (fread(&type
,1,1,fp
) == 0) return -1;
3616 static time_t rdbLoadTime(FILE *fp
) {
3618 if (fread(&t32
,4,1,fp
) == 0) return -1;
3619 return (time_t) t32
;
3622 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3623 * of this file for a description of how this are stored on disk.
3625 * isencoded is set to 1 if the readed length is not actually a length but
3626 * an "encoding type", check the above comments for more info */
3627 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3628 unsigned char buf
[2];
3632 if (isencoded
) *isencoded
= 0;
3633 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3634 type
= (buf
[0]&0xC0)>>6;
3635 if (type
== REDIS_RDB_6BITLEN
) {
3636 /* Read a 6 bit len */
3638 } else if (type
== REDIS_RDB_ENCVAL
) {
3639 /* Read a 6 bit len encoding type */
3640 if (isencoded
) *isencoded
= 1;
3642 } else if (type
== REDIS_RDB_14BITLEN
) {
3643 /* Read a 14 bit len */
3644 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3645 return ((buf
[0]&0x3F)<<8)|buf
[1];
3647 /* Read a 32 bit len */
3648 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3653 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3654 unsigned char enc
[4];
3657 if (enctype
== REDIS_RDB_ENC_INT8
) {
3658 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3659 val
= (signed char)enc
[0];
3660 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3662 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3663 v
= enc
[0]|(enc
[1]<<8);
3665 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3667 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3668 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3671 val
= 0; /* anti-warning */
3672 redisPanic("Unknown RDB integer encoding type");
3674 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3677 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3678 unsigned int len
, clen
;
3679 unsigned char *c
= NULL
;
3682 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3683 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3684 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3685 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3686 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3687 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3689 return createObject(REDIS_STRING
,val
);
3696 static robj
*rdbLoadStringObject(FILE*fp
) {
3701 len
= rdbLoadLen(fp
,&isencoded
);
3704 case REDIS_RDB_ENC_INT8
:
3705 case REDIS_RDB_ENC_INT16
:
3706 case REDIS_RDB_ENC_INT32
:
3707 return rdbLoadIntegerObject(fp
,len
);
3708 case REDIS_RDB_ENC_LZF
:
3709 return rdbLoadLzfStringObject(fp
);
3711 redisPanic("Unknown RDB encoding type");
3715 if (len
== REDIS_RDB_LENERR
) return NULL
;
3716 val
= sdsnewlen(NULL
,len
);
3717 if (len
&& fread(val
,len
,1,fp
) == 0) {
3721 return createObject(REDIS_STRING
,val
);
3724 /* For information about double serialization check rdbSaveDoubleValue() */
3725 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3729 if (fread(&len
,1,1,fp
) == 0) return -1;
3731 case 255: *val
= R_NegInf
; return 0;
3732 case 254: *val
= R_PosInf
; return 0;
3733 case 253: *val
= R_Nan
; return 0;
3735 if (fread(buf
,len
,1,fp
) == 0) return -1;
3737 sscanf(buf
, "%lg", val
);
3742 /* Load a Redis object of the specified type from the specified file.
3743 * On success a newly allocated object is returned, otherwise NULL. */
3744 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3747 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3748 if (type
== REDIS_STRING
) {
3749 /* Read string value */
3750 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3751 o
= tryObjectEncoding(o
);
3752 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3753 /* Read list/set value */
3756 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3757 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3758 /* It's faster to expand the dict to the right size asap in order
3759 * to avoid rehashing */
3760 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3761 dictExpand(o
->ptr
,listlen
);
3762 /* Load every single element of the list/set */
3766 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3767 ele
= tryObjectEncoding(ele
);
3768 if (type
== REDIS_LIST
) {
3769 listAddNodeTail((list
*)o
->ptr
,ele
);
3771 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3774 } else if (type
== REDIS_ZSET
) {
3775 /* Read list/set value */
3779 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3780 o
= createZsetObject();
3782 /* Load every single element of the list/set */
3785 double *score
= zmalloc(sizeof(double));
3787 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3788 ele
= tryObjectEncoding(ele
);
3789 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3790 dictAdd(zs
->dict
,ele
,score
);
3791 zslInsert(zs
->zsl
,*score
,ele
);
3792 incrRefCount(ele
); /* added to skiplist */
3794 } else if (type
== REDIS_HASH
) {
3797 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3798 o
= createHashObject();
3799 /* Too many entries? Use an hash table. */
3800 if (hashlen
> server
.hash_max_zipmap_entries
)
3801 convertToRealHash(o
);
3802 /* Load every key/value, then set it into the zipmap or hash
3803 * table, as needed. */
3807 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3808 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3809 /* If we are using a zipmap and there are too big values
3810 * the object is converted to real hash table encoding. */
3811 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3812 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3813 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3815 convertToRealHash(o
);
3818 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3819 unsigned char *zm
= o
->ptr
;
3821 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3822 val
->ptr
,sdslen(val
->ptr
),NULL
);
3827 key
= tryObjectEncoding(key
);
3828 val
= tryObjectEncoding(val
);
3829 dictAdd((dict
*)o
->ptr
,key
,val
);
3833 redisPanic("Unknown object type");
3838 static int rdbLoad(char *filename
) {
3840 robj
*keyobj
= NULL
;
3842 int type
, retval
, rdbver
;
3843 dict
*d
= server
.db
[0].dict
;
3844 redisDb
*db
= server
.db
+0;
3846 time_t expiretime
= -1, now
= time(NULL
);
3847 long long loadedkeys
= 0;
3849 fp
= fopen(filename
,"r");
3850 if (!fp
) return REDIS_ERR
;
3851 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3853 if (memcmp(buf
,"REDIS",5) != 0) {
3855 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3858 rdbver
= atoi(buf
+5);
3861 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3868 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3869 if (type
== REDIS_EXPIRETIME
) {
3870 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3871 /* We read the time so we need to read the object type again */
3872 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3874 if (type
== REDIS_EOF
) break;
3875 /* Handle SELECT DB opcode as a special case */
3876 if (type
== REDIS_SELECTDB
) {
3877 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3879 if (dbid
>= (unsigned)server
.dbnum
) {
3880 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3883 db
= server
.db
+dbid
;
3888 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3890 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3891 /* Add the new object in the hash table */
3892 retval
= dictAdd(d
,keyobj
,o
);
3893 if (retval
== DICT_ERR
) {
3894 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3897 /* Set the expire time if needed */
3898 if (expiretime
!= -1) {
3899 setExpire(db
,keyobj
,expiretime
);
3900 /* Delete this key if already expired */
3901 if (expiretime
< now
) deleteKey(db
,keyobj
);
3905 /* Handle swapping while loading big datasets when VM is on */
3907 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3908 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3909 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3916 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3917 if (keyobj
) decrRefCount(keyobj
);
3918 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3920 return REDIS_ERR
; /* Just to avoid warning */
3923 /*================================== Commands =============================== */
3925 static void authCommand(redisClient
*c
) {
3926 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3927 c
->authenticated
= 1;
3928 addReply(c
,shared
.ok
);
3930 c
->authenticated
= 0;
3931 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3935 static void pingCommand(redisClient
*c
) {
3936 addReply(c
,shared
.pong
);
3939 static void echoCommand(redisClient
*c
) {
3940 addReplyBulk(c
,c
->argv
[1]);
3943 /*=================================== Strings =============================== */
3945 static void setGenericCommand(redisClient
*c
, int nx
) {
3948 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3949 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3950 if (retval
== DICT_ERR
) {
3952 /* If the key is about a swapped value, we want a new key object
3953 * to overwrite the old. So we delete the old key in the database.
3954 * This will also make sure that swap pages about the old object
3955 * will be marked as free. */
3956 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3957 incrRefCount(c
->argv
[1]);
3958 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3959 incrRefCount(c
->argv
[2]);
3961 addReply(c
,shared
.czero
);
3965 incrRefCount(c
->argv
[1]);
3966 incrRefCount(c
->argv
[2]);
3969 removeExpire(c
->db
,c
->argv
[1]);
3970 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3973 static void setCommand(redisClient
*c
) {
3974 setGenericCommand(c
,0);
3977 static void setnxCommand(redisClient
*c
) {
3978 setGenericCommand(c
,1);
3981 static int getGenericCommand(redisClient
*c
) {
3984 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3987 if (o
->type
!= REDIS_STRING
) {
3988 addReply(c
,shared
.wrongtypeerr
);
3996 static void getCommand(redisClient
*c
) {
3997 getGenericCommand(c
);
4000 static void getsetCommand(redisClient
*c
) {
4001 if (getGenericCommand(c
) == REDIS_ERR
) return;
4002 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4003 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4005 incrRefCount(c
->argv
[1]);
4007 incrRefCount(c
->argv
[2]);
4009 removeExpire(c
->db
,c
->argv
[1]);
4012 static void mgetCommand(redisClient
*c
) {
4015 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4016 for (j
= 1; j
< c
->argc
; j
++) {
4017 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4019 addReply(c
,shared
.nullbulk
);
4021 if (o
->type
!= REDIS_STRING
) {
4022 addReply(c
,shared
.nullbulk
);
4030 static void msetGenericCommand(redisClient
*c
, int nx
) {
4031 int j
, busykeys
= 0;
4033 if ((c
->argc
% 2) == 0) {
4034 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4037 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4038 * set nothing at all if at least one already key exists. */
4040 for (j
= 1; j
< c
->argc
; j
+= 2) {
4041 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4047 addReply(c
, shared
.czero
);
4051 for (j
= 1; j
< c
->argc
; j
+= 2) {
4054 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4055 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4056 if (retval
== DICT_ERR
) {
4057 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4058 incrRefCount(c
->argv
[j
+1]);
4060 incrRefCount(c
->argv
[j
]);
4061 incrRefCount(c
->argv
[j
+1]);
4063 removeExpire(c
->db
,c
->argv
[j
]);
4065 server
.dirty
+= (c
->argc
-1)/2;
4066 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4069 static void msetCommand(redisClient
*c
) {
4070 msetGenericCommand(c
,0);
4073 static void msetnxCommand(redisClient
*c
) {
4074 msetGenericCommand(c
,1);
4077 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4082 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4084 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4087 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4088 o
= tryObjectEncoding(o
);
4089 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4090 if (retval
== DICT_ERR
) {
4091 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4092 removeExpire(c
->db
,c
->argv
[1]);
4094 incrRefCount(c
->argv
[1]);
4097 addReply(c
,shared
.colon
);
4099 addReply(c
,shared
.crlf
);
4102 static void incrCommand(redisClient
*c
) {
4103 incrDecrCommand(c
,1);
4106 static void decrCommand(redisClient
*c
) {
4107 incrDecrCommand(c
,-1);
4110 static void incrbyCommand(redisClient
*c
) {
4113 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4114 incrDecrCommand(c
,incr
);
4117 static void decrbyCommand(redisClient
*c
) {
4120 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4121 incrDecrCommand(c
,-incr
);
4124 static void appendCommand(redisClient
*c
) {
4129 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4131 /* Create the key */
4132 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4133 incrRefCount(c
->argv
[1]);
4134 incrRefCount(c
->argv
[2]);
4135 totlen
= stringObjectLen(c
->argv
[2]);
4139 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4142 o
= dictGetEntryVal(de
);
4143 if (o
->type
!= REDIS_STRING
) {
4144 addReply(c
,shared
.wrongtypeerr
);
4147 /* If the object is specially encoded or shared we have to make
4149 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4150 robj
*decoded
= getDecodedObject(o
);
4152 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4153 decrRefCount(decoded
);
4154 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4157 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4158 o
->ptr
= sdscatlen(o
->ptr
,
4159 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4161 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4162 (unsigned long) c
->argv
[2]->ptr
);
4164 totlen
= sdslen(o
->ptr
);
4167 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4170 static void substrCommand(redisClient
*c
) {
4172 long start
= atoi(c
->argv
[2]->ptr
);
4173 long end
= atoi(c
->argv
[3]->ptr
);
4174 size_t rangelen
, strlen
;
4177 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4178 checkType(c
,o
,REDIS_STRING
)) return;
4180 o
= getDecodedObject(o
);
4181 strlen
= sdslen(o
->ptr
);
4183 /* convert negative indexes */
4184 if (start
< 0) start
= strlen
+start
;
4185 if (end
< 0) end
= strlen
+end
;
4186 if (start
< 0) start
= 0;
4187 if (end
< 0) end
= 0;
4189 /* indexes sanity checks */
4190 if (start
> end
|| (size_t)start
>= strlen
) {
4191 /* Out of range start or start > end result in null reply */
4192 addReply(c
,shared
.nullbulk
);
4196 if ((size_t)end
>= strlen
) end
= strlen
-1;
4197 rangelen
= (end
-start
)+1;
4199 /* Return the result */
4200 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4201 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4202 addReplySds(c
,range
);
4203 addReply(c
,shared
.crlf
);
4207 /* ========================= Type agnostic commands ========================= */
4209 static void delCommand(redisClient
*c
) {
4212 for (j
= 1; j
< c
->argc
; j
++) {
4213 if (deleteKey(c
->db
,c
->argv
[j
])) {
4218 addReplyLong(c
,deleted
);
4221 static void existsCommand(redisClient
*c
) {
4222 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4225 static void selectCommand(redisClient
*c
) {
4226 int id
= atoi(c
->argv
[1]->ptr
);
4228 if (selectDb(c
,id
) == REDIS_ERR
) {
4229 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4231 addReply(c
,shared
.ok
);
4235 static void randomkeyCommand(redisClient
*c
) {
4240 de
= dictGetRandomKey(c
->db
->dict
);
4241 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4245 addReply(c
,shared
.nullbulk
);
4249 key
= dictGetEntryKey(de
);
4250 if (server
.vm_enabled
) {
4251 key
= dupStringObject(key
);
4252 addReplyBulk(c
,key
);
4255 addReplyBulk(c
,key
);
4259 static void keysCommand(redisClient
*c
) {
4262 sds pattern
= c
->argv
[1]->ptr
;
4263 int plen
= sdslen(pattern
);
4264 unsigned long numkeys
= 0;
4265 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4267 di
= dictGetIterator(c
->db
->dict
);
4269 decrRefCount(lenobj
);
4270 while((de
= dictNext(di
)) != NULL
) {
4271 robj
*keyobj
= dictGetEntryKey(de
);
4273 sds key
= keyobj
->ptr
;
4274 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4275 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4276 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4277 addReplyBulk(c
,keyobj
);
4282 dictReleaseIterator(di
);
4283 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4286 static void dbsizeCommand(redisClient
*c
) {
4288 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4291 static void lastsaveCommand(redisClient
*c
) {
4293 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4296 static void typeCommand(redisClient
*c
) {
4300 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4305 case REDIS_STRING
: type
= "+string"; break;
4306 case REDIS_LIST
: type
= "+list"; break;
4307 case REDIS_SET
: type
= "+set"; break;
4308 case REDIS_ZSET
: type
= "+zset"; break;
4309 case REDIS_HASH
: type
= "+hash"; break;
4310 default: type
= "+unknown"; break;
4313 addReplySds(c
,sdsnew(type
));
4314 addReply(c
,shared
.crlf
);
4317 static void saveCommand(redisClient
*c
) {
4318 if (server
.bgsavechildpid
!= -1) {
4319 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4322 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4323 addReply(c
,shared
.ok
);
4325 addReply(c
,shared
.err
);
4329 static void bgsaveCommand(redisClient
*c
) {
4330 if (server
.bgsavechildpid
!= -1) {
4331 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4334 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4335 char *status
= "+Background saving started\r\n";
4336 addReplySds(c
,sdsnew(status
));
4338 addReply(c
,shared
.err
);
4342 static void shutdownCommand(redisClient
*c
) {
4343 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4344 /* Kill the saving child if there is a background saving in progress.
4345 We want to avoid race conditions, for instance our saving child may
4346 overwrite the synchronous saving did by SHUTDOWN. */
4347 if (server
.bgsavechildpid
!= -1) {
4348 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4349 kill(server
.bgsavechildpid
,SIGKILL
);
4350 rdbRemoveTempFile(server
.bgsavechildpid
);
4352 if (server
.appendonly
) {
4353 /* Append only file: fsync() the AOF and exit */
4354 fsync(server
.appendfd
);
4355 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4358 /* Snapshotting. Perform a SYNC SAVE and exit */
4359 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4360 if (server
.daemonize
)
4361 unlink(server
.pidfile
);
4362 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4363 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4364 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4367 /* Ooops.. error saving! The best we can do is to continue
4368 * operating. Note that if there was a background saving process,
4369 * in the next cron() Redis will be notified that the background
4370 * saving aborted, handling special stuff like slaves pending for
4371 * synchronization... */
4372 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4374 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4379 static void renameGenericCommand(redisClient
*c
, int nx
) {
4382 /* To use the same key as src and dst is probably an error */
4383 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4384 addReply(c
,shared
.sameobjecterr
);
4388 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4392 deleteIfVolatile(c
->db
,c
->argv
[2]);
4393 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4396 addReply(c
,shared
.czero
);
4399 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4401 incrRefCount(c
->argv
[2]);
4403 deleteKey(c
->db
,c
->argv
[1]);
4405 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4408 static void renameCommand(redisClient
*c
) {
4409 renameGenericCommand(c
,0);
4412 static void renamenxCommand(redisClient
*c
) {
4413 renameGenericCommand(c
,1);
4416 static void moveCommand(redisClient
*c
) {
4421 /* Obtain source and target DB pointers */
4424 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4425 addReply(c
,shared
.outofrangeerr
);
4429 selectDb(c
,srcid
); /* Back to the source DB */
4431 /* If the user is moving using as target the same
4432 * DB as the source DB it is probably an error. */
4434 addReply(c
,shared
.sameobjecterr
);
4438 /* Check if the element exists and get a reference */
4439 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4441 addReply(c
,shared
.czero
);
4445 /* Try to add the element to the target DB */
4446 deleteIfVolatile(dst
,c
->argv
[1]);
4447 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4448 addReply(c
,shared
.czero
);
4451 incrRefCount(c
->argv
[1]);
4454 /* OK! key moved, free the entry in the source DB */
4455 deleteKey(src
,c
->argv
[1]);
4457 addReply(c
,shared
.cone
);
4460 /* =================================== Lists ================================ */
4461 static void pushGenericCommand(redisClient
*c
, int where
) {
4465 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4467 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4468 addReply(c
,shared
.cone
);
4471 lobj
= createListObject();
4473 if (where
== REDIS_HEAD
) {
4474 listAddNodeHead(list
,c
->argv
[2]);
4476 listAddNodeTail(list
,c
->argv
[2]);
4478 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4479 incrRefCount(c
->argv
[1]);
4480 incrRefCount(c
->argv
[2]);
4482 if (lobj
->type
!= REDIS_LIST
) {
4483 addReply(c
,shared
.wrongtypeerr
);
4486 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4487 addReply(c
,shared
.cone
);
4491 if (where
== REDIS_HEAD
) {
4492 listAddNodeHead(list
,c
->argv
[2]);
4494 listAddNodeTail(list
,c
->argv
[2]);
4496 incrRefCount(c
->argv
[2]);
4499 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4502 static void lpushCommand(redisClient
*c
) {
4503 pushGenericCommand(c
,REDIS_HEAD
);
4506 static void rpushCommand(redisClient
*c
) {
4507 pushGenericCommand(c
,REDIS_TAIL
);
4510 static void llenCommand(redisClient
*c
) {
4514 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4515 checkType(c
,o
,REDIS_LIST
)) return;
4518 addReplyUlong(c
,listLength(l
));
4521 static void lindexCommand(redisClient
*c
) {
4523 int index
= atoi(c
->argv
[2]->ptr
);
4527 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4528 checkType(c
,o
,REDIS_LIST
)) return;
4531 ln
= listIndex(list
, index
);
4533 addReply(c
,shared
.nullbulk
);
4535 robj
*ele
= listNodeValue(ln
);
4536 addReplyBulk(c
,ele
);
4540 static void lsetCommand(redisClient
*c
) {
4542 int index
= atoi(c
->argv
[2]->ptr
);
4546 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4547 checkType(c
,o
,REDIS_LIST
)) return;
4550 ln
= listIndex(list
, index
);
4552 addReply(c
,shared
.outofrangeerr
);
4554 robj
*ele
= listNodeValue(ln
);
4557 listNodeValue(ln
) = c
->argv
[3];
4558 incrRefCount(c
->argv
[3]);
4559 addReply(c
,shared
.ok
);
4564 static void popGenericCommand(redisClient
*c
, int where
) {
4569 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4570 checkType(c
,o
,REDIS_LIST
)) return;
4573 if (where
== REDIS_HEAD
)
4574 ln
= listFirst(list
);
4576 ln
= listLast(list
);
4579 addReply(c
,shared
.nullbulk
);
4581 robj
*ele
= listNodeValue(ln
);
4582 addReplyBulk(c
,ele
);
4583 listDelNode(list
,ln
);
4584 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4589 static void lpopCommand(redisClient
*c
) {
4590 popGenericCommand(c
,REDIS_HEAD
);
4593 static void rpopCommand(redisClient
*c
) {
4594 popGenericCommand(c
,REDIS_TAIL
);
4597 static void lrangeCommand(redisClient
*c
) {
4599 int start
= atoi(c
->argv
[2]->ptr
);
4600 int end
= atoi(c
->argv
[3]->ptr
);
4607 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4608 || checkType(c
,o
,REDIS_LIST
)) return;
4610 llen
= listLength(list
);
4612 /* convert negative indexes */
4613 if (start
< 0) start
= llen
+start
;
4614 if (end
< 0) end
= llen
+end
;
4615 if (start
< 0) start
= 0;
4616 if (end
< 0) end
= 0;
4618 /* indexes sanity checks */
4619 if (start
> end
|| start
>= llen
) {
4620 /* Out of range start or start > end result in empty list */
4621 addReply(c
,shared
.emptymultibulk
);
4624 if (end
>= llen
) end
= llen
-1;
4625 rangelen
= (end
-start
)+1;
4627 /* Return the result in form of a multi-bulk reply */
4628 ln
= listIndex(list
, start
);
4629 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4630 for (j
= 0; j
< rangelen
; j
++) {
4631 ele
= listNodeValue(ln
);
4632 addReplyBulk(c
,ele
);
4637 static void ltrimCommand(redisClient
*c
) {
4639 int start
= atoi(c
->argv
[2]->ptr
);
4640 int end
= atoi(c
->argv
[3]->ptr
);
4642 int j
, ltrim
, rtrim
;
4646 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4647 checkType(c
,o
,REDIS_LIST
)) return;
4649 llen
= listLength(list
);
4651 /* convert negative indexes */
4652 if (start
< 0) start
= llen
+start
;
4653 if (end
< 0) end
= llen
+end
;
4654 if (start
< 0) start
= 0;
4655 if (end
< 0) end
= 0;
4657 /* indexes sanity checks */
4658 if (start
> end
|| start
>= llen
) {
4659 /* Out of range start or start > end result in empty list */
4663 if (end
>= llen
) end
= llen
-1;
4668 /* Remove list elements to perform the trim */
4669 for (j
= 0; j
< ltrim
; j
++) {
4670 ln
= listFirst(list
);
4671 listDelNode(list
,ln
);
4673 for (j
= 0; j
< rtrim
; j
++) {
4674 ln
= listLast(list
);
4675 listDelNode(list
,ln
);
4677 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4679 addReply(c
,shared
.ok
);
4682 static void lremCommand(redisClient
*c
) {
4685 listNode
*ln
, *next
;
4686 int toremove
= atoi(c
->argv
[2]->ptr
);
4690 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4691 checkType(c
,o
,REDIS_LIST
)) return;
4695 toremove
= -toremove
;
4698 ln
= fromtail
? list
->tail
: list
->head
;
4700 robj
*ele
= listNodeValue(ln
);
4702 next
= fromtail
? ln
->prev
: ln
->next
;
4703 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4704 listDelNode(list
,ln
);
4707 if (toremove
&& removed
== toremove
) break;
4711 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4712 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4715 /* This is the semantic of this command:
4716 * RPOPLPUSH srclist dstlist:
4717 * IF LLEN(srclist) > 0
4718 * element = RPOP srclist
4719 * LPUSH dstlist element
4726 * The idea is to be able to get an element from a list in a reliable way
4727 * since the element is not just returned but pushed against another list
4728 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4730 static void rpoplpushcommand(redisClient
*c
) {
4735 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4736 checkType(c
,sobj
,REDIS_LIST
)) return;
4737 srclist
= sobj
->ptr
;
4738 ln
= listLast(srclist
);
4741 addReply(c
,shared
.nullbulk
);
4743 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4744 robj
*ele
= listNodeValue(ln
);
4747 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4748 addReply(c
,shared
.wrongtypeerr
);
4752 /* Add the element to the target list (unless it's directly
4753 * passed to some BLPOP-ing client */
4754 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4756 /* Create the list if the key does not exist */
4757 dobj
= createListObject();
4758 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4759 incrRefCount(c
->argv
[2]);
4761 dstlist
= dobj
->ptr
;
4762 listAddNodeHead(dstlist
,ele
);
4766 /* Send the element to the client as reply as well */
4767 addReplyBulk(c
,ele
);
4769 /* Finally remove the element from the source list */
4770 listDelNode(srclist
,ln
);
4771 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4776 /* ==================================== Sets ================================ */
4778 static void saddCommand(redisClient
*c
) {
4781 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4783 set
= createSetObject();
4784 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4785 incrRefCount(c
->argv
[1]);
4787 if (set
->type
!= REDIS_SET
) {
4788 addReply(c
,shared
.wrongtypeerr
);
4792 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4793 incrRefCount(c
->argv
[2]);
4795 addReply(c
,shared
.cone
);
4797 addReply(c
,shared
.czero
);
4801 static void sremCommand(redisClient
*c
) {
4804 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4805 checkType(c
,set
,REDIS_SET
)) return;
4807 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4809 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4810 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4811 addReply(c
,shared
.cone
);
4813 addReply(c
,shared
.czero
);
4817 static void smoveCommand(redisClient
*c
) {
4818 robj
*srcset
, *dstset
;
4820 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4821 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4823 /* If the source key does not exist return 0, if it's of the wrong type
4825 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4826 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4829 /* Error if the destination key is not a set as well */
4830 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4831 addReply(c
,shared
.wrongtypeerr
);
4834 /* Remove the element from the source set */
4835 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4836 /* Key not found in the src set! return zero */
4837 addReply(c
,shared
.czero
);
4840 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4841 deleteKey(c
->db
,c
->argv
[1]);
4843 /* Add the element to the destination set */
4845 dstset
= createSetObject();
4846 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4847 incrRefCount(c
->argv
[2]);
4849 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4850 incrRefCount(c
->argv
[3]);
4851 addReply(c
,shared
.cone
);
4854 static void sismemberCommand(redisClient
*c
) {
4857 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4858 checkType(c
,set
,REDIS_SET
)) return;
4860 if (dictFind(set
->ptr
,c
->argv
[2]))
4861 addReply(c
,shared
.cone
);
4863 addReply(c
,shared
.czero
);
4866 static void scardCommand(redisClient
*c
) {
4870 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4871 checkType(c
,o
,REDIS_SET
)) return;
4874 addReplyUlong(c
,dictSize(s
));
4877 static void spopCommand(redisClient
*c
) {
4881 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4882 checkType(c
,set
,REDIS_SET
)) return;
4884 de
= dictGetRandomKey(set
->ptr
);
4886 addReply(c
,shared
.nullbulk
);
4888 robj
*ele
= dictGetEntryKey(de
);
4890 addReplyBulk(c
,ele
);
4891 dictDelete(set
->ptr
,ele
);
4892 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4893 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4898 static void srandmemberCommand(redisClient
*c
) {
4902 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4903 checkType(c
,set
,REDIS_SET
)) return;
4905 de
= dictGetRandomKey(set
->ptr
);
4907 addReply(c
,shared
.nullbulk
);
4909 robj
*ele
= dictGetEntryKey(de
);
4911 addReplyBulk(c
,ele
);
4915 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4916 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4918 return dictSize(*d1
)-dictSize(*d2
);
4921 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4922 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4925 robj
*lenobj
= NULL
, *dstset
= NULL
;
4926 unsigned long j
, cardinality
= 0;
4928 for (j
= 0; j
< setsnum
; j
++) {
4932 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4933 lookupKeyRead(c
->db
,setskeys
[j
]);
4937 if (deleteKey(c
->db
,dstkey
))
4939 addReply(c
,shared
.czero
);
4941 addReply(c
,shared
.emptymultibulk
);
4945 if (setobj
->type
!= REDIS_SET
) {
4947 addReply(c
,shared
.wrongtypeerr
);
4950 dv
[j
] = setobj
->ptr
;
4952 /* Sort sets from the smallest to largest, this will improve our
4953 * algorithm's performace */
4954 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4956 /* The first thing we should output is the total number of elements...
4957 * since this is a multi-bulk write, but at this stage we don't know
4958 * the intersection set size, so we use a trick, append an empty object
4959 * to the output list and save the pointer to later modify it with the
4962 lenobj
= createObject(REDIS_STRING
,NULL
);
4964 decrRefCount(lenobj
);
4966 /* If we have a target key where to store the resulting set
4967 * create this key with an empty set inside */
4968 dstset
= createSetObject();
4971 /* Iterate all the elements of the first (smallest) set, and test
4972 * the element against all the other sets, if at least one set does
4973 * not include the element it is discarded */
4974 di
= dictGetIterator(dv
[0]);
4976 while((de
= dictNext(di
)) != NULL
) {
4979 for (j
= 1; j
< setsnum
; j
++)
4980 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4982 continue; /* at least one set does not contain the member */
4983 ele
= dictGetEntryKey(de
);
4985 addReplyBulk(c
,ele
);
4988 dictAdd(dstset
->ptr
,ele
,NULL
);
4992 dictReleaseIterator(di
);
4995 /* Store the resulting set into the target, if the intersection
4996 * is not an empty set. */
4997 deleteKey(c
->db
,dstkey
);
4998 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4999 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5000 incrRefCount(dstkey
);
5001 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5003 decrRefCount(dstset
);
5004 addReply(c
,shared
.czero
);
5008 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5013 static void sinterCommand(redisClient
*c
) {
5014 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5017 static void sinterstoreCommand(redisClient
*c
) {
5018 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5021 #define REDIS_OP_UNION 0
5022 #define REDIS_OP_DIFF 1
5023 #define REDIS_OP_INTER 2
5025 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5026 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5029 robj
*dstset
= NULL
;
5030 int j
, cardinality
= 0;
5032 for (j
= 0; j
< setsnum
; j
++) {
5036 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5037 lookupKeyRead(c
->db
,setskeys
[j
]);
5042 if (setobj
->type
!= REDIS_SET
) {
5044 addReply(c
,shared
.wrongtypeerr
);
5047 dv
[j
] = setobj
->ptr
;
5050 /* We need a temp set object to store our union. If the dstkey
5051 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5052 * this set object will be the resulting object to set into the target key*/
5053 dstset
= createSetObject();
5055 /* Iterate all the elements of all the sets, add every element a single
5056 * time to the result set */
5057 for (j
= 0; j
< setsnum
; j
++) {
5058 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5059 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5061 di
= dictGetIterator(dv
[j
]);
5063 while((de
= dictNext(di
)) != NULL
) {
5066 /* dictAdd will not add the same element multiple times */
5067 ele
= dictGetEntryKey(de
);
5068 if (op
== REDIS_OP_UNION
|| j
== 0) {
5069 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5073 } else if (op
== REDIS_OP_DIFF
) {
5074 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5079 dictReleaseIterator(di
);
5081 /* result set is empty? Exit asap. */
5082 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5085 /* Output the content of the resulting set, if not in STORE mode */
5087 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5088 di
= dictGetIterator(dstset
->ptr
);
5089 while((de
= dictNext(di
)) != NULL
) {
5092 ele
= dictGetEntryKey(de
);
5093 addReplyBulk(c
,ele
);
5095 dictReleaseIterator(di
);
5096 decrRefCount(dstset
);
5098 /* If we have a target key where to store the resulting set
5099 * create this key with the result set inside */
5100 deleteKey(c
->db
,dstkey
);
5101 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5102 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5103 incrRefCount(dstkey
);
5104 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5106 decrRefCount(dstset
);
5107 addReply(c
,shared
.czero
);
5114 static void sunionCommand(redisClient
*c
) {
5115 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5118 static void sunionstoreCommand(redisClient
*c
) {
5119 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5122 static void sdiffCommand(redisClient
*c
) {
5123 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5126 static void sdiffstoreCommand(redisClient
*c
) {
5127 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5130 /* ==================================== ZSets =============================== */
5132 /* ZSETs are ordered sets using two data structures to hold the same elements
5133 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5136 * The elements are added to an hash table mapping Redis objects to scores.
5137 * At the same time the elements are added to a skip list mapping scores
5138 * to Redis objects (so objects are sorted by scores in this "view"). */
5140 /* This skiplist implementation is almost a C translation of the original
5141 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5142 * Alternative to Balanced Trees", modified in three ways:
5143 * a) this implementation allows for repeated values.
5144 * b) the comparison is not just by key (our 'score') but by satellite data.
5145 * c) there is a back pointer, so it's a doubly linked list with the back
5146 * pointers being only at "level 1". This allows to traverse the list
5147 * from tail to head, useful for ZREVRANGE. */
5149 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5150 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5152 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5154 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5160 static zskiplist
*zslCreate(void) {
5164 zsl
= zmalloc(sizeof(*zsl
));
5167 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5168 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5169 zsl
->header
->forward
[j
] = NULL
;
5171 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5172 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5173 zsl
->header
->span
[j
] = 0;
5175 zsl
->header
->backward
= NULL
;
5180 static void zslFreeNode(zskiplistNode
*node
) {
5181 decrRefCount(node
->obj
);
5182 zfree(node
->forward
);
5187 static void zslFree(zskiplist
*zsl
) {
5188 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5190 zfree(zsl
->header
->forward
);
5191 zfree(zsl
->header
->span
);
5194 next
= node
->forward
[0];
5201 static int zslRandomLevel(void) {
5203 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5205 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5208 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5209 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5210 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5214 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5215 /* store rank that is crossed to reach the insert position */
5216 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5218 while (x
->forward
[i
] &&
5219 (x
->forward
[i
]->score
< score
||
5220 (x
->forward
[i
]->score
== score
&&
5221 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5222 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5227 /* we assume the key is not already inside, since we allow duplicated
5228 * scores, and the re-insertion of score and redis object should never
5229 * happpen since the caller of zslInsert() should test in the hash table
5230 * if the element is already inside or not. */
5231 level
= zslRandomLevel();
5232 if (level
> zsl
->level
) {
5233 for (i
= zsl
->level
; i
< level
; i
++) {
5235 update
[i
] = zsl
->header
;
5236 update
[i
]->span
[i
-1] = zsl
->length
;
5240 x
= zslCreateNode(level
,score
,obj
);
5241 for (i
= 0; i
< level
; i
++) {
5242 x
->forward
[i
] = update
[i
]->forward
[i
];
5243 update
[i
]->forward
[i
] = x
;
5245 /* update span covered by update[i] as x is inserted here */
5247 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5248 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5252 /* increment span for untouched levels */
5253 for (i
= level
; i
< zsl
->level
; i
++) {
5254 update
[i
]->span
[i
-1]++;
5257 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5259 x
->forward
[0]->backward
= x
;
5265 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5266 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5268 for (i
= 0; i
< zsl
->level
; i
++) {
5269 if (update
[i
]->forward
[i
] == x
) {
5271 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5273 update
[i
]->forward
[i
] = x
->forward
[i
];
5275 /* invariant: i > 0, because update[0]->forward[0]
5276 * is always equal to x */
5277 update
[i
]->span
[i
-1] -= 1;
5280 if (x
->forward
[0]) {
5281 x
->forward
[0]->backward
= x
->backward
;
5283 zsl
->tail
= x
->backward
;
5285 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5290 /* Delete an element with matching score/object from the skiplist. */
5291 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5292 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5296 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5297 while (x
->forward
[i
] &&
5298 (x
->forward
[i
]->score
< score
||
5299 (x
->forward
[i
]->score
== score
&&
5300 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5304 /* We may have multiple elements with the same score, what we need
5305 * is to find the element with both the right score and object. */
5307 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5308 zslDeleteNode(zsl
, x
, update
);
5312 return 0; /* not found */
5314 return 0; /* not found */
5317 /* Delete all the elements with score between min and max from the skiplist.
5318 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5319 * Note that this function takes the reference to the hash table view of the
5320 * sorted set, in order to remove the elements from the hash table too. */
5321 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5322 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5323 unsigned long removed
= 0;
5327 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5328 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5332 /* We may have multiple elements with the same score, what we need
5333 * is to find the element with both the right score and object. */
5335 while (x
&& x
->score
<= max
) {
5336 zskiplistNode
*next
= x
->forward
[0];
5337 zslDeleteNode(zsl
, x
, update
);
5338 dictDelete(dict
,x
->obj
);
5343 return removed
; /* not found */
5346 /* Delete all the elements with rank between start and end from the skiplist.
5347 * Start and end are inclusive. Note that start and end need to be 1-based */
5348 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5349 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5350 unsigned long traversed
= 0, removed
= 0;
5354 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5355 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5356 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5364 while (x
&& traversed
<= end
) {
5365 zskiplistNode
*next
= x
->forward
[0];
5366 zslDeleteNode(zsl
, x
, update
);
5367 dictDelete(dict
,x
->obj
);
5376 /* Find the first node having a score equal or greater than the specified one.
5377 * Returns NULL if there is no match. */
5378 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5383 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5384 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5387 /* We may have multiple elements with the same score, what we need
5388 * is to find the element with both the right score and object. */
5389 return x
->forward
[0];
5392 /* Find the rank for an element by both score and key.
5393 * Returns 0 when the element cannot be found, rank otherwise.
5394 * Note that the rank is 1-based due to the span of zsl->header to the
5396 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5398 unsigned long rank
= 0;
5402 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5403 while (x
->forward
[i
] &&
5404 (x
->forward
[i
]->score
< score
||
5405 (x
->forward
[i
]->score
== score
&&
5406 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5407 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5411 /* x might be equal to zsl->header, so test if obj is non-NULL */
5412 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5419 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5420 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5422 unsigned long traversed
= 0;
5426 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5427 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5429 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5432 if (traversed
== rank
) {
5439 /* The actual Z-commands implementations */
5441 /* This generic command implements both ZADD and ZINCRBY.
5442 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5443 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5444 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5449 zsetobj
= lookupKeyWrite(c
->db
,key
);
5450 if (zsetobj
== NULL
) {
5451 zsetobj
= createZsetObject();
5452 dictAdd(c
->db
->dict
,key
,zsetobj
);
5455 if (zsetobj
->type
!= REDIS_ZSET
) {
5456 addReply(c
,shared
.wrongtypeerr
);
5462 /* Ok now since we implement both ZADD and ZINCRBY here the code
5463 * needs to handle the two different conditions. It's all about setting
5464 * '*score', that is, the new score to set, to the right value. */
5465 score
= zmalloc(sizeof(double));
5469 /* Read the old score. If the element was not present starts from 0 */
5470 de
= dictFind(zs
->dict
,ele
);
5472 double *oldscore
= dictGetEntryVal(de
);
5473 *score
= *oldscore
+ scoreval
;
5481 /* What follows is a simple remove and re-insert operation that is common
5482 * to both ZADD and ZINCRBY... */
5483 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5484 /* case 1: New element */
5485 incrRefCount(ele
); /* added to hash */
5486 zslInsert(zs
->zsl
,*score
,ele
);
5487 incrRefCount(ele
); /* added to skiplist */
5490 addReplyDouble(c
,*score
);
5492 addReply(c
,shared
.cone
);
5497 /* case 2: Score update operation */
5498 de
= dictFind(zs
->dict
,ele
);
5499 redisAssert(de
!= NULL
);
5500 oldscore
= dictGetEntryVal(de
);
5501 if (*score
!= *oldscore
) {
5504 /* Remove and insert the element in the skip list with new score */
5505 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5506 redisAssert(deleted
!= 0);
5507 zslInsert(zs
->zsl
,*score
,ele
);
5509 /* Update the score in the hash table */
5510 dictReplace(zs
->dict
,ele
,score
);
5516 addReplyDouble(c
,*score
);
5518 addReply(c
,shared
.czero
);
5522 static void zaddCommand(redisClient
*c
) {
5525 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5526 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5529 static void zincrbyCommand(redisClient
*c
) {
5532 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5533 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5536 static void zremCommand(redisClient
*c
) {
5543 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5544 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5547 de
= dictFind(zs
->dict
,c
->argv
[2]);
5549 addReply(c
,shared
.czero
);
5552 /* Delete from the skiplist */
5553 oldscore
= dictGetEntryVal(de
);
5554 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5555 redisAssert(deleted
!= 0);
5557 /* Delete from the hash table */
5558 dictDelete(zs
->dict
,c
->argv
[2]);
5559 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5560 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5562 addReply(c
,shared
.cone
);
5565 static void zremrangebyscoreCommand(redisClient
*c
) {
5572 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5573 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5575 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5576 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5579 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5580 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5581 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5582 server
.dirty
+= deleted
;
5583 addReplyLong(c
,deleted
);
5586 static void zremrangebyrankCommand(redisClient
*c
) {
5594 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5595 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5597 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5598 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5600 llen
= zs
->zsl
->length
;
5602 /* convert negative indexes */
5603 if (start
< 0) start
= llen
+start
;
5604 if (end
< 0) end
= llen
+end
;
5605 if (start
< 0) start
= 0;
5606 if (end
< 0) end
= 0;
5608 /* indexes sanity checks */
5609 if (start
> end
|| start
>= llen
) {
5610 addReply(c
,shared
.czero
);
5613 if (end
>= llen
) end
= llen
-1;
5615 /* increment start and end because zsl*Rank functions
5616 * use 1-based rank */
5617 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5618 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5619 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5620 server
.dirty
+= deleted
;
5621 addReplyLong(c
, deleted
);
5629 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5630 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5631 unsigned long size1
, size2
;
5632 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5633 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5634 return size1
- size2
;
5637 #define REDIS_AGGR_SUM 1
5638 #define REDIS_AGGR_MIN 2
5639 #define REDIS_AGGR_MAX 3
5641 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5642 if (aggregate
== REDIS_AGGR_SUM
) {
5643 *target
= *target
+ val
;
5644 } else if (aggregate
== REDIS_AGGR_MIN
) {
5645 *target
= val
< *target
? val
: *target
;
5646 } else if (aggregate
== REDIS_AGGR_MAX
) {
5647 *target
= val
> *target
? val
: *target
;
5650 redisPanic("Unknown ZUNION/INTER aggregate type");
5654 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5656 int aggregate
= REDIS_AGGR_SUM
;
5663 /* expect zsetnum input keys to be given */
5664 zsetnum
= atoi(c
->argv
[2]->ptr
);
5666 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5670 /* test if the expected number of keys would overflow */
5671 if (3+zsetnum
> c
->argc
) {
5672 addReply(c
,shared
.syntaxerr
);
5676 /* read keys to be used for input */
5677 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5678 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5679 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5683 if (zsetobj
->type
!= REDIS_ZSET
) {
5685 addReply(c
,shared
.wrongtypeerr
);
5688 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5691 /* default all weights to 1 */
5692 src
[i
].weight
= 1.0;
5695 /* parse optional extra arguments */
5697 int remaining
= c
->argc
- j
;
5700 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5702 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5703 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5706 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5708 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5709 aggregate
= REDIS_AGGR_SUM
;
5710 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5711 aggregate
= REDIS_AGGR_MIN
;
5712 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5713 aggregate
= REDIS_AGGR_MAX
;
5716 addReply(c
,shared
.syntaxerr
);
5722 addReply(c
,shared
.syntaxerr
);
5728 /* sort sets from the smallest to largest, this will improve our
5729 * algorithm's performance */
5730 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5732 dstobj
= createZsetObject();
5733 dstzset
= dstobj
->ptr
;
5735 if (op
== REDIS_OP_INTER
) {
5736 /* skip going over all entries if the smallest zset is NULL or empty */
5737 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5738 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5739 * from small to large, all src[i > 0].dict are non-empty too */
5740 di
= dictGetIterator(src
[0].dict
);
5741 while((de
= dictNext(di
)) != NULL
) {
5742 double *score
= zmalloc(sizeof(double)), value
;
5743 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5745 for (j
= 1; j
< zsetnum
; j
++) {
5746 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5748 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5749 zunionInterAggregate(score
, value
, aggregate
);
5755 /* skip entry when not present in every source dict */
5759 robj
*o
= dictGetEntryKey(de
);
5760 dictAdd(dstzset
->dict
,o
,score
);
5761 incrRefCount(o
); /* added to dictionary */
5762 zslInsert(dstzset
->zsl
,*score
,o
);
5763 incrRefCount(o
); /* added to skiplist */
5766 dictReleaseIterator(di
);
5768 } else if (op
== REDIS_OP_UNION
) {
5769 for (i
= 0; i
< zsetnum
; i
++) {
5770 if (!src
[i
].dict
) continue;
5772 di
= dictGetIterator(src
[i
].dict
);
5773 while((de
= dictNext(di
)) != NULL
) {
5774 /* skip key when already processed */
5775 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5777 double *score
= zmalloc(sizeof(double)), value
;
5778 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5780 /* because the zsets are sorted by size, its only possible
5781 * for sets at larger indices to hold this entry */
5782 for (j
= (i
+1); j
< zsetnum
; j
++) {
5783 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5785 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5786 zunionInterAggregate(score
, value
, aggregate
);
5790 robj
*o
= dictGetEntryKey(de
);
5791 dictAdd(dstzset
->dict
,o
,score
);
5792 incrRefCount(o
); /* added to dictionary */
5793 zslInsert(dstzset
->zsl
,*score
,o
);
5794 incrRefCount(o
); /* added to skiplist */
5796 dictReleaseIterator(di
);
5799 /* unknown operator */
5800 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5803 deleteKey(c
->db
,dstkey
);
5804 if (dstzset
->zsl
->length
) {
5805 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5806 incrRefCount(dstkey
);
5807 addReplyLong(c
, dstzset
->zsl
->length
);
5810 decrRefCount(dstobj
);
5811 addReply(c
, shared
.czero
);
5816 static void zunionCommand(redisClient
*c
) {
5817 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5820 static void zinterCommand(redisClient
*c
) {
5821 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5824 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5836 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5837 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5839 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5841 } else if (c
->argc
>= 5) {
5842 addReply(c
,shared
.syntaxerr
);
5846 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5847 || checkType(c
,o
,REDIS_ZSET
)) return;
5852 /* convert negative indexes */
5853 if (start
< 0) start
= llen
+start
;
5854 if (end
< 0) end
= llen
+end
;
5855 if (start
< 0) start
= 0;
5856 if (end
< 0) end
= 0;
5858 /* indexes sanity checks */
5859 if (start
> end
|| start
>= llen
) {
5860 /* Out of range start or start > end result in empty list */
5861 addReply(c
,shared
.emptymultibulk
);
5864 if (end
>= llen
) end
= llen
-1;
5865 rangelen
= (end
-start
)+1;
5867 /* check if starting point is trivial, before searching
5868 * the element in log(N) time */
5870 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5873 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5876 /* Return the result in form of a multi-bulk reply */
5877 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5878 withscores
? (rangelen
*2) : rangelen
));
5879 for (j
= 0; j
< rangelen
; j
++) {
5881 addReplyBulk(c
,ele
);
5883 addReplyDouble(c
,ln
->score
);
5884 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5888 static void zrangeCommand(redisClient
*c
) {
5889 zrangeGenericCommand(c
,0);
5892 static void zrevrangeCommand(redisClient
*c
) {
5893 zrangeGenericCommand(c
,1);
5896 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5897 * If justcount is non-zero, just the count is returned. */
5898 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5901 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5902 int offset
= 0, limit
= -1;
5906 /* Parse the min-max interval. If one of the values is prefixed
5907 * by the "(" character, it's considered "open". For instance
5908 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5909 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5910 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5911 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5914 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5916 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5917 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5920 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5923 /* Parse "WITHSCORES": note that if the command was called with
5924 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5925 * enter the following paths to parse WITHSCORES and LIMIT. */
5926 if (c
->argc
== 5 || c
->argc
== 8) {
5927 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5932 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5936 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5941 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5942 addReply(c
,shared
.syntaxerr
);
5944 } else if (c
->argc
== (7 + withscores
)) {
5945 offset
= atoi(c
->argv
[5]->ptr
);
5946 limit
= atoi(c
->argv
[6]->ptr
);
5947 if (offset
< 0) offset
= 0;
5950 /* Ok, lookup the key and get the range */
5951 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5953 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5955 if (o
->type
!= REDIS_ZSET
) {
5956 addReply(c
,shared
.wrongtypeerr
);
5958 zset
*zsetobj
= o
->ptr
;
5959 zskiplist
*zsl
= zsetobj
->zsl
;
5961 robj
*ele
, *lenobj
= NULL
;
5962 unsigned long rangelen
= 0;
5964 /* Get the first node with the score >= min, or with
5965 * score > min if 'minex' is true. */
5966 ln
= zslFirstWithScore(zsl
,min
);
5967 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5970 /* No element matching the speciifed interval */
5971 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5975 /* We don't know in advance how many matching elements there
5976 * are in the list, so we push this object that will represent
5977 * the multi-bulk length in the output buffer, and will "fix"
5980 lenobj
= createObject(REDIS_STRING
,NULL
);
5982 decrRefCount(lenobj
);
5985 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5988 ln
= ln
->forward
[0];
5991 if (limit
== 0) break;
5994 addReplyBulk(c
,ele
);
5996 addReplyDouble(c
,ln
->score
);
5998 ln
= ln
->forward
[0];
6000 if (limit
> 0) limit
--;
6003 addReplyLong(c
,(long)rangelen
);
6005 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6006 withscores
? (rangelen
*2) : rangelen
);
6012 static void zrangebyscoreCommand(redisClient
*c
) {
6013 genericZrangebyscoreCommand(c
,0);
6016 static void zcountCommand(redisClient
*c
) {
6017 genericZrangebyscoreCommand(c
,1);
6020 static void zcardCommand(redisClient
*c
) {
6024 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6025 checkType(c
,o
,REDIS_ZSET
)) return;
6028 addReplyUlong(c
,zs
->zsl
->length
);
6031 static void zscoreCommand(redisClient
*c
) {
6036 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6037 checkType(c
,o
,REDIS_ZSET
)) return;
6040 de
= dictFind(zs
->dict
,c
->argv
[2]);
6042 addReply(c
,shared
.nullbulk
);
6044 double *score
= dictGetEntryVal(de
);
6046 addReplyDouble(c
,*score
);
6050 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6058 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6059 checkType(c
,o
,REDIS_ZSET
)) return;
6063 de
= dictFind(zs
->dict
,c
->argv
[2]);
6065 addReply(c
,shared
.nullbulk
);
6069 score
= dictGetEntryVal(de
);
6070 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6073 addReplyLong(c
, zsl
->length
- rank
);
6075 addReplyLong(c
, rank
-1);
6078 addReply(c
,shared
.nullbulk
);
6082 static void zrankCommand(redisClient
*c
) {
6083 zrankGenericCommand(c
, 0);
6086 static void zrevrankCommand(redisClient
*c
) {
6087 zrankGenericCommand(c
, 1);
6090 /* ========================= Hashes utility functions ======================= */
6091 #define REDIS_HASH_KEY 1
6092 #define REDIS_HASH_VALUE 2
6094 /* Check the length of a number of objects to see if we need to convert a
6095 * zipmap to a real hash. Note that we only check string encoded objects
6096 * as their string length can be queried in constant time. */
6097 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6099 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6101 for (i
= start
; i
<= end
; i
++) {
6102 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6103 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6105 convertToRealHash(subject
);
6111 /* Encode given objects in-place when the hash uses a dict. */
6112 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6113 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6114 if (o1
) *o1
= tryObjectEncoding(*o1
);
6115 if (o2
) *o2
= tryObjectEncoding(*o2
);
6119 /* Get the value from a hash identified by key. Returns either a string
6120 * object or NULL if the value cannot be found. The refcount of the object
6121 * is always increased by 1 when the value was found. */
6122 static robj
*hashGet(robj
*o
, robj
*key
) {
6124 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6127 key
= getDecodedObject(key
);
6128 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6129 value
= createStringObject((char*)v
,vlen
);
6133 dictEntry
*de
= dictFind(o
->ptr
,key
);
6135 value
= dictGetEntryVal(de
);
6136 incrRefCount(value
);
6142 /* Test if the key exists in the given hash. Returns 1 if the key
6143 * exists and 0 when it doesn't. */
6144 static int hashExists(robj
*o
, robj
*key
) {
6145 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6146 key
= getDecodedObject(key
);
6147 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6153 if (dictFind(o
->ptr
,key
) != NULL
) {
6160 /* Add an element, discard the old if the key already exists.
6161 * Return 0 on insert and 1 on update. */
6162 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6164 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6165 key
= getDecodedObject(key
);
6166 value
= getDecodedObject(value
);
6167 o
->ptr
= zipmapSet(o
->ptr
,
6168 key
->ptr
,sdslen(key
->ptr
),
6169 value
->ptr
,sdslen(value
->ptr
), &update
);
6171 decrRefCount(value
);
6173 /* Check if the zipmap needs to be upgraded to a real hash table */
6174 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6175 convertToRealHash(o
);
6177 if (dictReplace(o
->ptr
,key
,value
)) {
6184 incrRefCount(value
);
6189 /* Delete an element from a hash.
6190 * Return 1 on deleted and 0 on not found. */
6191 static int hashDelete(robj
*o
, robj
*key
) {
6193 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6194 key
= getDecodedObject(key
);
6195 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6198 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6199 /* Always check if the dictionary needs a resize after a delete. */
6200 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6205 /* Return the number of elements in a hash. */
6206 static unsigned long hashLength(robj
*o
) {
6207 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6208 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6211 /* Structure to hold hash iteration abstration. Note that iteration over
6212 * hashes involves both fields and values. Because it is possible that
6213 * not both are required, store pointers in the iterator to avoid
6214 * unnecessary memory allocation for fields/values. */
6218 unsigned char *zk
, *zv
;
6219 unsigned int zklen
, zvlen
;
6225 static hashIterator
*hashInitIterator(robj
*subject
) {
6226 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6227 hi
->encoding
= subject
->encoding
;
6228 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6229 hi
->zi
= zipmapRewind(subject
->ptr
);
6230 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6231 hi
->di
= dictGetIterator(subject
->ptr
);
6238 static void hashReleaseIterator(hashIterator
*hi
) {
6239 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6240 dictReleaseIterator(hi
->di
);
6245 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6246 * could be found and REDIS_ERR when the iterator reaches the end. */
6247 static int hashNext(hashIterator
*hi
) {
6248 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6249 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6250 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6252 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6257 /* Get key or value object at current iteration position.
6258 * This increases the refcount of the field object by 1. */
6259 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6261 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6262 if (what
& REDIS_HASH_KEY
) {
6263 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6265 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6268 if (what
& REDIS_HASH_KEY
) {
6269 o
= dictGetEntryKey(hi
->de
);
6271 o
= dictGetEntryVal(hi
->de
);
6278 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6279 robj
*o
= lookupKeyWrite(c
->db
,key
);
6281 o
= createHashObject();
6282 dictAdd(c
->db
->dict
,key
,o
);
6285 if (o
->type
!= REDIS_HASH
) {
6286 addReply(c
,shared
.wrongtypeerr
);
6293 /* ============================= Hash commands ============================== */
6294 static void hsetCommand(redisClient
*c
) {
6298 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6299 hashTryConversion(o
,c
->argv
,2,3);
6300 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6301 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6302 addReply(c
, update
? shared
.czero
: shared
.cone
);
6306 static void hsetnxCommand(redisClient
*c
) {
6308 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6309 hashTryConversion(o
,c
->argv
,2,3);
6311 if (hashExists(o
, c
->argv
[2])) {
6312 addReply(c
, shared
.czero
);
6314 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6315 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6316 addReply(c
, shared
.cone
);
6321 static void hmsetCommand(redisClient
*c
) {
6325 if ((c
->argc
% 2) == 1) {
6326 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6330 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6331 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6332 for (i
= 2; i
< c
->argc
; i
+= 2) {
6333 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6334 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6336 addReply(c
, shared
.ok
);
6340 static void hincrbyCommand(redisClient
*c
) {
6341 long long value
, incr
;
6342 robj
*o
, *current
, *new;
6344 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6345 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6346 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6347 if (current
->encoding
== REDIS_ENCODING_RAW
)
6348 value
= strtoll(current
->ptr
,NULL
,10);
6349 else if (current
->encoding
== REDIS_ENCODING_INT
)
6350 value
= (long)current
->ptr
;
6352 redisAssert(1 != 1);
6353 decrRefCount(current
);
6359 new = createStringObjectFromLongLong(value
);
6360 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6361 hashSet(o
,c
->argv
[2],new);
6363 addReplyLongLong(c
,value
);
6367 static void hgetCommand(redisClient
*c
) {
6369 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6370 checkType(c
,o
,REDIS_HASH
)) return;
6372 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6373 addReplyBulk(c
,value
);
6374 decrRefCount(value
);
6376 addReply(c
,shared
.nullbulk
);
6380 static void hmgetCommand(redisClient
*c
) {
6383 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6384 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6385 addReply(c
,shared
.wrongtypeerr
);
6388 /* Note the check for o != NULL happens inside the loop. This is
6389 * done because objects that cannot be found are considered to be
6390 * an empty hash. The reply should then be a series of NULLs. */
6391 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6392 for (i
= 2; i
< c
->argc
; i
++) {
6393 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6394 addReplyBulk(c
,value
);
6395 decrRefCount(value
);
6397 addReply(c
,shared
.nullbulk
);
6402 static void hdelCommand(redisClient
*c
) {
6404 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6405 checkType(c
,o
,REDIS_HASH
)) return;
6407 if (hashDelete(o
,c
->argv
[2])) {
6408 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6409 addReply(c
,shared
.cone
);
6412 addReply(c
,shared
.czero
);
6416 static void hlenCommand(redisClient
*c
) {
6418 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6419 checkType(c
,o
,REDIS_HASH
)) return;
6421 addReplyUlong(c
,hashLength(o
));
6424 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6425 robj
*o
, *lenobj
, *obj
;
6426 unsigned long count
= 0;
6429 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6430 || checkType(c
,o
,REDIS_HASH
)) return;
6432 lenobj
= createObject(REDIS_STRING
,NULL
);
6434 decrRefCount(lenobj
);
6436 hi
= hashInitIterator(o
);
6437 while (hashNext(hi
) != REDIS_ERR
) {
6438 if (flags
& REDIS_HASH_KEY
) {
6439 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6440 addReplyBulk(c
,obj
);
6444 if (flags
& REDIS_HASH_VALUE
) {
6445 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6446 addReplyBulk(c
,obj
);
6451 hashReleaseIterator(hi
);
6453 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6456 static void hkeysCommand(redisClient
*c
) {
6457 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6460 static void hvalsCommand(redisClient
*c
) {
6461 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6464 static void hgetallCommand(redisClient
*c
) {
6465 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6468 static void hexistsCommand(redisClient
*c
) {
6470 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6471 checkType(c
,o
,REDIS_HASH
)) return;
6473 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6476 static void convertToRealHash(robj
*o
) {
6477 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6478 unsigned int klen
, vlen
;
6479 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6481 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6482 p
= zipmapRewind(zm
);
6483 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6484 robj
*keyobj
, *valobj
;
6486 keyobj
= createStringObject((char*)key
,klen
);
6487 valobj
= createStringObject((char*)val
,vlen
);
6488 keyobj
= tryObjectEncoding(keyobj
);
6489 valobj
= tryObjectEncoding(valobj
);
6490 dictAdd(dict
,keyobj
,valobj
);
6492 o
->encoding
= REDIS_ENCODING_HT
;
6497 /* ========================= Non type-specific commands ==================== */
6499 static void flushdbCommand(redisClient
*c
) {
6500 server
.dirty
+= dictSize(c
->db
->dict
);
6501 dictEmpty(c
->db
->dict
);
6502 dictEmpty(c
->db
->expires
);
6503 addReply(c
,shared
.ok
);
6506 static void flushallCommand(redisClient
*c
) {
6507 server
.dirty
+= emptyDb();
6508 addReply(c
,shared
.ok
);
6509 if (server
.bgsavechildpid
!= -1) {
6510 kill(server
.bgsavechildpid
,SIGKILL
);
6511 rdbRemoveTempFile(server
.bgsavechildpid
);
6513 rdbSave(server
.dbfilename
);
6517 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6518 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6520 so
->pattern
= pattern
;
6524 /* Return the value associated to the key with a name obtained
6525 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6526 * The returned object will always have its refcount increased by 1
6527 * when it is non-NULL. */
6528 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6531 robj keyobj
, fieldobj
, *o
;
6532 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6533 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6537 char buf
[REDIS_SORTKEY_MAX
+1];
6538 } keyname
, fieldname
;
6540 /* If the pattern is "#" return the substitution object itself in order
6541 * to implement the "SORT ... GET #" feature. */
6542 spat
= pattern
->ptr
;
6543 if (spat
[0] == '#' && spat
[1] == '\0') {
6544 incrRefCount(subst
);
6548 /* The substitution object may be specially encoded. If so we create
6549 * a decoded object on the fly. Otherwise getDecodedObject will just
6550 * increment the ref count, that we'll decrement later. */
6551 subst
= getDecodedObject(subst
);
6554 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6555 p
= strchr(spat
,'*');
6557 decrRefCount(subst
);
6561 /* Find out if we're dealing with a hash dereference. */
6562 if ((f
= strstr(p
+1, "->")) != NULL
) {
6563 fieldlen
= sdslen(spat
)-(f
-spat
);
6564 /* this also copies \0 character */
6565 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6566 fieldname
.len
= fieldlen
-2;
6572 sublen
= sdslen(ssub
);
6573 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6574 memcpy(keyname
.buf
,spat
,prefixlen
);
6575 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6576 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6577 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6578 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6579 decrRefCount(subst
);
6581 /* Lookup substituted key */
6582 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6583 o
= lookupKeyRead(db
,&keyobj
);
6584 if (o
== NULL
) return NULL
;
6587 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6589 /* Retrieve value from hash by the field name. This operation
6590 * already increases the refcount of the returned object. */
6591 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6592 o
= hashGet(o
, &fieldobj
);
6594 if (o
->type
!= REDIS_STRING
) return NULL
;
6596 /* Every object that this function returns needs to have its refcount
6597 * increased. sortCommand decreases it again. */
6604 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6605 * the additional parameter is not standard but a BSD-specific we have to
6606 * pass sorting parameters via the global 'server' structure */
6607 static int sortCompare(const void *s1
, const void *s2
) {
6608 const redisSortObject
*so1
= s1
, *so2
= s2
;
6611 if (!server
.sort_alpha
) {
6612 /* Numeric sorting. Here it's trivial as we precomputed scores */
6613 if (so1
->u
.score
> so2
->u
.score
) {
6615 } else if (so1
->u
.score
< so2
->u
.score
) {
6621 /* Alphanumeric sorting */
6622 if (server
.sort_bypattern
) {
6623 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6624 /* At least one compare object is NULL */
6625 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6627 else if (so1
->u
.cmpobj
== NULL
)
6632 /* We have both the objects, use strcoll */
6633 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6636 /* Compare elements directly. */
6637 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6640 return server
.sort_desc
? -cmp
: cmp
;
6643 /* The SORT command is the most complex command in Redis. Warning: this code
6644 * is optimized for speed and a bit less for readability */
6645 static void sortCommand(redisClient
*c
) {
6648 int desc
= 0, alpha
= 0;
6649 int limit_start
= 0, limit_count
= -1, start
, end
;
6650 int j
, dontsort
= 0, vectorlen
;
6651 int getop
= 0; /* GET operation counter */
6652 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6653 redisSortObject
*vector
; /* Resulting vector to sort */
6655 /* Lookup the key to sort. It must be of the right types */
6656 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6657 if (sortval
== NULL
) {
6658 addReply(c
,shared
.emptymultibulk
);
6661 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6662 sortval
->type
!= REDIS_ZSET
)
6664 addReply(c
,shared
.wrongtypeerr
);
6668 /* Create a list of operations to perform for every sorted element.
6669 * Operations can be GET/DEL/INCR/DECR */
6670 operations
= listCreate();
6671 listSetFreeMethod(operations
,zfree
);
6674 /* Now we need to protect sortval incrementing its count, in the future
6675 * SORT may have options able to overwrite/delete keys during the sorting
6676 * and the sorted key itself may get destroied */
6677 incrRefCount(sortval
);
6679 /* The SORT command has an SQL-alike syntax, parse it */
6680 while(j
< c
->argc
) {
6681 int leftargs
= c
->argc
-j
-1;
6682 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6684 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6686 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6688 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6689 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6690 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6692 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6693 storekey
= c
->argv
[j
+1];
6695 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6696 sortby
= c
->argv
[j
+1];
6697 /* If the BY pattern does not contain '*', i.e. it is constant,
6698 * we don't need to sort nor to lookup the weight keys. */
6699 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6701 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6702 listAddNodeTail(operations
,createSortOperation(
6703 REDIS_SORT_GET
,c
->argv
[j
+1]));
6707 decrRefCount(sortval
);
6708 listRelease(operations
);
6709 addReply(c
,shared
.syntaxerr
);
6715 /* Load the sorting vector with all the objects to sort */
6716 switch(sortval
->type
) {
6717 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6718 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6719 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6720 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6722 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6725 if (sortval
->type
== REDIS_LIST
) {
6726 list
*list
= sortval
->ptr
;
6730 listRewind(list
,&li
);
6731 while((ln
= listNext(&li
))) {
6732 robj
*ele
= ln
->value
;
6733 vector
[j
].obj
= ele
;
6734 vector
[j
].u
.score
= 0;
6735 vector
[j
].u
.cmpobj
= NULL
;
6743 if (sortval
->type
== REDIS_SET
) {
6746 zset
*zs
= sortval
->ptr
;
6750 di
= dictGetIterator(set
);
6751 while((setele
= dictNext(di
)) != NULL
) {
6752 vector
[j
].obj
= dictGetEntryKey(setele
);
6753 vector
[j
].u
.score
= 0;
6754 vector
[j
].u
.cmpobj
= NULL
;
6757 dictReleaseIterator(di
);
6759 redisAssert(j
== vectorlen
);
6761 /* Now it's time to load the right scores in the sorting vector */
6762 if (dontsort
== 0) {
6763 for (j
= 0; j
< vectorlen
; j
++) {
6766 /* lookup value to sort by */
6767 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6768 if (!byval
) continue;
6770 /* use object itself to sort by */
6771 byval
= vector
[j
].obj
;
6775 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6777 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6778 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6779 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6780 /* Don't need to decode the object if it's
6781 * integer-encoded (the only encoding supported) so
6782 * far. We can just cast it */
6783 vector
[j
].u
.score
= (long)byval
->ptr
;
6785 redisAssert(1 != 1);
6789 /* when the object was retrieved using lookupKeyByPattern,
6790 * its refcount needs to be decreased. */
6792 decrRefCount(byval
);
6797 /* We are ready to sort the vector... perform a bit of sanity check
6798 * on the LIMIT option too. We'll use a partial version of quicksort. */
6799 start
= (limit_start
< 0) ? 0 : limit_start
;
6800 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6801 if (start
>= vectorlen
) {
6802 start
= vectorlen
-1;
6805 if (end
>= vectorlen
) end
= vectorlen
-1;
6807 if (dontsort
== 0) {
6808 server
.sort_desc
= desc
;
6809 server
.sort_alpha
= alpha
;
6810 server
.sort_bypattern
= sortby
? 1 : 0;
6811 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6812 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6814 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6817 /* Send command output to the output buffer, performing the specified
6818 * GET/DEL/INCR/DECR operations if any. */
6819 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6820 if (storekey
== NULL
) {
6821 /* STORE option not specified, sent the sorting result to client */
6822 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6823 for (j
= start
; j
<= end
; j
++) {
6827 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6828 listRewind(operations
,&li
);
6829 while((ln
= listNext(&li
))) {
6830 redisSortOperation
*sop
= ln
->value
;
6831 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6834 if (sop
->type
== REDIS_SORT_GET
) {
6836 addReply(c
,shared
.nullbulk
);
6838 addReplyBulk(c
,val
);
6842 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6847 robj
*listObject
= createListObject();
6848 list
*listPtr
= (list
*) listObject
->ptr
;
6850 /* STORE option specified, set the sorting result as a List object */
6851 for (j
= start
; j
<= end
; j
++) {
6856 listAddNodeTail(listPtr
,vector
[j
].obj
);
6857 incrRefCount(vector
[j
].obj
);
6859 listRewind(operations
,&li
);
6860 while((ln
= listNext(&li
))) {
6861 redisSortOperation
*sop
= ln
->value
;
6862 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6865 if (sop
->type
== REDIS_SORT_GET
) {
6867 listAddNodeTail(listPtr
,createStringObject("",0));
6869 /* We should do a incrRefCount on val because it is
6870 * added to the list, but also a decrRefCount because
6871 * it is returned by lookupKeyByPattern. This results
6872 * in doing nothing at all. */
6873 listAddNodeTail(listPtr
,val
);
6876 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6880 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6881 incrRefCount(storekey
);
6883 /* Note: we add 1 because the DB is dirty anyway since even if the
6884 * SORT result is empty a new key is set and maybe the old content
6886 server
.dirty
+= 1+outputlen
;
6887 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6891 decrRefCount(sortval
);
6892 listRelease(operations
);
6893 for (j
= 0; j
< vectorlen
; j
++) {
6894 if (alpha
&& vector
[j
].u
.cmpobj
)
6895 decrRefCount(vector
[j
].u
.cmpobj
);
6900 /* Convert an amount of bytes into a human readable string in the form
6901 * of 100B, 2G, 100M, 4K, and so forth. */
6902 static void bytesToHuman(char *s
, unsigned long long n
) {
6907 sprintf(s
,"%lluB",n
);
6909 } else if (n
< (1024*1024)) {
6910 d
= (double)n
/(1024);
6911 sprintf(s
,"%.2fK",d
);
6912 } else if (n
< (1024LL*1024*1024)) {
6913 d
= (double)n
/(1024*1024);
6914 sprintf(s
,"%.2fM",d
);
6915 } else if (n
< (1024LL*1024*1024*1024)) {
6916 d
= (double)n
/(1024LL*1024*1024);
6917 sprintf(s
,"%.2fG",d
);
6921 /* Create the string returned by the INFO command. This is decoupled
6922 * by the INFO command itself as we need to report the same information
6923 * on memory corruption problems. */
6924 static sds
genRedisInfoString(void) {
6926 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6930 bytesToHuman(hmem
,zmalloc_used_memory());
6931 info
= sdscatprintf(sdsempty(),
6932 "redis_version:%s\r\n"
6934 "multiplexing_api:%s\r\n"
6935 "process_id:%ld\r\n"
6936 "uptime_in_seconds:%ld\r\n"
6937 "uptime_in_days:%ld\r\n"
6938 "connected_clients:%d\r\n"
6939 "connected_slaves:%d\r\n"
6940 "blocked_clients:%d\r\n"
6941 "used_memory:%zu\r\n"
6942 "used_memory_human:%s\r\n"
6943 "changes_since_last_save:%lld\r\n"
6944 "bgsave_in_progress:%d\r\n"
6945 "last_save_time:%ld\r\n"
6946 "bgrewriteaof_in_progress:%d\r\n"
6947 "total_connections_received:%lld\r\n"
6948 "total_commands_processed:%lld\r\n"
6949 "expired_keys:%lld\r\n"
6950 "hash_max_zipmap_entries:%ld\r\n"
6951 "hash_max_zipmap_value:%ld\r\n"
6952 "pubsub_channels:%ld\r\n"
6953 "pubsub_patterns:%u\r\n"
6957 (sizeof(long) == 8) ? "64" : "32",
6962 listLength(server
.clients
)-listLength(server
.slaves
),
6963 listLength(server
.slaves
),
6964 server
.blpop_blocked_clients
,
6965 zmalloc_used_memory(),
6968 server
.bgsavechildpid
!= -1,
6970 server
.bgrewritechildpid
!= -1,
6971 server
.stat_numconnections
,
6972 server
.stat_numcommands
,
6973 server
.stat_expiredkeys
,
6974 server
.hash_max_zipmap_entries
,
6975 server
.hash_max_zipmap_value
,
6976 dictSize(server
.pubsub_channels
),
6977 listLength(server
.pubsub_patterns
),
6978 server
.vm_enabled
!= 0,
6979 server
.masterhost
== NULL
? "master" : "slave"
6981 if (server
.masterhost
) {
6982 info
= sdscatprintf(info
,
6983 "master_host:%s\r\n"
6984 "master_port:%d\r\n"
6985 "master_link_status:%s\r\n"
6986 "master_last_io_seconds_ago:%d\r\n"
6989 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6991 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6994 if (server
.vm_enabled
) {
6996 info
= sdscatprintf(info
,
6997 "vm_conf_max_memory:%llu\r\n"
6998 "vm_conf_page_size:%llu\r\n"
6999 "vm_conf_pages:%llu\r\n"
7000 "vm_stats_used_pages:%llu\r\n"
7001 "vm_stats_swapped_objects:%llu\r\n"
7002 "vm_stats_swappin_count:%llu\r\n"
7003 "vm_stats_swappout_count:%llu\r\n"
7004 "vm_stats_io_newjobs_len:%lu\r\n"
7005 "vm_stats_io_processing_len:%lu\r\n"
7006 "vm_stats_io_processed_len:%lu\r\n"
7007 "vm_stats_io_active_threads:%lu\r\n"
7008 "vm_stats_blocked_clients:%lu\r\n"
7009 ,(unsigned long long) server
.vm_max_memory
,
7010 (unsigned long long) server
.vm_page_size
,
7011 (unsigned long long) server
.vm_pages
,
7012 (unsigned long long) server
.vm_stats_used_pages
,
7013 (unsigned long long) server
.vm_stats_swapped_objects
,
7014 (unsigned long long) server
.vm_stats_swapins
,
7015 (unsigned long long) server
.vm_stats_swapouts
,
7016 (unsigned long) listLength(server
.io_newjobs
),
7017 (unsigned long) listLength(server
.io_processing
),
7018 (unsigned long) listLength(server
.io_processed
),
7019 (unsigned long) server
.io_active_threads
,
7020 (unsigned long) server
.vm_blocked_clients
7024 for (j
= 0; j
< server
.dbnum
; j
++) {
7025 long long keys
, vkeys
;
7027 keys
= dictSize(server
.db
[j
].dict
);
7028 vkeys
= dictSize(server
.db
[j
].expires
);
7029 if (keys
|| vkeys
) {
7030 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7037 static void infoCommand(redisClient
*c
) {
7038 sds info
= genRedisInfoString();
7039 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7040 (unsigned long)sdslen(info
)));
7041 addReplySds(c
,info
);
7042 addReply(c
,shared
.crlf
);
7045 static void monitorCommand(redisClient
*c
) {
7046 /* ignore MONITOR if aleady slave or in monitor mode */
7047 if (c
->flags
& REDIS_SLAVE
) return;
7049 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7051 listAddNodeTail(server
.monitors
,c
);
7052 addReply(c
,shared
.ok
);
7055 /* ================================= Expire ================================= */
7056 static int removeExpire(redisDb
*db
, robj
*key
) {
7057 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7064 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7065 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7073 /* Return the expire time of the specified key, or -1 if no expire
7074 * is associated with this key (i.e. the key is non volatile) */
7075 static time_t getExpire(redisDb
*db
, robj
*key
) {
7078 /* No expire? return ASAP */
7079 if (dictSize(db
->expires
) == 0 ||
7080 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7082 return (time_t) dictGetEntryVal(de
);
7085 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7089 /* No expire? return ASAP */
7090 if (dictSize(db
->expires
) == 0 ||
7091 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7093 /* Lookup the expire */
7094 when
= (time_t) dictGetEntryVal(de
);
7095 if (time(NULL
) <= when
) return 0;
7097 /* Delete the key */
7098 dictDelete(db
->expires
,key
);
7099 server
.stat_expiredkeys
++;
7100 return dictDelete(db
->dict
,key
) == DICT_OK
;
7103 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7106 /* No expire? return ASAP */
7107 if (dictSize(db
->expires
) == 0 ||
7108 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7110 /* Delete the key */
7112 server
.stat_expiredkeys
++;
7113 dictDelete(db
->expires
,key
);
7114 return dictDelete(db
->dict
,key
) == DICT_OK
;
7117 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7121 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7125 de
= dictFind(c
->db
->dict
,key
);
7127 addReply(c
,shared
.czero
);
7131 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7132 addReply(c
, shared
.cone
);
7135 time_t when
= time(NULL
)+seconds
;
7136 if (setExpire(c
->db
,key
,when
)) {
7137 addReply(c
,shared
.cone
);
7140 addReply(c
,shared
.czero
);
7146 static void expireCommand(redisClient
*c
) {
7147 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7150 static void expireatCommand(redisClient
*c
) {
7151 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7154 static void ttlCommand(redisClient
*c
) {
7158 expire
= getExpire(c
->db
,c
->argv
[1]);
7160 ttl
= (int) (expire
-time(NULL
));
7161 if (ttl
< 0) ttl
= -1;
7163 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7166 /* ================================ MULTI/EXEC ============================== */
7168 /* Client state initialization for MULTI/EXEC */
7169 static void initClientMultiState(redisClient
*c
) {
7170 c
->mstate
.commands
= NULL
;
7171 c
->mstate
.count
= 0;
7174 /* Release all the resources associated with MULTI/EXEC state */
7175 static void freeClientMultiState(redisClient
*c
) {
7178 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7180 multiCmd
*mc
= c
->mstate
.commands
+j
;
7182 for (i
= 0; i
< mc
->argc
; i
++)
7183 decrRefCount(mc
->argv
[i
]);
7186 zfree(c
->mstate
.commands
);
7189 /* Add a new command into the MULTI commands queue */
7190 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7194 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7195 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7196 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7199 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7200 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7201 for (j
= 0; j
< c
->argc
; j
++)
7202 incrRefCount(mc
->argv
[j
]);
7206 static void multiCommand(redisClient
*c
) {
7207 c
->flags
|= REDIS_MULTI
;
7208 addReply(c
,shared
.ok
);
7211 static void discardCommand(redisClient
*c
) {
7212 if (!(c
->flags
& REDIS_MULTI
)) {
7213 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7217 freeClientMultiState(c
);
7218 initClientMultiState(c
);
7219 c
->flags
&= (~REDIS_MULTI
);
7220 addReply(c
,shared
.ok
);
7223 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7224 * implememntation for more information. */
7225 static void execCommandReplicateMulti(redisClient
*c
) {
7226 struct redisCommand
*cmd
;
7227 robj
*multistring
= createStringObject("MULTI",5);
7229 cmd
= lookupCommand("multi");
7230 if (server
.appendonly
)
7231 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7232 if (listLength(server
.slaves
))
7233 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7234 decrRefCount(multistring
);
7237 static void execCommand(redisClient
*c
) {
7242 if (!(c
->flags
& REDIS_MULTI
)) {
7243 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7247 /* Replicate a MULTI request now that we are sure the block is executed.
7248 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7249 * both the AOF and the replication link will have the same consistency
7250 * and atomicity guarantees. */
7251 execCommandReplicateMulti(c
);
7253 /* Exec all the queued commands */
7254 orig_argv
= c
->argv
;
7255 orig_argc
= c
->argc
;
7256 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7257 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7258 c
->argc
= c
->mstate
.commands
[j
].argc
;
7259 c
->argv
= c
->mstate
.commands
[j
].argv
;
7260 call(c
,c
->mstate
.commands
[j
].cmd
);
7262 c
->argv
= orig_argv
;
7263 c
->argc
= orig_argc
;
7264 freeClientMultiState(c
);
7265 initClientMultiState(c
);
7266 c
->flags
&= (~REDIS_MULTI
);
7267 /* Make sure the EXEC command is always replicated / AOF, since we
7268 * always send the MULTI command (we can't know beforehand if the
7269 * next operations will contain at least a modification to the DB). */
7273 /* =========================== Blocking Operations ========================= */
7275 /* Currently Redis blocking operations support is limited to list POP ops,
7276 * so the current implementation is not fully generic, but it is also not
7277 * completely specific so it will not require a rewrite to support new
7278 * kind of blocking operations in the future.
7280 * Still it's important to note that list blocking operations can be already
7281 * used as a notification mechanism in order to implement other blocking
7282 * operations at application level, so there must be a very strong evidence
7283 * of usefulness and generality before new blocking operations are implemented.
7285 * This is how the current blocking POP works, we use BLPOP as example:
7286 * - If the user calls BLPOP and the key exists and contains a non empty list
7287 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7288 * if there is not to block.
7289 * - If instead BLPOP is called and the key does not exists or the list is
7290 * empty we need to block. In order to do so we remove the notification for
7291 * new data to read in the client socket (so that we'll not serve new
7292 * requests if the blocking request is not served). Also we put the client
7293 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7294 * blocking for this keys.
7295 * - If a PUSH operation against a key with blocked clients waiting is
7296 * performed, we serve the first in the list: basically instead to push
7297 * the new element inside the list we return it to the (first / oldest)
7298 * blocking client, unblock the client, and remove it form the list.
7300 * The above comment and the source code should be enough in order to understand
7301 * the implementation and modify / fix it later.
7304 /* Set a client in blocking mode for the specified key, with the specified
7306 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7311 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7312 c
->blockingkeysnum
= numkeys
;
7313 c
->blockingto
= timeout
;
7314 for (j
= 0; j
< numkeys
; j
++) {
7315 /* Add the key in the client structure, to map clients -> keys */
7316 c
->blockingkeys
[j
] = keys
[j
];
7317 incrRefCount(keys
[j
]);
7319 /* And in the other "side", to map keys -> clients */
7320 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7324 /* For every key we take a list of clients blocked for it */
7326 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7327 incrRefCount(keys
[j
]);
7328 assert(retval
== DICT_OK
);
7330 l
= dictGetEntryVal(de
);
7332 listAddNodeTail(l
,c
);
7334 /* Mark the client as a blocked client */
7335 c
->flags
|= REDIS_BLOCKED
;
7336 server
.blpop_blocked_clients
++;
7339 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7340 static void unblockClientWaitingData(redisClient
*c
) {
7345 assert(c
->blockingkeys
!= NULL
);
7346 /* The client may wait for multiple keys, so unblock it for every key. */
7347 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7348 /* Remove this client from the list of clients waiting for this key. */
7349 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7351 l
= dictGetEntryVal(de
);
7352 listDelNode(l
,listSearchKey(l
,c
));
7353 /* If the list is empty we need to remove it to avoid wasting memory */
7354 if (listLength(l
) == 0)
7355 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7356 decrRefCount(c
->blockingkeys
[j
]);
7358 /* Cleanup the client structure */
7359 zfree(c
->blockingkeys
);
7360 c
->blockingkeys
= NULL
;
7361 c
->flags
&= (~REDIS_BLOCKED
);
7362 server
.blpop_blocked_clients
--;
7363 /* We want to process data if there is some command waiting
7364 * in the input buffer. Note that this is safe even if
7365 * unblockClientWaitingData() gets called from freeClient() because
7366 * freeClient() will be smart enough to call this function
7367 * *after* c->querybuf was set to NULL. */
7368 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7371 /* This should be called from any function PUSHing into lists.
7372 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7373 * 'ele' is the element pushed.
7375 * If the function returns 0 there was no client waiting for a list push
7378 * If the function returns 1 there was a client waiting for a list push
7379 * against this key, the element was passed to this client thus it's not
7380 * needed to actually add it to the list and the caller should return asap. */
7381 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7382 struct dictEntry
*de
;
7383 redisClient
*receiver
;
7387 de
= dictFind(c
->db
->blockingkeys
,key
);
7388 if (de
== NULL
) return 0;
7389 l
= dictGetEntryVal(de
);
7392 receiver
= ln
->value
;
7394 addReplySds(receiver
,sdsnew("*2\r\n"));
7395 addReplyBulk(receiver
,key
);
7396 addReplyBulk(receiver
,ele
);
7397 unblockClientWaitingData(receiver
);
7401 /* Blocking RPOP/LPOP */
7402 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7407 for (j
= 1; j
< c
->argc
-1; j
++) {
7408 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7410 if (o
->type
!= REDIS_LIST
) {
7411 addReply(c
,shared
.wrongtypeerr
);
7414 list
*list
= o
->ptr
;
7415 if (listLength(list
) != 0) {
7416 /* If the list contains elements fall back to the usual
7417 * non-blocking POP operation */
7418 robj
*argv
[2], **orig_argv
;
7421 /* We need to alter the command arguments before to call
7422 * popGenericCommand() as the command takes a single key. */
7423 orig_argv
= c
->argv
;
7424 orig_argc
= c
->argc
;
7425 argv
[1] = c
->argv
[j
];
7429 /* Also the return value is different, we need to output
7430 * the multi bulk reply header and the key name. The
7431 * "real" command will add the last element (the value)
7432 * for us. If this souds like an hack to you it's just
7433 * because it is... */
7434 addReplySds(c
,sdsnew("*2\r\n"));
7435 addReplyBulk(c
,argv
[1]);
7436 popGenericCommand(c
,where
);
7438 /* Fix the client structure with the original stuff */
7439 c
->argv
= orig_argv
;
7440 c
->argc
= orig_argc
;
7446 /* If the list is empty or the key does not exists we must block */
7447 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7448 if (timeout
> 0) timeout
+= time(NULL
);
7449 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7452 static void blpopCommand(redisClient
*c
) {
7453 blockingPopGenericCommand(c
,REDIS_HEAD
);
7456 static void brpopCommand(redisClient
*c
) {
7457 blockingPopGenericCommand(c
,REDIS_TAIL
);
7460 /* =============================== Replication ============================= */
7462 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7463 ssize_t nwritten
, ret
= size
;
7464 time_t start
= time(NULL
);
7468 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7469 nwritten
= write(fd
,ptr
,size
);
7470 if (nwritten
== -1) return -1;
7474 if ((time(NULL
)-start
) > timeout
) {
7482 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7483 ssize_t nread
, totread
= 0;
7484 time_t start
= time(NULL
);
7488 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7489 nread
= read(fd
,ptr
,size
);
7490 if (nread
== -1) return -1;
7495 if ((time(NULL
)-start
) > timeout
) {
7503 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7510 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7513 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7524 static void syncCommand(redisClient
*c
) {
7525 /* ignore SYNC if aleady slave or in monitor mode */
7526 if (c
->flags
& REDIS_SLAVE
) return;
7528 /* SYNC can't be issued when the server has pending data to send to
7529 * the client about already issued commands. We need a fresh reply
7530 * buffer registering the differences between the BGSAVE and the current
7531 * dataset, so that we can copy to other slaves if needed. */
7532 if (listLength(c
->reply
) != 0) {
7533 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7537 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7538 /* Here we need to check if there is a background saving operation
7539 * in progress, or if it is required to start one */
7540 if (server
.bgsavechildpid
!= -1) {
7541 /* Ok a background save is in progress. Let's check if it is a good
7542 * one for replication, i.e. if there is another slave that is
7543 * registering differences since the server forked to save */
7548 listRewind(server
.slaves
,&li
);
7549 while((ln
= listNext(&li
))) {
7551 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7554 /* Perfect, the server is already registering differences for
7555 * another slave. Set the right state, and copy the buffer. */
7556 listRelease(c
->reply
);
7557 c
->reply
= listDup(slave
->reply
);
7558 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7559 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7561 /* No way, we need to wait for the next BGSAVE in order to
7562 * register differences */
7563 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7564 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7567 /* Ok we don't have a BGSAVE in progress, let's start one */
7568 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7569 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7570 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7571 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7574 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7577 c
->flags
|= REDIS_SLAVE
;
7579 listAddNodeTail(server
.slaves
,c
);
7583 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7584 redisClient
*slave
= privdata
;
7586 REDIS_NOTUSED(mask
);
7587 char buf
[REDIS_IOBUF_LEN
];
7588 ssize_t nwritten
, buflen
;
7590 if (slave
->repldboff
== 0) {
7591 /* Write the bulk write count before to transfer the DB. In theory here
7592 * we don't know how much room there is in the output buffer of the
7593 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7594 * operations) will never be smaller than the few bytes we need. */
7597 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7599 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7607 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7608 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7610 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7611 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7615 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7616 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7621 slave
->repldboff
+= nwritten
;
7622 if (slave
->repldboff
== slave
->repldbsize
) {
7623 close(slave
->repldbfd
);
7624 slave
->repldbfd
= -1;
7625 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7626 slave
->replstate
= REDIS_REPL_ONLINE
;
7627 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7628 sendReplyToClient
, slave
) == AE_ERR
) {
7632 addReplySds(slave
,sdsempty());
7633 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7637 /* This function is called at the end of every backgrond saving.
7638 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7639 * otherwise REDIS_ERR is passed to the function.
7641 * The goal of this function is to handle slaves waiting for a successful
7642 * background saving in order to perform non-blocking synchronization. */
7643 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7645 int startbgsave
= 0;
7648 listRewind(server
.slaves
,&li
);
7649 while((ln
= listNext(&li
))) {
7650 redisClient
*slave
= ln
->value
;
7652 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7654 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7655 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7656 struct redis_stat buf
;
7658 if (bgsaveerr
!= REDIS_OK
) {
7660 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7663 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7664 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7666 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7669 slave
->repldboff
= 0;
7670 slave
->repldbsize
= buf
.st_size
;
7671 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7672 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7673 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7680 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7683 listRewind(server
.slaves
,&li
);
7684 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7685 while((ln
= listNext(&li
))) {
7686 redisClient
*slave
= ln
->value
;
7688 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7695 static int syncWithMaster(void) {
7696 char buf
[1024], tmpfile
[256], authcmd
[1024];
7698 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7699 int dfd
, maxtries
= 5;
7702 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7707 /* AUTH with the master if required. */
7708 if(server
.masterauth
) {
7709 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7710 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7712 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7716 /* Read the AUTH result. */
7717 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7719 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7723 if (buf
[0] != '+') {
7725 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7730 /* Issue the SYNC command */
7731 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7733 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7737 /* Read the bulk write count */
7738 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7740 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7744 if (buf
[0] != '$') {
7746 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7749 dumpsize
= strtol(buf
+1,NULL
,10);
7750 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7751 /* Read the bulk write data on a temp file */
7753 snprintf(tmpfile
,256,
7754 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7755 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7756 if (dfd
!= -1) break;
7761 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7765 int nread
, nwritten
;
7767 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7769 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7775 nwritten
= write(dfd
,buf
,nread
);
7776 if (nwritten
== -1) {
7777 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7785 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7786 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7792 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7793 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7797 server
.master
= createClient(fd
);
7798 server
.master
->flags
|= REDIS_MASTER
;
7799 server
.master
->authenticated
= 1;
7800 server
.replstate
= REDIS_REPL_CONNECTED
;
7804 static void slaveofCommand(redisClient
*c
) {
7805 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7806 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7807 if (server
.masterhost
) {
7808 sdsfree(server
.masterhost
);
7809 server
.masterhost
= NULL
;
7810 if (server
.master
) freeClient(server
.master
);
7811 server
.replstate
= REDIS_REPL_NONE
;
7812 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7815 sdsfree(server
.masterhost
);
7816 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7817 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7818 if (server
.master
) freeClient(server
.master
);
7819 server
.replstate
= REDIS_REPL_CONNECT
;
7820 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7821 server
.masterhost
, server
.masterport
);
7823 addReply(c
,shared
.ok
);
7826 /* ============================ Maxmemory directive ======================== */
7828 /* Try to free one object form the pre-allocated objects free list.
7829 * This is useful under low mem conditions as by default we take 1 million
7830 * free objects allocated. On success REDIS_OK is returned, otherwise
7832 static int tryFreeOneObjectFromFreelist(void) {
7835 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7836 if (listLength(server
.objfreelist
)) {
7837 listNode
*head
= listFirst(server
.objfreelist
);
7838 o
= listNodeValue(head
);
7839 listDelNode(server
.objfreelist
,head
);
7840 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7844 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7849 /* This function gets called when 'maxmemory' is set on the config file to limit
7850 * the max memory used by the server, and we are out of memory.
7851 * This function will try to, in order:
7853 * - Free objects from the free list
7854 * - Try to remove keys with an EXPIRE set
7856 * It is not possible to free enough memory to reach used-memory < maxmemory
7857 * the server will start refusing commands that will enlarge even more the
7860 static void freeMemoryIfNeeded(void) {
7861 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7862 int j
, k
, freed
= 0;
7864 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7865 for (j
= 0; j
< server
.dbnum
; j
++) {
7867 robj
*minkey
= NULL
;
7868 struct dictEntry
*de
;
7870 if (dictSize(server
.db
[j
].expires
)) {
7872 /* From a sample of three keys drop the one nearest to
7873 * the natural expire */
7874 for (k
= 0; k
< 3; k
++) {
7877 de
= dictGetRandomKey(server
.db
[j
].expires
);
7878 t
= (time_t) dictGetEntryVal(de
);
7879 if (minttl
== -1 || t
< minttl
) {
7880 minkey
= dictGetEntryKey(de
);
7884 deleteKey(server
.db
+j
,minkey
);
7887 if (!freed
) return; /* nothing to free... */
7891 /* ============================== Append Only file ========================== */
7893 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7894 sds buf
= sdsempty();
7900 /* The DB this command was targetting is not the same as the last command
7901 * we appendend. To issue a SELECT command is needed. */
7902 if (dictid
!= server
.appendseldb
) {
7905 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7906 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7907 (unsigned long)strlen(seldb
),seldb
);
7908 server
.appendseldb
= dictid
;
7911 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7912 * EXPIREs into EXPIREATs calls */
7913 if (cmd
->proc
== expireCommand
) {
7916 tmpargv
[0] = createStringObject("EXPIREAT",8);
7917 tmpargv
[1] = argv
[1];
7918 incrRefCount(argv
[1]);
7919 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7920 tmpargv
[2] = createObject(REDIS_STRING
,
7921 sdscatprintf(sdsempty(),"%ld",when
));
7925 /* Append the actual command */
7926 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7927 for (j
= 0; j
< argc
; j
++) {
7930 o
= getDecodedObject(o
);
7931 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7932 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7933 buf
= sdscatlen(buf
,"\r\n",2);
7937 /* Free the objects from the modified argv for EXPIREAT */
7938 if (cmd
->proc
== expireCommand
) {
7939 for (j
= 0; j
< 3; j
++)
7940 decrRefCount(argv
[j
]);
7943 /* We want to perform a single write. This should be guaranteed atomic
7944 * at least if the filesystem we are writing is a real physical one.
7945 * While this will save us against the server being killed I don't think
7946 * there is much to do about the whole server stopping for power problems
7948 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7949 if (nwritten
!= (signed)sdslen(buf
)) {
7950 /* Ooops, we are in troubles. The best thing to do for now is
7951 * to simply exit instead to give the illusion that everything is
7952 * working as expected. */
7953 if (nwritten
== -1) {
7954 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7956 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7960 /* If a background append only file rewriting is in progress we want to
7961 * accumulate the differences between the child DB and the current one
7962 * in a buffer, so that when the child process will do its work we
7963 * can append the differences to the new append only file. */
7964 if (server
.bgrewritechildpid
!= -1)
7965 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7969 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7970 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7971 now
-server
.lastfsync
> 1))
7973 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7974 server
.lastfsync
= now
;
7978 /* In Redis commands are always executed in the context of a client, so in
7979 * order to load the append only file we need to create a fake client. */
7980 static struct redisClient
*createFakeClient(void) {
7981 struct redisClient
*c
= zmalloc(sizeof(*c
));
7985 c
->querybuf
= sdsempty();
7989 /* We set the fake client as a slave waiting for the synchronization
7990 * so that Redis will not try to send replies to this client. */
7991 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7992 c
->reply
= listCreate();
7993 listSetFreeMethod(c
->reply
,decrRefCount
);
7994 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7998 static void freeFakeClient(struct redisClient
*c
) {
7999 sdsfree(c
->querybuf
);
8000 listRelease(c
->reply
);
8004 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8005 * error (the append only file is zero-length) REDIS_ERR is returned. On
8006 * fatal error an error message is logged and the program exists. */
8007 int loadAppendOnlyFile(char *filename
) {
8008 struct redisClient
*fakeClient
;
8009 FILE *fp
= fopen(filename
,"r");
8010 struct redis_stat sb
;
8011 unsigned long long loadedkeys
= 0;
8013 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8017 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8021 fakeClient
= createFakeClient();
8028 struct redisCommand
*cmd
;
8030 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8036 if (buf
[0] != '*') goto fmterr
;
8038 argv
= zmalloc(sizeof(robj
*)*argc
);
8039 for (j
= 0; j
< argc
; j
++) {
8040 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8041 if (buf
[0] != '$') goto fmterr
;
8042 len
= strtol(buf
+1,NULL
,10);
8043 argsds
= sdsnewlen(NULL
,len
);
8044 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8045 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8046 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8049 /* Command lookup */
8050 cmd
= lookupCommand(argv
[0]->ptr
);
8052 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8055 /* Try object encoding */
8056 if (cmd
->flags
& REDIS_CMD_BULK
)
8057 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8058 /* Run the command in the context of a fake client */
8059 fakeClient
->argc
= argc
;
8060 fakeClient
->argv
= argv
;
8061 cmd
->proc(fakeClient
);
8062 /* Discard the reply objects list from the fake client */
8063 while(listLength(fakeClient
->reply
))
8064 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8065 /* Clean up, ready for the next command */
8066 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8068 /* Handle swapping while loading big datasets when VM is on */
8070 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8071 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8072 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8077 freeFakeClient(fakeClient
);
8082 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8084 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8088 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8092 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8093 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8097 /* Avoid the incr/decr ref count business if possible to help
8098 * copy-on-write (we are often in a child process when this function
8100 * Also makes sure that key objects don't get incrRefCount-ed when VM
8102 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8103 obj
= getDecodedObject(obj
);
8106 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8107 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8108 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8110 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8111 if (decrrc
) decrRefCount(obj
);
8114 if (decrrc
) decrRefCount(obj
);
8118 /* Write binary-safe string into a file in the bulkformat
8119 * $<count>\r\n<payload>\r\n */
8120 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8123 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8124 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8125 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8126 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8130 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8131 static int fwriteBulkDouble(FILE *fp
, double d
) {
8132 char buf
[128], dbuf
[128];
8134 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8135 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8136 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8137 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8141 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8142 static int fwriteBulkLong(FILE *fp
, long l
) {
8143 char buf
[128], lbuf
[128];
8145 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8146 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8147 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8148 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8152 /* Write a sequence of commands able to fully rebuild the dataset into
8153 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8154 static int rewriteAppendOnlyFile(char *filename
) {
8155 dictIterator
*di
= NULL
;
8160 time_t now
= time(NULL
);
8162 /* Note that we have to use a different temp name here compared to the
8163 * one used by rewriteAppendOnlyFileBackground() function. */
8164 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8165 fp
= fopen(tmpfile
,"w");
8167 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8170 for (j
= 0; j
< server
.dbnum
; j
++) {
8171 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8172 redisDb
*db
= server
.db
+j
;
8174 if (dictSize(d
) == 0) continue;
8175 di
= dictGetIterator(d
);
8181 /* SELECT the new DB */
8182 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8183 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8185 /* Iterate this DB writing every entry */
8186 while((de
= dictNext(di
)) != NULL
) {
8191 key
= dictGetEntryKey(de
);
8192 /* If the value for this key is swapped, load a preview in memory.
8193 * We use a "swapped" flag to remember if we need to free the
8194 * value object instead to just increment the ref count anyway
8195 * in order to avoid copy-on-write of pages if we are forked() */
8196 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8197 key
->storage
== REDIS_VM_SWAPPING
) {
8198 o
= dictGetEntryVal(de
);
8201 o
= vmPreviewObject(key
);
8204 expiretime
= getExpire(db
,key
);
8206 /* Save the key and associated value */
8207 if (o
->type
== REDIS_STRING
) {
8208 /* Emit a SET command */
8209 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8210 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8212 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8213 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8214 } else if (o
->type
== REDIS_LIST
) {
8215 /* Emit the RPUSHes needed to rebuild the list */
8216 list
*list
= o
->ptr
;
8220 listRewind(list
,&li
);
8221 while((ln
= listNext(&li
))) {
8222 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8223 robj
*eleobj
= listNodeValue(ln
);
8225 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8226 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8227 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8229 } else if (o
->type
== REDIS_SET
) {
8230 /* Emit the SADDs needed to rebuild the set */
8232 dictIterator
*di
= dictGetIterator(set
);
8235 while((de
= dictNext(di
)) != NULL
) {
8236 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8237 robj
*eleobj
= dictGetEntryKey(de
);
8239 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8240 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8241 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8243 dictReleaseIterator(di
);
8244 } else if (o
->type
== REDIS_ZSET
) {
8245 /* Emit the ZADDs needed to rebuild the sorted set */
8247 dictIterator
*di
= dictGetIterator(zs
->dict
);
8250 while((de
= dictNext(di
)) != NULL
) {
8251 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8252 robj
*eleobj
= dictGetEntryKey(de
);
8253 double *score
= dictGetEntryVal(de
);
8255 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8256 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8257 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8258 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8260 dictReleaseIterator(di
);
8261 } else if (o
->type
== REDIS_HASH
) {
8262 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8264 /* Emit the HSETs needed to rebuild the hash */
8265 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8266 unsigned char *p
= zipmapRewind(o
->ptr
);
8267 unsigned char *field
, *val
;
8268 unsigned int flen
, vlen
;
8270 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8271 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8272 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8273 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8275 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8279 dictIterator
*di
= dictGetIterator(o
->ptr
);
8282 while((de
= dictNext(di
)) != NULL
) {
8283 robj
*field
= dictGetEntryKey(de
);
8284 robj
*val
= dictGetEntryVal(de
);
8286 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8287 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8288 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8289 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8291 dictReleaseIterator(di
);
8294 redisPanic("Unknown object type");
8296 /* Save the expire time */
8297 if (expiretime
!= -1) {
8298 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8299 /* If this key is already expired skip it */
8300 if (expiretime
< now
) continue;
8301 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8302 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8303 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8305 if (swapped
) decrRefCount(o
);
8307 dictReleaseIterator(di
);
8310 /* Make sure data will not remain on the OS's output buffers */
8315 /* Use RENAME to make sure the DB file is changed atomically only
8316 * if the generate DB file is ok. */
8317 if (rename(tmpfile
,filename
) == -1) {
8318 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8322 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8328 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8329 if (di
) dictReleaseIterator(di
);
8333 /* This is how rewriting of the append only file in background works:
8335 * 1) The user calls BGREWRITEAOF
8336 * 2) Redis calls this function, that forks():
8337 * 2a) the child rewrite the append only file in a temp file.
8338 * 2b) the parent accumulates differences in server.bgrewritebuf.
8339 * 3) When the child finished '2a' exists.
8340 * 4) The parent will trap the exit code, if it's OK, will append the
8341 * data accumulated into server.bgrewritebuf into the temp file, and
8342 * finally will rename(2) the temp file in the actual file name.
8343 * The the new file is reopened as the new append only file. Profit!
8345 static int rewriteAppendOnlyFileBackground(void) {
8348 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8349 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8350 if ((childpid
= fork()) == 0) {
8354 if (server
.vm_enabled
) vmReopenSwapFile();
8356 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8357 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8364 if (childpid
== -1) {
8365 redisLog(REDIS_WARNING
,
8366 "Can't rewrite append only file in background: fork: %s",
8370 redisLog(REDIS_NOTICE
,
8371 "Background append only file rewriting started by pid %d",childpid
);
8372 server
.bgrewritechildpid
= childpid
;
8373 updateDictResizePolicy();
8374 /* We set appendseldb to -1 in order to force the next call to the
8375 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8376 * accumulated by the parent into server.bgrewritebuf will start
8377 * with a SELECT statement and it will be safe to merge. */
8378 server
.appendseldb
= -1;
8381 return REDIS_OK
; /* unreached */
8384 static void bgrewriteaofCommand(redisClient
*c
) {
8385 if (server
.bgrewritechildpid
!= -1) {
8386 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8389 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8390 char *status
= "+Background append only file rewriting started\r\n";
8391 addReplySds(c
,sdsnew(status
));
8393 addReply(c
,shared
.err
);
8397 static void aofRemoveTempFile(pid_t childpid
) {
8400 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8404 /* Virtual Memory is composed mainly of two subsystems:
8405 * - Blocking Virutal Memory
8406 * - Threaded Virtual Memory I/O
8407 * The two parts are not fully decoupled, but functions are split among two
8408 * different sections of the source code (delimited by comments) in order to
8409 * make more clear what functionality is about the blocking VM and what about
8410 * the threaded (not blocking) VM.
8414 * Redis VM is a blocking VM (one that blocks reading swapped values from
8415 * disk into memory when a value swapped out is needed in memory) that is made
8416 * unblocking by trying to examine the command argument vector in order to
8417 * load in background values that will likely be needed in order to exec
8418 * the command. The command is executed only once all the relevant keys
8419 * are loaded into memory.
8421 * This basically is almost as simple of a blocking VM, but almost as parallel
8422 * as a fully non-blocking VM.
8425 /* =================== Virtual Memory - Blocking Side ====================== */
8427 /* substitute the first occurrence of '%p' with the process pid in the
8428 * swap file name. */
8429 static void expandVmSwapFilename(void) {
8430 char *p
= strstr(server
.vm_swap_file
,"%p");
8436 new = sdscat(new,server
.vm_swap_file
);
8437 new = sdscatprintf(new,"%ld",(long) getpid());
8438 new = sdscat(new,p
+2);
8439 zfree(server
.vm_swap_file
);
8440 server
.vm_swap_file
= new;
8443 static void vmInit(void) {
8448 if (server
.vm_max_threads
!= 0)
8449 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8451 expandVmSwapFilename();
8452 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8453 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8454 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8456 if (server
.vm_fp
== NULL
) {
8457 redisLog(REDIS_WARNING
,
8458 "Impossible to open the swap file: %s. Exiting.",
8462 server
.vm_fd
= fileno(server
.vm_fp
);
8463 server
.vm_next_page
= 0;
8464 server
.vm_near_pages
= 0;
8465 server
.vm_stats_used_pages
= 0;
8466 server
.vm_stats_swapped_objects
= 0;
8467 server
.vm_stats_swapouts
= 0;
8468 server
.vm_stats_swapins
= 0;
8469 totsize
= server
.vm_pages
*server
.vm_page_size
;
8470 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8471 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8472 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8476 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8478 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8479 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8480 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8481 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8483 /* Initialize threaded I/O (used by Virtual Memory) */
8484 server
.io_newjobs
= listCreate();
8485 server
.io_processing
= listCreate();
8486 server
.io_processed
= listCreate();
8487 server
.io_ready_clients
= listCreate();
8488 pthread_mutex_init(&server
.io_mutex
,NULL
);
8489 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8490 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8491 server
.io_active_threads
= 0;
8492 if (pipe(pipefds
) == -1) {
8493 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8497 server
.io_ready_pipe_read
= pipefds
[0];
8498 server
.io_ready_pipe_write
= pipefds
[1];
8499 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8500 /* LZF requires a lot of stack */
8501 pthread_attr_init(&server
.io_threads_attr
);
8502 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8503 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8504 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8505 /* Listen for events in the threaded I/O pipe */
8506 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8507 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8508 oom("creating file event");
8511 /* Mark the page as used */
8512 static void vmMarkPageUsed(off_t page
) {
8513 off_t byte
= page
/8;
8515 redisAssert(vmFreePage(page
) == 1);
8516 server
.vm_bitmap
[byte
] |= 1<<bit
;
8519 /* Mark N contiguous pages as used, with 'page' being the first. */
8520 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8523 for (j
= 0; j
< count
; j
++)
8524 vmMarkPageUsed(page
+j
);
8525 server
.vm_stats_used_pages
+= count
;
8526 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8527 (long long)count
, (long long)page
);
8530 /* Mark the page as free */
8531 static void vmMarkPageFree(off_t page
) {
8532 off_t byte
= page
/8;
8534 redisAssert(vmFreePage(page
) == 0);
8535 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8538 /* Mark N contiguous pages as free, with 'page' being the first. */
8539 static void vmMarkPagesFree(off_t page
, off_t count
) {
8542 for (j
= 0; j
< count
; j
++)
8543 vmMarkPageFree(page
+j
);
8544 server
.vm_stats_used_pages
-= count
;
8545 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8546 (long long)count
, (long long)page
);
8549 /* Test if the page is free */
8550 static int vmFreePage(off_t page
) {
8551 off_t byte
= page
/8;
8553 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8556 /* Find N contiguous free pages storing the first page of the cluster in *first.
8557 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8558 * REDIS_ERR is returned.
8560 * This function uses a simple algorithm: we try to allocate
8561 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8562 * again from the start of the swap file searching for free spaces.
8564 * If it looks pretty clear that there are no free pages near our offset
8565 * we try to find less populated places doing a forward jump of
8566 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8567 * without hurry, and then we jump again and so forth...
8569 * This function can be improved using a free list to avoid to guess
8570 * too much, since we could collect data about freed pages.
8572 * note: I implemented this function just after watching an episode of
8573 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8575 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8576 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8578 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8579 server
.vm_near_pages
= 0;
8580 server
.vm_next_page
= 0;
8582 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8583 base
= server
.vm_next_page
;
8585 while(offset
< server
.vm_pages
) {
8586 off_t
this = base
+offset
;
8588 /* If we overflow, restart from page zero */
8589 if (this >= server
.vm_pages
) {
8590 this -= server
.vm_pages
;
8592 /* Just overflowed, what we found on tail is no longer
8593 * interesting, as it's no longer contiguous. */
8597 if (vmFreePage(this)) {
8598 /* This is a free page */
8600 /* Already got N free pages? Return to the caller, with success */
8602 *first
= this-(n
-1);
8603 server
.vm_next_page
= this+1;
8604 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8608 /* The current one is not a free page */
8612 /* Fast-forward if the current page is not free and we already
8613 * searched enough near this place. */
8615 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8616 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8618 /* Note that even if we rewind after the jump, we are don't need
8619 * to make sure numfree is set to zero as we only jump *if* it
8620 * is set to zero. */
8622 /* Otherwise just check the next page */
8629 /* Write the specified object at the specified page of the swap file */
8630 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8631 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8632 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8633 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8634 redisLog(REDIS_WARNING
,
8635 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8639 rdbSaveObject(server
.vm_fp
,o
);
8640 fflush(server
.vm_fp
);
8641 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8645 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8646 * needed to later retrieve the object into the key object.
8647 * If we can't find enough contiguous empty pages to swap the object on disk
8648 * REDIS_ERR is returned. */
8649 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8650 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8653 assert(key
->storage
== REDIS_VM_MEMORY
);
8654 assert(key
->refcount
== 1);
8655 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8656 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8657 key
->vm
.page
= page
;
8658 key
->vm
.usedpages
= pages
;
8659 key
->storage
= REDIS_VM_SWAPPED
;
8660 key
->vtype
= val
->type
;
8661 decrRefCount(val
); /* Deallocate the object from memory. */
8662 vmMarkPagesUsed(page
,pages
);
8663 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8664 (unsigned char*) key
->ptr
,
8665 (unsigned long long) page
, (unsigned long long) pages
);
8666 server
.vm_stats_swapped_objects
++;
8667 server
.vm_stats_swapouts
++;
8671 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8674 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8675 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8676 redisLog(REDIS_WARNING
,
8677 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8681 o
= rdbLoadObject(type
,server
.vm_fp
);
8683 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8686 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8690 /* Load the value object relative to the 'key' object from swap to memory.
8691 * The newly allocated object is returned.
8693 * If preview is true the unserialized object is returned to the caller but
8694 * no changes are made to the key object, nor the pages are marked as freed */
8695 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8698 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8699 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8701 key
->storage
= REDIS_VM_MEMORY
;
8702 key
->vm
.atime
= server
.unixtime
;
8703 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8704 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8705 (unsigned char*) key
->ptr
);
8706 server
.vm_stats_swapped_objects
--;
8708 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8709 (unsigned char*) key
->ptr
);
8711 server
.vm_stats_swapins
++;
8715 /* Plain object loading, from swap to memory */
8716 static robj
*vmLoadObject(robj
*key
) {
8717 /* If we are loading the object in background, stop it, we
8718 * need to load this object synchronously ASAP. */
8719 if (key
->storage
== REDIS_VM_LOADING
)
8720 vmCancelThreadedIOJob(key
);
8721 return vmGenericLoadObject(key
,0);
8724 /* Just load the value on disk, without to modify the key.
8725 * This is useful when we want to perform some operation on the value
8726 * without to really bring it from swap to memory, like while saving the
8727 * dataset or rewriting the append only log. */
8728 static robj
*vmPreviewObject(robj
*key
) {
8729 return vmGenericLoadObject(key
,1);
8732 /* How a good candidate is this object for swapping?
8733 * The better candidate it is, the greater the returned value.
8735 * Currently we try to perform a fast estimation of the object size in
8736 * memory, and combine it with aging informations.
8738 * Basically swappability = idle-time * log(estimated size)
8740 * Bigger objects are preferred over smaller objects, but not
8741 * proportionally, this is why we use the logarithm. This algorithm is
8742 * just a first try and will probably be tuned later. */
8743 static double computeObjectSwappability(robj
*o
) {
8744 time_t age
= server
.unixtime
- o
->vm
.atime
;
8748 struct dictEntry
*de
;
8751 if (age
<= 0) return 0;
8754 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8757 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8762 listNode
*ln
= listFirst(l
);
8764 asize
= sizeof(list
);
8766 robj
*ele
= ln
->value
;
8769 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8770 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8772 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8777 z
= (o
->type
== REDIS_ZSET
);
8778 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8780 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8781 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8786 de
= dictGetRandomKey(d
);
8787 ele
= dictGetEntryKey(de
);
8788 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8789 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8791 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8792 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8796 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8797 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8798 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8799 unsigned int klen
, vlen
;
8800 unsigned char *key
, *val
;
8802 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8806 asize
= len
*(klen
+vlen
+3);
8807 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8809 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8814 de
= dictGetRandomKey(d
);
8815 ele
= dictGetEntryKey(de
);
8816 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8817 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8819 ele
= dictGetEntryVal(de
);
8820 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8821 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8823 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8828 return (double)age
*log(1+asize
);
8831 /* Try to swap an object that's a good candidate for swapping.
8832 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8833 * to swap any object at all.
8835 * If 'usethreaded' is true, Redis will try to swap the object in background
8836 * using I/O threads. */
8837 static int vmSwapOneObject(int usethreads
) {
8839 struct dictEntry
*best
= NULL
;
8840 double best_swappability
= 0;
8841 redisDb
*best_db
= NULL
;
8844 for (j
= 0; j
< server
.dbnum
; j
++) {
8845 redisDb
*db
= server
.db
+j
;
8846 /* Why maxtries is set to 100?
8847 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8848 * are swappable objects */
8851 if (dictSize(db
->dict
) == 0) continue;
8852 for (i
= 0; i
< 5; i
++) {
8854 double swappability
;
8856 if (maxtries
) maxtries
--;
8857 de
= dictGetRandomKey(db
->dict
);
8858 key
= dictGetEntryKey(de
);
8859 val
= dictGetEntryVal(de
);
8860 /* Only swap objects that are currently in memory.
8862 * Also don't swap shared objects if threaded VM is on, as we
8863 * try to ensure that the main thread does not touch the
8864 * object while the I/O thread is using it, but we can't
8865 * control other keys without adding additional mutex. */
8866 if (key
->storage
!= REDIS_VM_MEMORY
||
8867 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8868 if (maxtries
) i
--; /* don't count this try */
8871 swappability
= computeObjectSwappability(val
);
8872 if (!best
|| swappability
> best_swappability
) {
8874 best_swappability
= swappability
;
8879 if (best
== NULL
) return REDIS_ERR
;
8880 key
= dictGetEntryKey(best
);
8881 val
= dictGetEntryVal(best
);
8883 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8884 key
->ptr
, best_swappability
);
8886 /* Unshare the key if needed */
8887 if (key
->refcount
> 1) {
8888 robj
*newkey
= dupStringObject(key
);
8890 key
= dictGetEntryKey(best
) = newkey
;
8894 vmSwapObjectThreaded(key
,val
,best_db
);
8897 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8898 dictGetEntryVal(best
) = NULL
;
8906 static int vmSwapOneObjectBlocking() {
8907 return vmSwapOneObject(0);
8910 static int vmSwapOneObjectThreaded() {
8911 return vmSwapOneObject(1);
8914 /* Return true if it's safe to swap out objects in a given moment.
8915 * Basically we don't want to swap objects out while there is a BGSAVE
8916 * or a BGAEOREWRITE running in backgroud. */
8917 static int vmCanSwapOut(void) {
8918 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8921 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8922 * and was deleted. Otherwise 0 is returned. */
8923 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8927 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8928 foundkey
= dictGetEntryKey(de
);
8929 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8934 /* =================== Virtual Memory - Threaded I/O ======================= */
8936 static void freeIOJob(iojob
*j
) {
8937 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8938 j
->type
== REDIS_IOJOB_DO_SWAP
||
8939 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8940 decrRefCount(j
->val
);
8941 /* We don't decrRefCount the j->key field as we did't incremented
8942 * the count creating IO Jobs. This is because the key field here is
8943 * just used as an indentifier and if a key is removed the Job should
8944 * never be touched again. */
8948 /* Every time a thread finished a Job, it writes a byte into the write side
8949 * of an unix pipe in order to "awake" the main thread, and this function
8951 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8955 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8957 REDIS_NOTUSED(mask
);
8958 REDIS_NOTUSED(privdata
);
8960 /* For every byte we read in the read side of the pipe, there is one
8961 * I/O job completed to process. */
8962 while((retval
= read(fd
,buf
,1)) == 1) {
8966 struct dictEntry
*de
;
8968 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8970 /* Get the processed element (the oldest one) */
8972 assert(listLength(server
.io_processed
) != 0);
8973 if (toprocess
== -1) {
8974 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8975 if (toprocess
<= 0) toprocess
= 1;
8977 ln
= listFirst(server
.io_processed
);
8979 listDelNode(server
.io_processed
,ln
);
8981 /* If this job is marked as canceled, just ignore it */
8986 /* Post process it in the main thread, as there are things we
8987 * can do just here to avoid race conditions and/or invasive locks */
8988 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
);
8989 de
= dictFind(j
->db
->dict
,j
->key
);
8991 key
= dictGetEntryKey(de
);
8992 if (j
->type
== REDIS_IOJOB_LOAD
) {
8995 /* Key loaded, bring it at home */
8996 key
->storage
= REDIS_VM_MEMORY
;
8997 key
->vm
.atime
= server
.unixtime
;
8998 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8999 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9000 (unsigned char*) key
->ptr
);
9001 server
.vm_stats_swapped_objects
--;
9002 server
.vm_stats_swapins
++;
9003 dictGetEntryVal(de
) = j
->val
;
9004 incrRefCount(j
->val
);
9007 /* Handle clients waiting for this key to be loaded. */
9008 handleClientsBlockedOnSwappedKey(db
,key
);
9009 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9010 /* Now we know the amount of pages required to swap this object.
9011 * Let's find some space for it, and queue this task again
9012 * rebranded as REDIS_IOJOB_DO_SWAP. */
9013 if (!vmCanSwapOut() ||
9014 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9016 /* Ooops... no space or we can't swap as there is
9017 * a fork()ed Redis trying to save stuff on disk. */
9019 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9021 /* Note that we need to mark this pages as used now,
9022 * if the job will be canceled, we'll mark them as freed
9024 vmMarkPagesUsed(j
->page
,j
->pages
);
9025 j
->type
= REDIS_IOJOB_DO_SWAP
;
9030 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9033 /* Key swapped. We can finally free some memory. */
9034 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9035 printf("key->storage: %d\n",key
->storage
);
9036 printf("key->name: %s\n",(char*)key
->ptr
);
9037 printf("key->refcount: %d\n",key
->refcount
);
9038 printf("val: %p\n",(void*)j
->val
);
9039 printf("val->type: %d\n",j
->val
->type
);
9040 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9042 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9043 val
= dictGetEntryVal(de
);
9044 key
->vm
.page
= j
->page
;
9045 key
->vm
.usedpages
= j
->pages
;
9046 key
->storage
= REDIS_VM_SWAPPED
;
9047 key
->vtype
= j
->val
->type
;
9048 decrRefCount(val
); /* Deallocate the object from memory. */
9049 dictGetEntryVal(de
) = NULL
;
9050 redisLog(REDIS_DEBUG
,
9051 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9052 (unsigned char*) key
->ptr
,
9053 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9054 server
.vm_stats_swapped_objects
++;
9055 server
.vm_stats_swapouts
++;
9057 /* Put a few more swap requests in queue if we are still
9059 if (trytoswap
&& vmCanSwapOut() &&
9060 zmalloc_used_memory() > server
.vm_max_memory
)
9065 more
= listLength(server
.io_newjobs
) <
9066 (unsigned) server
.vm_max_threads
;
9068 /* Don't waste CPU time if swappable objects are rare. */
9069 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9077 if (processed
== toprocess
) return;
9079 if (retval
< 0 && errno
!= EAGAIN
) {
9080 redisLog(REDIS_WARNING
,
9081 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9086 static void lockThreadedIO(void) {
9087 pthread_mutex_lock(&server
.io_mutex
);
9090 static void unlockThreadedIO(void) {
9091 pthread_mutex_unlock(&server
.io_mutex
);
9094 /* Remove the specified object from the threaded I/O queue if still not
9095 * processed, otherwise make sure to flag it as canceled. */
9096 static void vmCancelThreadedIOJob(robj
*o
) {
9098 server
.io_newjobs
, /* 0 */
9099 server
.io_processing
, /* 1 */
9100 server
.io_processed
/* 2 */
9104 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9107 /* Search for a matching key in one of the queues */
9108 for (i
= 0; i
< 3; i
++) {
9112 listRewind(lists
[i
],&li
);
9113 while ((ln
= listNext(&li
)) != NULL
) {
9114 iojob
*job
= ln
->value
;
9116 if (job
->canceled
) continue; /* Skip this, already canceled. */
9117 if (job
->key
== o
) {
9118 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9119 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9120 /* Mark the pages as free since the swap didn't happened
9121 * or happened but is now discarded. */
9122 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9123 vmMarkPagesFree(job
->page
,job
->pages
);
9124 /* Cancel the job. It depends on the list the job is
9127 case 0: /* io_newjobs */
9128 /* If the job was yet not processed the best thing to do
9129 * is to remove it from the queue at all */
9131 listDelNode(lists
[i
],ln
);
9133 case 1: /* io_processing */
9134 /* Oh Shi- the thread is messing with the Job:
9136 * Probably it's accessing the object if this is a
9137 * PREPARE_SWAP or DO_SWAP job.
9138 * If it's a LOAD job it may be reading from disk and
9139 * if we don't wait for the job to terminate before to
9140 * cancel it, maybe in a few microseconds data can be
9141 * corrupted in this pages. So the short story is:
9143 * Better to wait for the job to move into the
9144 * next queue (processed)... */
9146 /* We try again and again until the job is completed. */
9148 /* But let's wait some time for the I/O thread
9149 * to finish with this job. After all this condition
9150 * should be very rare. */
9153 case 2: /* io_processed */
9154 /* The job was already processed, that's easy...
9155 * just mark it as canceled so that we'll ignore it
9156 * when processing completed jobs. */
9160 /* Finally we have to adjust the storage type of the object
9161 * in order to "UNDO" the operaiton. */
9162 if (o
->storage
== REDIS_VM_LOADING
)
9163 o
->storage
= REDIS_VM_SWAPPED
;
9164 else if (o
->storage
== REDIS_VM_SWAPPING
)
9165 o
->storage
= REDIS_VM_MEMORY
;
9172 assert(1 != 1); /* We should never reach this */
9175 static void *IOThreadEntryPoint(void *arg
) {
9180 pthread_detach(pthread_self());
9182 /* Get a new job to process */
9184 if (listLength(server
.io_newjobs
) == 0) {
9185 /* No new jobs in queue, exit. */
9186 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9187 (long) pthread_self());
9188 server
.io_active_threads
--;
9192 ln
= listFirst(server
.io_newjobs
);
9194 listDelNode(server
.io_newjobs
,ln
);
9195 /* Add the job in the processing queue */
9196 j
->thread
= pthread_self();
9197 listAddNodeTail(server
.io_processing
,j
);
9198 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9200 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9201 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9203 /* Process the Job */
9204 if (j
->type
== REDIS_IOJOB_LOAD
) {
9205 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9206 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9207 FILE *fp
= fopen("/dev/null","w+");
9208 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9210 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9211 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9215 /* Done: insert the job into the processed queue */
9216 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9217 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9219 listDelNode(server
.io_processing
,ln
);
9220 listAddNodeTail(server
.io_processed
,j
);
9223 /* Signal the main thread there is new stuff to process */
9224 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9226 return NULL
; /* never reached */
9229 static void spawnIOThread(void) {
9231 sigset_t mask
, omask
;
9235 sigaddset(&mask
,SIGCHLD
);
9236 sigaddset(&mask
,SIGHUP
);
9237 sigaddset(&mask
,SIGPIPE
);
9238 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9239 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9240 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9244 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9245 server
.io_active_threads
++;
9248 /* We need to wait for the last thread to exit before we are able to
9249 * fork() in order to BGSAVE or BGREWRITEAOF. */
9250 static void waitEmptyIOJobsQueue(void) {
9252 int io_processed_len
;
9255 if (listLength(server
.io_newjobs
) == 0 &&
9256 listLength(server
.io_processing
) == 0 &&
9257 server
.io_active_threads
== 0)
9262 /* While waiting for empty jobs queue condition we post-process some
9263 * finshed job, as I/O threads may be hanging trying to write against
9264 * the io_ready_pipe_write FD but there are so much pending jobs that
9266 io_processed_len
= listLength(server
.io_processed
);
9268 if (io_processed_len
) {
9269 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9270 usleep(1000); /* 1 millisecond */
9272 usleep(10000); /* 10 milliseconds */
9277 static void vmReopenSwapFile(void) {
9278 /* Note: we don't close the old one as we are in the child process
9279 * and don't want to mess at all with the original file object. */
9280 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9281 if (server
.vm_fp
== NULL
) {
9282 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9283 server
.vm_swap_file
);
9286 server
.vm_fd
= fileno(server
.vm_fp
);
9289 /* This function must be called while with threaded IO locked */
9290 static void queueIOJob(iojob
*j
) {
9291 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9292 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9293 listAddNodeTail(server
.io_newjobs
,j
);
9294 if (server
.io_active_threads
< server
.vm_max_threads
)
9298 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9301 assert(key
->storage
== REDIS_VM_MEMORY
);
9302 assert(key
->refcount
== 1);
9304 j
= zmalloc(sizeof(*j
));
9305 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9311 j
->thread
= (pthread_t
) -1;
9312 key
->storage
= REDIS_VM_SWAPPING
;
9320 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9322 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9323 * If there is not already a job loading the key, it is craeted.
9324 * The key is added to the io_keys list in the client structure, and also
9325 * in the hash table mapping swapped keys to waiting clients, that is,
9326 * server.io_waited_keys. */
9327 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9328 struct dictEntry
*de
;
9332 /* If the key does not exist or is already in RAM we don't need to
9333 * block the client at all. */
9334 de
= dictFind(c
->db
->dict
,key
);
9335 if (de
== NULL
) return 0;
9336 o
= dictGetEntryKey(de
);
9337 if (o
->storage
== REDIS_VM_MEMORY
) {
9339 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9340 /* We were swapping the key, undo it! */
9341 vmCancelThreadedIOJob(o
);
9345 /* OK: the key is either swapped, or being loaded just now. */
9347 /* Add the key to the list of keys this client is waiting for.
9348 * This maps clients to keys they are waiting for. */
9349 listAddNodeTail(c
->io_keys
,key
);
9352 /* Add the client to the swapped keys => clients waiting map. */
9353 de
= dictFind(c
->db
->io_keys
,key
);
9357 /* For every key we take a list of clients blocked for it */
9359 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9361 assert(retval
== DICT_OK
);
9363 l
= dictGetEntryVal(de
);
9365 listAddNodeTail(l
,c
);
9367 /* Are we already loading the key from disk? If not create a job */
9368 if (o
->storage
== REDIS_VM_SWAPPED
) {
9371 o
->storage
= REDIS_VM_LOADING
;
9372 j
= zmalloc(sizeof(*j
));
9373 j
->type
= REDIS_IOJOB_LOAD
;
9376 j
->key
->vtype
= o
->vtype
;
9377 j
->page
= o
->vm
.page
;
9380 j
->thread
= (pthread_t
) -1;
9388 /* Preload keys needed for the ZUNION and ZINTER commands. */
9389 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9391 num
= atoi(c
->argv
[2]->ptr
);
9392 for (i
= 0; i
< num
; i
++) {
9393 waitForSwappedKey(c
,c
->argv
[3+i
]);
9397 /* Is this client attempting to run a command against swapped keys?
9398 * If so, block it ASAP, load the keys in background, then resume it.
9400 * The important idea about this function is that it can fail! If keys will
9401 * still be swapped when the client is resumed, this key lookups will
9402 * just block loading keys from disk. In practical terms this should only
9403 * happen with SORT BY command or if there is a bug in this function.
9405 * Return 1 if the client is marked as blocked, 0 if the client can
9406 * continue as the keys it is going to access appear to be in memory. */
9407 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9410 if (cmd
->vm_preload_proc
!= NULL
) {
9411 cmd
->vm_preload_proc(c
);
9413 if (cmd
->vm_firstkey
== 0) return 0;
9414 last
= cmd
->vm_lastkey
;
9415 if (last
< 0) last
= c
->argc
+last
;
9416 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9417 waitForSwappedKey(c
,c
->argv
[j
]);
9420 /* If the client was blocked for at least one key, mark it as blocked. */
9421 if (listLength(c
->io_keys
)) {
9422 c
->flags
|= REDIS_IO_WAIT
;
9423 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9424 server
.vm_blocked_clients
++;
9431 /* Remove the 'key' from the list of blocked keys for a given client.
9433 * The function returns 1 when there are no longer blocking keys after
9434 * the current one was removed (and the client can be unblocked). */
9435 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9439 struct dictEntry
*de
;
9441 /* Remove the key from the list of keys this client is waiting for. */
9442 listRewind(c
->io_keys
,&li
);
9443 while ((ln
= listNext(&li
)) != NULL
) {
9444 if (compareStringObjects(ln
->value
,key
) == 0) {
9445 listDelNode(c
->io_keys
,ln
);
9451 /* Remove the client form the key => waiting clients map. */
9452 de
= dictFind(c
->db
->io_keys
,key
);
9454 l
= dictGetEntryVal(de
);
9455 ln
= listSearchKey(l
,c
);
9458 if (listLength(l
) == 0)
9459 dictDelete(c
->db
->io_keys
,key
);
9461 return listLength(c
->io_keys
) == 0;
9464 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9465 struct dictEntry
*de
;
9470 de
= dictFind(db
->io_keys
,key
);
9473 l
= dictGetEntryVal(de
);
9474 len
= listLength(l
);
9475 /* Note: we can't use something like while(listLength(l)) as the list
9476 * can be freed by the calling function when we remove the last element. */
9479 redisClient
*c
= ln
->value
;
9481 if (dontWaitForSwappedKey(c
,key
)) {
9482 /* Put the client in the list of clients ready to go as we
9483 * loaded all the keys about it. */
9484 listAddNodeTail(server
.io_ready_clients
,c
);
9489 /* =========================== Remote Configuration ========================= */
9491 static void configSetCommand(redisClient
*c
) {
9492 robj
*o
= getDecodedObject(c
->argv
[3]);
9493 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9494 zfree(server
.dbfilename
);
9495 server
.dbfilename
= zstrdup(o
->ptr
);
9496 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9497 zfree(server
.requirepass
);
9498 server
.requirepass
= zstrdup(o
->ptr
);
9499 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9500 zfree(server
.masterauth
);
9501 server
.masterauth
= zstrdup(o
->ptr
);
9502 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9503 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9505 addReplySds(c
,sdscatprintf(sdsempty(),
9506 "-ERR not supported CONFIG parameter %s\r\n",
9507 (char*)c
->argv
[2]->ptr
));
9512 addReply(c
,shared
.ok
);
9515 static void configGetCommand(redisClient
*c
) {
9516 robj
*o
= getDecodedObject(c
->argv
[2]);
9517 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9518 char *pattern
= o
->ptr
;
9522 decrRefCount(lenobj
);
9524 if (stringmatch(pattern
,"dbfilename",0)) {
9525 addReplyBulkCString(c
,"dbfilename");
9526 addReplyBulkCString(c
,server
.dbfilename
);
9529 if (stringmatch(pattern
,"requirepass",0)) {
9530 addReplyBulkCString(c
,"requirepass");
9531 addReplyBulkCString(c
,server
.requirepass
);
9534 if (stringmatch(pattern
,"masterauth",0)) {
9535 addReplyBulkCString(c
,"masterauth");
9536 addReplyBulkCString(c
,server
.masterauth
);
9539 if (stringmatch(pattern
,"maxmemory",0)) {
9542 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9543 addReplyBulkCString(c
,"maxmemory");
9544 addReplyBulkCString(c
,buf
);
9548 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9551 static void configCommand(redisClient
*c
) {
9552 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9553 if (c
->argc
!= 4) goto badarity
;
9554 configSetCommand(c
);
9555 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9556 if (c
->argc
!= 3) goto badarity
;
9557 configGetCommand(c
);
9558 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9559 if (c
->argc
!= 2) goto badarity
;
9560 server
.stat_numcommands
= 0;
9561 server
.stat_numconnections
= 0;
9562 server
.stat_expiredkeys
= 0;
9563 server
.stat_starttime
= time(NULL
);
9564 addReply(c
,shared
.ok
);
9566 addReplySds(c
,sdscatprintf(sdsempty(),
9567 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9572 addReplySds(c
,sdscatprintf(sdsempty(),
9573 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9574 (char*) c
->argv
[1]->ptr
));
9577 /* =========================== Pubsub implementation ======================== */
9579 static void freePubsubPattern(void *p
) {
9580 pubsubPattern
*pat
= p
;
9582 decrRefCount(pat
->pattern
);
9586 static int listMatchPubsubPattern(void *a
, void *b
) {
9587 pubsubPattern
*pa
= a
, *pb
= b
;
9589 return (pa
->client
== pb
->client
) &&
9590 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9593 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9594 * 0 if the client was already subscribed to that channel. */
9595 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9596 struct dictEntry
*de
;
9597 list
*clients
= NULL
;
9600 /* Add the channel to the client -> channels hash table */
9601 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9603 incrRefCount(channel
);
9604 /* Add the client to the channel -> list of clients hash table */
9605 de
= dictFind(server
.pubsub_channels
,channel
);
9607 clients
= listCreate();
9608 dictAdd(server
.pubsub_channels
,channel
,clients
);
9609 incrRefCount(channel
);
9611 clients
= dictGetEntryVal(de
);
9613 listAddNodeTail(clients
,c
);
9615 /* Notify the client */
9616 addReply(c
,shared
.mbulk3
);
9617 addReply(c
,shared
.subscribebulk
);
9618 addReplyBulk(c
,channel
);
9619 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9623 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9624 * 0 if the client was not subscribed to the specified channel. */
9625 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9626 struct dictEntry
*de
;
9631 /* Remove the channel from the client -> channels hash table */
9632 incrRefCount(channel
); /* channel may be just a pointer to the same object
9633 we have in the hash tables. Protect it... */
9634 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9636 /* Remove the client from the channel -> clients list hash table */
9637 de
= dictFind(server
.pubsub_channels
,channel
);
9639 clients
= dictGetEntryVal(de
);
9640 ln
= listSearchKey(clients
,c
);
9642 listDelNode(clients
,ln
);
9643 if (listLength(clients
) == 0) {
9644 /* Free the list and associated hash entry at all if this was
9645 * the latest client, so that it will be possible to abuse
9646 * Redis PUBSUB creating millions of channels. */
9647 dictDelete(server
.pubsub_channels
,channel
);
9650 /* Notify the client */
9652 addReply(c
,shared
.mbulk3
);
9653 addReply(c
,shared
.unsubscribebulk
);
9654 addReplyBulk(c
,channel
);
9655 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9656 listLength(c
->pubsub_patterns
));
9659 decrRefCount(channel
); /* it is finally safe to release it */
9663 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9664 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9667 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9670 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9671 incrRefCount(pattern
);
9672 pat
= zmalloc(sizeof(*pat
));
9673 pat
->pattern
= getDecodedObject(pattern
);
9675 listAddNodeTail(server
.pubsub_patterns
,pat
);
9677 /* Notify the client */
9678 addReply(c
,shared
.mbulk3
);
9679 addReply(c
,shared
.psubscribebulk
);
9680 addReplyBulk(c
,pattern
);
9681 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9685 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9686 * 0 if the client was not subscribed to the specified channel. */
9687 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9692 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9693 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9695 listDelNode(c
->pubsub_patterns
,ln
);
9697 pat
.pattern
= pattern
;
9698 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9699 listDelNode(server
.pubsub_patterns
,ln
);
9701 /* Notify the client */
9703 addReply(c
,shared
.mbulk3
);
9704 addReply(c
,shared
.punsubscribebulk
);
9705 addReplyBulk(c
,pattern
);
9706 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9707 listLength(c
->pubsub_patterns
));
9709 decrRefCount(pattern
);
9713 /* Unsubscribe from all the channels. Return the number of channels the
9714 * client was subscribed from. */
9715 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9716 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9720 while((de
= dictNext(di
)) != NULL
) {
9721 robj
*channel
= dictGetEntryKey(de
);
9723 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9725 dictReleaseIterator(di
);
9729 /* Unsubscribe from all the patterns. Return the number of patterns the
9730 * client was subscribed from. */
9731 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9736 listRewind(c
->pubsub_patterns
,&li
);
9737 while ((ln
= listNext(&li
)) != NULL
) {
9738 robj
*pattern
= ln
->value
;
9740 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9745 /* Publish a message */
9746 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9748 struct dictEntry
*de
;
9752 /* Send to clients listening for that channel */
9753 de
= dictFind(server
.pubsub_channels
,channel
);
9755 list
*list
= dictGetEntryVal(de
);
9759 listRewind(list
,&li
);
9760 while ((ln
= listNext(&li
)) != NULL
) {
9761 redisClient
*c
= ln
->value
;
9763 addReply(c
,shared
.mbulk3
);
9764 addReply(c
,shared
.messagebulk
);
9765 addReplyBulk(c
,channel
);
9766 addReplyBulk(c
,message
);
9770 /* Send to clients listening to matching channels */
9771 if (listLength(server
.pubsub_patterns
)) {
9772 listRewind(server
.pubsub_patterns
,&li
);
9773 channel
= getDecodedObject(channel
);
9774 while ((ln
= listNext(&li
)) != NULL
) {
9775 pubsubPattern
*pat
= ln
->value
;
9777 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9778 sdslen(pat
->pattern
->ptr
),
9779 (char*)channel
->ptr
,
9780 sdslen(channel
->ptr
),0)) {
9781 addReply(pat
->client
,shared
.mbulk3
);
9782 addReply(pat
->client
,shared
.messagebulk
);
9783 addReplyBulk(pat
->client
,channel
);
9784 addReplyBulk(pat
->client
,message
);
9788 decrRefCount(channel
);
9793 static void subscribeCommand(redisClient
*c
) {
9796 for (j
= 1; j
< c
->argc
; j
++)
9797 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9800 static void unsubscribeCommand(redisClient
*c
) {
9802 pubsubUnsubscribeAllChannels(c
,1);
9807 for (j
= 1; j
< c
->argc
; j
++)
9808 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9812 static void psubscribeCommand(redisClient
*c
) {
9815 for (j
= 1; j
< c
->argc
; j
++)
9816 pubsubSubscribePattern(c
,c
->argv
[j
]);
9819 static void punsubscribeCommand(redisClient
*c
) {
9821 pubsubUnsubscribeAllPatterns(c
,1);
9826 for (j
= 1; j
< c
->argc
; j
++)
9827 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9831 static void publishCommand(redisClient
*c
) {
9832 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9833 addReplyLong(c
,receivers
);
9836 /* ================================= Debugging ============================== */
9838 static void debugCommand(redisClient
*c
) {
9839 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9841 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9842 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9843 addReply(c
,shared
.err
);
9847 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9848 addReply(c
,shared
.err
);
9851 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9852 addReply(c
,shared
.ok
);
9853 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9855 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9856 addReply(c
,shared
.err
);
9859 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9860 addReply(c
,shared
.ok
);
9861 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9862 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9866 addReply(c
,shared
.nokeyerr
);
9869 key
= dictGetEntryKey(de
);
9870 val
= dictGetEntryVal(de
);
9871 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9872 key
->storage
== REDIS_VM_SWAPPING
)) {
9876 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9877 strenc
= strencoding
[val
->encoding
];
9879 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9882 addReplySds(c
,sdscatprintf(sdsempty(),
9883 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9884 "encoding:%s serializedlength:%lld\r\n",
9885 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9886 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9888 addReplySds(c
,sdscatprintf(sdsempty(),
9889 "+Key at:%p refcount:%d, value swapped at: page %llu "
9890 "using %llu pages\r\n",
9891 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9892 (unsigned long long) key
->vm
.usedpages
));
9894 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9895 lookupKeyRead(c
->db
,c
->argv
[2]);
9896 addReply(c
,shared
.ok
);
9897 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9898 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9901 if (!server
.vm_enabled
) {
9902 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9906 addReply(c
,shared
.nokeyerr
);
9909 key
= dictGetEntryKey(de
);
9910 val
= dictGetEntryVal(de
);
9911 /* If the key is shared we want to create a copy */
9912 if (key
->refcount
> 1) {
9913 robj
*newkey
= dupStringObject(key
);
9915 key
= dictGetEntryKey(de
) = newkey
;
9918 if (key
->storage
!= REDIS_VM_MEMORY
) {
9919 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9920 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9921 dictGetEntryVal(de
) = NULL
;
9922 addReply(c
,shared
.ok
);
9924 addReply(c
,shared
.err
);
9927 addReplySds(c
,sdsnew(
9928 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9932 static void _redisAssert(char *estr
, char *file
, int line
) {
9933 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9934 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9935 #ifdef HAVE_BACKTRACE
9936 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9941 static void _redisPanic(char *msg
, char *file
, int line
) {
9942 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
9943 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
9944 #ifdef HAVE_BACKTRACE
9945 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9950 /* =================================== Main! ================================ */
9953 int linuxOvercommitMemoryValue(void) {
9954 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9958 if (fgets(buf
,64,fp
) == NULL
) {
9967 void linuxOvercommitMemoryWarning(void) {
9968 if (linuxOvercommitMemoryValue() == 0) {
9969 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. 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.");
9972 #endif /* __linux__ */
9974 static void daemonize(void) {
9978 if (fork() != 0) exit(0); /* parent exits */
9979 setsid(); /* create a new session */
9981 /* Every output goes to /dev/null. If Redis is daemonized but
9982 * the 'logfile' is set to 'stdout' in the configuration file
9983 * it will not log at all. */
9984 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9985 dup2(fd
, STDIN_FILENO
);
9986 dup2(fd
, STDOUT_FILENO
);
9987 dup2(fd
, STDERR_FILENO
);
9988 if (fd
> STDERR_FILENO
) close(fd
);
9990 /* Try to write the pid file */
9991 fp
= fopen(server
.pidfile
,"w");
9993 fprintf(fp
,"%d\n",getpid());
9998 static void version() {
9999 printf("Redis server version %s\n", REDIS_VERSION
);
10003 static void usage() {
10004 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10005 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10009 int main(int argc
, char **argv
) {
10012 initServerConfig();
10014 if (strcmp(argv
[1], "-v") == 0 ||
10015 strcmp(argv
[1], "--version") == 0) version();
10016 if (strcmp(argv
[1], "--help") == 0) usage();
10017 resetServerSaveParams();
10018 loadServerConfig(argv
[1]);
10019 } else if ((argc
> 2)) {
10022 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'");
10024 if (server
.daemonize
) daemonize();
10026 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10028 linuxOvercommitMemoryWarning();
10030 start
= time(NULL
);
10031 if (server
.appendonly
) {
10032 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10033 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10035 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10036 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10038 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10039 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10041 aeDeleteEventLoop(server
.el
);
10045 /* ============================= Backtrace support ========================= */
10047 #ifdef HAVE_BACKTRACE
10048 static char *findFuncName(void *pointer
, unsigned long *offset
);
10050 static void *getMcontextEip(ucontext_t
*uc
) {
10051 #if defined(__FreeBSD__)
10052 return (void*) uc
->uc_mcontext
.mc_eip
;
10053 #elif defined(__dietlibc__)
10054 return (void*) uc
->uc_mcontext
.eip
;
10055 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10057 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10059 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10061 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10062 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10063 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10065 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10067 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10068 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10069 #elif defined(__ia64__) /* Linux IA64 */
10070 return (void*) uc
->uc_mcontext
.sc_ip
;
10076 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10078 char **messages
= NULL
;
10079 int i
, trace_size
= 0;
10080 unsigned long offset
=0;
10081 ucontext_t
*uc
= (ucontext_t
*) secret
;
10083 REDIS_NOTUSED(info
);
10085 redisLog(REDIS_WARNING
,
10086 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10087 infostring
= genRedisInfoString();
10088 redisLog(REDIS_WARNING
, "%s",infostring
);
10089 /* It's not safe to sdsfree() the returned string under memory
10090 * corruption conditions. Let it leak as we are going to abort */
10092 trace_size
= backtrace(trace
, 100);
10093 /* overwrite sigaction with caller's address */
10094 if (getMcontextEip(uc
) != NULL
) {
10095 trace
[1] = getMcontextEip(uc
);
10097 messages
= backtrace_symbols(trace
, trace_size
);
10099 for (i
=1; i
<trace_size
; ++i
) {
10100 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10102 p
= strchr(messages
[i
],'+');
10103 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10104 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10106 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10109 /* free(messages); Don't call free() with possibly corrupted memory. */
10113 static void setupSigSegvAction(void) {
10114 struct sigaction act
;
10116 sigemptyset (&act
.sa_mask
);
10117 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10118 * is used. Otherwise, sa_handler is used */
10119 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10120 act
.sa_sigaction
= segvHandler
;
10121 sigaction (SIGSEGV
, &act
, NULL
);
10122 sigaction (SIGBUS
, &act
, NULL
);
10123 sigaction (SIGFPE
, &act
, NULL
);
10124 sigaction (SIGILL
, &act
, NULL
);
10125 sigaction (SIGBUS
, &act
, NULL
);
10129 #include "staticsymbols.h"
10130 /* This function try to convert a pointer into a function name. It's used in
10131 * oreder to provide a backtrace under segmentation fault that's able to
10132 * display functions declared as static (otherwise the backtrace is useless). */
10133 static char *findFuncName(void *pointer
, unsigned long *offset
){
10135 unsigned long off
, minoff
= 0;
10137 /* Try to match against the Symbol with the smallest offset */
10138 for (i
=0; symsTable
[i
].pointer
; i
++) {
10139 unsigned long lp
= (unsigned long) pointer
;
10141 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10142 off
=lp
-symsTable
[i
].pointer
;
10143 if (ret
< 0 || off
< minoff
) {
10149 if (ret
== -1) return NULL
;
10151 return symsTable
[ret
].name
;
10153 #else /* HAVE_BACKTRACE */
10154 static void setupSigSegvAction(void) {
10156 #endif /* HAVE_BACKTRACE */