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.8"
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 redisAssert(1 != 1);
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 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3118 value
= (long)o
->ptr
;
3120 redisAssert(1 != 1);
3124 if (eptr
!= NULL
&& eptr
[0] != '\0') {
3132 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3134 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3136 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3138 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3147 static int getLongLongFromObject(robj
*o
, long long *target
) {
3154 redisAssert(o
->type
== REDIS_STRING
);
3155 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3156 value
= strtoll(o
->ptr
, &eptr
, 10);
3157 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3158 value
= (long)o
->ptr
;
3160 redisAssert(1 != 1);
3164 if (eptr
!= NULL
&& eptr
[0] != '\0') {
3172 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3174 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3176 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3178 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3187 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3190 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3191 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3193 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3195 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3204 /*============================ RDB saving/loading =========================== */
3206 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3207 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3211 static int rdbSaveTime(FILE *fp
, time_t t
) {
3212 int32_t t32
= (int32_t) t
;
3213 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3217 /* check rdbLoadLen() comments for more info */
3218 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3219 unsigned char buf
[2];
3222 /* Save a 6 bit len */
3223 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3224 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3225 } else if (len
< (1<<14)) {
3226 /* Save a 14 bit len */
3227 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3229 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3231 /* Save a 32 bit len */
3232 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3233 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3235 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3240 /* String objects in the form "2391" "-100" without any space and with a
3241 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3242 * encoded as integers to save space */
3243 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3245 char *endptr
, buf
[32];
3247 /* Check if it's possible to encode this value as a number */
3248 value
= strtoll(s
, &endptr
, 10);
3249 if (endptr
[0] != '\0') return 0;
3250 snprintf(buf
,32,"%lld",value
);
3252 /* If the number converted back into a string is not identical
3253 * then it's not possible to encode the string as integer */
3254 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3256 /* Finally check if it fits in our ranges */
3257 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3258 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3259 enc
[1] = value
&0xFF;
3261 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3262 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3263 enc
[1] = value
&0xFF;
3264 enc
[2] = (value
>>8)&0xFF;
3266 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3267 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3268 enc
[1] = value
&0xFF;
3269 enc
[2] = (value
>>8)&0xFF;
3270 enc
[3] = (value
>>16)&0xFF;
3271 enc
[4] = (value
>>24)&0xFF;
3278 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3279 size_t comprlen
, outlen
;
3283 /* We require at least four bytes compression for this to be worth it */
3284 if (len
<= 4) return 0;
3286 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3287 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3288 if (comprlen
== 0) {
3292 /* Data compressed! Let's save it on disk */
3293 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3294 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3295 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3296 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3297 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3306 /* Save a string objet as [len][data] on disk. If the object is a string
3307 * representation of an integer value we try to safe it in a special form */
3308 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3311 /* Try integer encoding */
3313 unsigned char buf
[5];
3314 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3315 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3320 /* Try LZF compression - under 20 bytes it's unable to compress even
3321 * aaaaaaaaaaaaaaaaaa so skip it */
3322 if (server
.rdbcompression
&& len
> 20) {
3325 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3326 if (retval
== -1) return -1;
3327 if (retval
> 0) return 0;
3328 /* retval == 0 means data can't be compressed, save the old way */
3331 /* Store verbatim */
3332 if (rdbSaveLen(fp
,len
) == -1) return -1;
3333 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3337 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3338 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3341 /* Avoid incr/decr ref count business when possible.
3342 * This plays well with copy-on-write given that we are probably
3343 * in a child process (BGSAVE). Also this makes sure key objects
3344 * of swapped objects are not incRefCount-ed (an assert does not allow
3345 * this in order to avoid bugs) */
3346 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3347 obj
= getDecodedObject(obj
);
3348 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3351 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3356 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3357 * 8 bit integer specifing the length of the representation.
3358 * This 8 bit integer has special values in order to specify the following
3364 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3365 unsigned char buf
[128];
3371 } else if (!isfinite(val
)) {
3373 buf
[0] = (val
< 0) ? 255 : 254;
3375 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3376 buf
[0] = strlen((char*)buf
+1);
3379 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3383 /* Save a Redis object. */
3384 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3385 if (o
->type
== REDIS_STRING
) {
3386 /* Save a string value */
3387 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3388 } else if (o
->type
== REDIS_LIST
) {
3389 /* Save a list value */
3390 list
*list
= o
->ptr
;
3394 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3395 listRewind(list
,&li
);
3396 while((ln
= listNext(&li
))) {
3397 robj
*eleobj
= listNodeValue(ln
);
3399 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3401 } else if (o
->type
== REDIS_SET
) {
3402 /* Save a set value */
3404 dictIterator
*di
= dictGetIterator(set
);
3407 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3408 while((de
= dictNext(di
)) != NULL
) {
3409 robj
*eleobj
= dictGetEntryKey(de
);
3411 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3413 dictReleaseIterator(di
);
3414 } else if (o
->type
== REDIS_ZSET
) {
3415 /* Save a set value */
3417 dictIterator
*di
= dictGetIterator(zs
->dict
);
3420 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3421 while((de
= dictNext(di
)) != NULL
) {
3422 robj
*eleobj
= dictGetEntryKey(de
);
3423 double *score
= dictGetEntryVal(de
);
3425 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3426 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3428 dictReleaseIterator(di
);
3429 } else if (o
->type
== REDIS_HASH
) {
3430 /* Save a hash value */
3431 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3432 unsigned char *p
= zipmapRewind(o
->ptr
);
3433 unsigned int count
= zipmapLen(o
->ptr
);
3434 unsigned char *key
, *val
;
3435 unsigned int klen
, vlen
;
3437 if (rdbSaveLen(fp
,count
) == -1) return -1;
3438 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3439 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3440 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3443 dictIterator
*di
= dictGetIterator(o
->ptr
);
3446 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3447 while((de
= dictNext(di
)) != NULL
) {
3448 robj
*key
= dictGetEntryKey(de
);
3449 robj
*val
= dictGetEntryVal(de
);
3451 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3452 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3454 dictReleaseIterator(di
);
3457 redisPanic("Unknown object type");
3462 /* Return the length the object will have on disk if saved with
3463 * the rdbSaveObject() function. Currently we use a trick to get
3464 * this length with very little changes to the code. In the future
3465 * we could switch to a faster solution. */
3466 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3467 if (fp
== NULL
) fp
= server
.devnull
;
3469 assert(rdbSaveObject(fp
,o
) != 1);
3473 /* Return the number of pages required to save this object in the swap file */
3474 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3475 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3477 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3480 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3481 static int rdbSave(char *filename
) {
3482 dictIterator
*di
= NULL
;
3487 time_t now
= time(NULL
);
3489 /* Wait for I/O therads to terminate, just in case this is a
3490 * foreground-saving, to avoid seeking the swap file descriptor at the
3492 if (server
.vm_enabled
)
3493 waitEmptyIOJobsQueue();
3495 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3496 fp
= fopen(tmpfile
,"w");
3498 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3501 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3502 for (j
= 0; j
< server
.dbnum
; j
++) {
3503 redisDb
*db
= server
.db
+j
;
3505 if (dictSize(d
) == 0) continue;
3506 di
= dictGetIterator(d
);
3512 /* Write the SELECT DB opcode */
3513 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3514 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3516 /* Iterate this DB writing every entry */
3517 while((de
= dictNext(di
)) != NULL
) {
3518 robj
*key
= dictGetEntryKey(de
);
3519 robj
*o
= dictGetEntryVal(de
);
3520 time_t expiretime
= getExpire(db
,key
);
3522 /* Save the expire time */
3523 if (expiretime
!= -1) {
3524 /* If this key is already expired skip it */
3525 if (expiretime
< now
) continue;
3526 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3527 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3529 /* Save the key and associated value. This requires special
3530 * handling if the value is swapped out. */
3531 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3532 key
->storage
== REDIS_VM_SWAPPING
) {
3533 /* Save type, key, value */
3534 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3535 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3536 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3538 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3540 /* Get a preview of the object in memory */
3541 po
= vmPreviewObject(key
);
3542 /* Save type, key, value */
3543 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3544 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3545 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3546 /* Remove the loaded object from memory */
3550 dictReleaseIterator(di
);
3553 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3555 /* Make sure data will not remain on the OS's output buffers */
3560 /* Use RENAME to make sure the DB file is changed atomically only
3561 * if the generate DB file is ok. */
3562 if (rename(tmpfile
,filename
) == -1) {
3563 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3567 redisLog(REDIS_NOTICE
,"DB saved on disk");
3569 server
.lastsave
= time(NULL
);
3575 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3576 if (di
) dictReleaseIterator(di
);
3580 static int rdbSaveBackground(char *filename
) {
3583 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3584 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3585 if ((childpid
= fork()) == 0) {
3587 if (server
.vm_enabled
) vmReopenSwapFile();
3589 if (rdbSave(filename
) == REDIS_OK
) {
3596 if (childpid
== -1) {
3597 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3601 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3602 server
.bgsavechildpid
= childpid
;
3603 updateDictResizePolicy();
3606 return REDIS_OK
; /* unreached */
3609 static void rdbRemoveTempFile(pid_t childpid
) {
3612 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3616 static int rdbLoadType(FILE *fp
) {
3618 if (fread(&type
,1,1,fp
) == 0) return -1;
3622 static time_t rdbLoadTime(FILE *fp
) {
3624 if (fread(&t32
,4,1,fp
) == 0) return -1;
3625 return (time_t) t32
;
3628 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3629 * of this file for a description of how this are stored on disk.
3631 * isencoded is set to 1 if the readed length is not actually a length but
3632 * an "encoding type", check the above comments for more info */
3633 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3634 unsigned char buf
[2];
3638 if (isencoded
) *isencoded
= 0;
3639 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3640 type
= (buf
[0]&0xC0)>>6;
3641 if (type
== REDIS_RDB_6BITLEN
) {
3642 /* Read a 6 bit len */
3644 } else if (type
== REDIS_RDB_ENCVAL
) {
3645 /* Read a 6 bit len encoding type */
3646 if (isencoded
) *isencoded
= 1;
3648 } else if (type
== REDIS_RDB_14BITLEN
) {
3649 /* Read a 14 bit len */
3650 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3651 return ((buf
[0]&0x3F)<<8)|buf
[1];
3653 /* Read a 32 bit len */
3654 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3659 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3660 unsigned char enc
[4];
3663 if (enctype
== REDIS_RDB_ENC_INT8
) {
3664 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3665 val
= (signed char)enc
[0];
3666 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3668 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3669 v
= enc
[0]|(enc
[1]<<8);
3671 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3673 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3674 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3677 val
= 0; /* anti-warning */
3678 redisPanic("Unknown RDB integer encoding type");
3680 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3683 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3684 unsigned int len
, clen
;
3685 unsigned char *c
= NULL
;
3688 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3689 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3690 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3691 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3692 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3693 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3695 return createObject(REDIS_STRING
,val
);
3702 static robj
*rdbLoadStringObject(FILE*fp
) {
3707 len
= rdbLoadLen(fp
,&isencoded
);
3710 case REDIS_RDB_ENC_INT8
:
3711 case REDIS_RDB_ENC_INT16
:
3712 case REDIS_RDB_ENC_INT32
:
3713 return rdbLoadIntegerObject(fp
,len
);
3714 case REDIS_RDB_ENC_LZF
:
3715 return rdbLoadLzfStringObject(fp
);
3717 redisPanic("Unknown RDB encoding type");
3721 if (len
== REDIS_RDB_LENERR
) return NULL
;
3722 val
= sdsnewlen(NULL
,len
);
3723 if (len
&& fread(val
,len
,1,fp
) == 0) {
3727 return createObject(REDIS_STRING
,val
);
3730 /* For information about double serialization check rdbSaveDoubleValue() */
3731 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3735 if (fread(&len
,1,1,fp
) == 0) return -1;
3737 case 255: *val
= R_NegInf
; return 0;
3738 case 254: *val
= R_PosInf
; return 0;
3739 case 253: *val
= R_Nan
; return 0;
3741 if (fread(buf
,len
,1,fp
) == 0) return -1;
3743 sscanf(buf
, "%lg", val
);
3748 /* Load a Redis object of the specified type from the specified file.
3749 * On success a newly allocated object is returned, otherwise NULL. */
3750 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3753 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3754 if (type
== REDIS_STRING
) {
3755 /* Read string value */
3756 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3757 o
= tryObjectEncoding(o
);
3758 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3759 /* Read list/set value */
3762 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3763 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3764 /* It's faster to expand the dict to the right size asap in order
3765 * to avoid rehashing */
3766 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3767 dictExpand(o
->ptr
,listlen
);
3768 /* Load every single element of the list/set */
3772 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3773 ele
= tryObjectEncoding(ele
);
3774 if (type
== REDIS_LIST
) {
3775 listAddNodeTail((list
*)o
->ptr
,ele
);
3777 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3780 } else if (type
== REDIS_ZSET
) {
3781 /* Read list/set value */
3785 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3786 o
= createZsetObject();
3788 /* Load every single element of the list/set */
3791 double *score
= zmalloc(sizeof(double));
3793 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3794 ele
= tryObjectEncoding(ele
);
3795 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3796 dictAdd(zs
->dict
,ele
,score
);
3797 zslInsert(zs
->zsl
,*score
,ele
);
3798 incrRefCount(ele
); /* added to skiplist */
3800 } else if (type
== REDIS_HASH
) {
3803 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3804 o
= createHashObject();
3805 /* Too many entries? Use an hash table. */
3806 if (hashlen
> server
.hash_max_zipmap_entries
)
3807 convertToRealHash(o
);
3808 /* Load every key/value, then set it into the zipmap or hash
3809 * table, as needed. */
3813 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3814 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3815 /* If we are using a zipmap and there are too big values
3816 * the object is converted to real hash table encoding. */
3817 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3818 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3819 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3821 convertToRealHash(o
);
3824 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3825 unsigned char *zm
= o
->ptr
;
3827 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3828 val
->ptr
,sdslen(val
->ptr
),NULL
);
3833 key
= tryObjectEncoding(key
);
3834 val
= tryObjectEncoding(val
);
3835 dictAdd((dict
*)o
->ptr
,key
,val
);
3839 redisPanic("Unknown object type");
3844 static int rdbLoad(char *filename
) {
3846 robj
*keyobj
= NULL
;
3848 int type
, retval
, rdbver
;
3849 dict
*d
= server
.db
[0].dict
;
3850 redisDb
*db
= server
.db
+0;
3852 time_t expiretime
= -1, now
= time(NULL
);
3853 long long loadedkeys
= 0;
3855 fp
= fopen(filename
,"r");
3856 if (!fp
) return REDIS_ERR
;
3857 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3859 if (memcmp(buf
,"REDIS",5) != 0) {
3861 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3864 rdbver
= atoi(buf
+5);
3867 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3874 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3875 if (type
== REDIS_EXPIRETIME
) {
3876 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3877 /* We read the time so we need to read the object type again */
3878 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3880 if (type
== REDIS_EOF
) break;
3881 /* Handle SELECT DB opcode as a special case */
3882 if (type
== REDIS_SELECTDB
) {
3883 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3885 if (dbid
>= (unsigned)server
.dbnum
) {
3886 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3889 db
= server
.db
+dbid
;
3894 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3896 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3897 /* Add the new object in the hash table */
3898 retval
= dictAdd(d
,keyobj
,o
);
3899 if (retval
== DICT_ERR
) {
3900 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3903 /* Set the expire time if needed */
3904 if (expiretime
!= -1) {
3905 setExpire(db
,keyobj
,expiretime
);
3906 /* Delete this key if already expired */
3907 if (expiretime
< now
) deleteKey(db
,keyobj
);
3911 /* Handle swapping while loading big datasets when VM is on */
3913 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3914 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3915 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3922 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3923 if (keyobj
) decrRefCount(keyobj
);
3924 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3926 return REDIS_ERR
; /* Just to avoid warning */
3929 /*================================== Commands =============================== */
3931 static void authCommand(redisClient
*c
) {
3932 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3933 c
->authenticated
= 1;
3934 addReply(c
,shared
.ok
);
3936 c
->authenticated
= 0;
3937 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3941 static void pingCommand(redisClient
*c
) {
3942 addReply(c
,shared
.pong
);
3945 static void echoCommand(redisClient
*c
) {
3946 addReplyBulk(c
,c
->argv
[1]);
3949 /*=================================== Strings =============================== */
3951 static void setGenericCommand(redisClient
*c
, int nx
) {
3954 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3955 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3956 if (retval
== DICT_ERR
) {
3958 /* If the key is about a swapped value, we want a new key object
3959 * to overwrite the old. So we delete the old key in the database.
3960 * This will also make sure that swap pages about the old object
3961 * will be marked as free. */
3962 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3963 incrRefCount(c
->argv
[1]);
3964 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3965 incrRefCount(c
->argv
[2]);
3967 addReply(c
,shared
.czero
);
3971 incrRefCount(c
->argv
[1]);
3972 incrRefCount(c
->argv
[2]);
3975 removeExpire(c
->db
,c
->argv
[1]);
3976 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3979 static void setCommand(redisClient
*c
) {
3980 setGenericCommand(c
,0);
3983 static void setnxCommand(redisClient
*c
) {
3984 setGenericCommand(c
,1);
3987 static int getGenericCommand(redisClient
*c
) {
3990 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3993 if (o
->type
!= REDIS_STRING
) {
3994 addReply(c
,shared
.wrongtypeerr
);
4002 static void getCommand(redisClient
*c
) {
4003 getGenericCommand(c
);
4006 static void getsetCommand(redisClient
*c
) {
4007 if (getGenericCommand(c
) == REDIS_ERR
) return;
4008 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4009 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4011 incrRefCount(c
->argv
[1]);
4013 incrRefCount(c
->argv
[2]);
4015 removeExpire(c
->db
,c
->argv
[1]);
4018 static void mgetCommand(redisClient
*c
) {
4021 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4022 for (j
= 1; j
< c
->argc
; j
++) {
4023 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4025 addReply(c
,shared
.nullbulk
);
4027 if (o
->type
!= REDIS_STRING
) {
4028 addReply(c
,shared
.nullbulk
);
4036 static void msetGenericCommand(redisClient
*c
, int nx
) {
4037 int j
, busykeys
= 0;
4039 if ((c
->argc
% 2) == 0) {
4040 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4043 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4044 * set nothing at all if at least one already key exists. */
4046 for (j
= 1; j
< c
->argc
; j
+= 2) {
4047 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4053 addReply(c
, shared
.czero
);
4057 for (j
= 1; j
< c
->argc
; j
+= 2) {
4060 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4061 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4062 if (retval
== DICT_ERR
) {
4063 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4064 incrRefCount(c
->argv
[j
+1]);
4066 incrRefCount(c
->argv
[j
]);
4067 incrRefCount(c
->argv
[j
+1]);
4069 removeExpire(c
->db
,c
->argv
[j
]);
4071 server
.dirty
+= (c
->argc
-1)/2;
4072 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4075 static void msetCommand(redisClient
*c
) {
4076 msetGenericCommand(c
,0);
4079 static void msetnxCommand(redisClient
*c
) {
4080 msetGenericCommand(c
,1);
4083 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4088 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4090 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4093 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4094 o
= tryObjectEncoding(o
);
4095 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4096 if (retval
== DICT_ERR
) {
4097 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4098 removeExpire(c
->db
,c
->argv
[1]);
4100 incrRefCount(c
->argv
[1]);
4103 addReply(c
,shared
.colon
);
4105 addReply(c
,shared
.crlf
);
4108 static void incrCommand(redisClient
*c
) {
4109 incrDecrCommand(c
,1);
4112 static void decrCommand(redisClient
*c
) {
4113 incrDecrCommand(c
,-1);
4116 static void incrbyCommand(redisClient
*c
) {
4119 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4120 incrDecrCommand(c
,incr
);
4123 static void decrbyCommand(redisClient
*c
) {
4126 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4127 incrDecrCommand(c
,-incr
);
4130 static void appendCommand(redisClient
*c
) {
4135 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4137 /* Create the key */
4138 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4139 incrRefCount(c
->argv
[1]);
4140 incrRefCount(c
->argv
[2]);
4141 totlen
= stringObjectLen(c
->argv
[2]);
4145 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4148 o
= dictGetEntryVal(de
);
4149 if (o
->type
!= REDIS_STRING
) {
4150 addReply(c
,shared
.wrongtypeerr
);
4153 /* If the object is specially encoded or shared we have to make
4155 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4156 robj
*decoded
= getDecodedObject(o
);
4158 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4159 decrRefCount(decoded
);
4160 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4163 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4164 o
->ptr
= sdscatlen(o
->ptr
,
4165 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4167 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4168 (unsigned long) c
->argv
[2]->ptr
);
4170 totlen
= sdslen(o
->ptr
);
4173 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4176 static void substrCommand(redisClient
*c
) {
4178 long start
= atoi(c
->argv
[2]->ptr
);
4179 long end
= atoi(c
->argv
[3]->ptr
);
4180 size_t rangelen
, strlen
;
4183 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4184 checkType(c
,o
,REDIS_STRING
)) return;
4186 o
= getDecodedObject(o
);
4187 strlen
= sdslen(o
->ptr
);
4189 /* convert negative indexes */
4190 if (start
< 0) start
= strlen
+start
;
4191 if (end
< 0) end
= strlen
+end
;
4192 if (start
< 0) start
= 0;
4193 if (end
< 0) end
= 0;
4195 /* indexes sanity checks */
4196 if (start
> end
|| (size_t)start
>= strlen
) {
4197 /* Out of range start or start > end result in null reply */
4198 addReply(c
,shared
.nullbulk
);
4202 if ((size_t)end
>= strlen
) end
= strlen
-1;
4203 rangelen
= (end
-start
)+1;
4205 /* Return the result */
4206 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4207 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4208 addReplySds(c
,range
);
4209 addReply(c
,shared
.crlf
);
4213 /* ========================= Type agnostic commands ========================= */
4215 static void delCommand(redisClient
*c
) {
4218 for (j
= 1; j
< c
->argc
; j
++) {
4219 if (deleteKey(c
->db
,c
->argv
[j
])) {
4224 addReplyLong(c
,deleted
);
4227 static void existsCommand(redisClient
*c
) {
4228 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4231 static void selectCommand(redisClient
*c
) {
4232 int id
= atoi(c
->argv
[1]->ptr
);
4234 if (selectDb(c
,id
) == REDIS_ERR
) {
4235 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4237 addReply(c
,shared
.ok
);
4241 static void randomkeyCommand(redisClient
*c
) {
4245 de
= dictGetRandomKey(c
->db
->dict
);
4246 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4249 addReply(c
,shared
.plus
);
4250 addReply(c
,shared
.crlf
);
4252 addReply(c
,shared
.plus
);
4253 addReply(c
,dictGetEntryKey(de
));
4254 addReply(c
,shared
.crlf
);
4258 static void keysCommand(redisClient
*c
) {
4261 sds pattern
= c
->argv
[1]->ptr
;
4262 int plen
= sdslen(pattern
);
4263 unsigned long numkeys
= 0;
4264 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4266 di
= dictGetIterator(c
->db
->dict
);
4268 decrRefCount(lenobj
);
4269 while((de
= dictNext(di
)) != NULL
) {
4270 robj
*keyobj
= dictGetEntryKey(de
);
4272 sds key
= keyobj
->ptr
;
4273 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4274 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4275 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4276 addReplyBulk(c
,keyobj
);
4281 dictReleaseIterator(di
);
4282 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4285 static void dbsizeCommand(redisClient
*c
) {
4287 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4290 static void lastsaveCommand(redisClient
*c
) {
4292 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4295 static void typeCommand(redisClient
*c
) {
4299 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4304 case REDIS_STRING
: type
= "+string"; break;
4305 case REDIS_LIST
: type
= "+list"; break;
4306 case REDIS_SET
: type
= "+set"; break;
4307 case REDIS_ZSET
: type
= "+zset"; break;
4308 case REDIS_HASH
: type
= "+hash"; break;
4309 default: type
= "+unknown"; break;
4312 addReplySds(c
,sdsnew(type
));
4313 addReply(c
,shared
.crlf
);
4316 static void saveCommand(redisClient
*c
) {
4317 if (server
.bgsavechildpid
!= -1) {
4318 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4321 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4322 addReply(c
,shared
.ok
);
4324 addReply(c
,shared
.err
);
4328 static void bgsaveCommand(redisClient
*c
) {
4329 if (server
.bgsavechildpid
!= -1) {
4330 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4333 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4334 char *status
= "+Background saving started\r\n";
4335 addReplySds(c
,sdsnew(status
));
4337 addReply(c
,shared
.err
);
4341 static void shutdownCommand(redisClient
*c
) {
4342 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4343 /* Kill the saving child if there is a background saving in progress.
4344 We want to avoid race conditions, for instance our saving child may
4345 overwrite the synchronous saving did by SHUTDOWN. */
4346 if (server
.bgsavechildpid
!= -1) {
4347 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4348 kill(server
.bgsavechildpid
,SIGKILL
);
4349 rdbRemoveTempFile(server
.bgsavechildpid
);
4351 if (server
.appendonly
) {
4352 /* Append only file: fsync() the AOF and exit */
4353 fsync(server
.appendfd
);
4354 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4357 /* Snapshotting. Perform a SYNC SAVE and exit */
4358 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4359 if (server
.daemonize
)
4360 unlink(server
.pidfile
);
4361 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4362 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4363 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4366 /* Ooops.. error saving! The best we can do is to continue
4367 * operating. Note that if there was a background saving process,
4368 * in the next cron() Redis will be notified that the background
4369 * saving aborted, handling special stuff like slaves pending for
4370 * synchronization... */
4371 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4373 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4378 static void renameGenericCommand(redisClient
*c
, int nx
) {
4381 /* To use the same key as src and dst is probably an error */
4382 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4383 addReply(c
,shared
.sameobjecterr
);
4387 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4391 deleteIfVolatile(c
->db
,c
->argv
[2]);
4392 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4395 addReply(c
,shared
.czero
);
4398 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4400 incrRefCount(c
->argv
[2]);
4402 deleteKey(c
->db
,c
->argv
[1]);
4404 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4407 static void renameCommand(redisClient
*c
) {
4408 renameGenericCommand(c
,0);
4411 static void renamenxCommand(redisClient
*c
) {
4412 renameGenericCommand(c
,1);
4415 static void moveCommand(redisClient
*c
) {
4420 /* Obtain source and target DB pointers */
4423 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4424 addReply(c
,shared
.outofrangeerr
);
4428 selectDb(c
,srcid
); /* Back to the source DB */
4430 /* If the user is moving using as target the same
4431 * DB as the source DB it is probably an error. */
4433 addReply(c
,shared
.sameobjecterr
);
4437 /* Check if the element exists and get a reference */
4438 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4440 addReply(c
,shared
.czero
);
4444 /* Try to add the element to the target DB */
4445 deleteIfVolatile(dst
,c
->argv
[1]);
4446 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4447 addReply(c
,shared
.czero
);
4450 incrRefCount(c
->argv
[1]);
4453 /* OK! key moved, free the entry in the source DB */
4454 deleteKey(src
,c
->argv
[1]);
4456 addReply(c
,shared
.cone
);
4459 /* =================================== Lists ================================ */
4460 static void pushGenericCommand(redisClient
*c
, int where
) {
4464 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4466 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4467 addReply(c
,shared
.cone
);
4470 lobj
= createListObject();
4472 if (where
== REDIS_HEAD
) {
4473 listAddNodeHead(list
,c
->argv
[2]);
4475 listAddNodeTail(list
,c
->argv
[2]);
4477 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4478 incrRefCount(c
->argv
[1]);
4479 incrRefCount(c
->argv
[2]);
4481 if (lobj
->type
!= REDIS_LIST
) {
4482 addReply(c
,shared
.wrongtypeerr
);
4485 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4486 addReply(c
,shared
.cone
);
4490 if (where
== REDIS_HEAD
) {
4491 listAddNodeHead(list
,c
->argv
[2]);
4493 listAddNodeTail(list
,c
->argv
[2]);
4495 incrRefCount(c
->argv
[2]);
4498 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4501 static void lpushCommand(redisClient
*c
) {
4502 pushGenericCommand(c
,REDIS_HEAD
);
4505 static void rpushCommand(redisClient
*c
) {
4506 pushGenericCommand(c
,REDIS_TAIL
);
4509 static void llenCommand(redisClient
*c
) {
4513 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4514 checkType(c
,o
,REDIS_LIST
)) return;
4517 addReplyUlong(c
,listLength(l
));
4520 static void lindexCommand(redisClient
*c
) {
4522 int index
= atoi(c
->argv
[2]->ptr
);
4526 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4527 checkType(c
,o
,REDIS_LIST
)) return;
4530 ln
= listIndex(list
, index
);
4532 addReply(c
,shared
.nullbulk
);
4534 robj
*ele
= listNodeValue(ln
);
4535 addReplyBulk(c
,ele
);
4539 static void lsetCommand(redisClient
*c
) {
4541 int index
= atoi(c
->argv
[2]->ptr
);
4545 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4546 checkType(c
,o
,REDIS_LIST
)) return;
4549 ln
= listIndex(list
, index
);
4551 addReply(c
,shared
.outofrangeerr
);
4553 robj
*ele
= listNodeValue(ln
);
4556 listNodeValue(ln
) = c
->argv
[3];
4557 incrRefCount(c
->argv
[3]);
4558 addReply(c
,shared
.ok
);
4563 static void popGenericCommand(redisClient
*c
, int where
) {
4568 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4569 checkType(c
,o
,REDIS_LIST
)) return;
4572 if (where
== REDIS_HEAD
)
4573 ln
= listFirst(list
);
4575 ln
= listLast(list
);
4578 addReply(c
,shared
.nullbulk
);
4580 robj
*ele
= listNodeValue(ln
);
4581 addReplyBulk(c
,ele
);
4582 listDelNode(list
,ln
);
4583 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4588 static void lpopCommand(redisClient
*c
) {
4589 popGenericCommand(c
,REDIS_HEAD
);
4592 static void rpopCommand(redisClient
*c
) {
4593 popGenericCommand(c
,REDIS_TAIL
);
4596 static void lrangeCommand(redisClient
*c
) {
4598 int start
= atoi(c
->argv
[2]->ptr
);
4599 int end
= atoi(c
->argv
[3]->ptr
);
4606 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4607 || checkType(c
,o
,REDIS_LIST
)) return;
4609 llen
= listLength(list
);
4611 /* convert negative indexes */
4612 if (start
< 0) start
= llen
+start
;
4613 if (end
< 0) end
= llen
+end
;
4614 if (start
< 0) start
= 0;
4615 if (end
< 0) end
= 0;
4617 /* indexes sanity checks */
4618 if (start
> end
|| start
>= llen
) {
4619 /* Out of range start or start > end result in empty list */
4620 addReply(c
,shared
.emptymultibulk
);
4623 if (end
>= llen
) end
= llen
-1;
4624 rangelen
= (end
-start
)+1;
4626 /* Return the result in form of a multi-bulk reply */
4627 ln
= listIndex(list
, start
);
4628 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4629 for (j
= 0; j
< rangelen
; j
++) {
4630 ele
= listNodeValue(ln
);
4631 addReplyBulk(c
,ele
);
4636 static void ltrimCommand(redisClient
*c
) {
4638 int start
= atoi(c
->argv
[2]->ptr
);
4639 int end
= atoi(c
->argv
[3]->ptr
);
4641 int j
, ltrim
, rtrim
;
4645 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4646 checkType(c
,o
,REDIS_LIST
)) return;
4648 llen
= listLength(list
);
4650 /* convert negative indexes */
4651 if (start
< 0) start
= llen
+start
;
4652 if (end
< 0) end
= llen
+end
;
4653 if (start
< 0) start
= 0;
4654 if (end
< 0) end
= 0;
4656 /* indexes sanity checks */
4657 if (start
> end
|| start
>= llen
) {
4658 /* Out of range start or start > end result in empty list */
4662 if (end
>= llen
) end
= llen
-1;
4667 /* Remove list elements to perform the trim */
4668 for (j
= 0; j
< ltrim
; j
++) {
4669 ln
= listFirst(list
);
4670 listDelNode(list
,ln
);
4672 for (j
= 0; j
< rtrim
; j
++) {
4673 ln
= listLast(list
);
4674 listDelNode(list
,ln
);
4676 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4678 addReply(c
,shared
.ok
);
4681 static void lremCommand(redisClient
*c
) {
4684 listNode
*ln
, *next
;
4685 int toremove
= atoi(c
->argv
[2]->ptr
);
4689 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4690 checkType(c
,o
,REDIS_LIST
)) return;
4694 toremove
= -toremove
;
4697 ln
= fromtail
? list
->tail
: list
->head
;
4699 robj
*ele
= listNodeValue(ln
);
4701 next
= fromtail
? ln
->prev
: ln
->next
;
4702 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4703 listDelNode(list
,ln
);
4706 if (toremove
&& removed
== toremove
) break;
4710 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4711 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4714 /* This is the semantic of this command:
4715 * RPOPLPUSH srclist dstlist:
4716 * IF LLEN(srclist) > 0
4717 * element = RPOP srclist
4718 * LPUSH dstlist element
4725 * The idea is to be able to get an element from a list in a reliable way
4726 * since the element is not just returned but pushed against another list
4727 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4729 static void rpoplpushcommand(redisClient
*c
) {
4734 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4735 checkType(c
,sobj
,REDIS_LIST
)) return;
4736 srclist
= sobj
->ptr
;
4737 ln
= listLast(srclist
);
4740 addReply(c
,shared
.nullbulk
);
4742 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4743 robj
*ele
= listNodeValue(ln
);
4746 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4747 addReply(c
,shared
.wrongtypeerr
);
4751 /* Add the element to the target list (unless it's directly
4752 * passed to some BLPOP-ing client */
4753 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4755 /* Create the list if the key does not exist */
4756 dobj
= createListObject();
4757 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4758 incrRefCount(c
->argv
[2]);
4760 dstlist
= dobj
->ptr
;
4761 listAddNodeHead(dstlist
,ele
);
4765 /* Send the element to the client as reply as well */
4766 addReplyBulk(c
,ele
);
4768 /* Finally remove the element from the source list */
4769 listDelNode(srclist
,ln
);
4770 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4775 /* ==================================== Sets ================================ */
4777 static void saddCommand(redisClient
*c
) {
4780 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4782 set
= createSetObject();
4783 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4784 incrRefCount(c
->argv
[1]);
4786 if (set
->type
!= REDIS_SET
) {
4787 addReply(c
,shared
.wrongtypeerr
);
4791 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4792 incrRefCount(c
->argv
[2]);
4794 addReply(c
,shared
.cone
);
4796 addReply(c
,shared
.czero
);
4800 static void sremCommand(redisClient
*c
) {
4803 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4804 checkType(c
,set
,REDIS_SET
)) return;
4806 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4808 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4809 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4810 addReply(c
,shared
.cone
);
4812 addReply(c
,shared
.czero
);
4816 static void smoveCommand(redisClient
*c
) {
4817 robj
*srcset
, *dstset
;
4819 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4820 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4822 /* If the source key does not exist return 0, if it's of the wrong type
4824 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4825 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4828 /* Error if the destination key is not a set as well */
4829 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4830 addReply(c
,shared
.wrongtypeerr
);
4833 /* Remove the element from the source set */
4834 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4835 /* Key not found in the src set! return zero */
4836 addReply(c
,shared
.czero
);
4839 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4840 deleteKey(c
->db
,c
->argv
[1]);
4842 /* Add the element to the destination set */
4844 dstset
= createSetObject();
4845 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4846 incrRefCount(c
->argv
[2]);
4848 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4849 incrRefCount(c
->argv
[3]);
4850 addReply(c
,shared
.cone
);
4853 static void sismemberCommand(redisClient
*c
) {
4856 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4857 checkType(c
,set
,REDIS_SET
)) return;
4859 if (dictFind(set
->ptr
,c
->argv
[2]))
4860 addReply(c
,shared
.cone
);
4862 addReply(c
,shared
.czero
);
4865 static void scardCommand(redisClient
*c
) {
4869 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4870 checkType(c
,o
,REDIS_SET
)) return;
4873 addReplyUlong(c
,dictSize(s
));
4876 static void spopCommand(redisClient
*c
) {
4880 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4881 checkType(c
,set
,REDIS_SET
)) return;
4883 de
= dictGetRandomKey(set
->ptr
);
4885 addReply(c
,shared
.nullbulk
);
4887 robj
*ele
= dictGetEntryKey(de
);
4889 addReplyBulk(c
,ele
);
4890 dictDelete(set
->ptr
,ele
);
4891 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4892 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4897 static void srandmemberCommand(redisClient
*c
) {
4901 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4902 checkType(c
,set
,REDIS_SET
)) return;
4904 de
= dictGetRandomKey(set
->ptr
);
4906 addReply(c
,shared
.nullbulk
);
4908 robj
*ele
= dictGetEntryKey(de
);
4910 addReplyBulk(c
,ele
);
4914 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4915 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4917 return dictSize(*d1
)-dictSize(*d2
);
4920 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4921 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4924 robj
*lenobj
= NULL
, *dstset
= NULL
;
4925 unsigned long j
, cardinality
= 0;
4927 for (j
= 0; j
< setsnum
; j
++) {
4931 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4932 lookupKeyRead(c
->db
,setskeys
[j
]);
4936 if (deleteKey(c
->db
,dstkey
))
4938 addReply(c
,shared
.czero
);
4940 addReply(c
,shared
.emptymultibulk
);
4944 if (setobj
->type
!= REDIS_SET
) {
4946 addReply(c
,shared
.wrongtypeerr
);
4949 dv
[j
] = setobj
->ptr
;
4951 /* Sort sets from the smallest to largest, this will improve our
4952 * algorithm's performace */
4953 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4955 /* The first thing we should output is the total number of elements...
4956 * since this is a multi-bulk write, but at this stage we don't know
4957 * the intersection set size, so we use a trick, append an empty object
4958 * to the output list and save the pointer to later modify it with the
4961 lenobj
= createObject(REDIS_STRING
,NULL
);
4963 decrRefCount(lenobj
);
4965 /* If we have a target key where to store the resulting set
4966 * create this key with an empty set inside */
4967 dstset
= createSetObject();
4970 /* Iterate all the elements of the first (smallest) set, and test
4971 * the element against all the other sets, if at least one set does
4972 * not include the element it is discarded */
4973 di
= dictGetIterator(dv
[0]);
4975 while((de
= dictNext(di
)) != NULL
) {
4978 for (j
= 1; j
< setsnum
; j
++)
4979 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4981 continue; /* at least one set does not contain the member */
4982 ele
= dictGetEntryKey(de
);
4984 addReplyBulk(c
,ele
);
4987 dictAdd(dstset
->ptr
,ele
,NULL
);
4991 dictReleaseIterator(di
);
4994 /* Store the resulting set into the target, if the intersection
4995 * is not an empty set. */
4996 deleteKey(c
->db
,dstkey
);
4997 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4998 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4999 incrRefCount(dstkey
);
5000 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5002 decrRefCount(dstset
);
5003 addReply(c
,shared
.czero
);
5007 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5012 static void sinterCommand(redisClient
*c
) {
5013 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5016 static void sinterstoreCommand(redisClient
*c
) {
5017 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5020 #define REDIS_OP_UNION 0
5021 #define REDIS_OP_DIFF 1
5022 #define REDIS_OP_INTER 2
5024 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5025 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5028 robj
*dstset
= NULL
;
5029 int j
, cardinality
= 0;
5031 for (j
= 0; j
< setsnum
; j
++) {
5035 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5036 lookupKeyRead(c
->db
,setskeys
[j
]);
5041 if (setobj
->type
!= REDIS_SET
) {
5043 addReply(c
,shared
.wrongtypeerr
);
5046 dv
[j
] = setobj
->ptr
;
5049 /* We need a temp set object to store our union. If the dstkey
5050 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5051 * this set object will be the resulting object to set into the target key*/
5052 dstset
= createSetObject();
5054 /* Iterate all the elements of all the sets, add every element a single
5055 * time to the result set */
5056 for (j
= 0; j
< setsnum
; j
++) {
5057 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5058 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5060 di
= dictGetIterator(dv
[j
]);
5062 while((de
= dictNext(di
)) != NULL
) {
5065 /* dictAdd will not add the same element multiple times */
5066 ele
= dictGetEntryKey(de
);
5067 if (op
== REDIS_OP_UNION
|| j
== 0) {
5068 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5072 } else if (op
== REDIS_OP_DIFF
) {
5073 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5078 dictReleaseIterator(di
);
5080 /* result set is empty? Exit asap. */
5081 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5084 /* Output the content of the resulting set, if not in STORE mode */
5086 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5087 di
= dictGetIterator(dstset
->ptr
);
5088 while((de
= dictNext(di
)) != NULL
) {
5091 ele
= dictGetEntryKey(de
);
5092 addReplyBulk(c
,ele
);
5094 dictReleaseIterator(di
);
5095 decrRefCount(dstset
);
5097 /* If we have a target key where to store the resulting set
5098 * create this key with the result set inside */
5099 deleteKey(c
->db
,dstkey
);
5100 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5101 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5102 incrRefCount(dstkey
);
5103 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5105 decrRefCount(dstset
);
5106 addReply(c
,shared
.czero
);
5113 static void sunionCommand(redisClient
*c
) {
5114 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5117 static void sunionstoreCommand(redisClient
*c
) {
5118 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5121 static void sdiffCommand(redisClient
*c
) {
5122 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5125 static void sdiffstoreCommand(redisClient
*c
) {
5126 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5129 /* ==================================== ZSets =============================== */
5131 /* ZSETs are ordered sets using two data structures to hold the same elements
5132 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5135 * The elements are added to an hash table mapping Redis objects to scores.
5136 * At the same time the elements are added to a skip list mapping scores
5137 * to Redis objects (so objects are sorted by scores in this "view"). */
5139 /* This skiplist implementation is almost a C translation of the original
5140 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5141 * Alternative to Balanced Trees", modified in three ways:
5142 * a) this implementation allows for repeated values.
5143 * b) the comparison is not just by key (our 'score') but by satellite data.
5144 * c) there is a back pointer, so it's a doubly linked list with the back
5145 * pointers being only at "level 1". This allows to traverse the list
5146 * from tail to head, useful for ZREVRANGE. */
5148 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5149 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5151 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5153 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5159 static zskiplist
*zslCreate(void) {
5163 zsl
= zmalloc(sizeof(*zsl
));
5166 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5167 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5168 zsl
->header
->forward
[j
] = NULL
;
5170 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5171 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5172 zsl
->header
->span
[j
] = 0;
5174 zsl
->header
->backward
= NULL
;
5179 static void zslFreeNode(zskiplistNode
*node
) {
5180 decrRefCount(node
->obj
);
5181 zfree(node
->forward
);
5186 static void zslFree(zskiplist
*zsl
) {
5187 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5189 zfree(zsl
->header
->forward
);
5190 zfree(zsl
->header
->span
);
5193 next
= node
->forward
[0];
5200 static int zslRandomLevel(void) {
5202 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5204 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5207 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5208 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5209 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5213 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5214 /* store rank that is crossed to reach the insert position */
5215 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5217 while (x
->forward
[i
] &&
5218 (x
->forward
[i
]->score
< score
||
5219 (x
->forward
[i
]->score
== score
&&
5220 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5221 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5226 /* we assume the key is not already inside, since we allow duplicated
5227 * scores, and the re-insertion of score and redis object should never
5228 * happpen since the caller of zslInsert() should test in the hash table
5229 * if the element is already inside or not. */
5230 level
= zslRandomLevel();
5231 if (level
> zsl
->level
) {
5232 for (i
= zsl
->level
; i
< level
; i
++) {
5234 update
[i
] = zsl
->header
;
5235 update
[i
]->span
[i
-1] = zsl
->length
;
5239 x
= zslCreateNode(level
,score
,obj
);
5240 for (i
= 0; i
< level
; i
++) {
5241 x
->forward
[i
] = update
[i
]->forward
[i
];
5242 update
[i
]->forward
[i
] = x
;
5244 /* update span covered by update[i] as x is inserted here */
5246 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5247 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5251 /* increment span for untouched levels */
5252 for (i
= level
; i
< zsl
->level
; i
++) {
5253 update
[i
]->span
[i
-1]++;
5256 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5258 x
->forward
[0]->backward
= x
;
5264 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5265 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5267 for (i
= 0; i
< zsl
->level
; i
++) {
5268 if (update
[i
]->forward
[i
] == x
) {
5270 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5272 update
[i
]->forward
[i
] = x
->forward
[i
];
5274 /* invariant: i > 0, because update[0]->forward[0]
5275 * is always equal to x */
5276 update
[i
]->span
[i
-1] -= 1;
5279 if (x
->forward
[0]) {
5280 x
->forward
[0]->backward
= x
->backward
;
5282 zsl
->tail
= x
->backward
;
5284 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5289 /* Delete an element with matching score/object from the skiplist. */
5290 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5291 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5295 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5296 while (x
->forward
[i
] &&
5297 (x
->forward
[i
]->score
< score
||
5298 (x
->forward
[i
]->score
== score
&&
5299 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5303 /* We may have multiple elements with the same score, what we need
5304 * is to find the element with both the right score and object. */
5306 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5307 zslDeleteNode(zsl
, x
, update
);
5311 return 0; /* not found */
5313 return 0; /* not found */
5316 /* Delete all the elements with score between min and max from the skiplist.
5317 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5318 * Note that this function takes the reference to the hash table view of the
5319 * sorted set, in order to remove the elements from the hash table too. */
5320 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5321 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5322 unsigned long removed
= 0;
5326 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5327 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5331 /* We may have multiple elements with the same score, what we need
5332 * is to find the element with both the right score and object. */
5334 while (x
&& x
->score
<= max
) {
5335 zskiplistNode
*next
= x
->forward
[0];
5336 zslDeleteNode(zsl
, x
, update
);
5337 dictDelete(dict
,x
->obj
);
5342 return removed
; /* not found */
5345 /* Delete all the elements with rank between start and end from the skiplist.
5346 * Start and end are inclusive. Note that start and end need to be 1-based */
5347 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5348 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5349 unsigned long traversed
= 0, removed
= 0;
5353 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5354 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5355 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5363 while (x
&& traversed
<= end
) {
5364 zskiplistNode
*next
= x
->forward
[0];
5365 zslDeleteNode(zsl
, x
, update
);
5366 dictDelete(dict
,x
->obj
);
5375 /* Find the first node having a score equal or greater than the specified one.
5376 * Returns NULL if there is no match. */
5377 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5382 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5383 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5386 /* We may have multiple elements with the same score, what we need
5387 * is to find the element with both the right score and object. */
5388 return x
->forward
[0];
5391 /* Find the rank for an element by both score and key.
5392 * Returns 0 when the element cannot be found, rank otherwise.
5393 * Note that the rank is 1-based due to the span of zsl->header to the
5395 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5397 unsigned long rank
= 0;
5401 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5402 while (x
->forward
[i
] &&
5403 (x
->forward
[i
]->score
< score
||
5404 (x
->forward
[i
]->score
== score
&&
5405 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5406 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5410 /* x might be equal to zsl->header, so test if obj is non-NULL */
5411 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5418 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5419 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5421 unsigned long traversed
= 0;
5425 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5426 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5428 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5431 if (traversed
== rank
) {
5438 /* The actual Z-commands implementations */
5440 /* This generic command implements both ZADD and ZINCRBY.
5441 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5442 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5443 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5448 zsetobj
= lookupKeyWrite(c
->db
,key
);
5449 if (zsetobj
== NULL
) {
5450 zsetobj
= createZsetObject();
5451 dictAdd(c
->db
->dict
,key
,zsetobj
);
5454 if (zsetobj
->type
!= REDIS_ZSET
) {
5455 addReply(c
,shared
.wrongtypeerr
);
5461 /* Ok now since we implement both ZADD and ZINCRBY here the code
5462 * needs to handle the two different conditions. It's all about setting
5463 * '*score', that is, the new score to set, to the right value. */
5464 score
= zmalloc(sizeof(double));
5468 /* Read the old score. If the element was not present starts from 0 */
5469 de
= dictFind(zs
->dict
,ele
);
5471 double *oldscore
= dictGetEntryVal(de
);
5472 *score
= *oldscore
+ scoreval
;
5480 /* What follows is a simple remove and re-insert operation that is common
5481 * to both ZADD and ZINCRBY... */
5482 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5483 /* case 1: New element */
5484 incrRefCount(ele
); /* added to hash */
5485 zslInsert(zs
->zsl
,*score
,ele
);
5486 incrRefCount(ele
); /* added to skiplist */
5489 addReplyDouble(c
,*score
);
5491 addReply(c
,shared
.cone
);
5496 /* case 2: Score update operation */
5497 de
= dictFind(zs
->dict
,ele
);
5498 redisAssert(de
!= NULL
);
5499 oldscore
= dictGetEntryVal(de
);
5500 if (*score
!= *oldscore
) {
5503 /* Remove and insert the element in the skip list with new score */
5504 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5505 redisAssert(deleted
!= 0);
5506 zslInsert(zs
->zsl
,*score
,ele
);
5508 /* Update the score in the hash table */
5509 dictReplace(zs
->dict
,ele
,score
);
5515 addReplyDouble(c
,*score
);
5517 addReply(c
,shared
.czero
);
5521 static void zaddCommand(redisClient
*c
) {
5524 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5525 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5528 static void zincrbyCommand(redisClient
*c
) {
5531 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5532 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5535 static void zremCommand(redisClient
*c
) {
5542 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5543 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5546 de
= dictFind(zs
->dict
,c
->argv
[2]);
5548 addReply(c
,shared
.czero
);
5551 /* Delete from the skiplist */
5552 oldscore
= dictGetEntryVal(de
);
5553 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5554 redisAssert(deleted
!= 0);
5556 /* Delete from the hash table */
5557 dictDelete(zs
->dict
,c
->argv
[2]);
5558 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5559 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5561 addReply(c
,shared
.cone
);
5564 static void zremrangebyscoreCommand(redisClient
*c
) {
5571 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5572 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5574 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5575 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5578 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5579 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5580 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5581 server
.dirty
+= deleted
;
5582 addReplyLong(c
,deleted
);
5585 static void zremrangebyrankCommand(redisClient
*c
) {
5593 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5594 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5596 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5597 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5599 llen
= zs
->zsl
->length
;
5601 /* convert negative indexes */
5602 if (start
< 0) start
= llen
+start
;
5603 if (end
< 0) end
= llen
+end
;
5604 if (start
< 0) start
= 0;
5605 if (end
< 0) end
= 0;
5607 /* indexes sanity checks */
5608 if (start
> end
|| start
>= llen
) {
5609 addReply(c
,shared
.czero
);
5612 if (end
>= llen
) end
= llen
-1;
5614 /* increment start and end because zsl*Rank functions
5615 * use 1-based rank */
5616 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5617 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5618 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5619 server
.dirty
+= deleted
;
5620 addReplyLong(c
, deleted
);
5628 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5629 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5630 unsigned long size1
, size2
;
5631 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5632 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5633 return size1
- size2
;
5636 #define REDIS_AGGR_SUM 1
5637 #define REDIS_AGGR_MIN 2
5638 #define REDIS_AGGR_MAX 3
5640 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5641 if (aggregate
== REDIS_AGGR_SUM
) {
5642 *target
= *target
+ val
;
5643 } else if (aggregate
== REDIS_AGGR_MIN
) {
5644 *target
= val
< *target
? val
: *target
;
5645 } else if (aggregate
== REDIS_AGGR_MAX
) {
5646 *target
= val
> *target
? val
: *target
;
5649 redisPanic("Unknown ZUNION/INTER aggregate type");
5653 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5655 int aggregate
= REDIS_AGGR_SUM
;
5662 /* expect zsetnum input keys to be given */
5663 zsetnum
= atoi(c
->argv
[2]->ptr
);
5665 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5669 /* test if the expected number of keys would overflow */
5670 if (3+zsetnum
> c
->argc
) {
5671 addReply(c
,shared
.syntaxerr
);
5675 /* read keys to be used for input */
5676 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5677 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5678 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5682 if (zsetobj
->type
!= REDIS_ZSET
) {
5684 addReply(c
,shared
.wrongtypeerr
);
5687 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5690 /* default all weights to 1 */
5691 src
[i
].weight
= 1.0;
5694 /* parse optional extra arguments */
5696 int remaining
= c
->argc
- j
;
5699 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5701 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5702 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5705 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5707 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5708 aggregate
= REDIS_AGGR_SUM
;
5709 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5710 aggregate
= REDIS_AGGR_MIN
;
5711 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5712 aggregate
= REDIS_AGGR_MAX
;
5715 addReply(c
,shared
.syntaxerr
);
5721 addReply(c
,shared
.syntaxerr
);
5727 /* sort sets from the smallest to largest, this will improve our
5728 * algorithm's performance */
5729 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5731 dstobj
= createZsetObject();
5732 dstzset
= dstobj
->ptr
;
5734 if (op
== REDIS_OP_INTER
) {
5735 /* skip going over all entries if the smallest zset is NULL or empty */
5736 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5737 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5738 * from small to large, all src[i > 0].dict are non-empty too */
5739 di
= dictGetIterator(src
[0].dict
);
5740 while((de
= dictNext(di
)) != NULL
) {
5741 double *score
= zmalloc(sizeof(double)), value
;
5742 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5744 for (j
= 1; j
< zsetnum
; j
++) {
5745 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5747 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5748 zunionInterAggregate(score
, value
, aggregate
);
5754 /* skip entry when not present in every source dict */
5758 robj
*o
= dictGetEntryKey(de
);
5759 dictAdd(dstzset
->dict
,o
,score
);
5760 incrRefCount(o
); /* added to dictionary */
5761 zslInsert(dstzset
->zsl
,*score
,o
);
5762 incrRefCount(o
); /* added to skiplist */
5765 dictReleaseIterator(di
);
5767 } else if (op
== REDIS_OP_UNION
) {
5768 for (i
= 0; i
< zsetnum
; i
++) {
5769 if (!src
[i
].dict
) continue;
5771 di
= dictGetIterator(src
[i
].dict
);
5772 while((de
= dictNext(di
)) != NULL
) {
5773 /* skip key when already processed */
5774 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5776 double *score
= zmalloc(sizeof(double)), value
;
5777 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5779 /* because the zsets are sorted by size, its only possible
5780 * for sets at larger indices to hold this entry */
5781 for (j
= (i
+1); j
< zsetnum
; j
++) {
5782 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5784 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5785 zunionInterAggregate(score
, value
, aggregate
);
5789 robj
*o
= dictGetEntryKey(de
);
5790 dictAdd(dstzset
->dict
,o
,score
);
5791 incrRefCount(o
); /* added to dictionary */
5792 zslInsert(dstzset
->zsl
,*score
,o
);
5793 incrRefCount(o
); /* added to skiplist */
5795 dictReleaseIterator(di
);
5798 /* unknown operator */
5799 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5802 deleteKey(c
->db
,dstkey
);
5803 if (dstzset
->zsl
->length
) {
5804 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5805 incrRefCount(dstkey
);
5806 addReplyLong(c
, dstzset
->zsl
->length
);
5809 decrRefCount(dstobj
);
5810 addReply(c
, shared
.czero
);
5815 static void zunionCommand(redisClient
*c
) {
5816 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5819 static void zinterCommand(redisClient
*c
) {
5820 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5823 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5835 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5836 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5838 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5840 } else if (c
->argc
>= 5) {
5841 addReply(c
,shared
.syntaxerr
);
5845 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5846 || checkType(c
,o
,REDIS_ZSET
)) return;
5851 /* convert negative indexes */
5852 if (start
< 0) start
= llen
+start
;
5853 if (end
< 0) end
= llen
+end
;
5854 if (start
< 0) start
= 0;
5855 if (end
< 0) end
= 0;
5857 /* indexes sanity checks */
5858 if (start
> end
|| start
>= llen
) {
5859 /* Out of range start or start > end result in empty list */
5860 addReply(c
,shared
.emptymultibulk
);
5863 if (end
>= llen
) end
= llen
-1;
5864 rangelen
= (end
-start
)+1;
5866 /* check if starting point is trivial, before searching
5867 * the element in log(N) time */
5869 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5872 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5875 /* Return the result in form of a multi-bulk reply */
5876 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5877 withscores
? (rangelen
*2) : rangelen
));
5878 for (j
= 0; j
< rangelen
; j
++) {
5880 addReplyBulk(c
,ele
);
5882 addReplyDouble(c
,ln
->score
);
5883 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5887 static void zrangeCommand(redisClient
*c
) {
5888 zrangeGenericCommand(c
,0);
5891 static void zrevrangeCommand(redisClient
*c
) {
5892 zrangeGenericCommand(c
,1);
5895 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5896 * If justcount is non-zero, just the count is returned. */
5897 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5900 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5901 int offset
= 0, limit
= -1;
5905 /* Parse the min-max interval. If one of the values is prefixed
5906 * by the "(" character, it's considered "open". For instance
5907 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5908 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5909 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5910 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5913 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5915 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5916 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5919 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5922 /* Parse "WITHSCORES": note that if the command was called with
5923 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5924 * enter the following paths to parse WITHSCORES and LIMIT. */
5925 if (c
->argc
== 5 || c
->argc
== 8) {
5926 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5931 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5935 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5940 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5941 addReply(c
,shared
.syntaxerr
);
5943 } else if (c
->argc
== (7 + withscores
)) {
5944 offset
= atoi(c
->argv
[5]->ptr
);
5945 limit
= atoi(c
->argv
[6]->ptr
);
5946 if (offset
< 0) offset
= 0;
5949 /* Ok, lookup the key and get the range */
5950 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5952 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5954 if (o
->type
!= REDIS_ZSET
) {
5955 addReply(c
,shared
.wrongtypeerr
);
5957 zset
*zsetobj
= o
->ptr
;
5958 zskiplist
*zsl
= zsetobj
->zsl
;
5960 robj
*ele
, *lenobj
= NULL
;
5961 unsigned long rangelen
= 0;
5963 /* Get the first node with the score >= min, or with
5964 * score > min if 'minex' is true. */
5965 ln
= zslFirstWithScore(zsl
,min
);
5966 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5969 /* No element matching the speciifed interval */
5970 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5974 /* We don't know in advance how many matching elements there
5975 * are in the list, so we push this object that will represent
5976 * the multi-bulk length in the output buffer, and will "fix"
5979 lenobj
= createObject(REDIS_STRING
,NULL
);
5981 decrRefCount(lenobj
);
5984 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5987 ln
= ln
->forward
[0];
5990 if (limit
== 0) break;
5993 addReplyBulk(c
,ele
);
5995 addReplyDouble(c
,ln
->score
);
5997 ln
= ln
->forward
[0];
5999 if (limit
> 0) limit
--;
6002 addReplyLong(c
,(long)rangelen
);
6004 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6005 withscores
? (rangelen
*2) : rangelen
);
6011 static void zrangebyscoreCommand(redisClient
*c
) {
6012 genericZrangebyscoreCommand(c
,0);
6015 static void zcountCommand(redisClient
*c
) {
6016 genericZrangebyscoreCommand(c
,1);
6019 static void zcardCommand(redisClient
*c
) {
6023 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6024 checkType(c
,o
,REDIS_ZSET
)) return;
6027 addReplyUlong(c
,zs
->zsl
->length
);
6030 static void zscoreCommand(redisClient
*c
) {
6035 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6036 checkType(c
,o
,REDIS_ZSET
)) return;
6039 de
= dictFind(zs
->dict
,c
->argv
[2]);
6041 addReply(c
,shared
.nullbulk
);
6043 double *score
= dictGetEntryVal(de
);
6045 addReplyDouble(c
,*score
);
6049 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6057 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6058 checkType(c
,o
,REDIS_ZSET
)) return;
6062 de
= dictFind(zs
->dict
,c
->argv
[2]);
6064 addReply(c
,shared
.nullbulk
);
6068 score
= dictGetEntryVal(de
);
6069 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6072 addReplyLong(c
, zsl
->length
- rank
);
6074 addReplyLong(c
, rank
-1);
6077 addReply(c
,shared
.nullbulk
);
6081 static void zrankCommand(redisClient
*c
) {
6082 zrankGenericCommand(c
, 0);
6085 static void zrevrankCommand(redisClient
*c
) {
6086 zrankGenericCommand(c
, 1);
6089 /* ========================= Hashes utility functions ======================= */
6090 #define REDIS_HASH_KEY 1
6091 #define REDIS_HASH_VALUE 2
6093 /* Check the length of a number of objects to see if we need to convert a
6094 * zipmap to a real hash. Note that we only check string encoded objects
6095 * as their string length can be queried in constant time. */
6096 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6098 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6100 for (i
= start
; i
<= end
; i
++) {
6101 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6102 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6104 convertToRealHash(subject
);
6110 /* Encode given objects in-place when the hash uses a dict. */
6111 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6112 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6113 if (o1
) *o1
= tryObjectEncoding(*o1
);
6114 if (o2
) *o2
= tryObjectEncoding(*o2
);
6118 /* Get the value from a hash identified by key. Returns either a string
6119 * object or NULL if the value cannot be found. The refcount of the object
6120 * is always increased by 1 when the value was found. */
6121 static robj
*hashGet(robj
*o
, robj
*key
) {
6123 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6126 key
= getDecodedObject(key
);
6127 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6128 value
= createStringObject((char*)v
,vlen
);
6132 dictEntry
*de
= dictFind(o
->ptr
,key
);
6134 value
= dictGetEntryVal(de
);
6135 incrRefCount(value
);
6141 /* Test if the key exists in the given hash. Returns 1 if the key
6142 * exists and 0 when it doesn't. */
6143 static int hashExists(robj
*o
, robj
*key
) {
6144 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6145 key
= getDecodedObject(key
);
6146 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6152 if (dictFind(o
->ptr
,key
) != NULL
) {
6159 /* Add an element, discard the old if the key already exists.
6160 * Return 0 on insert and 1 on update. */
6161 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6163 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6164 key
= getDecodedObject(key
);
6165 value
= getDecodedObject(value
);
6166 o
->ptr
= zipmapSet(o
->ptr
,
6167 key
->ptr
,sdslen(key
->ptr
),
6168 value
->ptr
,sdslen(value
->ptr
), &update
);
6170 decrRefCount(value
);
6172 /* Check if the zipmap needs to be upgraded to a real hash table */
6173 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6174 convertToRealHash(o
);
6176 if (dictReplace(o
->ptr
,key
,value
)) {
6183 incrRefCount(value
);
6188 /* Delete an element from a hash.
6189 * Return 1 on deleted and 0 on not found. */
6190 static int hashDelete(robj
*o
, robj
*key
) {
6192 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6193 key
= getDecodedObject(key
);
6194 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6197 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6198 /* Always check if the dictionary needs a resize after a delete. */
6199 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6204 /* Return the number of elements in a hash. */
6205 static unsigned long hashLength(robj
*o
) {
6206 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6207 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6210 /* Structure to hold hash iteration abstration. Note that iteration over
6211 * hashes involves both fields and values. Because it is possible that
6212 * not both are required, store pointers in the iterator to avoid
6213 * unnecessary memory allocation for fields/values. */
6217 unsigned char *zk
, *zv
;
6218 unsigned int zklen
, zvlen
;
6224 static hashIterator
*hashInitIterator(robj
*subject
) {
6225 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6226 hi
->encoding
= subject
->encoding
;
6227 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6228 hi
->zi
= zipmapRewind(subject
->ptr
);
6229 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6230 hi
->di
= dictGetIterator(subject
->ptr
);
6237 static void hashReleaseIterator(hashIterator
*hi
) {
6238 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6239 dictReleaseIterator(hi
->di
);
6244 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6245 * could be found and REDIS_ERR when the iterator reaches the end. */
6246 static int hashNext(hashIterator
*hi
) {
6247 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6248 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6249 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6251 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6256 /* Get key or value object at current iteration position.
6257 * This increases the refcount of the field object by 1. */
6258 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6260 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6261 if (what
& REDIS_HASH_KEY
) {
6262 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6264 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6267 if (what
& REDIS_HASH_KEY
) {
6268 o
= dictGetEntryKey(hi
->de
);
6270 o
= dictGetEntryVal(hi
->de
);
6277 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6278 robj
*o
= lookupKeyWrite(c
->db
,key
);
6280 o
= createHashObject();
6281 dictAdd(c
->db
->dict
,key
,o
);
6284 if (o
->type
!= REDIS_HASH
) {
6285 addReply(c
,shared
.wrongtypeerr
);
6292 /* ============================= Hash commands ============================== */
6293 static void hsetCommand(redisClient
*c
) {
6297 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6298 hashTryConversion(o
,c
->argv
,2,3);
6299 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6300 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6301 addReply(c
, update
? shared
.czero
: shared
.cone
);
6305 static void hsetnxCommand(redisClient
*c
) {
6307 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6308 hashTryConversion(o
,c
->argv
,2,3);
6310 if (hashExists(o
, c
->argv
[2])) {
6311 addReply(c
, shared
.czero
);
6313 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6314 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6315 addReply(c
, shared
.cone
);
6320 static void hmsetCommand(redisClient
*c
) {
6324 if ((c
->argc
% 2) == 1) {
6325 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6329 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6330 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6331 for (i
= 2; i
< c
->argc
; i
+= 2) {
6332 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6333 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6335 addReply(c
, shared
.ok
);
6339 static void hincrbyCommand(redisClient
*c
) {
6340 long long value
, incr
;
6341 robj
*o
, *current
, *new;
6343 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6344 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6345 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6346 if (current
->encoding
== REDIS_ENCODING_RAW
)
6347 value
= strtoll(current
->ptr
,NULL
,10);
6348 else if (current
->encoding
== REDIS_ENCODING_INT
)
6349 value
= (long)current
->ptr
;
6351 redisAssert(1 != 1);
6352 decrRefCount(current
);
6358 new = createStringObjectFromLongLong(value
);
6359 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6360 hashSet(o
,c
->argv
[2],new);
6362 addReplyLongLong(c
,value
);
6366 static void hgetCommand(redisClient
*c
) {
6368 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6369 checkType(c
,o
,REDIS_HASH
)) return;
6371 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6372 addReplyBulk(c
,value
);
6373 decrRefCount(value
);
6375 addReply(c
,shared
.nullbulk
);
6379 static void hmgetCommand(redisClient
*c
) {
6382 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6383 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6384 addReply(c
,shared
.wrongtypeerr
);
6387 /* Note the check for o != NULL happens inside the loop. This is
6388 * done because objects that cannot be found are considered to be
6389 * an empty hash. The reply should then be a series of NULLs. */
6390 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6391 for (i
= 2; i
< c
->argc
; i
++) {
6392 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6393 addReplyBulk(c
,value
);
6394 decrRefCount(value
);
6396 addReply(c
,shared
.nullbulk
);
6401 static void hdelCommand(redisClient
*c
) {
6403 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6404 checkType(c
,o
,REDIS_HASH
)) return;
6406 if (hashDelete(o
,c
->argv
[2])) {
6407 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6408 addReply(c
,shared
.cone
);
6411 addReply(c
,shared
.czero
);
6415 static void hlenCommand(redisClient
*c
) {
6417 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6418 checkType(c
,o
,REDIS_HASH
)) return;
6420 addReplyUlong(c
,hashLength(o
));
6423 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6424 robj
*o
, *lenobj
, *obj
;
6425 unsigned long count
= 0;
6428 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6429 || checkType(c
,o
,REDIS_HASH
)) return;
6431 lenobj
= createObject(REDIS_STRING
,NULL
);
6433 decrRefCount(lenobj
);
6435 hi
= hashInitIterator(o
);
6436 while (hashNext(hi
) != REDIS_ERR
) {
6437 if (flags
& REDIS_HASH_KEY
) {
6438 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6439 addReplyBulk(c
,obj
);
6443 if (flags
& REDIS_HASH_VALUE
) {
6444 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6445 addReplyBulk(c
,obj
);
6450 hashReleaseIterator(hi
);
6452 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6455 static void hkeysCommand(redisClient
*c
) {
6456 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6459 static void hvalsCommand(redisClient
*c
) {
6460 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6463 static void hgetallCommand(redisClient
*c
) {
6464 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6467 static void hexistsCommand(redisClient
*c
) {
6469 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6470 checkType(c
,o
,REDIS_HASH
)) return;
6472 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6475 static void convertToRealHash(robj
*o
) {
6476 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6477 unsigned int klen
, vlen
;
6478 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6480 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6481 p
= zipmapRewind(zm
);
6482 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6483 robj
*keyobj
, *valobj
;
6485 keyobj
= createStringObject((char*)key
,klen
);
6486 valobj
= createStringObject((char*)val
,vlen
);
6487 keyobj
= tryObjectEncoding(keyobj
);
6488 valobj
= tryObjectEncoding(valobj
);
6489 dictAdd(dict
,keyobj
,valobj
);
6491 o
->encoding
= REDIS_ENCODING_HT
;
6496 /* ========================= Non type-specific commands ==================== */
6498 static void flushdbCommand(redisClient
*c
) {
6499 server
.dirty
+= dictSize(c
->db
->dict
);
6500 dictEmpty(c
->db
->dict
);
6501 dictEmpty(c
->db
->expires
);
6502 addReply(c
,shared
.ok
);
6505 static void flushallCommand(redisClient
*c
) {
6506 server
.dirty
+= emptyDb();
6507 addReply(c
,shared
.ok
);
6508 if (server
.bgsavechildpid
!= -1) {
6509 kill(server
.bgsavechildpid
,SIGKILL
);
6510 rdbRemoveTempFile(server
.bgsavechildpid
);
6512 rdbSave(server
.dbfilename
);
6516 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6517 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6519 so
->pattern
= pattern
;
6523 /* Return the value associated to the key with a name obtained
6524 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6525 * The returned object will always have its refcount increased by 1
6526 * when it is non-NULL. */
6527 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6530 robj keyobj
, fieldobj
, *o
;
6531 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6532 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6536 char buf
[REDIS_SORTKEY_MAX
+1];
6537 } keyname
, fieldname
;
6539 /* If the pattern is "#" return the substitution object itself in order
6540 * to implement the "SORT ... GET #" feature. */
6541 spat
= pattern
->ptr
;
6542 if (spat
[0] == '#' && spat
[1] == '\0') {
6543 incrRefCount(subst
);
6547 /* The substitution object may be specially encoded. If so we create
6548 * a decoded object on the fly. Otherwise getDecodedObject will just
6549 * increment the ref count, that we'll decrement later. */
6550 subst
= getDecodedObject(subst
);
6553 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6554 p
= strchr(spat
,'*');
6556 decrRefCount(subst
);
6560 /* Find out if we're dealing with a hash dereference. */
6561 if ((f
= strstr(p
+1, "->")) != NULL
) {
6562 fieldlen
= sdslen(spat
)-(f
-spat
);
6563 /* this also copies \0 character */
6564 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6565 fieldname
.len
= fieldlen
-2;
6571 sublen
= sdslen(ssub
);
6572 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6573 memcpy(keyname
.buf
,spat
,prefixlen
);
6574 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6575 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6576 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6577 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6578 decrRefCount(subst
);
6580 /* Lookup substituted key */
6581 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6582 o
= lookupKeyRead(db
,&keyobj
);
6583 if (o
== NULL
) return NULL
;
6586 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6588 /* Retrieve value from hash by the field name. This operation
6589 * already increases the refcount of the returned object. */
6590 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6591 o
= hashGet(o
, &fieldobj
);
6593 if (o
->type
!= REDIS_STRING
) return NULL
;
6595 /* Every object that this function returns needs to have its refcount
6596 * increased. sortCommand decreases it again. */
6603 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6604 * the additional parameter is not standard but a BSD-specific we have to
6605 * pass sorting parameters via the global 'server' structure */
6606 static int sortCompare(const void *s1
, const void *s2
) {
6607 const redisSortObject
*so1
= s1
, *so2
= s2
;
6610 if (!server
.sort_alpha
) {
6611 /* Numeric sorting. Here it's trivial as we precomputed scores */
6612 if (so1
->u
.score
> so2
->u
.score
) {
6614 } else if (so1
->u
.score
< so2
->u
.score
) {
6620 /* Alphanumeric sorting */
6621 if (server
.sort_bypattern
) {
6622 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6623 /* At least one compare object is NULL */
6624 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6626 else if (so1
->u
.cmpobj
== NULL
)
6631 /* We have both the objects, use strcoll */
6632 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6635 /* Compare elements directly. Note that these objects already
6636 * need to be non-encoded (see sortCommand). */
6637 cmp
= strcoll(so1
->obj
->ptr
,so2
->obj
->ptr
);
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 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 static void execCommand(redisClient
*c
) {
7228 if (!(c
->flags
& REDIS_MULTI
)) {
7229 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7233 orig_argv
= c
->argv
;
7234 orig_argc
= c
->argc
;
7235 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7236 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7237 c
->argc
= c
->mstate
.commands
[j
].argc
;
7238 c
->argv
= c
->mstate
.commands
[j
].argv
;
7239 call(c
,c
->mstate
.commands
[j
].cmd
);
7241 c
->argv
= orig_argv
;
7242 c
->argc
= orig_argc
;
7243 freeClientMultiState(c
);
7244 initClientMultiState(c
);
7245 c
->flags
&= (~REDIS_MULTI
);
7248 /* =========================== Blocking Operations ========================= */
7250 /* Currently Redis blocking operations support is limited to list POP ops,
7251 * so the current implementation is not fully generic, but it is also not
7252 * completely specific so it will not require a rewrite to support new
7253 * kind of blocking operations in the future.
7255 * Still it's important to note that list blocking operations can be already
7256 * used as a notification mechanism in order to implement other blocking
7257 * operations at application level, so there must be a very strong evidence
7258 * of usefulness and generality before new blocking operations are implemented.
7260 * This is how the current blocking POP works, we use BLPOP as example:
7261 * - If the user calls BLPOP and the key exists and contains a non empty list
7262 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7263 * if there is not to block.
7264 * - If instead BLPOP is called and the key does not exists or the list is
7265 * empty we need to block. In order to do so we remove the notification for
7266 * new data to read in the client socket (so that we'll not serve new
7267 * requests if the blocking request is not served). Also we put the client
7268 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7269 * blocking for this keys.
7270 * - If a PUSH operation against a key with blocked clients waiting is
7271 * performed, we serve the first in the list: basically instead to push
7272 * the new element inside the list we return it to the (first / oldest)
7273 * blocking client, unblock the client, and remove it form the list.
7275 * The above comment and the source code should be enough in order to understand
7276 * the implementation and modify / fix it later.
7279 /* Set a client in blocking mode for the specified key, with the specified
7281 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7286 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7287 c
->blockingkeysnum
= numkeys
;
7288 c
->blockingto
= timeout
;
7289 for (j
= 0; j
< numkeys
; j
++) {
7290 /* Add the key in the client structure, to map clients -> keys */
7291 c
->blockingkeys
[j
] = keys
[j
];
7292 incrRefCount(keys
[j
]);
7294 /* And in the other "side", to map keys -> clients */
7295 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7299 /* For every key we take a list of clients blocked for it */
7301 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7302 incrRefCount(keys
[j
]);
7303 assert(retval
== DICT_OK
);
7305 l
= dictGetEntryVal(de
);
7307 listAddNodeTail(l
,c
);
7309 /* Mark the client as a blocked client */
7310 c
->flags
|= REDIS_BLOCKED
;
7311 server
.blpop_blocked_clients
++;
7314 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7315 static void unblockClientWaitingData(redisClient
*c
) {
7320 assert(c
->blockingkeys
!= NULL
);
7321 /* The client may wait for multiple keys, so unblock it for every key. */
7322 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7323 /* Remove this client from the list of clients waiting for this key. */
7324 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7326 l
= dictGetEntryVal(de
);
7327 listDelNode(l
,listSearchKey(l
,c
));
7328 /* If the list is empty we need to remove it to avoid wasting memory */
7329 if (listLength(l
) == 0)
7330 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7331 decrRefCount(c
->blockingkeys
[j
]);
7333 /* Cleanup the client structure */
7334 zfree(c
->blockingkeys
);
7335 c
->blockingkeys
= NULL
;
7336 c
->flags
&= (~REDIS_BLOCKED
);
7337 server
.blpop_blocked_clients
--;
7338 /* We want to process data if there is some command waiting
7339 * in the input buffer. Note that this is safe even if
7340 * unblockClientWaitingData() gets called from freeClient() because
7341 * freeClient() will be smart enough to call this function
7342 * *after* c->querybuf was set to NULL. */
7343 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7346 /* This should be called from any function PUSHing into lists.
7347 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7348 * 'ele' is the element pushed.
7350 * If the function returns 0 there was no client waiting for a list push
7353 * If the function returns 1 there was a client waiting for a list push
7354 * against this key, the element was passed to this client thus it's not
7355 * needed to actually add it to the list and the caller should return asap. */
7356 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7357 struct dictEntry
*de
;
7358 redisClient
*receiver
;
7362 de
= dictFind(c
->db
->blockingkeys
,key
);
7363 if (de
== NULL
) return 0;
7364 l
= dictGetEntryVal(de
);
7367 receiver
= ln
->value
;
7369 addReplySds(receiver
,sdsnew("*2\r\n"));
7370 addReplyBulk(receiver
,key
);
7371 addReplyBulk(receiver
,ele
);
7372 unblockClientWaitingData(receiver
);
7376 /* Blocking RPOP/LPOP */
7377 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7382 for (j
= 1; j
< c
->argc
-1; j
++) {
7383 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7385 if (o
->type
!= REDIS_LIST
) {
7386 addReply(c
,shared
.wrongtypeerr
);
7389 list
*list
= o
->ptr
;
7390 if (listLength(list
) != 0) {
7391 /* If the list contains elements fall back to the usual
7392 * non-blocking POP operation */
7393 robj
*argv
[2], **orig_argv
;
7396 /* We need to alter the command arguments before to call
7397 * popGenericCommand() as the command takes a single key. */
7398 orig_argv
= c
->argv
;
7399 orig_argc
= c
->argc
;
7400 argv
[1] = c
->argv
[j
];
7404 /* Also the return value is different, we need to output
7405 * the multi bulk reply header and the key name. The
7406 * "real" command will add the last element (the value)
7407 * for us. If this souds like an hack to you it's just
7408 * because it is... */
7409 addReplySds(c
,sdsnew("*2\r\n"));
7410 addReplyBulk(c
,argv
[1]);
7411 popGenericCommand(c
,where
);
7413 /* Fix the client structure with the original stuff */
7414 c
->argv
= orig_argv
;
7415 c
->argc
= orig_argc
;
7421 /* If the list is empty or the key does not exists we must block */
7422 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7423 if (timeout
> 0) timeout
+= time(NULL
);
7424 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7427 static void blpopCommand(redisClient
*c
) {
7428 blockingPopGenericCommand(c
,REDIS_HEAD
);
7431 static void brpopCommand(redisClient
*c
) {
7432 blockingPopGenericCommand(c
,REDIS_TAIL
);
7435 /* =============================== Replication ============================= */
7437 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7438 ssize_t nwritten
, ret
= size
;
7439 time_t start
= time(NULL
);
7443 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7444 nwritten
= write(fd
,ptr
,size
);
7445 if (nwritten
== -1) return -1;
7449 if ((time(NULL
)-start
) > timeout
) {
7457 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7458 ssize_t nread
, totread
= 0;
7459 time_t start
= time(NULL
);
7463 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7464 nread
= read(fd
,ptr
,size
);
7465 if (nread
== -1) return -1;
7470 if ((time(NULL
)-start
) > timeout
) {
7478 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7485 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7488 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7499 static void syncCommand(redisClient
*c
) {
7500 /* ignore SYNC if aleady slave or in monitor mode */
7501 if (c
->flags
& REDIS_SLAVE
) return;
7503 /* SYNC can't be issued when the server has pending data to send to
7504 * the client about already issued commands. We need a fresh reply
7505 * buffer registering the differences between the BGSAVE and the current
7506 * dataset, so that we can copy to other slaves if needed. */
7507 if (listLength(c
->reply
) != 0) {
7508 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7512 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7513 /* Here we need to check if there is a background saving operation
7514 * in progress, or if it is required to start one */
7515 if (server
.bgsavechildpid
!= -1) {
7516 /* Ok a background save is in progress. Let's check if it is a good
7517 * one for replication, i.e. if there is another slave that is
7518 * registering differences since the server forked to save */
7523 listRewind(server
.slaves
,&li
);
7524 while((ln
= listNext(&li
))) {
7526 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7529 /* Perfect, the server is already registering differences for
7530 * another slave. Set the right state, and copy the buffer. */
7531 listRelease(c
->reply
);
7532 c
->reply
= listDup(slave
->reply
);
7533 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7534 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7536 /* No way, we need to wait for the next BGSAVE in order to
7537 * register differences */
7538 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7539 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7542 /* Ok we don't have a BGSAVE in progress, let's start one */
7543 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7544 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7545 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7546 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7549 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7552 c
->flags
|= REDIS_SLAVE
;
7554 listAddNodeTail(server
.slaves
,c
);
7558 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7559 redisClient
*slave
= privdata
;
7561 REDIS_NOTUSED(mask
);
7562 char buf
[REDIS_IOBUF_LEN
];
7563 ssize_t nwritten
, buflen
;
7565 if (slave
->repldboff
== 0) {
7566 /* Write the bulk write count before to transfer the DB. In theory here
7567 * we don't know how much room there is in the output buffer of the
7568 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7569 * operations) will never be smaller than the few bytes we need. */
7572 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7574 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7582 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7583 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7585 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7586 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7590 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7591 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7596 slave
->repldboff
+= nwritten
;
7597 if (slave
->repldboff
== slave
->repldbsize
) {
7598 close(slave
->repldbfd
);
7599 slave
->repldbfd
= -1;
7600 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7601 slave
->replstate
= REDIS_REPL_ONLINE
;
7602 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7603 sendReplyToClient
, slave
) == AE_ERR
) {
7607 addReplySds(slave
,sdsempty());
7608 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7612 /* This function is called at the end of every backgrond saving.
7613 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7614 * otherwise REDIS_ERR is passed to the function.
7616 * The goal of this function is to handle slaves waiting for a successful
7617 * background saving in order to perform non-blocking synchronization. */
7618 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7620 int startbgsave
= 0;
7623 listRewind(server
.slaves
,&li
);
7624 while((ln
= listNext(&li
))) {
7625 redisClient
*slave
= ln
->value
;
7627 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7629 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7630 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7631 struct redis_stat buf
;
7633 if (bgsaveerr
!= REDIS_OK
) {
7635 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7638 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7639 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7641 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7644 slave
->repldboff
= 0;
7645 slave
->repldbsize
= buf
.st_size
;
7646 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7647 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7648 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7655 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7658 listRewind(server
.slaves
,&li
);
7659 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7660 while((ln
= listNext(&li
))) {
7661 redisClient
*slave
= ln
->value
;
7663 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7670 static int syncWithMaster(void) {
7671 char buf
[1024], tmpfile
[256], authcmd
[1024];
7673 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7674 int dfd
, maxtries
= 5;
7677 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7682 /* AUTH with the master if required. */
7683 if(server
.masterauth
) {
7684 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7685 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7687 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7691 /* Read the AUTH result. */
7692 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7694 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7698 if (buf
[0] != '+') {
7700 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7705 /* Issue the SYNC command */
7706 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7708 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7712 /* Read the bulk write count */
7713 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7715 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7719 if (buf
[0] != '$') {
7721 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7724 dumpsize
= strtol(buf
+1,NULL
,10);
7725 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7726 /* Read the bulk write data on a temp file */
7728 snprintf(tmpfile
,256,
7729 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7730 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7731 if (dfd
!= -1) break;
7736 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7740 int nread
, nwritten
;
7742 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7744 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7750 nwritten
= write(dfd
,buf
,nread
);
7751 if (nwritten
== -1) {
7752 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7760 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7761 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7767 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7768 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7772 server
.master
= createClient(fd
);
7773 server
.master
->flags
|= REDIS_MASTER
;
7774 server
.master
->authenticated
= 1;
7775 server
.replstate
= REDIS_REPL_CONNECTED
;
7779 static void slaveofCommand(redisClient
*c
) {
7780 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7781 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7782 if (server
.masterhost
) {
7783 sdsfree(server
.masterhost
);
7784 server
.masterhost
= NULL
;
7785 if (server
.master
) freeClient(server
.master
);
7786 server
.replstate
= REDIS_REPL_NONE
;
7787 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7790 sdsfree(server
.masterhost
);
7791 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7792 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7793 if (server
.master
) freeClient(server
.master
);
7794 server
.replstate
= REDIS_REPL_CONNECT
;
7795 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7796 server
.masterhost
, server
.masterport
);
7798 addReply(c
,shared
.ok
);
7801 /* ============================ Maxmemory directive ======================== */
7803 /* Try to free one object form the pre-allocated objects free list.
7804 * This is useful under low mem conditions as by default we take 1 million
7805 * free objects allocated. On success REDIS_OK is returned, otherwise
7807 static int tryFreeOneObjectFromFreelist(void) {
7810 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7811 if (listLength(server
.objfreelist
)) {
7812 listNode
*head
= listFirst(server
.objfreelist
);
7813 o
= listNodeValue(head
);
7814 listDelNode(server
.objfreelist
,head
);
7815 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7819 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7824 /* This function gets called when 'maxmemory' is set on the config file to limit
7825 * the max memory used by the server, and we are out of memory.
7826 * This function will try to, in order:
7828 * - Free objects from the free list
7829 * - Try to remove keys with an EXPIRE set
7831 * It is not possible to free enough memory to reach used-memory < maxmemory
7832 * the server will start refusing commands that will enlarge even more the
7835 static void freeMemoryIfNeeded(void) {
7836 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7837 int j
, k
, freed
= 0;
7839 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7840 for (j
= 0; j
< server
.dbnum
; j
++) {
7842 robj
*minkey
= NULL
;
7843 struct dictEntry
*de
;
7845 if (dictSize(server
.db
[j
].expires
)) {
7847 /* From a sample of three keys drop the one nearest to
7848 * the natural expire */
7849 for (k
= 0; k
< 3; k
++) {
7852 de
= dictGetRandomKey(server
.db
[j
].expires
);
7853 t
= (time_t) dictGetEntryVal(de
);
7854 if (minttl
== -1 || t
< minttl
) {
7855 minkey
= dictGetEntryKey(de
);
7859 deleteKey(server
.db
+j
,minkey
);
7862 if (!freed
) return; /* nothing to free... */
7866 /* ============================== Append Only file ========================== */
7868 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7869 sds buf
= sdsempty();
7875 /* The DB this command was targetting is not the same as the last command
7876 * we appendend. To issue a SELECT command is needed. */
7877 if (dictid
!= server
.appendseldb
) {
7880 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7881 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7882 (unsigned long)strlen(seldb
),seldb
);
7883 server
.appendseldb
= dictid
;
7886 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7887 * EXPIREs into EXPIREATs calls */
7888 if (cmd
->proc
== expireCommand
) {
7891 tmpargv
[0] = createStringObject("EXPIREAT",8);
7892 tmpargv
[1] = argv
[1];
7893 incrRefCount(argv
[1]);
7894 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7895 tmpargv
[2] = createObject(REDIS_STRING
,
7896 sdscatprintf(sdsempty(),"%ld",when
));
7900 /* Append the actual command */
7901 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7902 for (j
= 0; j
< argc
; j
++) {
7905 o
= getDecodedObject(o
);
7906 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7907 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7908 buf
= sdscatlen(buf
,"\r\n",2);
7912 /* Free the objects from the modified argv for EXPIREAT */
7913 if (cmd
->proc
== expireCommand
) {
7914 for (j
= 0; j
< 3; j
++)
7915 decrRefCount(argv
[j
]);
7918 /* We want to perform a single write. This should be guaranteed atomic
7919 * at least if the filesystem we are writing is a real physical one.
7920 * While this will save us against the server being killed I don't think
7921 * there is much to do about the whole server stopping for power problems
7923 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7924 if (nwritten
!= (signed)sdslen(buf
)) {
7925 /* Ooops, we are in troubles. The best thing to do for now is
7926 * to simply exit instead to give the illusion that everything is
7927 * working as expected. */
7928 if (nwritten
== -1) {
7929 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7931 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7935 /* If a background append only file rewriting is in progress we want to
7936 * accumulate the differences between the child DB and the current one
7937 * in a buffer, so that when the child process will do its work we
7938 * can append the differences to the new append only file. */
7939 if (server
.bgrewritechildpid
!= -1)
7940 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7944 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7945 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7946 now
-server
.lastfsync
> 1))
7948 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7949 server
.lastfsync
= now
;
7953 /* In Redis commands are always executed in the context of a client, so in
7954 * order to load the append only file we need to create a fake client. */
7955 static struct redisClient
*createFakeClient(void) {
7956 struct redisClient
*c
= zmalloc(sizeof(*c
));
7960 c
->querybuf
= sdsempty();
7964 /* We set the fake client as a slave waiting for the synchronization
7965 * so that Redis will not try to send replies to this client. */
7966 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7967 c
->reply
= listCreate();
7968 listSetFreeMethod(c
->reply
,decrRefCount
);
7969 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7973 static void freeFakeClient(struct redisClient
*c
) {
7974 sdsfree(c
->querybuf
);
7975 listRelease(c
->reply
);
7979 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7980 * error (the append only file is zero-length) REDIS_ERR is returned. On
7981 * fatal error an error message is logged and the program exists. */
7982 int loadAppendOnlyFile(char *filename
) {
7983 struct redisClient
*fakeClient
;
7984 FILE *fp
= fopen(filename
,"r");
7985 struct redis_stat sb
;
7986 unsigned long long loadedkeys
= 0;
7988 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7992 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7996 fakeClient
= createFakeClient();
8003 struct redisCommand
*cmd
;
8005 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8011 if (buf
[0] != '*') goto fmterr
;
8013 argv
= zmalloc(sizeof(robj
*)*argc
);
8014 for (j
= 0; j
< argc
; j
++) {
8015 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8016 if (buf
[0] != '$') goto fmterr
;
8017 len
= strtol(buf
+1,NULL
,10);
8018 argsds
= sdsnewlen(NULL
,len
);
8019 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8020 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8021 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8024 /* Command lookup */
8025 cmd
= lookupCommand(argv
[0]->ptr
);
8027 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8030 /* Try object encoding */
8031 if (cmd
->flags
& REDIS_CMD_BULK
)
8032 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8033 /* Run the command in the context of a fake client */
8034 fakeClient
->argc
= argc
;
8035 fakeClient
->argv
= argv
;
8036 cmd
->proc(fakeClient
);
8037 /* Discard the reply objects list from the fake client */
8038 while(listLength(fakeClient
->reply
))
8039 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8040 /* Clean up, ready for the next command */
8041 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8043 /* Handle swapping while loading big datasets when VM is on */
8045 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8046 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8047 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8052 freeFakeClient(fakeClient
);
8057 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8059 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8063 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8067 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8068 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8072 /* Avoid the incr/decr ref count business if possible to help
8073 * copy-on-write (we are often in a child process when this function
8075 * Also makes sure that key objects don't get incrRefCount-ed when VM
8077 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8078 obj
= getDecodedObject(obj
);
8081 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8082 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8083 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8085 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8086 if (decrrc
) decrRefCount(obj
);
8089 if (decrrc
) decrRefCount(obj
);
8093 /* Write binary-safe string into a file in the bulkformat
8094 * $<count>\r\n<payload>\r\n */
8095 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8098 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8099 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8100 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8101 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8105 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8106 static int fwriteBulkDouble(FILE *fp
, double d
) {
8107 char buf
[128], dbuf
[128];
8109 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8110 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8111 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8112 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8116 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8117 static int fwriteBulkLong(FILE *fp
, long l
) {
8118 char buf
[128], lbuf
[128];
8120 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8121 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8122 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8123 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8127 /* Write a sequence of commands able to fully rebuild the dataset into
8128 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8129 static int rewriteAppendOnlyFile(char *filename
) {
8130 dictIterator
*di
= NULL
;
8135 time_t now
= time(NULL
);
8137 /* Note that we have to use a different temp name here compared to the
8138 * one used by rewriteAppendOnlyFileBackground() function. */
8139 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8140 fp
= fopen(tmpfile
,"w");
8142 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8145 for (j
= 0; j
< server
.dbnum
; j
++) {
8146 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8147 redisDb
*db
= server
.db
+j
;
8149 if (dictSize(d
) == 0) continue;
8150 di
= dictGetIterator(d
);
8156 /* SELECT the new DB */
8157 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8158 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8160 /* Iterate this DB writing every entry */
8161 while((de
= dictNext(di
)) != NULL
) {
8166 key
= dictGetEntryKey(de
);
8167 /* If the value for this key is swapped, load a preview in memory.
8168 * We use a "swapped" flag to remember if we need to free the
8169 * value object instead to just increment the ref count anyway
8170 * in order to avoid copy-on-write of pages if we are forked() */
8171 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8172 key
->storage
== REDIS_VM_SWAPPING
) {
8173 o
= dictGetEntryVal(de
);
8176 o
= vmPreviewObject(key
);
8179 expiretime
= getExpire(db
,key
);
8181 /* Save the key and associated value */
8182 if (o
->type
== REDIS_STRING
) {
8183 /* Emit a SET command */
8184 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8185 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8187 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8188 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8189 } else if (o
->type
== REDIS_LIST
) {
8190 /* Emit the RPUSHes needed to rebuild the list */
8191 list
*list
= o
->ptr
;
8195 listRewind(list
,&li
);
8196 while((ln
= listNext(&li
))) {
8197 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8198 robj
*eleobj
= listNodeValue(ln
);
8200 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8201 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8202 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8204 } else if (o
->type
== REDIS_SET
) {
8205 /* Emit the SADDs needed to rebuild the set */
8207 dictIterator
*di
= dictGetIterator(set
);
8210 while((de
= dictNext(di
)) != NULL
) {
8211 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8212 robj
*eleobj
= dictGetEntryKey(de
);
8214 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8215 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8216 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8218 dictReleaseIterator(di
);
8219 } else if (o
->type
== REDIS_ZSET
) {
8220 /* Emit the ZADDs needed to rebuild the sorted set */
8222 dictIterator
*di
= dictGetIterator(zs
->dict
);
8225 while((de
= dictNext(di
)) != NULL
) {
8226 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8227 robj
*eleobj
= dictGetEntryKey(de
);
8228 double *score
= dictGetEntryVal(de
);
8230 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8231 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8232 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8233 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8235 dictReleaseIterator(di
);
8236 } else if (o
->type
== REDIS_HASH
) {
8237 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8239 /* Emit the HSETs needed to rebuild the hash */
8240 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8241 unsigned char *p
= zipmapRewind(o
->ptr
);
8242 unsigned char *field
, *val
;
8243 unsigned int flen
, vlen
;
8245 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8246 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8247 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8248 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8250 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8254 dictIterator
*di
= dictGetIterator(o
->ptr
);
8257 while((de
= dictNext(di
)) != NULL
) {
8258 robj
*field
= dictGetEntryKey(de
);
8259 robj
*val
= dictGetEntryVal(de
);
8261 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8262 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8263 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8264 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8266 dictReleaseIterator(di
);
8269 redisPanic("Unknown object type");
8271 /* Save the expire time */
8272 if (expiretime
!= -1) {
8273 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8274 /* If this key is already expired skip it */
8275 if (expiretime
< now
) continue;
8276 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8277 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8278 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8280 if (swapped
) decrRefCount(o
);
8282 dictReleaseIterator(di
);
8285 /* Make sure data will not remain on the OS's output buffers */
8290 /* Use RENAME to make sure the DB file is changed atomically only
8291 * if the generate DB file is ok. */
8292 if (rename(tmpfile
,filename
) == -1) {
8293 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8297 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8303 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8304 if (di
) dictReleaseIterator(di
);
8308 /* This is how rewriting of the append only file in background works:
8310 * 1) The user calls BGREWRITEAOF
8311 * 2) Redis calls this function, that forks():
8312 * 2a) the child rewrite the append only file in a temp file.
8313 * 2b) the parent accumulates differences in server.bgrewritebuf.
8314 * 3) When the child finished '2a' exists.
8315 * 4) The parent will trap the exit code, if it's OK, will append the
8316 * data accumulated into server.bgrewritebuf into the temp file, and
8317 * finally will rename(2) the temp file in the actual file name.
8318 * The the new file is reopened as the new append only file. Profit!
8320 static int rewriteAppendOnlyFileBackground(void) {
8323 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8324 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8325 if ((childpid
= fork()) == 0) {
8329 if (server
.vm_enabled
) vmReopenSwapFile();
8331 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8332 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8339 if (childpid
== -1) {
8340 redisLog(REDIS_WARNING
,
8341 "Can't rewrite append only file in background: fork: %s",
8345 redisLog(REDIS_NOTICE
,
8346 "Background append only file rewriting started by pid %d",childpid
);
8347 server
.bgrewritechildpid
= childpid
;
8348 updateDictResizePolicy();
8349 /* We set appendseldb to -1 in order to force the next call to the
8350 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8351 * accumulated by the parent into server.bgrewritebuf will start
8352 * with a SELECT statement and it will be safe to merge. */
8353 server
.appendseldb
= -1;
8356 return REDIS_OK
; /* unreached */
8359 static void bgrewriteaofCommand(redisClient
*c
) {
8360 if (server
.bgrewritechildpid
!= -1) {
8361 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8364 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8365 char *status
= "+Background append only file rewriting started\r\n";
8366 addReplySds(c
,sdsnew(status
));
8368 addReply(c
,shared
.err
);
8372 static void aofRemoveTempFile(pid_t childpid
) {
8375 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8379 /* Virtual Memory is composed mainly of two subsystems:
8380 * - Blocking Virutal Memory
8381 * - Threaded Virtual Memory I/O
8382 * The two parts are not fully decoupled, but functions are split among two
8383 * different sections of the source code (delimited by comments) in order to
8384 * make more clear what functionality is about the blocking VM and what about
8385 * the threaded (not blocking) VM.
8389 * Redis VM is a blocking VM (one that blocks reading swapped values from
8390 * disk into memory when a value swapped out is needed in memory) that is made
8391 * unblocking by trying to examine the command argument vector in order to
8392 * load in background values that will likely be needed in order to exec
8393 * the command. The command is executed only once all the relevant keys
8394 * are loaded into memory.
8396 * This basically is almost as simple of a blocking VM, but almost as parallel
8397 * as a fully non-blocking VM.
8400 /* =================== Virtual Memory - Blocking Side ====================== */
8402 /* substitute the first occurrence of '%p' with the process pid in the
8403 * swap file name. */
8404 static void expandVmSwapFilename(void) {
8405 char *p
= strstr(server
.vm_swap_file
,"%p");
8411 new = sdscat(new,server
.vm_swap_file
);
8412 new = sdscatprintf(new,"%ld",(long) getpid());
8413 new = sdscat(new,p
+2);
8414 zfree(server
.vm_swap_file
);
8415 server
.vm_swap_file
= new;
8418 static void vmInit(void) {
8423 if (server
.vm_max_threads
!= 0)
8424 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8426 expandVmSwapFilename();
8427 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8428 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8429 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8431 if (server
.vm_fp
== NULL
) {
8432 redisLog(REDIS_WARNING
,
8433 "Impossible to open the swap file: %s. Exiting.",
8437 server
.vm_fd
= fileno(server
.vm_fp
);
8438 server
.vm_next_page
= 0;
8439 server
.vm_near_pages
= 0;
8440 server
.vm_stats_used_pages
= 0;
8441 server
.vm_stats_swapped_objects
= 0;
8442 server
.vm_stats_swapouts
= 0;
8443 server
.vm_stats_swapins
= 0;
8444 totsize
= server
.vm_pages
*server
.vm_page_size
;
8445 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8446 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8447 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8451 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8453 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8454 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8455 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8456 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8458 /* Initialize threaded I/O (used by Virtual Memory) */
8459 server
.io_newjobs
= listCreate();
8460 server
.io_processing
= listCreate();
8461 server
.io_processed
= listCreate();
8462 server
.io_ready_clients
= listCreate();
8463 pthread_mutex_init(&server
.io_mutex
,NULL
);
8464 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8465 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8466 server
.io_active_threads
= 0;
8467 if (pipe(pipefds
) == -1) {
8468 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8472 server
.io_ready_pipe_read
= pipefds
[0];
8473 server
.io_ready_pipe_write
= pipefds
[1];
8474 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8475 /* LZF requires a lot of stack */
8476 pthread_attr_init(&server
.io_threads_attr
);
8477 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8478 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8479 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8480 /* Listen for events in the threaded I/O pipe */
8481 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8482 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8483 oom("creating file event");
8486 /* Mark the page as used */
8487 static void vmMarkPageUsed(off_t page
) {
8488 off_t byte
= page
/8;
8490 redisAssert(vmFreePage(page
) == 1);
8491 server
.vm_bitmap
[byte
] |= 1<<bit
;
8494 /* Mark N contiguous pages as used, with 'page' being the first. */
8495 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8498 for (j
= 0; j
< count
; j
++)
8499 vmMarkPageUsed(page
+j
);
8500 server
.vm_stats_used_pages
+= count
;
8501 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8502 (long long)count
, (long long)page
);
8505 /* Mark the page as free */
8506 static void vmMarkPageFree(off_t page
) {
8507 off_t byte
= page
/8;
8509 redisAssert(vmFreePage(page
) == 0);
8510 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8513 /* Mark N contiguous pages as free, with 'page' being the first. */
8514 static void vmMarkPagesFree(off_t page
, off_t count
) {
8517 for (j
= 0; j
< count
; j
++)
8518 vmMarkPageFree(page
+j
);
8519 server
.vm_stats_used_pages
-= count
;
8520 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8521 (long long)count
, (long long)page
);
8524 /* Test if the page is free */
8525 static int vmFreePage(off_t page
) {
8526 off_t byte
= page
/8;
8528 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8531 /* Find N contiguous free pages storing the first page of the cluster in *first.
8532 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8533 * REDIS_ERR is returned.
8535 * This function uses a simple algorithm: we try to allocate
8536 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8537 * again from the start of the swap file searching for free spaces.
8539 * If it looks pretty clear that there are no free pages near our offset
8540 * we try to find less populated places doing a forward jump of
8541 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8542 * without hurry, and then we jump again and so forth...
8544 * This function can be improved using a free list to avoid to guess
8545 * too much, since we could collect data about freed pages.
8547 * note: I implemented this function just after watching an episode of
8548 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8550 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8551 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8553 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8554 server
.vm_near_pages
= 0;
8555 server
.vm_next_page
= 0;
8557 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8558 base
= server
.vm_next_page
;
8560 while(offset
< server
.vm_pages
) {
8561 off_t
this = base
+offset
;
8563 /* If we overflow, restart from page zero */
8564 if (this >= server
.vm_pages
) {
8565 this -= server
.vm_pages
;
8567 /* Just overflowed, what we found on tail is no longer
8568 * interesting, as it's no longer contiguous. */
8572 if (vmFreePage(this)) {
8573 /* This is a free page */
8575 /* Already got N free pages? Return to the caller, with success */
8577 *first
= this-(n
-1);
8578 server
.vm_next_page
= this+1;
8579 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8583 /* The current one is not a free page */
8587 /* Fast-forward if the current page is not free and we already
8588 * searched enough near this place. */
8590 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8591 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8593 /* Note that even if we rewind after the jump, we are don't need
8594 * to make sure numfree is set to zero as we only jump *if* it
8595 * is set to zero. */
8597 /* Otherwise just check the next page */
8604 /* Write the specified object at the specified page of the swap file */
8605 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8606 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8607 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8608 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8609 redisLog(REDIS_WARNING
,
8610 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8614 rdbSaveObject(server
.vm_fp
,o
);
8615 fflush(server
.vm_fp
);
8616 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8620 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8621 * needed to later retrieve the object into the key object.
8622 * If we can't find enough contiguous empty pages to swap the object on disk
8623 * REDIS_ERR is returned. */
8624 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8625 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8628 assert(key
->storage
== REDIS_VM_MEMORY
);
8629 assert(key
->refcount
== 1);
8630 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8631 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8632 key
->vm
.page
= page
;
8633 key
->vm
.usedpages
= pages
;
8634 key
->storage
= REDIS_VM_SWAPPED
;
8635 key
->vtype
= val
->type
;
8636 decrRefCount(val
); /* Deallocate the object from memory. */
8637 vmMarkPagesUsed(page
,pages
);
8638 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8639 (unsigned char*) key
->ptr
,
8640 (unsigned long long) page
, (unsigned long long) pages
);
8641 server
.vm_stats_swapped_objects
++;
8642 server
.vm_stats_swapouts
++;
8646 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8649 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8650 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8651 redisLog(REDIS_WARNING
,
8652 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8656 o
= rdbLoadObject(type
,server
.vm_fp
);
8658 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8661 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8665 /* Load the value object relative to the 'key' object from swap to memory.
8666 * The newly allocated object is returned.
8668 * If preview is true the unserialized object is returned to the caller but
8669 * no changes are made to the key object, nor the pages are marked as freed */
8670 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8673 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8674 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8676 key
->storage
= REDIS_VM_MEMORY
;
8677 key
->vm
.atime
= server
.unixtime
;
8678 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8679 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8680 (unsigned char*) key
->ptr
);
8681 server
.vm_stats_swapped_objects
--;
8683 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8684 (unsigned char*) key
->ptr
);
8686 server
.vm_stats_swapins
++;
8690 /* Plain object loading, from swap to memory */
8691 static robj
*vmLoadObject(robj
*key
) {
8692 /* If we are loading the object in background, stop it, we
8693 * need to load this object synchronously ASAP. */
8694 if (key
->storage
== REDIS_VM_LOADING
)
8695 vmCancelThreadedIOJob(key
);
8696 return vmGenericLoadObject(key
,0);
8699 /* Just load the value on disk, without to modify the key.
8700 * This is useful when we want to perform some operation on the value
8701 * without to really bring it from swap to memory, like while saving the
8702 * dataset or rewriting the append only log. */
8703 static robj
*vmPreviewObject(robj
*key
) {
8704 return vmGenericLoadObject(key
,1);
8707 /* How a good candidate is this object for swapping?
8708 * The better candidate it is, the greater the returned value.
8710 * Currently we try to perform a fast estimation of the object size in
8711 * memory, and combine it with aging informations.
8713 * Basically swappability = idle-time * log(estimated size)
8715 * Bigger objects are preferred over smaller objects, but not
8716 * proportionally, this is why we use the logarithm. This algorithm is
8717 * just a first try and will probably be tuned later. */
8718 static double computeObjectSwappability(robj
*o
) {
8719 time_t age
= server
.unixtime
- o
->vm
.atime
;
8723 struct dictEntry
*de
;
8726 if (age
<= 0) return 0;
8729 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8732 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8737 listNode
*ln
= listFirst(l
);
8739 asize
= sizeof(list
);
8741 robj
*ele
= ln
->value
;
8744 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8745 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8747 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8752 z
= (o
->type
== REDIS_ZSET
);
8753 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8755 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8756 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8761 de
= dictGetRandomKey(d
);
8762 ele
= dictGetEntryKey(de
);
8763 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8764 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8766 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8767 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8771 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8772 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8773 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8774 unsigned int klen
, vlen
;
8775 unsigned char *key
, *val
;
8777 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8781 asize
= len
*(klen
+vlen
+3);
8782 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8784 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8789 de
= dictGetRandomKey(d
);
8790 ele
= dictGetEntryKey(de
);
8791 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8792 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8794 ele
= dictGetEntryVal(de
);
8795 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8796 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8798 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8803 return (double)age
*log(1+asize
);
8806 /* Try to swap an object that's a good candidate for swapping.
8807 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8808 * to swap any object at all.
8810 * If 'usethreaded' is true, Redis will try to swap the object in background
8811 * using I/O threads. */
8812 static int vmSwapOneObject(int usethreads
) {
8814 struct dictEntry
*best
= NULL
;
8815 double best_swappability
= 0;
8816 redisDb
*best_db
= NULL
;
8819 for (j
= 0; j
< server
.dbnum
; j
++) {
8820 redisDb
*db
= server
.db
+j
;
8821 /* Why maxtries is set to 100?
8822 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8823 * are swappable objects */
8826 if (dictSize(db
->dict
) == 0) continue;
8827 for (i
= 0; i
< 5; i
++) {
8829 double swappability
;
8831 if (maxtries
) maxtries
--;
8832 de
= dictGetRandomKey(db
->dict
);
8833 key
= dictGetEntryKey(de
);
8834 val
= dictGetEntryVal(de
);
8835 /* Only swap objects that are currently in memory.
8837 * Also don't swap shared objects if threaded VM is on, as we
8838 * try to ensure that the main thread does not touch the
8839 * object while the I/O thread is using it, but we can't
8840 * control other keys without adding additional mutex. */
8841 if (key
->storage
!= REDIS_VM_MEMORY
||
8842 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8843 if (maxtries
) i
--; /* don't count this try */
8846 swappability
= computeObjectSwappability(val
);
8847 if (!best
|| swappability
> best_swappability
) {
8849 best_swappability
= swappability
;
8854 if (best
== NULL
) return REDIS_ERR
;
8855 key
= dictGetEntryKey(best
);
8856 val
= dictGetEntryVal(best
);
8858 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8859 key
->ptr
, best_swappability
);
8861 /* Unshare the key if needed */
8862 if (key
->refcount
> 1) {
8863 robj
*newkey
= dupStringObject(key
);
8865 key
= dictGetEntryKey(best
) = newkey
;
8869 vmSwapObjectThreaded(key
,val
,best_db
);
8872 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8873 dictGetEntryVal(best
) = NULL
;
8881 static int vmSwapOneObjectBlocking() {
8882 return vmSwapOneObject(0);
8885 static int vmSwapOneObjectThreaded() {
8886 return vmSwapOneObject(1);
8889 /* Return true if it's safe to swap out objects in a given moment.
8890 * Basically we don't want to swap objects out while there is a BGSAVE
8891 * or a BGAEOREWRITE running in backgroud. */
8892 static int vmCanSwapOut(void) {
8893 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8896 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8897 * and was deleted. Otherwise 0 is returned. */
8898 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8902 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8903 foundkey
= dictGetEntryKey(de
);
8904 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8909 /* =================== Virtual Memory - Threaded I/O ======================= */
8911 static void freeIOJob(iojob
*j
) {
8912 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8913 j
->type
== REDIS_IOJOB_DO_SWAP
||
8914 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8915 decrRefCount(j
->val
);
8916 /* We don't decrRefCount the j->key field as we did't incremented
8917 * the count creating IO Jobs. This is because the key field here is
8918 * just used as an indentifier and if a key is removed the Job should
8919 * never be touched again. */
8923 /* Every time a thread finished a Job, it writes a byte into the write side
8924 * of an unix pipe in order to "awake" the main thread, and this function
8926 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8930 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8932 REDIS_NOTUSED(mask
);
8933 REDIS_NOTUSED(privdata
);
8935 /* For every byte we read in the read side of the pipe, there is one
8936 * I/O job completed to process. */
8937 while((retval
= read(fd
,buf
,1)) == 1) {
8941 struct dictEntry
*de
;
8943 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8945 /* Get the processed element (the oldest one) */
8947 assert(listLength(server
.io_processed
) != 0);
8948 if (toprocess
== -1) {
8949 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8950 if (toprocess
<= 0) toprocess
= 1;
8952 ln
= listFirst(server
.io_processed
);
8954 listDelNode(server
.io_processed
,ln
);
8956 /* If this job is marked as canceled, just ignore it */
8961 /* Post process it in the main thread, as there are things we
8962 * can do just here to avoid race conditions and/or invasive locks */
8963 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
);
8964 de
= dictFind(j
->db
->dict
,j
->key
);
8966 key
= dictGetEntryKey(de
);
8967 if (j
->type
== REDIS_IOJOB_LOAD
) {
8970 /* Key loaded, bring it at home */
8971 key
->storage
= REDIS_VM_MEMORY
;
8972 key
->vm
.atime
= server
.unixtime
;
8973 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8974 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8975 (unsigned char*) key
->ptr
);
8976 server
.vm_stats_swapped_objects
--;
8977 server
.vm_stats_swapins
++;
8978 dictGetEntryVal(de
) = j
->val
;
8979 incrRefCount(j
->val
);
8982 /* Handle clients waiting for this key to be loaded. */
8983 handleClientsBlockedOnSwappedKey(db
,key
);
8984 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8985 /* Now we know the amount of pages required to swap this object.
8986 * Let's find some space for it, and queue this task again
8987 * rebranded as REDIS_IOJOB_DO_SWAP. */
8988 if (!vmCanSwapOut() ||
8989 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8991 /* Ooops... no space or we can't swap as there is
8992 * a fork()ed Redis trying to save stuff on disk. */
8994 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8996 /* Note that we need to mark this pages as used now,
8997 * if the job will be canceled, we'll mark them as freed
8999 vmMarkPagesUsed(j
->page
,j
->pages
);
9000 j
->type
= REDIS_IOJOB_DO_SWAP
;
9005 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9008 /* Key swapped. We can finally free some memory. */
9009 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9010 printf("key->storage: %d\n",key
->storage
);
9011 printf("key->name: %s\n",(char*)key
->ptr
);
9012 printf("key->refcount: %d\n",key
->refcount
);
9013 printf("val: %p\n",(void*)j
->val
);
9014 printf("val->type: %d\n",j
->val
->type
);
9015 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9017 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9018 val
= dictGetEntryVal(de
);
9019 key
->vm
.page
= j
->page
;
9020 key
->vm
.usedpages
= j
->pages
;
9021 key
->storage
= REDIS_VM_SWAPPED
;
9022 key
->vtype
= j
->val
->type
;
9023 decrRefCount(val
); /* Deallocate the object from memory. */
9024 dictGetEntryVal(de
) = NULL
;
9025 redisLog(REDIS_DEBUG
,
9026 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9027 (unsigned char*) key
->ptr
,
9028 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9029 server
.vm_stats_swapped_objects
++;
9030 server
.vm_stats_swapouts
++;
9032 /* Put a few more swap requests in queue if we are still
9034 if (trytoswap
&& vmCanSwapOut() &&
9035 zmalloc_used_memory() > server
.vm_max_memory
)
9040 more
= listLength(server
.io_newjobs
) <
9041 (unsigned) server
.vm_max_threads
;
9043 /* Don't waste CPU time if swappable objects are rare. */
9044 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9052 if (processed
== toprocess
) return;
9054 if (retval
< 0 && errno
!= EAGAIN
) {
9055 redisLog(REDIS_WARNING
,
9056 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9061 static void lockThreadedIO(void) {
9062 pthread_mutex_lock(&server
.io_mutex
);
9065 static void unlockThreadedIO(void) {
9066 pthread_mutex_unlock(&server
.io_mutex
);
9069 /* Remove the specified object from the threaded I/O queue if still not
9070 * processed, otherwise make sure to flag it as canceled. */
9071 static void vmCancelThreadedIOJob(robj
*o
) {
9073 server
.io_newjobs
, /* 0 */
9074 server
.io_processing
, /* 1 */
9075 server
.io_processed
/* 2 */
9079 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9082 /* Search for a matching key in one of the queues */
9083 for (i
= 0; i
< 3; i
++) {
9087 listRewind(lists
[i
],&li
);
9088 while ((ln
= listNext(&li
)) != NULL
) {
9089 iojob
*job
= ln
->value
;
9091 if (job
->canceled
) continue; /* Skip this, already canceled. */
9092 if (job
->key
== o
) {
9093 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9094 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9095 /* Mark the pages as free since the swap didn't happened
9096 * or happened but is now discarded. */
9097 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9098 vmMarkPagesFree(job
->page
,job
->pages
);
9099 /* Cancel the job. It depends on the list the job is
9102 case 0: /* io_newjobs */
9103 /* If the job was yet not processed the best thing to do
9104 * is to remove it from the queue at all */
9106 listDelNode(lists
[i
],ln
);
9108 case 1: /* io_processing */
9109 /* Oh Shi- the thread is messing with the Job:
9111 * Probably it's accessing the object if this is a
9112 * PREPARE_SWAP or DO_SWAP job.
9113 * If it's a LOAD job it may be reading from disk and
9114 * if we don't wait for the job to terminate before to
9115 * cancel it, maybe in a few microseconds data can be
9116 * corrupted in this pages. So the short story is:
9118 * Better to wait for the job to move into the
9119 * next queue (processed)... */
9121 /* We try again and again until the job is completed. */
9123 /* But let's wait some time for the I/O thread
9124 * to finish with this job. After all this condition
9125 * should be very rare. */
9128 case 2: /* io_processed */
9129 /* The job was already processed, that's easy...
9130 * just mark it as canceled so that we'll ignore it
9131 * when processing completed jobs. */
9135 /* Finally we have to adjust the storage type of the object
9136 * in order to "UNDO" the operaiton. */
9137 if (o
->storage
== REDIS_VM_LOADING
)
9138 o
->storage
= REDIS_VM_SWAPPED
;
9139 else if (o
->storage
== REDIS_VM_SWAPPING
)
9140 o
->storage
= REDIS_VM_MEMORY
;
9147 assert(1 != 1); /* We should never reach this */
9150 static void *IOThreadEntryPoint(void *arg
) {
9155 pthread_detach(pthread_self());
9157 /* Get a new job to process */
9159 if (listLength(server
.io_newjobs
) == 0) {
9160 /* No new jobs in queue, exit. */
9161 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9162 (long) pthread_self());
9163 server
.io_active_threads
--;
9167 ln
= listFirst(server
.io_newjobs
);
9169 listDelNode(server
.io_newjobs
,ln
);
9170 /* Add the job in the processing queue */
9171 j
->thread
= pthread_self();
9172 listAddNodeTail(server
.io_processing
,j
);
9173 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9175 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9176 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9178 /* Process the Job */
9179 if (j
->type
== REDIS_IOJOB_LOAD
) {
9180 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9181 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9182 FILE *fp
= fopen("/dev/null","w+");
9183 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9185 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9186 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9190 /* Done: insert the job into the processed queue */
9191 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9192 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9194 listDelNode(server
.io_processing
,ln
);
9195 listAddNodeTail(server
.io_processed
,j
);
9198 /* Signal the main thread there is new stuff to process */
9199 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9201 return NULL
; /* never reached */
9204 static void spawnIOThread(void) {
9206 sigset_t mask
, omask
;
9210 sigaddset(&mask
,SIGCHLD
);
9211 sigaddset(&mask
,SIGHUP
);
9212 sigaddset(&mask
,SIGPIPE
);
9213 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9214 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9215 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9219 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9220 server
.io_active_threads
++;
9223 /* We need to wait for the last thread to exit before we are able to
9224 * fork() in order to BGSAVE or BGREWRITEAOF. */
9225 static void waitEmptyIOJobsQueue(void) {
9227 int io_processed_len
;
9230 if (listLength(server
.io_newjobs
) == 0 &&
9231 listLength(server
.io_processing
) == 0 &&
9232 server
.io_active_threads
== 0)
9237 /* While waiting for empty jobs queue condition we post-process some
9238 * finshed job, as I/O threads may be hanging trying to write against
9239 * the io_ready_pipe_write FD but there are so much pending jobs that
9241 io_processed_len
= listLength(server
.io_processed
);
9243 if (io_processed_len
) {
9244 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9245 usleep(1000); /* 1 millisecond */
9247 usleep(10000); /* 10 milliseconds */
9252 static void vmReopenSwapFile(void) {
9253 /* Note: we don't close the old one as we are in the child process
9254 * and don't want to mess at all with the original file object. */
9255 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9256 if (server
.vm_fp
== NULL
) {
9257 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9258 server
.vm_swap_file
);
9261 server
.vm_fd
= fileno(server
.vm_fp
);
9264 /* This function must be called while with threaded IO locked */
9265 static void queueIOJob(iojob
*j
) {
9266 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9267 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9268 listAddNodeTail(server
.io_newjobs
,j
);
9269 if (server
.io_active_threads
< server
.vm_max_threads
)
9273 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9276 assert(key
->storage
== REDIS_VM_MEMORY
);
9277 assert(key
->refcount
== 1);
9279 j
= zmalloc(sizeof(*j
));
9280 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9286 j
->thread
= (pthread_t
) -1;
9287 key
->storage
= REDIS_VM_SWAPPING
;
9295 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9297 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9298 * If there is not already a job loading the key, it is craeted.
9299 * The key is added to the io_keys list in the client structure, and also
9300 * in the hash table mapping swapped keys to waiting clients, that is,
9301 * server.io_waited_keys. */
9302 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9303 struct dictEntry
*de
;
9307 /* If the key does not exist or is already in RAM we don't need to
9308 * block the client at all. */
9309 de
= dictFind(c
->db
->dict
,key
);
9310 if (de
== NULL
) return 0;
9311 o
= dictGetEntryKey(de
);
9312 if (o
->storage
== REDIS_VM_MEMORY
) {
9314 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9315 /* We were swapping the key, undo it! */
9316 vmCancelThreadedIOJob(o
);
9320 /* OK: the key is either swapped, or being loaded just now. */
9322 /* Add the key to the list of keys this client is waiting for.
9323 * This maps clients to keys they are waiting for. */
9324 listAddNodeTail(c
->io_keys
,key
);
9327 /* Add the client to the swapped keys => clients waiting map. */
9328 de
= dictFind(c
->db
->io_keys
,key
);
9332 /* For every key we take a list of clients blocked for it */
9334 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9336 assert(retval
== DICT_OK
);
9338 l
= dictGetEntryVal(de
);
9340 listAddNodeTail(l
,c
);
9342 /* Are we already loading the key from disk? If not create a job */
9343 if (o
->storage
== REDIS_VM_SWAPPED
) {
9346 o
->storage
= REDIS_VM_LOADING
;
9347 j
= zmalloc(sizeof(*j
));
9348 j
->type
= REDIS_IOJOB_LOAD
;
9351 j
->key
->vtype
= o
->vtype
;
9352 j
->page
= o
->vm
.page
;
9355 j
->thread
= (pthread_t
) -1;
9363 /* Preload keys needed for the ZUNION and ZINTER commands. */
9364 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9366 num
= atoi(c
->argv
[2]->ptr
);
9367 for (i
= 0; i
< num
; i
++) {
9368 waitForSwappedKey(c
,c
->argv
[3+i
]);
9372 /* Is this client attempting to run a command against swapped keys?
9373 * If so, block it ASAP, load the keys in background, then resume it.
9375 * The important idea about this function is that it can fail! If keys will
9376 * still be swapped when the client is resumed, this key lookups will
9377 * just block loading keys from disk. In practical terms this should only
9378 * happen with SORT BY command or if there is a bug in this function.
9380 * Return 1 if the client is marked as blocked, 0 if the client can
9381 * continue as the keys it is going to access appear to be in memory. */
9382 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9385 if (cmd
->vm_preload_proc
!= NULL
) {
9386 cmd
->vm_preload_proc(c
);
9388 if (cmd
->vm_firstkey
== 0) return 0;
9389 last
= cmd
->vm_lastkey
;
9390 if (last
< 0) last
= c
->argc
+last
;
9391 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9392 waitForSwappedKey(c
,c
->argv
[j
]);
9395 /* If the client was blocked for at least one key, mark it as blocked. */
9396 if (listLength(c
->io_keys
)) {
9397 c
->flags
|= REDIS_IO_WAIT
;
9398 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9399 server
.vm_blocked_clients
++;
9406 /* Remove the 'key' from the list of blocked keys for a given client.
9408 * The function returns 1 when there are no longer blocking keys after
9409 * the current one was removed (and the client can be unblocked). */
9410 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9414 struct dictEntry
*de
;
9416 /* Remove the key from the list of keys this client is waiting for. */
9417 listRewind(c
->io_keys
,&li
);
9418 while ((ln
= listNext(&li
)) != NULL
) {
9419 if (compareStringObjects(ln
->value
,key
) == 0) {
9420 listDelNode(c
->io_keys
,ln
);
9426 /* Remove the client form the key => waiting clients map. */
9427 de
= dictFind(c
->db
->io_keys
,key
);
9429 l
= dictGetEntryVal(de
);
9430 ln
= listSearchKey(l
,c
);
9433 if (listLength(l
) == 0)
9434 dictDelete(c
->db
->io_keys
,key
);
9436 return listLength(c
->io_keys
) == 0;
9439 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9440 struct dictEntry
*de
;
9445 de
= dictFind(db
->io_keys
,key
);
9448 l
= dictGetEntryVal(de
);
9449 len
= listLength(l
);
9450 /* Note: we can't use something like while(listLength(l)) as the list
9451 * can be freed by the calling function when we remove the last element. */
9454 redisClient
*c
= ln
->value
;
9456 if (dontWaitForSwappedKey(c
,key
)) {
9457 /* Put the client in the list of clients ready to go as we
9458 * loaded all the keys about it. */
9459 listAddNodeTail(server
.io_ready_clients
,c
);
9464 /* =========================== Remote Configuration ========================= */
9466 static void configSetCommand(redisClient
*c
) {
9467 robj
*o
= getDecodedObject(c
->argv
[3]);
9468 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9469 zfree(server
.dbfilename
);
9470 server
.dbfilename
= zstrdup(o
->ptr
);
9471 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9472 zfree(server
.requirepass
);
9473 server
.requirepass
= zstrdup(o
->ptr
);
9474 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9475 zfree(server
.masterauth
);
9476 server
.masterauth
= zstrdup(o
->ptr
);
9477 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9478 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9480 addReplySds(c
,sdscatprintf(sdsempty(),
9481 "-ERR not supported CONFIG parameter %s\r\n",
9482 (char*)c
->argv
[2]->ptr
));
9487 addReply(c
,shared
.ok
);
9490 static void configGetCommand(redisClient
*c
) {
9491 robj
*o
= getDecodedObject(c
->argv
[2]);
9492 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9493 char *pattern
= o
->ptr
;
9497 decrRefCount(lenobj
);
9499 if (stringmatch(pattern
,"dbfilename",0)) {
9500 addReplyBulkCString(c
,"dbfilename");
9501 addReplyBulkCString(c
,server
.dbfilename
);
9504 if (stringmatch(pattern
,"requirepass",0)) {
9505 addReplyBulkCString(c
,"requirepass");
9506 addReplyBulkCString(c
,server
.requirepass
);
9509 if (stringmatch(pattern
,"masterauth",0)) {
9510 addReplyBulkCString(c
,"masterauth");
9511 addReplyBulkCString(c
,server
.masterauth
);
9514 if (stringmatch(pattern
,"maxmemory",0)) {
9517 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9518 addReplyBulkCString(c
,"maxmemory");
9519 addReplyBulkCString(c
,buf
);
9523 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9526 static void configCommand(redisClient
*c
) {
9527 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9528 if (c
->argc
!= 4) goto badarity
;
9529 configSetCommand(c
);
9530 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9531 if (c
->argc
!= 3) goto badarity
;
9532 configGetCommand(c
);
9533 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9534 if (c
->argc
!= 2) goto badarity
;
9535 server
.stat_numcommands
= 0;
9536 server
.stat_numconnections
= 0;
9537 server
.stat_expiredkeys
= 0;
9538 server
.stat_starttime
= time(NULL
);
9539 addReply(c
,shared
.ok
);
9541 addReplySds(c
,sdscatprintf(sdsempty(),
9542 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9547 addReplySds(c
,sdscatprintf(sdsempty(),
9548 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9549 (char*) c
->argv
[1]->ptr
));
9552 /* =========================== Pubsub implementation ======================== */
9554 static void freePubsubPattern(void *p
) {
9555 pubsubPattern
*pat
= p
;
9557 decrRefCount(pat
->pattern
);
9561 static int listMatchPubsubPattern(void *a
, void *b
) {
9562 pubsubPattern
*pa
= a
, *pb
= b
;
9564 return (pa
->client
== pb
->client
) &&
9565 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9568 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9569 * 0 if the client was already subscribed to that channel. */
9570 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9571 struct dictEntry
*de
;
9572 list
*clients
= NULL
;
9575 /* Add the channel to the client -> channels hash table */
9576 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9578 incrRefCount(channel
);
9579 /* Add the client to the channel -> list of clients hash table */
9580 de
= dictFind(server
.pubsub_channels
,channel
);
9582 clients
= listCreate();
9583 dictAdd(server
.pubsub_channels
,channel
,clients
);
9584 incrRefCount(channel
);
9586 clients
= dictGetEntryVal(de
);
9588 listAddNodeTail(clients
,c
);
9590 /* Notify the client */
9591 addReply(c
,shared
.mbulk3
);
9592 addReply(c
,shared
.subscribebulk
);
9593 addReplyBulk(c
,channel
);
9594 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9598 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9599 * 0 if the client was not subscribed to the specified channel. */
9600 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9601 struct dictEntry
*de
;
9606 /* Remove the channel from the client -> channels hash table */
9607 incrRefCount(channel
); /* channel may be just a pointer to the same object
9608 we have in the hash tables. Protect it... */
9609 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9611 /* Remove the client from the channel -> clients list hash table */
9612 de
= dictFind(server
.pubsub_channels
,channel
);
9614 clients
= dictGetEntryVal(de
);
9615 ln
= listSearchKey(clients
,c
);
9617 listDelNode(clients
,ln
);
9618 if (listLength(clients
) == 0) {
9619 /* Free the list and associated hash entry at all if this was
9620 * the latest client, so that it will be possible to abuse
9621 * Redis PUBSUB creating millions of channels. */
9622 dictDelete(server
.pubsub_channels
,channel
);
9625 /* Notify the client */
9627 addReply(c
,shared
.mbulk3
);
9628 addReply(c
,shared
.unsubscribebulk
);
9629 addReplyBulk(c
,channel
);
9630 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9631 listLength(c
->pubsub_patterns
));
9634 decrRefCount(channel
); /* it is finally safe to release it */
9638 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9639 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9642 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9645 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9646 incrRefCount(pattern
);
9647 pat
= zmalloc(sizeof(*pat
));
9648 pat
->pattern
= getDecodedObject(pattern
);
9650 listAddNodeTail(server
.pubsub_patterns
,pat
);
9652 /* Notify the client */
9653 addReply(c
,shared
.mbulk3
);
9654 addReply(c
,shared
.psubscribebulk
);
9655 addReplyBulk(c
,pattern
);
9656 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9660 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9661 * 0 if the client was not subscribed to the specified channel. */
9662 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9667 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9668 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9670 listDelNode(c
->pubsub_patterns
,ln
);
9672 pat
.pattern
= pattern
;
9673 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9674 listDelNode(server
.pubsub_patterns
,ln
);
9676 /* Notify the client */
9678 addReply(c
,shared
.mbulk3
);
9679 addReply(c
,shared
.punsubscribebulk
);
9680 addReplyBulk(c
,pattern
);
9681 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9682 listLength(c
->pubsub_patterns
));
9684 decrRefCount(pattern
);
9688 /* Unsubscribe from all the channels. Return the number of channels the
9689 * client was subscribed from. */
9690 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9691 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9695 while((de
= dictNext(di
)) != NULL
) {
9696 robj
*channel
= dictGetEntryKey(de
);
9698 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9700 dictReleaseIterator(di
);
9704 /* Unsubscribe from all the patterns. Return the number of patterns the
9705 * client was subscribed from. */
9706 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9711 listRewind(c
->pubsub_patterns
,&li
);
9712 while ((ln
= listNext(&li
)) != NULL
) {
9713 robj
*pattern
= ln
->value
;
9715 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9720 /* Publish a message */
9721 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9723 struct dictEntry
*de
;
9727 /* Send to clients listening for that channel */
9728 de
= dictFind(server
.pubsub_channels
,channel
);
9730 list
*list
= dictGetEntryVal(de
);
9734 listRewind(list
,&li
);
9735 while ((ln
= listNext(&li
)) != NULL
) {
9736 redisClient
*c
= ln
->value
;
9738 addReply(c
,shared
.mbulk3
);
9739 addReply(c
,shared
.messagebulk
);
9740 addReplyBulk(c
,channel
);
9741 addReplyBulk(c
,message
);
9745 /* Send to clients listening to matching channels */
9746 if (listLength(server
.pubsub_patterns
)) {
9747 listRewind(server
.pubsub_patterns
,&li
);
9748 channel
= getDecodedObject(channel
);
9749 while ((ln
= listNext(&li
)) != NULL
) {
9750 pubsubPattern
*pat
= ln
->value
;
9752 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9753 sdslen(pat
->pattern
->ptr
),
9754 (char*)channel
->ptr
,
9755 sdslen(channel
->ptr
),0)) {
9756 addReply(pat
->client
,shared
.mbulk3
);
9757 addReply(pat
->client
,shared
.messagebulk
);
9758 addReplyBulk(pat
->client
,channel
);
9759 addReplyBulk(pat
->client
,message
);
9763 decrRefCount(channel
);
9768 static void subscribeCommand(redisClient
*c
) {
9771 for (j
= 1; j
< c
->argc
; j
++)
9772 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9775 static void unsubscribeCommand(redisClient
*c
) {
9777 pubsubUnsubscribeAllChannels(c
,1);
9782 for (j
= 1; j
< c
->argc
; j
++)
9783 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9787 static void psubscribeCommand(redisClient
*c
) {
9790 for (j
= 1; j
< c
->argc
; j
++)
9791 pubsubSubscribePattern(c
,c
->argv
[j
]);
9794 static void punsubscribeCommand(redisClient
*c
) {
9796 pubsubUnsubscribeAllPatterns(c
,1);
9801 for (j
= 1; j
< c
->argc
; j
++)
9802 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9806 static void publishCommand(redisClient
*c
) {
9807 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9808 addReplyLong(c
,receivers
);
9811 /* ================================= Debugging ============================== */
9813 static void debugCommand(redisClient
*c
) {
9814 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9816 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9817 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9818 addReply(c
,shared
.err
);
9822 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9823 addReply(c
,shared
.err
);
9826 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9827 addReply(c
,shared
.ok
);
9828 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9830 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9831 addReply(c
,shared
.err
);
9834 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9835 addReply(c
,shared
.ok
);
9836 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9837 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9841 addReply(c
,shared
.nokeyerr
);
9844 key
= dictGetEntryKey(de
);
9845 val
= dictGetEntryVal(de
);
9846 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9847 key
->storage
== REDIS_VM_SWAPPING
)) {
9851 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9852 strenc
= strencoding
[val
->encoding
];
9854 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9857 addReplySds(c
,sdscatprintf(sdsempty(),
9858 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9859 "encoding:%s serializedlength:%lld\r\n",
9860 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9861 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9863 addReplySds(c
,sdscatprintf(sdsempty(),
9864 "+Key at:%p refcount:%d, value swapped at: page %llu "
9865 "using %llu pages\r\n",
9866 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9867 (unsigned long long) key
->vm
.usedpages
));
9869 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9870 lookupKeyRead(c
->db
,c
->argv
[2]);
9871 addReply(c
,shared
.ok
);
9872 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9873 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9876 if (!server
.vm_enabled
) {
9877 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9881 addReply(c
,shared
.nokeyerr
);
9884 key
= dictGetEntryKey(de
);
9885 val
= dictGetEntryVal(de
);
9886 /* If the key is shared we want to create a copy */
9887 if (key
->refcount
> 1) {
9888 robj
*newkey
= dupStringObject(key
);
9890 key
= dictGetEntryKey(de
) = newkey
;
9893 if (key
->storage
!= REDIS_VM_MEMORY
) {
9894 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9895 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9896 dictGetEntryVal(de
) = NULL
;
9897 addReply(c
,shared
.ok
);
9899 addReply(c
,shared
.err
);
9902 addReplySds(c
,sdsnew(
9903 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9907 static void _redisAssert(char *estr
, char *file
, int line
) {
9908 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9909 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9910 #ifdef HAVE_BACKTRACE
9911 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9916 static void _redisPanic(char *msg
, char *file
, int line
) {
9917 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
9918 redisLog(REDIS_WARNING
,"Guru Mediation: %s #%s:%d",msg
,file
,line
);
9919 #ifdef HAVE_BACKTRACE
9920 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9925 /* =================================== Main! ================================ */
9928 int linuxOvercommitMemoryValue(void) {
9929 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9933 if (fgets(buf
,64,fp
) == NULL
) {
9942 void linuxOvercommitMemoryWarning(void) {
9943 if (linuxOvercommitMemoryValue() == 0) {
9944 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low condition memory. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
9947 #endif /* __linux__ */
9949 static void daemonize(void) {
9953 if (fork() != 0) exit(0); /* parent exits */
9954 setsid(); /* create a new session */
9956 /* Every output goes to /dev/null. If Redis is daemonized but
9957 * the 'logfile' is set to 'stdout' in the configuration file
9958 * it will not log at all. */
9959 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9960 dup2(fd
, STDIN_FILENO
);
9961 dup2(fd
, STDOUT_FILENO
);
9962 dup2(fd
, STDERR_FILENO
);
9963 if (fd
> STDERR_FILENO
) close(fd
);
9965 /* Try to write the pid file */
9966 fp
= fopen(server
.pidfile
,"w");
9968 fprintf(fp
,"%d\n",getpid());
9973 static void version() {
9974 printf("Redis server version %s\n", REDIS_VERSION
);
9978 static void usage() {
9979 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9980 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9984 int main(int argc
, char **argv
) {
9989 if (strcmp(argv
[1], "-v") == 0 ||
9990 strcmp(argv
[1], "--version") == 0) version();
9991 if (strcmp(argv
[1], "--help") == 0) usage();
9992 resetServerSaveParams();
9993 loadServerConfig(argv
[1]);
9994 } else if ((argc
> 2)) {
9997 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'");
9999 if (server
.daemonize
) daemonize();
10001 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10003 linuxOvercommitMemoryWarning();
10005 start
= time(NULL
);
10006 if (server
.appendonly
) {
10007 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10008 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10010 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10011 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10013 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10014 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10016 aeDeleteEventLoop(server
.el
);
10020 /* ============================= Backtrace support ========================= */
10022 #ifdef HAVE_BACKTRACE
10023 static char *findFuncName(void *pointer
, unsigned long *offset
);
10025 static void *getMcontextEip(ucontext_t
*uc
) {
10026 #if defined(__FreeBSD__)
10027 return (void*) uc
->uc_mcontext
.mc_eip
;
10028 #elif defined(__dietlibc__)
10029 return (void*) uc
->uc_mcontext
.eip
;
10030 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10032 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10034 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10036 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10037 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10038 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10040 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10042 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10043 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10044 #elif defined(__ia64__) /* Linux IA64 */
10045 return (void*) uc
->uc_mcontext
.sc_ip
;
10051 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10053 char **messages
= NULL
;
10054 int i
, trace_size
= 0;
10055 unsigned long offset
=0;
10056 ucontext_t
*uc
= (ucontext_t
*) secret
;
10058 REDIS_NOTUSED(info
);
10060 redisLog(REDIS_WARNING
,
10061 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10062 infostring
= genRedisInfoString();
10063 redisLog(REDIS_WARNING
, "%s",infostring
);
10064 /* It's not safe to sdsfree() the returned string under memory
10065 * corruption conditions. Let it leak as we are going to abort */
10067 trace_size
= backtrace(trace
, 100);
10068 /* overwrite sigaction with caller's address */
10069 if (getMcontextEip(uc
) != NULL
) {
10070 trace
[1] = getMcontextEip(uc
);
10072 messages
= backtrace_symbols(trace
, trace_size
);
10074 for (i
=1; i
<trace_size
; ++i
) {
10075 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10077 p
= strchr(messages
[i
],'+');
10078 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10079 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10081 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10084 /* free(messages); Don't call free() with possibly corrupted memory. */
10088 static void setupSigSegvAction(void) {
10089 struct sigaction act
;
10091 sigemptyset (&act
.sa_mask
);
10092 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10093 * is used. Otherwise, sa_handler is used */
10094 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10095 act
.sa_sigaction
= segvHandler
;
10096 sigaction (SIGSEGV
, &act
, NULL
);
10097 sigaction (SIGBUS
, &act
, NULL
);
10098 sigaction (SIGFPE
, &act
, NULL
);
10099 sigaction (SIGILL
, &act
, NULL
);
10100 sigaction (SIGBUS
, &act
, NULL
);
10104 #include "staticsymbols.h"
10105 /* This function try to convert a pointer into a function name. It's used in
10106 * oreder to provide a backtrace under segmentation fault that's able to
10107 * display functions declared as static (otherwise the backtrace is useless). */
10108 static char *findFuncName(void *pointer
, unsigned long *offset
){
10110 unsigned long off
, minoff
= 0;
10112 /* Try to match against the Symbol with the smallest offset */
10113 for (i
=0; symsTable
[i
].pointer
; i
++) {
10114 unsigned long lp
= (unsigned long) pointer
;
10116 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10117 off
=lp
-symsTable
[i
].pointer
;
10118 if (ret
< 0 || off
< minoff
) {
10124 if (ret
== -1) return NULL
;
10126 return symsTable
[ret
].name
;
10128 #else /* HAVE_BACKTRACE */
10129 static void setupSigSegvAction(void) {
10131 #endif /* HAVE_BACKTRACE */