2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.10"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117 #define REDIS_STRING 0
123 /* Objects encoding. Some kind of objects like Strings and Hashes can be
124 * internally represented in multiple ways. The 'encoding' field of the object
125 * is set to one of this fields for this object. */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
128 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
129 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131 static char* strencoding
[] = {
132 "raw", "int", "zipmap", "hashtable"
135 /* Object types only used for dumping to disk */
136 #define REDIS_EXPIRETIME 253
137 #define REDIS_SELECTDB 254
138 #define REDIS_EOF 255
140 /* Defines related to the dump file format. To store 32 bits lengths for short
141 * keys requires a lot of space, so we check the most significant 2 bits of
142 * the first byte to interpreter the length:
144 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
145 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
146 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
147 * 11|000000 this means: specially encoded object will follow. The six bits
148 * number specify the kind of object that follows.
149 * See the REDIS_RDB_ENC_* defines.
151 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
152 * values, will fit inside. */
153 #define REDIS_RDB_6BITLEN 0
154 #define REDIS_RDB_14BITLEN 1
155 #define REDIS_RDB_32BITLEN 2
156 #define REDIS_RDB_ENCVAL 3
157 #define REDIS_RDB_LENERR UINT_MAX
159 /* When a length of a string object stored on disk has the first two bits
160 * set, the remaining two bits specify a special encoding for the object
161 * accordingly to the following defines: */
162 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
163 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
164 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
165 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167 /* Virtual memory object->where field. */
168 #define REDIS_VM_MEMORY 0 /* The object is on memory */
169 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
170 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
171 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173 /* Virtual memory static configuration stuff.
174 * Check vmFindContiguousPages() to know more about this magic numbers. */
175 #define REDIS_VM_MAX_NEAR_PAGES 65536
176 #define REDIS_VM_MAX_RANDOM_JUMP 4096
177 #define REDIS_VM_MAX_THREADS 32
178 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
179 /* The following is the *percentage* of completed I/O jobs to process when the
180 * handelr is called. While Virtual Memory I/O operations are performed by
181 * threads, this operations must be processed by the main thread when completed
182 * in order to take effect. */
183 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
186 #define REDIS_SLAVE 1 /* This client is a slave server */
187 #define REDIS_MASTER 2 /* This client is a master server */
188 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
189 #define REDIS_MULTI 8 /* This client is in a MULTI context */
190 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
191 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 /* Slave replication state - slave side */
194 #define REDIS_REPL_NONE 0 /* No active replication */
195 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
196 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
198 /* Slave replication state - from the point of view of master
199 * Note that in SEND_BULK and ONLINE state the slave receives new updates
200 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
201 * to start the next background saving in order to send updates to it. */
202 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
203 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
204 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
205 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
207 /* List related stuff */
211 /* Sort operations */
212 #define REDIS_SORT_GET 0
213 #define REDIS_SORT_ASC 1
214 #define REDIS_SORT_DESC 2
215 #define REDIS_SORTKEY_MAX 1024
218 #define REDIS_DEBUG 0
219 #define REDIS_VERBOSE 1
220 #define REDIS_NOTICE 2
221 #define REDIS_WARNING 3
223 /* Anti-warning macro... */
224 #define REDIS_NOTUSED(V) ((void) V)
226 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
227 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
229 /* Append only defines */
230 #define APPENDFSYNC_NO 0
231 #define APPENDFSYNC_ALWAYS 1
232 #define APPENDFSYNC_EVERYSEC 2
234 /* Hashes related defaults */
235 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
236 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
238 /* We can print the stacktrace, so our assert is defined this way: */
239 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
240 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
241 static void _redisAssert(char *estr
, char *file
, int line
);
242 static void _redisPanic(char *msg
, char *file
, int line
);
244 /*================================= Data types ============================== */
246 /* A redis object, that is a type able to hold a string / list / set */
248 /* The VM object structure */
249 struct redisObjectVM
{
250 off_t page
; /* the page at witch the object is stored on disk */
251 off_t usedpages
; /* number of pages used on disk */
252 time_t atime
; /* Last access time */
255 /* The actual Redis Object */
256 typedef struct redisObject
{
259 unsigned char encoding
;
260 unsigned char storage
; /* If this object is a key, where is the value?
261 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
262 unsigned char vtype
; /* If this object is a key, and value is swapped out,
263 * this is the type of the swapped out object. */
265 /* VM fields, this are only allocated if VM is active, otherwise the
266 * object allocation function will just allocate
267 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
268 * Redis without VM active will not have any overhead. */
269 struct redisObjectVM vm
;
272 /* Macro used to initalize a Redis object allocated on the stack.
273 * Note that this macro is taken near the structure definition to make sure
274 * we'll update it when the structure is changed, to avoid bugs like
275 * bug #85 introduced exactly in this way. */
276 #define initStaticStringObject(_var,_ptr) do { \
278 _var.type = REDIS_STRING; \
279 _var.encoding = REDIS_ENCODING_RAW; \
281 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
284 typedef struct redisDb
{
285 dict
*dict
; /* The keyspace for this DB */
286 dict
*expires
; /* Timeout of keys with a timeout set */
287 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
288 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
292 /* Client MULTI/EXEC state */
293 typedef struct multiCmd
{
296 struct redisCommand
*cmd
;
299 typedef struct multiState
{
300 multiCmd
*commands
; /* Array of MULTI commands */
301 int count
; /* Total number of MULTI commands */
304 /* With multiplexing we need to take per-clinet state.
305 * Clients are taken in a liked list. */
306 typedef struct redisClient
{
311 robj
**argv
, **mbargv
;
313 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
314 int multibulk
; /* multi bulk command format active */
317 time_t lastinteraction
; /* time of the last interaction, used for timeout */
318 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
319 int slaveseldb
; /* slave selected db, if this client is a slave */
320 int authenticated
; /* when requirepass is non-NULL */
321 int replstate
; /* replication state if this is a slave */
322 int repldbfd
; /* replication DB file descriptor */
323 long repldboff
; /* replication DB file offset */
324 off_t repldbsize
; /* replication DB file size */
325 multiState mstate
; /* MULTI/EXEC state */
326 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
327 * operation such as BLPOP. Otherwise NULL. */
328 int blockingkeysnum
; /* Number of blocking keys */
329 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
330 * is >= blockingto then the operation timed out. */
331 list
*io_keys
; /* Keys this client is waiting to be loaded from the
332 * swap file in order to continue. */
333 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
334 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
342 /* Global server state structure */
347 long long dirty
; /* changes to DB from the last save */
349 list
*slaves
, *monitors
;
350 char neterr
[ANET_ERR_LEN
];
352 int cronloops
; /* number of times the cron function run */
353 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
354 time_t lastsave
; /* Unix time of last save succeeede */
355 /* Fields used only for stats */
356 time_t stat_starttime
; /* server start time */
357 long long stat_numcommands
; /* number of processed commands */
358 long long stat_numconnections
; /* number of connections received */
359 long long stat_expiredkeys
; /* number of expired keys */
372 pid_t bgsavechildpid
;
373 pid_t bgrewritechildpid
;
374 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
384 /* Replication related */
389 redisClient
*master
; /* client that is master for this slave */
391 unsigned int maxclients
;
392 unsigned long long maxmemory
;
393 unsigned int blpop_blocked_clients
;
394 unsigned int vm_blocked_clients
;
395 /* Sort parameters - qsort_r() is only available under BSD so we
396 * have to take this state global, in order to pass it to sortCompare() */
400 /* Virtual memory configuration */
405 unsigned long long vm_max_memory
;
407 size_t hash_max_zipmap_entries
;
408 size_t hash_max_zipmap_value
;
409 /* Virtual memory state */
412 off_t vm_next_page
; /* Next probably empty page */
413 off_t vm_near_pages
; /* Number of pages allocated sequentially */
414 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
415 time_t unixtime
; /* Unix time sampled every second. */
416 /* Virtual memory I/O threads stuff */
417 /* An I/O thread process an element taken from the io_jobs queue and
418 * put the result of the operation in the io_done list. While the
419 * job is being processed, it's put on io_processing queue. */
420 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
421 list
*io_processing
; /* List of VM I/O jobs being processed */
422 list
*io_processed
; /* List of VM I/O jobs already processed */
423 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
424 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
425 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
426 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
427 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
428 int io_active_threads
; /* Number of running I/O threads */
429 int vm_max_threads
; /* Max number of I/O threads running at the same time */
430 /* Our main thread is blocked on the event loop, locking for sockets ready
431 * to be read or written, so when a threaded I/O operation is ready to be
432 * processed by the main thread, the I/O thread will use a unix pipe to
433 * awake the main thread. The followings are the two pipe FDs. */
434 int io_ready_pipe_read
;
435 int io_ready_pipe_write
;
436 /* Virtual memory stats */
437 unsigned long long vm_stats_used_pages
;
438 unsigned long long vm_stats_swapped_objects
;
439 unsigned long long vm_stats_swapouts
;
440 unsigned long long vm_stats_swapins
;
442 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
443 list
*pubsub_patterns
; /* A list of pubsub_patterns */
448 typedef struct pubsubPattern
{
453 typedef void redisCommandProc(redisClient
*c
);
454 struct redisCommand
{
456 redisCommandProc
*proc
;
459 /* Use a function to determine which keys need to be loaded
460 * in the background prior to executing this command. Takes precedence
461 * over vm_firstkey and others, ignored when NULL */
462 redisCommandProc
*vm_preload_proc
;
463 /* What keys should be loaded in background when calling this command? */
464 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
465 int vm_lastkey
; /* THe last argument that's a key */
466 int vm_keystep
; /* The step between first and last key */
469 struct redisFunctionSym
{
471 unsigned long pointer
;
474 typedef struct _redisSortObject
{
482 typedef struct _redisSortOperation
{
485 } redisSortOperation
;
487 /* ZSETs use a specialized version of Skiplists */
489 typedef struct zskiplistNode
{
490 struct zskiplistNode
**forward
;
491 struct zskiplistNode
*backward
;
497 typedef struct zskiplist
{
498 struct zskiplistNode
*header
, *tail
;
499 unsigned long length
;
503 typedef struct zset
{
508 /* Our shared "common" objects */
510 #define REDIS_SHARED_INTEGERS 10000
511 struct sharedObjectsStruct
{
512 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
513 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
514 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
515 *outofrangeerr
, *plus
,
516 *select0
, *select1
, *select2
, *select3
, *select4
,
517 *select5
, *select6
, *select7
, *select8
, *select9
,
518 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
519 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
520 *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 /* Convert a string representing an amount of memory into the number of
974 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
977 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
979 static long long memtoll(const char *p
, int *err
) {
982 long mul
; /* unit multiplier */
987 /* Search the first non digit character. */
990 while(*u
&& isdigit(*u
)) u
++;
991 if (*u
== '\0' || !strcasecmp(u
,"b")) {
993 } else if (!strcasecmp(u
,"k")) {
995 } else if (!strcasecmp(u
,"kb")) {
997 } else if (!strcasecmp(u
,"m")) {
999 } else if (!strcasecmp(u
,"mb")) {
1001 } else if (!strcasecmp(u
,"g")) {
1002 mul
= 1000L*1000*1000;
1003 } else if (!strcasecmp(u
,"gb")) {
1004 mul
= 1024L*1024*1024;
1010 if (digits
>= sizeof(buf
)) {
1014 memcpy(buf
,p
,digits
);
1016 val
= strtoll(buf
,NULL
,10);
1020 static void redisLog(int level
, const char *fmt
, ...) {
1024 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1028 if (level
>= server
.verbosity
) {
1034 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1035 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1036 vfprintf(fp
, fmt
, ap
);
1042 if (server
.logfile
) fclose(fp
);
1045 /*====================== Hash table type implementation ==================== */
1047 /* This is an hash table type that uses the SDS dynamic strings libary as
1048 * keys and radis objects as values (objects can hold SDS strings,
1051 static void dictVanillaFree(void *privdata
, void *val
)
1053 DICT_NOTUSED(privdata
);
1057 static void dictListDestructor(void *privdata
, void *val
)
1059 DICT_NOTUSED(privdata
);
1060 listRelease((list
*)val
);
1063 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1067 DICT_NOTUSED(privdata
);
1069 l1
= sdslen((sds
)key1
);
1070 l2
= sdslen((sds
)key2
);
1071 if (l1
!= l2
) return 0;
1072 return memcmp(key1
, key2
, l1
) == 0;
1075 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1077 DICT_NOTUSED(privdata
);
1079 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1083 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1086 const robj
*o1
= key1
, *o2
= key2
;
1087 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1090 static unsigned int dictObjHash(const void *key
) {
1091 const robj
*o
= key
;
1092 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1095 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1098 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1101 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1102 o2
->encoding
== REDIS_ENCODING_INT
&&
1103 o1
->ptr
== o2
->ptr
) return 1;
1105 o1
= getDecodedObject(o1
);
1106 o2
= getDecodedObject(o2
);
1107 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1113 static unsigned int dictEncObjHash(const void *key
) {
1114 robj
*o
= (robj
*) key
;
1116 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1117 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1119 if (o
->encoding
== REDIS_ENCODING_INT
) {
1123 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1124 return dictGenHashFunction((unsigned char*)buf
, len
);
1128 o
= getDecodedObject(o
);
1129 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1136 /* Sets type and expires */
1137 static dictType setDictType
= {
1138 dictEncObjHash
, /* hash function */
1141 dictEncObjKeyCompare
, /* key compare */
1142 dictRedisObjectDestructor
, /* key destructor */
1143 NULL
/* val destructor */
1146 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1147 static dictType zsetDictType
= {
1148 dictEncObjHash
, /* hash function */
1151 dictEncObjKeyCompare
, /* key compare */
1152 dictRedisObjectDestructor
, /* key destructor */
1153 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1157 static dictType dbDictType
= {
1158 dictObjHash
, /* hash function */
1161 dictObjKeyCompare
, /* key compare */
1162 dictRedisObjectDestructor
, /* key destructor */
1163 dictRedisObjectDestructor
/* val destructor */
1167 static dictType keyptrDictType
= {
1168 dictObjHash
, /* hash function */
1171 dictObjKeyCompare
, /* key compare */
1172 dictRedisObjectDestructor
, /* key destructor */
1173 NULL
/* val destructor */
1176 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1177 static dictType hashDictType
= {
1178 dictEncObjHash
, /* hash function */
1181 dictEncObjKeyCompare
, /* key compare */
1182 dictRedisObjectDestructor
, /* key destructor */
1183 dictRedisObjectDestructor
/* val destructor */
1186 /* Keylist hash table type has unencoded redis objects as keys and
1187 * lists as values. It's used for blocking operations (BLPOP) and to
1188 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1189 static dictType keylistDictType
= {
1190 dictObjHash
, /* hash function */
1193 dictObjKeyCompare
, /* key compare */
1194 dictRedisObjectDestructor
, /* key destructor */
1195 dictListDestructor
/* val destructor */
1198 static void version();
1200 /* ========================= Random utility functions ======================= */
1202 /* Redis generally does not try to recover from out of memory conditions
1203 * when allocating objects or strings, it is not clear if it will be possible
1204 * to report this condition to the client since the networking layer itself
1205 * is based on heap allocation for send buffers, so we simply abort.
1206 * At least the code will be simpler to read... */
1207 static void oom(const char *msg
) {
1208 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1213 /* ====================== Redis server networking stuff ===================== */
1214 static void closeTimedoutClients(void) {
1217 time_t now
= time(NULL
);
1220 listRewind(server
.clients
,&li
);
1221 while ((ln
= listNext(&li
)) != NULL
) {
1222 c
= listNodeValue(ln
);
1223 if (server
.maxidletime
&&
1224 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1225 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1226 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1227 listLength(c
->pubsub_patterns
) == 0 &&
1228 (now
- c
->lastinteraction
> server
.maxidletime
))
1230 redisLog(REDIS_VERBOSE
,"Closing idle client");
1232 } else if (c
->flags
& REDIS_BLOCKED
) {
1233 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1234 addReply(c
,shared
.nullmultibulk
);
1235 unblockClientWaitingData(c
);
1241 static int htNeedsResize(dict
*dict
) {
1242 long long size
, used
;
1244 size
= dictSlots(dict
);
1245 used
= dictSize(dict
);
1246 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1247 (used
*100/size
< REDIS_HT_MINFILL
));
1250 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1251 * we resize the hash table to save memory */
1252 static void tryResizeHashTables(void) {
1255 for (j
= 0; j
< server
.dbnum
; j
++) {
1256 if (htNeedsResize(server
.db
[j
].dict
))
1257 dictResize(server
.db
[j
].dict
);
1258 if (htNeedsResize(server
.db
[j
].expires
))
1259 dictResize(server
.db
[j
].expires
);
1263 /* Our hash table implementation performs rehashing incrementally while
1264 * we write/read from the hash table. Still if the server is idle, the hash
1265 * table will use two tables for a long time. So we try to use 1 millisecond
1266 * of CPU time at every serverCron() loop in order to rehash some key. */
1267 static void incrementallyRehash(void) {
1270 for (j
= 0; j
< server
.dbnum
; j
++) {
1271 if (dictIsRehashing(server
.db
[j
].dict
)) {
1272 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1273 break; /* already used our millisecond for this loop... */
1278 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1279 void backgroundSaveDoneHandler(int statloc
) {
1280 int exitcode
= WEXITSTATUS(statloc
);
1281 int bysignal
= WIFSIGNALED(statloc
);
1283 if (!bysignal
&& exitcode
== 0) {
1284 redisLog(REDIS_NOTICE
,
1285 "Background saving terminated with success");
1287 server
.lastsave
= time(NULL
);
1288 } else if (!bysignal
&& exitcode
!= 0) {
1289 redisLog(REDIS_WARNING
, "Background saving error");
1291 redisLog(REDIS_WARNING
,
1292 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1293 rdbRemoveTempFile(server
.bgsavechildpid
);
1295 server
.bgsavechildpid
= -1;
1296 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1297 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1298 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1301 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1303 void backgroundRewriteDoneHandler(int statloc
) {
1304 int exitcode
= WEXITSTATUS(statloc
);
1305 int bysignal
= WIFSIGNALED(statloc
);
1307 if (!bysignal
&& exitcode
== 0) {
1311 redisLog(REDIS_NOTICE
,
1312 "Background append only file rewriting terminated with success");
1313 /* Now it's time to flush the differences accumulated by the parent */
1314 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1315 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1317 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1320 /* Flush our data... */
1321 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1322 (signed) sdslen(server
.bgrewritebuf
)) {
1323 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
));
1327 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1328 /* Now our work is to rename the temp file into the stable file. And
1329 * switch the file descriptor used by the server for append only. */
1330 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1331 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1335 /* Mission completed... almost */
1336 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1337 if (server
.appendfd
!= -1) {
1338 /* If append only is actually enabled... */
1339 close(server
.appendfd
);
1340 server
.appendfd
= fd
;
1342 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1343 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1345 /* If append only is disabled we just generate a dump in this
1346 * format. Why not? */
1349 } else if (!bysignal
&& exitcode
!= 0) {
1350 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1352 redisLog(REDIS_WARNING
,
1353 "Background append only file rewriting terminated by signal %d",
1357 sdsfree(server
.bgrewritebuf
);
1358 server
.bgrewritebuf
= sdsempty();
1359 aofRemoveTempFile(server
.bgrewritechildpid
);
1360 server
.bgrewritechildpid
= -1;
1363 /* This function is called once a background process of some kind terminates,
1364 * as we want to avoid resizing the hash tables when there is a child in order
1365 * to play well with copy-on-write (otherwise when a resize happens lots of
1366 * memory pages are copied). The goal of this function is to update the ability
1367 * for dict.c to resize the hash tables accordingly to the fact we have o not
1368 * running childs. */
1369 static void updateDictResizePolicy(void) {
1370 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1373 dictDisableResize();
1376 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1377 int j
, loops
= server
.cronloops
++;
1378 REDIS_NOTUSED(eventLoop
);
1380 REDIS_NOTUSED(clientData
);
1382 /* We take a cached value of the unix time in the global state because
1383 * with virtual memory and aging there is to store the current time
1384 * in objects at every object access, and accuracy is not needed.
1385 * To access a global var is faster than calling time(NULL) */
1386 server
.unixtime
= time(NULL
);
1388 /* Show some info about non-empty databases */
1389 for (j
= 0; j
< server
.dbnum
; j
++) {
1390 long long size
, used
, vkeys
;
1392 size
= dictSlots(server
.db
[j
].dict
);
1393 used
= dictSize(server
.db
[j
].dict
);
1394 vkeys
= dictSize(server
.db
[j
].expires
);
1395 if (!(loops
% 50) && (used
|| vkeys
)) {
1396 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1397 /* dictPrintStats(server.dict); */
1401 /* We don't want to resize the hash tables while a bacground saving
1402 * is in progress: the saving child is created using fork() that is
1403 * implemented with a copy-on-write semantic in most modern systems, so
1404 * if we resize the HT while there is the saving child at work actually
1405 * a lot of memory movements in the parent will cause a lot of pages
1407 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1408 if (!(loops
% 10)) tryResizeHashTables();
1409 if (server
.activerehashing
) incrementallyRehash();
1412 /* Show information about connected clients */
1413 if (!(loops
% 50)) {
1414 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1415 listLength(server
.clients
)-listLength(server
.slaves
),
1416 listLength(server
.slaves
),
1417 zmalloc_used_memory());
1420 /* Close connections of timedout clients */
1421 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1422 closeTimedoutClients();
1424 /* Check if a background saving or AOF rewrite in progress terminated */
1425 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1429 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1430 if (pid
== server
.bgsavechildpid
) {
1431 backgroundSaveDoneHandler(statloc
);
1433 backgroundRewriteDoneHandler(statloc
);
1435 updateDictResizePolicy();
1438 /* If there is not a background saving in progress check if
1439 * we have to save now */
1440 time_t now
= time(NULL
);
1441 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1442 struct saveparam
*sp
= server
.saveparams
+j
;
1444 if (server
.dirty
>= sp
->changes
&&
1445 now
-server
.lastsave
> sp
->seconds
) {
1446 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1447 sp
->changes
, sp
->seconds
);
1448 rdbSaveBackground(server
.dbfilename
);
1454 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1455 * will use few CPU cycles if there are few expiring keys, otherwise
1456 * it will get more aggressive to avoid that too much memory is used by
1457 * keys that can be removed from the keyspace. */
1458 for (j
= 0; j
< server
.dbnum
; j
++) {
1460 redisDb
*db
= server
.db
+j
;
1462 /* Continue to expire if at the end of the cycle more than 25%
1463 * of the keys were expired. */
1465 long num
= dictSize(db
->expires
);
1466 time_t now
= time(NULL
);
1469 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1470 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1475 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1476 t
= (time_t) dictGetEntryVal(de
);
1478 deleteKey(db
,dictGetEntryKey(de
));
1480 server
.stat_expiredkeys
++;
1483 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1486 /* Swap a few keys on disk if we are over the memory limit and VM
1487 * is enbled. Try to free objects from the free list first. */
1488 if (vmCanSwapOut()) {
1489 while (server
.vm_enabled
&& zmalloc_used_memory() >
1490 server
.vm_max_memory
)
1494 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1495 retval
= (server
.vm_max_threads
== 0) ?
1496 vmSwapOneObjectBlocking() :
1497 vmSwapOneObjectThreaded();
1498 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1499 zmalloc_used_memory() >
1500 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1502 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1504 /* Note that when using threade I/O we free just one object,
1505 * because anyway when the I/O thread in charge to swap this
1506 * object out will finish, the handler of completed jobs
1507 * will try to swap more objects if we are still out of memory. */
1508 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1512 /* Check if we should connect to a MASTER */
1513 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1514 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1515 if (syncWithMaster() == REDIS_OK
) {
1516 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1522 /* This function gets called every time Redis is entering the
1523 * main loop of the event driven library, that is, before to sleep
1524 * for ready file descriptors. */
1525 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1526 REDIS_NOTUSED(eventLoop
);
1528 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1532 listRewind(server
.io_ready_clients
,&li
);
1533 while((ln
= listNext(&li
))) {
1534 redisClient
*c
= ln
->value
;
1535 struct redisCommand
*cmd
;
1537 /* Resume the client. */
1538 listDelNode(server
.io_ready_clients
,ln
);
1539 c
->flags
&= (~REDIS_IO_WAIT
);
1540 server
.vm_blocked_clients
--;
1541 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1542 readQueryFromClient
, c
);
1543 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1544 assert(cmd
!= NULL
);
1547 /* There may be more data to process in the input buffer. */
1548 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1549 processInputBuffer(c
);
1554 static void createSharedObjects(void) {
1557 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1558 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1559 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1560 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1561 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1562 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1563 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1564 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1565 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1566 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1567 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1568 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1569 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1570 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1571 "-ERR no such key\r\n"));
1572 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1573 "-ERR syntax error\r\n"));
1574 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1575 "-ERR source and destination objects are the same\r\n"));
1576 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1577 "-ERR index out of range\r\n"));
1578 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1579 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1580 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1581 shared
.select0
= createStringObject("select 0\r\n",10);
1582 shared
.select1
= createStringObject("select 1\r\n",10);
1583 shared
.select2
= createStringObject("select 2\r\n",10);
1584 shared
.select3
= createStringObject("select 3\r\n",10);
1585 shared
.select4
= createStringObject("select 4\r\n",10);
1586 shared
.select5
= createStringObject("select 5\r\n",10);
1587 shared
.select6
= createStringObject("select 6\r\n",10);
1588 shared
.select7
= createStringObject("select 7\r\n",10);
1589 shared
.select8
= createStringObject("select 8\r\n",10);
1590 shared
.select9
= createStringObject("select 9\r\n",10);
1591 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1592 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1593 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1594 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1595 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1596 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1597 shared
.mbulk3
= createStringObject("*3\r\n",4);
1598 shared
.mbulk4
= createStringObject("*4\r\n",4);
1599 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1600 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1601 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1605 static void appendServerSaveParams(time_t seconds
, int changes
) {
1606 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1607 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1608 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1609 server
.saveparamslen
++;
1612 static void resetServerSaveParams() {
1613 zfree(server
.saveparams
);
1614 server
.saveparams
= NULL
;
1615 server
.saveparamslen
= 0;
1618 static void initServerConfig() {
1619 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1620 server
.port
= REDIS_SERVERPORT
;
1621 server
.verbosity
= REDIS_VERBOSE
;
1622 server
.maxidletime
= REDIS_MAXIDLETIME
;
1623 server
.saveparams
= NULL
;
1624 server
.logfile
= NULL
; /* NULL = log on standard output */
1625 server
.bindaddr
= NULL
;
1626 server
.glueoutputbuf
= 1;
1627 server
.daemonize
= 0;
1628 server
.appendonly
= 0;
1629 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1630 server
.lastfsync
= time(NULL
);
1631 server
.appendfd
= -1;
1632 server
.appendseldb
= -1; /* Make sure the first time will not match */
1633 server
.pidfile
= zstrdup("/var/run/redis.pid");
1634 server
.dbfilename
= zstrdup("dump.rdb");
1635 server
.appendfilename
= zstrdup("appendonly.aof");
1636 server
.requirepass
= NULL
;
1637 server
.rdbcompression
= 1;
1638 server
.activerehashing
= 1;
1639 server
.maxclients
= 0;
1640 server
.blpop_blocked_clients
= 0;
1641 server
.maxmemory
= 0;
1642 server
.vm_enabled
= 0;
1643 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1644 server
.vm_page_size
= 256; /* 256 bytes per page */
1645 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1646 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1647 server
.vm_max_threads
= 4;
1648 server
.vm_blocked_clients
= 0;
1649 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1650 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1652 resetServerSaveParams();
1654 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1655 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1656 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1657 /* Replication related */
1659 server
.masterauth
= NULL
;
1660 server
.masterhost
= NULL
;
1661 server
.masterport
= 6379;
1662 server
.master
= NULL
;
1663 server
.replstate
= REDIS_REPL_NONE
;
1665 /* Double constants initialization */
1667 R_PosInf
= 1.0/R_Zero
;
1668 R_NegInf
= -1.0/R_Zero
;
1669 R_Nan
= R_Zero
/R_Zero
;
1672 static void initServer() {
1675 signal(SIGHUP
, SIG_IGN
);
1676 signal(SIGPIPE
, SIG_IGN
);
1677 setupSigSegvAction();
1679 server
.devnull
= fopen("/dev/null","w");
1680 if (server
.devnull
== NULL
) {
1681 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1684 server
.clients
= listCreate();
1685 server
.slaves
= listCreate();
1686 server
.monitors
= listCreate();
1687 server
.objfreelist
= listCreate();
1688 createSharedObjects();
1689 server
.el
= aeCreateEventLoop();
1690 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1691 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1692 if (server
.fd
== -1) {
1693 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1696 for (j
= 0; j
< server
.dbnum
; j
++) {
1697 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1698 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1699 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1700 if (server
.vm_enabled
)
1701 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1702 server
.db
[j
].id
= j
;
1704 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1705 server
.pubsub_patterns
= listCreate();
1706 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1707 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1708 server
.cronloops
= 0;
1709 server
.bgsavechildpid
= -1;
1710 server
.bgrewritechildpid
= -1;
1711 server
.bgrewritebuf
= sdsempty();
1712 server
.lastsave
= time(NULL
);
1714 server
.stat_numcommands
= 0;
1715 server
.stat_numconnections
= 0;
1716 server
.stat_expiredkeys
= 0;
1717 server
.stat_starttime
= time(NULL
);
1718 server
.unixtime
= time(NULL
);
1719 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1720 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1721 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1723 if (server
.appendonly
) {
1724 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1725 if (server
.appendfd
== -1) {
1726 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1732 if (server
.vm_enabled
) vmInit();
1735 /* Empty the whole database */
1736 static long long emptyDb() {
1738 long long removed
= 0;
1740 for (j
= 0; j
< server
.dbnum
; j
++) {
1741 removed
+= dictSize(server
.db
[j
].dict
);
1742 dictEmpty(server
.db
[j
].dict
);
1743 dictEmpty(server
.db
[j
].expires
);
1748 static int yesnotoi(char *s
) {
1749 if (!strcasecmp(s
,"yes")) return 1;
1750 else if (!strcasecmp(s
,"no")) return 0;
1754 /* I agree, this is a very rudimental way to load a configuration...
1755 will improve later if the config gets more complex */
1756 static void loadServerConfig(char *filename
) {
1758 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1762 if (filename
[0] == '-' && filename
[1] == '\0')
1765 if ((fp
= fopen(filename
,"r")) == NULL
) {
1766 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1771 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1777 line
= sdstrim(line
," \t\r\n");
1779 /* Skip comments and blank lines*/
1780 if (line
[0] == '#' || line
[0] == '\0') {
1785 /* Split into arguments */
1786 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1787 sdstolower(argv
[0]);
1789 /* Execute config directives */
1790 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1791 server
.maxidletime
= atoi(argv
[1]);
1792 if (server
.maxidletime
< 0) {
1793 err
= "Invalid timeout value"; goto loaderr
;
1795 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1796 server
.port
= atoi(argv
[1]);
1797 if (server
.port
< 1 || server
.port
> 65535) {
1798 err
= "Invalid port"; goto loaderr
;
1800 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1801 server
.bindaddr
= zstrdup(argv
[1]);
1802 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1803 int seconds
= atoi(argv
[1]);
1804 int changes
= atoi(argv
[2]);
1805 if (seconds
< 1 || changes
< 0) {
1806 err
= "Invalid save parameters"; goto loaderr
;
1808 appendServerSaveParams(seconds
,changes
);
1809 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1810 if (chdir(argv
[1]) == -1) {
1811 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1812 argv
[1], strerror(errno
));
1815 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1816 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1817 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1818 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1819 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1821 err
= "Invalid log level. Must be one of debug, notice, warning";
1824 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1827 server
.logfile
= zstrdup(argv
[1]);
1828 if (!strcasecmp(server
.logfile
,"stdout")) {
1829 zfree(server
.logfile
);
1830 server
.logfile
= NULL
;
1832 if (server
.logfile
) {
1833 /* Test if we are able to open the file. The server will not
1834 * be able to abort just for this problem later... */
1835 logfp
= fopen(server
.logfile
,"a");
1836 if (logfp
== NULL
) {
1837 err
= sdscatprintf(sdsempty(),
1838 "Can't open the log file: %s", strerror(errno
));
1843 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1844 server
.dbnum
= atoi(argv
[1]);
1845 if (server
.dbnum
< 1) {
1846 err
= "Invalid number of databases"; goto loaderr
;
1848 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1849 loadServerConfig(argv
[1]);
1850 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1851 server
.maxclients
= atoi(argv
[1]);
1852 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1853 server
.maxmemory
= memtoll(argv
[1],NULL
);
1854 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1855 server
.masterhost
= sdsnew(argv
[1]);
1856 server
.masterport
= atoi(argv
[2]);
1857 server
.replstate
= REDIS_REPL_CONNECT
;
1858 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1859 server
.masterauth
= zstrdup(argv
[1]);
1860 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1861 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1862 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1864 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1865 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1866 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1868 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1869 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1870 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1872 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1873 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1874 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1876 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1877 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1878 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1880 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1881 if (!strcasecmp(argv
[1],"no")) {
1882 server
.appendfsync
= APPENDFSYNC_NO
;
1883 } else if (!strcasecmp(argv
[1],"always")) {
1884 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1885 } else if (!strcasecmp(argv
[1],"everysec")) {
1886 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1888 err
= "argument must be 'no', 'always' or 'everysec'";
1891 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1892 server
.requirepass
= zstrdup(argv
[1]);
1893 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1894 zfree(server
.pidfile
);
1895 server
.pidfile
= zstrdup(argv
[1]);
1896 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1897 zfree(server
.dbfilename
);
1898 server
.dbfilename
= zstrdup(argv
[1]);
1899 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1900 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1901 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1903 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1904 zfree(server
.vm_swap_file
);
1905 server
.vm_swap_file
= zstrdup(argv
[1]);
1906 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1907 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1908 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1909 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1910 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1911 server
.vm_pages
= memtoll(argv
[1], NULL
);
1912 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1913 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1914 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1915 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1916 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1917 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1919 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1921 for (j
= 0; j
< argc
; j
++)
1926 if (fp
!= stdin
) fclose(fp
);
1930 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1931 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1932 fprintf(stderr
, ">>> '%s'\n", line
);
1933 fprintf(stderr
, "%s\n", err
);
1937 static void freeClientArgv(redisClient
*c
) {
1940 for (j
= 0; j
< c
->argc
; j
++)
1941 decrRefCount(c
->argv
[j
]);
1942 for (j
= 0; j
< c
->mbargc
; j
++)
1943 decrRefCount(c
->mbargv
[j
]);
1948 static void freeClient(redisClient
*c
) {
1951 /* Note that if the client we are freeing is blocked into a blocking
1952 * call, we have to set querybuf to NULL *before* to call
1953 * unblockClientWaitingData() to avoid processInputBuffer() will get
1954 * called. Also it is important to remove the file events after
1955 * this, because this call adds the READABLE event. */
1956 sdsfree(c
->querybuf
);
1958 if (c
->flags
& REDIS_BLOCKED
)
1959 unblockClientWaitingData(c
);
1961 /* Unsubscribe from all the pubsub channels */
1962 pubsubUnsubscribeAllChannels(c
,0);
1963 pubsubUnsubscribeAllPatterns(c
,0);
1964 dictRelease(c
->pubsub_channels
);
1965 listRelease(c
->pubsub_patterns
);
1966 /* Obvious cleanup */
1967 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1968 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1969 listRelease(c
->reply
);
1972 /* Remove from the list of clients */
1973 ln
= listSearchKey(server
.clients
,c
);
1974 redisAssert(ln
!= NULL
);
1975 listDelNode(server
.clients
,ln
);
1976 /* Remove from the list of clients waiting for swapped keys */
1977 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1978 ln
= listSearchKey(server
.io_ready_clients
,c
);
1980 listDelNode(server
.io_ready_clients
,ln
);
1981 server
.vm_blocked_clients
--;
1984 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1985 ln
= listFirst(c
->io_keys
);
1986 dontWaitForSwappedKey(c
,ln
->value
);
1988 listRelease(c
->io_keys
);
1989 /* Master/slave cleanup */
1990 if (c
->flags
& REDIS_SLAVE
) {
1991 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1993 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1994 ln
= listSearchKey(l
,c
);
1995 redisAssert(ln
!= NULL
);
1998 if (c
->flags
& REDIS_MASTER
) {
1999 server
.master
= NULL
;
2000 server
.replstate
= REDIS_REPL_CONNECT
;
2002 /* Release memory */
2005 freeClientMultiState(c
);
2009 #define GLUEREPLY_UP_TO (1024)
2010 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2012 char buf
[GLUEREPLY_UP_TO
];
2017 listRewind(c
->reply
,&li
);
2018 while((ln
= listNext(&li
))) {
2022 objlen
= sdslen(o
->ptr
);
2023 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2024 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2026 listDelNode(c
->reply
,ln
);
2028 if (copylen
== 0) return;
2032 /* Now the output buffer is empty, add the new single element */
2033 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2034 listAddNodeHead(c
->reply
,o
);
2037 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2038 redisClient
*c
= privdata
;
2039 int nwritten
= 0, totwritten
= 0, objlen
;
2042 REDIS_NOTUSED(mask
);
2044 /* Use writev() if we have enough buffers to send */
2045 if (!server
.glueoutputbuf
&&
2046 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2047 !(c
->flags
& REDIS_MASTER
))
2049 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2053 while(listLength(c
->reply
)) {
2054 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2055 glueReplyBuffersIfNeeded(c
);
2057 o
= listNodeValue(listFirst(c
->reply
));
2058 objlen
= sdslen(o
->ptr
);
2061 listDelNode(c
->reply
,listFirst(c
->reply
));
2065 if (c
->flags
& REDIS_MASTER
) {
2066 /* Don't reply to a master */
2067 nwritten
= objlen
- c
->sentlen
;
2069 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2070 if (nwritten
<= 0) break;
2072 c
->sentlen
+= nwritten
;
2073 totwritten
+= nwritten
;
2074 /* If we fully sent the object on head go to the next one */
2075 if (c
->sentlen
== objlen
) {
2076 listDelNode(c
->reply
,listFirst(c
->reply
));
2079 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2080 * bytes, in a single threaded server it's a good idea to serve
2081 * other clients as well, even if a very large request comes from
2082 * super fast link that is always able to accept data (in real world
2083 * scenario think about 'KEYS *' against the loopback interfae) */
2084 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2086 if (nwritten
== -1) {
2087 if (errno
== EAGAIN
) {
2090 redisLog(REDIS_VERBOSE
,
2091 "Error writing to client: %s", strerror(errno
));
2096 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2097 if (listLength(c
->reply
) == 0) {
2099 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2103 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2105 redisClient
*c
= privdata
;
2106 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2108 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2109 int offset
, ion
= 0;
2111 REDIS_NOTUSED(mask
);
2114 while (listLength(c
->reply
)) {
2115 offset
= c
->sentlen
;
2119 /* fill-in the iov[] array */
2120 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2121 o
= listNodeValue(node
);
2122 objlen
= sdslen(o
->ptr
);
2124 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2127 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2128 break; /* no more iovecs */
2130 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2131 iov
[ion
].iov_len
= objlen
- offset
;
2132 willwrite
+= objlen
- offset
;
2133 offset
= 0; /* just for the first item */
2140 /* write all collected blocks at once */
2141 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2142 if (errno
!= EAGAIN
) {
2143 redisLog(REDIS_VERBOSE
,
2144 "Error writing to client: %s", strerror(errno
));
2151 totwritten
+= nwritten
;
2152 offset
= c
->sentlen
;
2154 /* remove written robjs from c->reply */
2155 while (nwritten
&& listLength(c
->reply
)) {
2156 o
= listNodeValue(listFirst(c
->reply
));
2157 objlen
= sdslen(o
->ptr
);
2159 if(nwritten
>= objlen
- offset
) {
2160 listDelNode(c
->reply
, listFirst(c
->reply
));
2161 nwritten
-= objlen
- offset
;
2165 c
->sentlen
+= nwritten
;
2173 c
->lastinteraction
= time(NULL
);
2175 if (listLength(c
->reply
) == 0) {
2177 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2181 static struct redisCommand
*lookupCommand(char *name
) {
2183 while(cmdTable
[j
].name
!= NULL
) {
2184 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2190 /* resetClient prepare the client to process the next command */
2191 static void resetClient(redisClient
*c
) {
2197 /* Call() is the core of Redis execution of a command */
2198 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2201 dirty
= server
.dirty
;
2203 dirty
= server
.dirty
-dirty
;
2205 if (server
.appendonly
&& dirty
)
2206 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2207 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2208 listLength(server
.slaves
))
2209 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2210 if (listLength(server
.monitors
))
2211 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2212 server
.stat_numcommands
++;
2215 /* If this function gets called we already read a whole
2216 * command, argments are in the client argv/argc fields.
2217 * processCommand() execute the command or prepare the
2218 * server for a bulk read from the client.
2220 * If 1 is returned the client is still alive and valid and
2221 * and other operations can be performed by the caller. Otherwise
2222 * if 0 is returned the client was destroied (i.e. after QUIT). */
2223 static int processCommand(redisClient
*c
) {
2224 struct redisCommand
*cmd
;
2226 /* Free some memory if needed (maxmemory setting) */
2227 if (server
.maxmemory
) freeMemoryIfNeeded();
2229 /* Handle the multi bulk command type. This is an alternative protocol
2230 * supported by Redis in order to receive commands that are composed of
2231 * multiple binary-safe "bulk" arguments. The latency of processing is
2232 * a bit higher but this allows things like multi-sets, so if this
2233 * protocol is used only for MSET and similar commands this is a big win. */
2234 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2235 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2236 if (c
->multibulk
<= 0) {
2240 decrRefCount(c
->argv
[c
->argc
-1]);
2244 } else if (c
->multibulk
) {
2245 if (c
->bulklen
== -1) {
2246 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2247 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2251 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2252 decrRefCount(c
->argv
[0]);
2253 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2255 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2260 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2264 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2265 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2269 if (c
->multibulk
== 0) {
2273 /* Here we need to swap the multi-bulk argc/argv with the
2274 * normal argc/argv of the client structure. */
2276 c
->argv
= c
->mbargv
;
2277 c
->mbargv
= auxargv
;
2280 c
->argc
= c
->mbargc
;
2281 c
->mbargc
= auxargc
;
2283 /* We need to set bulklen to something different than -1
2284 * in order for the code below to process the command without
2285 * to try to read the last argument of a bulk command as
2286 * a special argument. */
2288 /* continue below and process the command */
2295 /* -- end of multi bulk commands processing -- */
2297 /* The QUIT command is handled as a special case. Normal command
2298 * procs are unable to close the client connection safely */
2299 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2304 /* Now lookup the command and check ASAP about trivial error conditions
2305 * such wrong arity, bad command name and so forth. */
2306 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2309 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2310 (char*)c
->argv
[0]->ptr
));
2313 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2314 (c
->argc
< -cmd
->arity
)) {
2316 sdscatprintf(sdsempty(),
2317 "-ERR wrong number of arguments for '%s' command\r\n",
2321 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2322 /* This is a bulk command, we have to read the last argument yet. */
2323 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2325 decrRefCount(c
->argv
[c
->argc
-1]);
2326 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2328 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2333 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2334 /* It is possible that the bulk read is already in the
2335 * buffer. Check this condition and handle it accordingly.
2336 * This is just a fast path, alternative to call processInputBuffer().
2337 * It's a good idea since the code is small and this condition
2338 * happens most of the times. */
2339 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2340 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2342 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2344 /* Otherwise return... there is to read the last argument
2345 * from the socket. */
2349 /* Let's try to encode the bulk object to save space. */
2350 if (cmd
->flags
& REDIS_CMD_BULK
)
2351 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2353 /* Check if the user is authenticated */
2354 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2355 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2360 /* Handle the maxmemory directive */
2361 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2362 zmalloc_used_memory() > server
.maxmemory
)
2364 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2369 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2370 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2372 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2373 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2374 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2379 /* Exec the command */
2380 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2381 queueMultiCommand(c
,cmd
);
2382 addReply(c
,shared
.queued
);
2384 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2385 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2389 /* Prepare the client for the next command */
2394 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2399 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2400 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2401 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2402 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2405 if (argc
<= REDIS_STATIC_ARGS
) {
2408 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2411 lenobj
= createObject(REDIS_STRING
,
2412 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2413 lenobj
->refcount
= 0;
2414 outv
[outc
++] = lenobj
;
2415 for (j
= 0; j
< argc
; j
++) {
2416 lenobj
= createObject(REDIS_STRING
,
2417 sdscatprintf(sdsempty(),"$%lu\r\n",
2418 (unsigned long) stringObjectLen(argv
[j
])));
2419 lenobj
->refcount
= 0;
2420 outv
[outc
++] = lenobj
;
2421 outv
[outc
++] = argv
[j
];
2422 outv
[outc
++] = shared
.crlf
;
2425 /* Increment all the refcounts at start and decrement at end in order to
2426 * be sure to free objects if there is no slave in a replication state
2427 * able to be feed with commands */
2428 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2429 listRewind(slaves
,&li
);
2430 while((ln
= listNext(&li
))) {
2431 redisClient
*slave
= ln
->value
;
2433 /* Don't feed slaves that are still waiting for BGSAVE to start */
2434 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2436 /* Feed all the other slaves, MONITORs and so on */
2437 if (slave
->slaveseldb
!= dictid
) {
2441 case 0: selectcmd
= shared
.select0
; break;
2442 case 1: selectcmd
= shared
.select1
; break;
2443 case 2: selectcmd
= shared
.select2
; break;
2444 case 3: selectcmd
= shared
.select3
; break;
2445 case 4: selectcmd
= shared
.select4
; break;
2446 case 5: selectcmd
= shared
.select5
; break;
2447 case 6: selectcmd
= shared
.select6
; break;
2448 case 7: selectcmd
= shared
.select7
; break;
2449 case 8: selectcmd
= shared
.select8
; break;
2450 case 9: selectcmd
= shared
.select9
; break;
2452 selectcmd
= createObject(REDIS_STRING
,
2453 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2454 selectcmd
->refcount
= 0;
2457 addReply(slave
,selectcmd
);
2458 slave
->slaveseldb
= dictid
;
2460 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2462 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2463 if (outv
!= static_outv
) zfree(outv
);
2466 static void processInputBuffer(redisClient
*c
) {
2468 /* Before to process the input buffer, make sure the client is not
2469 * waitig for a blocking operation such as BLPOP. Note that the first
2470 * iteration the client is never blocked, otherwise the processInputBuffer
2471 * would not be called at all, but after the execution of the first commands
2472 * in the input buffer the client may be blocked, and the "goto again"
2473 * will try to reiterate. The following line will make it return asap. */
2474 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2475 if (c
->bulklen
== -1) {
2476 /* Read the first line of the query */
2477 char *p
= strchr(c
->querybuf
,'\n');
2484 query
= c
->querybuf
;
2485 c
->querybuf
= sdsempty();
2486 querylen
= 1+(p
-(query
));
2487 if (sdslen(query
) > querylen
) {
2488 /* leave data after the first line of the query in the buffer */
2489 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2491 *p
= '\0'; /* remove "\n" */
2492 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2493 sdsupdatelen(query
);
2495 /* Now we can split the query in arguments */
2496 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2499 if (c
->argv
) zfree(c
->argv
);
2500 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2502 for (j
= 0; j
< argc
; j
++) {
2503 if (sdslen(argv
[j
])) {
2504 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2512 /* Execute the command. If the client is still valid
2513 * after processCommand() return and there is something
2514 * on the query buffer try to process the next command. */
2515 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2517 /* Nothing to process, argc == 0. Just process the query
2518 * buffer if it's not empty or return to the caller */
2519 if (sdslen(c
->querybuf
)) goto again
;
2522 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2523 redisLog(REDIS_VERBOSE
, "Client protocol error");
2528 /* Bulk read handling. Note that if we are at this point
2529 the client already sent a command terminated with a newline,
2530 we are reading the bulk data that is actually the last
2531 argument of the command. */
2532 int qbl
= sdslen(c
->querybuf
);
2534 if (c
->bulklen
<= qbl
) {
2535 /* Copy everything but the final CRLF as final argument */
2536 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2538 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2539 /* Process the command. If the client is still valid after
2540 * the processing and there is more data in the buffer
2541 * try to parse it. */
2542 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2548 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2549 redisClient
*c
= (redisClient
*) privdata
;
2550 char buf
[REDIS_IOBUF_LEN
];
2553 REDIS_NOTUSED(mask
);
2555 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2557 if (errno
== EAGAIN
) {
2560 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2564 } else if (nread
== 0) {
2565 redisLog(REDIS_VERBOSE
, "Client closed connection");
2570 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2571 c
->lastinteraction
= time(NULL
);
2575 processInputBuffer(c
);
2578 static int selectDb(redisClient
*c
, int id
) {
2579 if (id
< 0 || id
>= server
.dbnum
)
2581 c
->db
= &server
.db
[id
];
2585 static void *dupClientReplyValue(void *o
) {
2586 incrRefCount((robj
*)o
);
2590 static int listMatchObjects(void *a
, void *b
) {
2591 return compareStringObjects(a
,b
) == 0;
2594 static redisClient
*createClient(int fd
) {
2595 redisClient
*c
= zmalloc(sizeof(*c
));
2597 anetNonBlock(NULL
,fd
);
2598 anetTcpNoDelay(NULL
,fd
);
2599 if (!c
) return NULL
;
2602 c
->querybuf
= sdsempty();
2611 c
->lastinteraction
= time(NULL
);
2612 c
->authenticated
= 0;
2613 c
->replstate
= REDIS_REPL_NONE
;
2614 c
->reply
= listCreate();
2615 listSetFreeMethod(c
->reply
,decrRefCount
);
2616 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2617 c
->blockingkeys
= NULL
;
2618 c
->blockingkeysnum
= 0;
2619 c
->io_keys
= listCreate();
2620 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2621 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2622 c
->pubsub_patterns
= listCreate();
2623 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2624 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2625 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2626 readQueryFromClient
, c
) == AE_ERR
) {
2630 listAddNodeTail(server
.clients
,c
);
2631 initClientMultiState(c
);
2635 static void addReply(redisClient
*c
, robj
*obj
) {
2636 if (listLength(c
->reply
) == 0 &&
2637 (c
->replstate
== REDIS_REPL_NONE
||
2638 c
->replstate
== REDIS_REPL_ONLINE
) &&
2639 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2640 sendReplyToClient
, c
) == AE_ERR
) return;
2642 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2643 obj
= dupStringObject(obj
);
2644 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2646 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2649 static void addReplySds(redisClient
*c
, sds s
) {
2650 robj
*o
= createObject(REDIS_STRING
,s
);
2655 static void addReplyDouble(redisClient
*c
, double d
) {
2658 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2659 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2660 (unsigned long) strlen(buf
),buf
));
2663 static void addReplyLong(redisClient
*c
, long l
) {
2668 addReply(c
,shared
.czero
);
2670 } else if (l
== 1) {
2671 addReply(c
,shared
.cone
);
2674 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2675 addReplySds(c
,sdsnewlen(buf
,len
));
2678 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2683 addReply(c
,shared
.czero
);
2685 } else if (ll
== 1) {
2686 addReply(c
,shared
.cone
);
2689 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2690 addReplySds(c
,sdsnewlen(buf
,len
));
2693 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2698 addReply(c
,shared
.czero
);
2700 } else if (ul
== 1) {
2701 addReply(c
,shared
.cone
);
2704 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2705 addReplySds(c
,sdsnewlen(buf
,len
));
2708 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2711 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2712 len
= sdslen(obj
->ptr
);
2714 long n
= (long)obj
->ptr
;
2716 /* Compute how many bytes will take this integer as a radix 10 string */
2722 while((n
= n
/10) != 0) {
2726 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2729 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2730 addReplyBulkLen(c
,obj
);
2732 addReply(c
,shared
.crlf
);
2735 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2736 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2738 addReply(c
,shared
.nullbulk
);
2740 robj
*o
= createStringObject(s
,strlen(s
));
2746 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2751 REDIS_NOTUSED(mask
);
2752 REDIS_NOTUSED(privdata
);
2754 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2755 if (cfd
== AE_ERR
) {
2756 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2759 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2760 if ((c
= createClient(cfd
)) == NULL
) {
2761 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2762 close(cfd
); /* May be already closed, just ingore errors */
2765 /* If maxclient directive is set and this is one client more... close the
2766 * connection. Note that we create the client instead to check before
2767 * for this condition, since now the socket is already set in nonblocking
2768 * mode and we can send an error for free using the Kernel I/O */
2769 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2770 char *err
= "-ERR max number of clients reached\r\n";
2772 /* That's a best effort error message, don't check write errors */
2773 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2774 /* Nothing to do, Just to avoid the warning... */
2779 server
.stat_numconnections
++;
2782 /* ======================= Redis objects implementation ===================== */
2784 static robj
*createObject(int type
, void *ptr
) {
2787 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2788 if (listLength(server
.objfreelist
)) {
2789 listNode
*head
= listFirst(server
.objfreelist
);
2790 o
= listNodeValue(head
);
2791 listDelNode(server
.objfreelist
,head
);
2792 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2794 if (server
.vm_enabled
) {
2795 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2796 o
= zmalloc(sizeof(*o
));
2798 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2802 o
->encoding
= REDIS_ENCODING_RAW
;
2805 if (server
.vm_enabled
) {
2806 /* Note that this code may run in the context of an I/O thread
2807 * and accessing to server.unixtime in theory is an error
2808 * (no locks). But in practice this is safe, and even if we read
2809 * garbage Redis will not fail, as it's just a statistical info */
2810 o
->vm
.atime
= server
.unixtime
;
2811 o
->storage
= REDIS_VM_MEMORY
;
2816 static robj
*createStringObject(char *ptr
, size_t len
) {
2817 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2820 static robj
*createStringObjectFromLongLong(long long value
) {
2822 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2823 incrRefCount(shared
.integers
[value
]);
2824 o
= shared
.integers
[value
];
2826 o
= createObject(REDIS_STRING
, NULL
);
2827 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2828 o
->encoding
= REDIS_ENCODING_INT
;
2829 o
->ptr
= (void*)((long)value
);
2831 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2837 static robj
*dupStringObject(robj
*o
) {
2838 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2839 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2842 static robj
*createListObject(void) {
2843 list
*l
= listCreate();
2845 listSetFreeMethod(l
,decrRefCount
);
2846 return createObject(REDIS_LIST
,l
);
2849 static robj
*createSetObject(void) {
2850 dict
*d
= dictCreate(&setDictType
,NULL
);
2851 return createObject(REDIS_SET
,d
);
2854 static robj
*createHashObject(void) {
2855 /* All the Hashes start as zipmaps. Will be automatically converted
2856 * into hash tables if there are enough elements or big elements
2858 unsigned char *zm
= zipmapNew();
2859 robj
*o
= createObject(REDIS_HASH
,zm
);
2860 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2864 static robj
*createZsetObject(void) {
2865 zset
*zs
= zmalloc(sizeof(*zs
));
2867 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2868 zs
->zsl
= zslCreate();
2869 return createObject(REDIS_ZSET
,zs
);
2872 static void freeStringObject(robj
*o
) {
2873 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2878 static void freeListObject(robj
*o
) {
2879 listRelease((list
*) o
->ptr
);
2882 static void freeSetObject(robj
*o
) {
2883 dictRelease((dict
*) o
->ptr
);
2886 static void freeZsetObject(robj
*o
) {
2889 dictRelease(zs
->dict
);
2894 static void freeHashObject(robj
*o
) {
2895 switch (o
->encoding
) {
2896 case REDIS_ENCODING_HT
:
2897 dictRelease((dict
*) o
->ptr
);
2899 case REDIS_ENCODING_ZIPMAP
:
2903 redisPanic("Unknown hash encoding type");
2908 static void incrRefCount(robj
*o
) {
2912 static void decrRefCount(void *obj
) {
2915 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2916 /* Object is a key of a swapped out value, or in the process of being
2918 if (server
.vm_enabled
&&
2919 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2921 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2922 redisAssert(o
->type
== REDIS_STRING
);
2923 freeStringObject(o
);
2924 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2925 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2926 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2927 !listAddNodeHead(server
.objfreelist
,o
))
2929 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2930 server
.vm_stats_swapped_objects
--;
2933 /* Object is in memory, or in the process of being swapped out. */
2934 if (--(o
->refcount
) == 0) {
2935 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2936 vmCancelThreadedIOJob(obj
);
2938 case REDIS_STRING
: freeStringObject(o
); break;
2939 case REDIS_LIST
: freeListObject(o
); break;
2940 case REDIS_SET
: freeSetObject(o
); break;
2941 case REDIS_ZSET
: freeZsetObject(o
); break;
2942 case REDIS_HASH
: freeHashObject(o
); break;
2943 default: redisPanic("Unknown object type"); break;
2945 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2946 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2947 !listAddNodeHead(server
.objfreelist
,o
))
2949 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2953 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2954 dictEntry
*de
= dictFind(db
->dict
,key
);
2956 robj
*key
= dictGetEntryKey(de
);
2957 robj
*val
= dictGetEntryVal(de
);
2959 if (server
.vm_enabled
) {
2960 if (key
->storage
== REDIS_VM_MEMORY
||
2961 key
->storage
== REDIS_VM_SWAPPING
)
2963 /* If we were swapping the object out, stop it, this key
2965 if (key
->storage
== REDIS_VM_SWAPPING
)
2966 vmCancelThreadedIOJob(key
);
2967 /* Update the access time of the key for the aging algorithm. */
2968 key
->vm
.atime
= server
.unixtime
;
2970 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2972 /* Our value was swapped on disk. Bring it at home. */
2973 redisAssert(val
== NULL
);
2974 val
= vmLoadObject(key
);
2975 dictGetEntryVal(de
) = val
;
2977 /* Clients blocked by the VM subsystem may be waiting for
2979 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2988 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2989 expireIfNeeded(db
,key
);
2990 return lookupKey(db
,key
);
2993 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2994 deleteIfVolatile(db
,key
);
2995 return lookupKey(db
,key
);
2998 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2999 robj
*o
= lookupKeyRead(c
->db
, key
);
3000 if (!o
) addReply(c
,reply
);
3004 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3005 robj
*o
= lookupKeyWrite(c
->db
, key
);
3006 if (!o
) addReply(c
,reply
);
3010 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3011 if (o
->type
!= type
) {
3012 addReply(c
,shared
.wrongtypeerr
);
3018 static int deleteKey(redisDb
*db
, robj
*key
) {
3021 /* We need to protect key from destruction: after the first dictDelete()
3022 * it may happen that 'key' is no longer valid if we don't increment
3023 * it's count. This may happen when we get the object reference directly
3024 * from the hash table with dictRandomKey() or dict iterators */
3026 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3027 retval
= dictDelete(db
->dict
,key
);
3030 return retval
== DICT_OK
;
3033 /* Check if the nul-terminated string 's' can be represented by a long
3034 * (that is, is a number that fits into long without any other space or
3035 * character before or after the digits).
3037 * If so, the function returns REDIS_OK and *longval is set to the value
3038 * of the number. Otherwise REDIS_ERR is returned */
3039 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3040 char buf
[32], *endptr
;
3044 value
= strtol(s
, &endptr
, 10);
3045 if (endptr
[0] != '\0') return REDIS_ERR
;
3046 slen
= snprintf(buf
,32,"%ld",value
);
3048 /* If the number converted back into a string is not identical
3049 * then it's not possible to encode the string as integer */
3050 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3051 if (longval
) *longval
= value
;
3055 /* Try to encode a string object in order to save space */
3056 static robj
*tryObjectEncoding(robj
*o
) {
3060 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3061 return o
; /* Already encoded */
3063 /* It's not safe to encode shared objects: shared objects can be shared
3064 * everywhere in the "object space" of Redis. Encoded objects can only
3065 * appear as "values" (and not, for instance, as keys) */
3066 if (o
->refcount
> 1) return o
;
3068 /* Currently we try to encode only strings */
3069 redisAssert(o
->type
== REDIS_STRING
);
3071 /* Check if we can represent this string as a long integer */
3072 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3074 /* Ok, this object can be encoded */
3075 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3077 incrRefCount(shared
.integers
[value
]);
3078 return shared
.integers
[value
];
3080 o
->encoding
= REDIS_ENCODING_INT
;
3082 o
->ptr
= (void*) value
;
3087 /* Get a decoded version of an encoded object (returned as a new object).
3088 * If the object is already raw-encoded just increment the ref count. */
3089 static robj
*getDecodedObject(robj
*o
) {
3092 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3096 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3099 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3100 dec
= createStringObject(buf
,strlen(buf
));
3103 redisPanic("Unknown encoding type");
3107 /* Compare two string objects via strcmp() or alike.
3108 * Note that the objects may be integer-encoded. In such a case we
3109 * use snprintf() to get a string representation of the numbers on the stack
3110 * and compare the strings, it's much faster than calling getDecodedObject().
3112 * Important note: if objects are not integer encoded, but binary-safe strings,
3113 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3115 static int compareStringObjects(robj
*a
, robj
*b
) {
3116 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3117 char bufa
[128], bufb
[128], *astr
, *bstr
;
3120 if (a
== b
) return 0;
3121 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3122 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3128 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3129 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3135 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3138 static size_t stringObjectLen(robj
*o
) {
3139 redisAssert(o
->type
== REDIS_STRING
);
3140 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3141 return sdslen(o
->ptr
);
3145 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3149 static int getDoubleFromObject(robj
*o
, double *target
) {
3156 redisAssert(o
->type
== REDIS_STRING
);
3157 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3158 value
= strtod(o
->ptr
, &eptr
);
3159 if (eptr
[0] != '\0') return REDIS_ERR
;
3160 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3161 value
= (long)o
->ptr
;
3163 redisAssert(1 != 1);
3171 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3173 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3175 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3177 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3186 static int getLongLongFromObject(robj
*o
, long long *target
) {
3193 redisAssert(o
->type
== REDIS_STRING
);
3194 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3195 value
= strtoll(o
->ptr
, &eptr
, 10);
3196 if (eptr
[0] != '\0') return REDIS_ERR
;
3197 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3198 value
= (long)o
->ptr
;
3200 redisAssert(1 != 1);
3208 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3210 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3212 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3214 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3223 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3226 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3227 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3229 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3231 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3240 /*============================ RDB saving/loading =========================== */
3242 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3243 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3247 static int rdbSaveTime(FILE *fp
, time_t t
) {
3248 int32_t t32
= (int32_t) t
;
3249 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3253 /* check rdbLoadLen() comments for more info */
3254 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3255 unsigned char buf
[2];
3258 /* Save a 6 bit len */
3259 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3260 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3261 } else if (len
< (1<<14)) {
3262 /* Save a 14 bit len */
3263 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3265 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3267 /* Save a 32 bit len */
3268 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3269 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3271 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3276 /* String objects in the form "2391" "-100" without any space and with a
3277 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3278 * encoded as integers to save space */
3279 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3281 char *endptr
, buf
[32];
3283 /* Check if it's possible to encode this value as a number */
3284 value
= strtoll(s
, &endptr
, 10);
3285 if (endptr
[0] != '\0') return 0;
3286 snprintf(buf
,32,"%lld",value
);
3288 /* If the number converted back into a string is not identical
3289 * then it's not possible to encode the string as integer */
3290 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3292 /* Finally check if it fits in our ranges */
3293 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3294 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3295 enc
[1] = value
&0xFF;
3297 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3298 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3299 enc
[1] = value
&0xFF;
3300 enc
[2] = (value
>>8)&0xFF;
3302 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3303 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3304 enc
[1] = value
&0xFF;
3305 enc
[2] = (value
>>8)&0xFF;
3306 enc
[3] = (value
>>16)&0xFF;
3307 enc
[4] = (value
>>24)&0xFF;
3314 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3315 size_t comprlen
, outlen
;
3319 /* We require at least four bytes compression for this to be worth it */
3320 if (len
<= 4) return 0;
3322 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3323 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3324 if (comprlen
== 0) {
3328 /* Data compressed! Let's save it on disk */
3329 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3330 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3331 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3332 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3333 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3342 /* Save a string objet as [len][data] on disk. If the object is a string
3343 * representation of an integer value we try to safe it in a special form */
3344 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3347 /* Try integer encoding */
3349 unsigned char buf
[5];
3350 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3351 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3356 /* Try LZF compression - under 20 bytes it's unable to compress even
3357 * aaaaaaaaaaaaaaaaaa so skip it */
3358 if (server
.rdbcompression
&& len
> 20) {
3361 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3362 if (retval
== -1) return -1;
3363 if (retval
> 0) return 0;
3364 /* retval == 0 means data can't be compressed, save the old way */
3367 /* Store verbatim */
3368 if (rdbSaveLen(fp
,len
) == -1) return -1;
3369 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3373 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3374 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3377 /* Avoid incr/decr ref count business when possible.
3378 * This plays well with copy-on-write given that we are probably
3379 * in a child process (BGSAVE). Also this makes sure key objects
3380 * of swapped objects are not incRefCount-ed (an assert does not allow
3381 * this in order to avoid bugs) */
3382 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3383 obj
= getDecodedObject(obj
);
3384 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3387 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3392 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3393 * 8 bit integer specifing the length of the representation.
3394 * This 8 bit integer has special values in order to specify the following
3400 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3401 unsigned char buf
[128];
3407 } else if (!isfinite(val
)) {
3409 buf
[0] = (val
< 0) ? 255 : 254;
3411 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3412 buf
[0] = strlen((char*)buf
+1);
3415 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3419 /* Save a Redis object. */
3420 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3421 if (o
->type
== REDIS_STRING
) {
3422 /* Save a string value */
3423 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3424 } else if (o
->type
== REDIS_LIST
) {
3425 /* Save a list value */
3426 list
*list
= o
->ptr
;
3430 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3431 listRewind(list
,&li
);
3432 while((ln
= listNext(&li
))) {
3433 robj
*eleobj
= listNodeValue(ln
);
3435 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3437 } else if (o
->type
== REDIS_SET
) {
3438 /* Save a set value */
3440 dictIterator
*di
= dictGetIterator(set
);
3443 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3444 while((de
= dictNext(di
)) != NULL
) {
3445 robj
*eleobj
= dictGetEntryKey(de
);
3447 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3449 dictReleaseIterator(di
);
3450 } else if (o
->type
== REDIS_ZSET
) {
3451 /* Save a set value */
3453 dictIterator
*di
= dictGetIterator(zs
->dict
);
3456 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3457 while((de
= dictNext(di
)) != NULL
) {
3458 robj
*eleobj
= dictGetEntryKey(de
);
3459 double *score
= dictGetEntryVal(de
);
3461 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3462 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3464 dictReleaseIterator(di
);
3465 } else if (o
->type
== REDIS_HASH
) {
3466 /* Save a hash value */
3467 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3468 unsigned char *p
= zipmapRewind(o
->ptr
);
3469 unsigned int count
= zipmapLen(o
->ptr
);
3470 unsigned char *key
, *val
;
3471 unsigned int klen
, vlen
;
3473 if (rdbSaveLen(fp
,count
) == -1) return -1;
3474 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3475 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3476 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3479 dictIterator
*di
= dictGetIterator(o
->ptr
);
3482 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3483 while((de
= dictNext(di
)) != NULL
) {
3484 robj
*key
= dictGetEntryKey(de
);
3485 robj
*val
= dictGetEntryVal(de
);
3487 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3488 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3490 dictReleaseIterator(di
);
3493 redisPanic("Unknown object type");
3498 /* Return the length the object will have on disk if saved with
3499 * the rdbSaveObject() function. Currently we use a trick to get
3500 * this length with very little changes to the code. In the future
3501 * we could switch to a faster solution. */
3502 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3503 if (fp
== NULL
) fp
= server
.devnull
;
3505 assert(rdbSaveObject(fp
,o
) != 1);
3509 /* Return the number of pages required to save this object in the swap file */
3510 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3511 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3513 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3516 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3517 static int rdbSave(char *filename
) {
3518 dictIterator
*di
= NULL
;
3523 time_t now
= time(NULL
);
3525 /* Wait for I/O therads to terminate, just in case this is a
3526 * foreground-saving, to avoid seeking the swap file descriptor at the
3528 if (server
.vm_enabled
)
3529 waitEmptyIOJobsQueue();
3531 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3532 fp
= fopen(tmpfile
,"w");
3534 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3537 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3538 for (j
= 0; j
< server
.dbnum
; j
++) {
3539 redisDb
*db
= server
.db
+j
;
3541 if (dictSize(d
) == 0) continue;
3542 di
= dictGetIterator(d
);
3548 /* Write the SELECT DB opcode */
3549 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3550 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3552 /* Iterate this DB writing every entry */
3553 while((de
= dictNext(di
)) != NULL
) {
3554 robj
*key
= dictGetEntryKey(de
);
3555 robj
*o
= dictGetEntryVal(de
);
3556 time_t expiretime
= getExpire(db
,key
);
3558 /* Save the expire time */
3559 if (expiretime
!= -1) {
3560 /* If this key is already expired skip it */
3561 if (expiretime
< now
) continue;
3562 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3563 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3565 /* Save the key and associated value. This requires special
3566 * handling if the value is swapped out. */
3567 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3568 key
->storage
== REDIS_VM_SWAPPING
) {
3569 /* Save type, key, value */
3570 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3571 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3572 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3574 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3576 /* Get a preview of the object in memory */
3577 po
= vmPreviewObject(key
);
3578 /* Save type, key, value */
3579 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3580 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3581 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3582 /* Remove the loaded object from memory */
3586 dictReleaseIterator(di
);
3589 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3591 /* Make sure data will not remain on the OS's output buffers */
3596 /* Use RENAME to make sure the DB file is changed atomically only
3597 * if the generate DB file is ok. */
3598 if (rename(tmpfile
,filename
) == -1) {
3599 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3603 redisLog(REDIS_NOTICE
,"DB saved on disk");
3605 server
.lastsave
= time(NULL
);
3611 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3612 if (di
) dictReleaseIterator(di
);
3616 static int rdbSaveBackground(char *filename
) {
3619 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3620 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3621 if ((childpid
= fork()) == 0) {
3623 if (server
.vm_enabled
) vmReopenSwapFile();
3625 if (rdbSave(filename
) == REDIS_OK
) {
3632 if (childpid
== -1) {
3633 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3637 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3638 server
.bgsavechildpid
= childpid
;
3639 updateDictResizePolicy();
3642 return REDIS_OK
; /* unreached */
3645 static void rdbRemoveTempFile(pid_t childpid
) {
3648 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3652 static int rdbLoadType(FILE *fp
) {
3654 if (fread(&type
,1,1,fp
) == 0) return -1;
3658 static time_t rdbLoadTime(FILE *fp
) {
3660 if (fread(&t32
,4,1,fp
) == 0) return -1;
3661 return (time_t) t32
;
3664 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3665 * of this file for a description of how this are stored on disk.
3667 * isencoded is set to 1 if the readed length is not actually a length but
3668 * an "encoding type", check the above comments for more info */
3669 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3670 unsigned char buf
[2];
3674 if (isencoded
) *isencoded
= 0;
3675 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3676 type
= (buf
[0]&0xC0)>>6;
3677 if (type
== REDIS_RDB_6BITLEN
) {
3678 /* Read a 6 bit len */
3680 } else if (type
== REDIS_RDB_ENCVAL
) {
3681 /* Read a 6 bit len encoding type */
3682 if (isencoded
) *isencoded
= 1;
3684 } else if (type
== REDIS_RDB_14BITLEN
) {
3685 /* Read a 14 bit len */
3686 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3687 return ((buf
[0]&0x3F)<<8)|buf
[1];
3689 /* Read a 32 bit len */
3690 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3695 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3696 unsigned char enc
[4];
3699 if (enctype
== REDIS_RDB_ENC_INT8
) {
3700 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3701 val
= (signed char)enc
[0];
3702 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3704 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3705 v
= enc
[0]|(enc
[1]<<8);
3707 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3709 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3710 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3713 val
= 0; /* anti-warning */
3714 redisPanic("Unknown RDB integer encoding type");
3716 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3719 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3720 unsigned int len
, clen
;
3721 unsigned char *c
= NULL
;
3724 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3725 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3726 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3727 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3728 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3729 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3731 return createObject(REDIS_STRING
,val
);
3738 static robj
*rdbLoadStringObject(FILE*fp
) {
3743 len
= rdbLoadLen(fp
,&isencoded
);
3746 case REDIS_RDB_ENC_INT8
:
3747 case REDIS_RDB_ENC_INT16
:
3748 case REDIS_RDB_ENC_INT32
:
3749 return rdbLoadIntegerObject(fp
,len
);
3750 case REDIS_RDB_ENC_LZF
:
3751 return rdbLoadLzfStringObject(fp
);
3753 redisPanic("Unknown RDB encoding type");
3757 if (len
== REDIS_RDB_LENERR
) return NULL
;
3758 val
= sdsnewlen(NULL
,len
);
3759 if (len
&& fread(val
,len
,1,fp
) == 0) {
3763 return createObject(REDIS_STRING
,val
);
3766 /* For information about double serialization check rdbSaveDoubleValue() */
3767 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3771 if (fread(&len
,1,1,fp
) == 0) return -1;
3773 case 255: *val
= R_NegInf
; return 0;
3774 case 254: *val
= R_PosInf
; return 0;
3775 case 253: *val
= R_Nan
; return 0;
3777 if (fread(buf
,len
,1,fp
) == 0) return -1;
3779 sscanf(buf
, "%lg", val
);
3784 /* Load a Redis object of the specified type from the specified file.
3785 * On success a newly allocated object is returned, otherwise NULL. */
3786 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3789 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3790 if (type
== REDIS_STRING
) {
3791 /* Read string value */
3792 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3793 o
= tryObjectEncoding(o
);
3794 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3795 /* Read list/set value */
3798 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3799 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3800 /* It's faster to expand the dict to the right size asap in order
3801 * to avoid rehashing */
3802 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3803 dictExpand(o
->ptr
,listlen
);
3804 /* Load every single element of the list/set */
3808 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3809 ele
= tryObjectEncoding(ele
);
3810 if (type
== REDIS_LIST
) {
3811 listAddNodeTail((list
*)o
->ptr
,ele
);
3813 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3816 } else if (type
== REDIS_ZSET
) {
3817 /* Read list/set value */
3821 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3822 o
= createZsetObject();
3824 /* Load every single element of the list/set */
3827 double *score
= zmalloc(sizeof(double));
3829 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3830 ele
= tryObjectEncoding(ele
);
3831 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3832 dictAdd(zs
->dict
,ele
,score
);
3833 zslInsert(zs
->zsl
,*score
,ele
);
3834 incrRefCount(ele
); /* added to skiplist */
3836 } else if (type
== REDIS_HASH
) {
3839 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3840 o
= createHashObject();
3841 /* Too many entries? Use an hash table. */
3842 if (hashlen
> server
.hash_max_zipmap_entries
)
3843 convertToRealHash(o
);
3844 /* Load every key/value, then set it into the zipmap or hash
3845 * table, as needed. */
3849 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3850 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3851 /* If we are using a zipmap and there are too big values
3852 * the object is converted to real hash table encoding. */
3853 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3854 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3855 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3857 convertToRealHash(o
);
3860 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3861 unsigned char *zm
= o
->ptr
;
3863 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3864 val
->ptr
,sdslen(val
->ptr
),NULL
);
3869 key
= tryObjectEncoding(key
);
3870 val
= tryObjectEncoding(val
);
3871 dictAdd((dict
*)o
->ptr
,key
,val
);
3875 redisPanic("Unknown object type");
3880 static int rdbLoad(char *filename
) {
3882 robj
*keyobj
= NULL
;
3884 int type
, retval
, rdbver
;
3885 dict
*d
= server
.db
[0].dict
;
3886 redisDb
*db
= server
.db
+0;
3888 time_t expiretime
= -1, now
= time(NULL
);
3889 long long loadedkeys
= 0;
3891 fp
= fopen(filename
,"r");
3892 if (!fp
) return REDIS_ERR
;
3893 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3895 if (memcmp(buf
,"REDIS",5) != 0) {
3897 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3900 rdbver
= atoi(buf
+5);
3903 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3910 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3911 if (type
== REDIS_EXPIRETIME
) {
3912 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3913 /* We read the time so we need to read the object type again */
3914 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3916 if (type
== REDIS_EOF
) break;
3917 /* Handle SELECT DB opcode as a special case */
3918 if (type
== REDIS_SELECTDB
) {
3919 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3921 if (dbid
>= (unsigned)server
.dbnum
) {
3922 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3925 db
= server
.db
+dbid
;
3930 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3932 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3933 /* Add the new object in the hash table */
3934 retval
= dictAdd(d
,keyobj
,o
);
3935 if (retval
== DICT_ERR
) {
3936 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3939 /* Set the expire time if needed */
3940 if (expiretime
!= -1) {
3941 setExpire(db
,keyobj
,expiretime
);
3942 /* Delete this key if already expired */
3943 if (expiretime
< now
) deleteKey(db
,keyobj
);
3947 /* Handle swapping while loading big datasets when VM is on */
3949 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3950 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3951 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3958 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3959 if (keyobj
) decrRefCount(keyobj
);
3960 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3962 return REDIS_ERR
; /* Just to avoid warning */
3965 /*================================== Commands =============================== */
3967 static void authCommand(redisClient
*c
) {
3968 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3969 c
->authenticated
= 1;
3970 addReply(c
,shared
.ok
);
3972 c
->authenticated
= 0;
3973 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3977 static void pingCommand(redisClient
*c
) {
3978 addReply(c
,shared
.pong
);
3981 static void echoCommand(redisClient
*c
) {
3982 addReplyBulk(c
,c
->argv
[1]);
3985 /*=================================== Strings =============================== */
3987 static void setGenericCommand(redisClient
*c
, int nx
) {
3990 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3991 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3992 if (retval
== DICT_ERR
) {
3994 /* If the key is about a swapped value, we want a new key object
3995 * to overwrite the old. So we delete the old key in the database.
3996 * This will also make sure that swap pages about the old object
3997 * will be marked as free. */
3998 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3999 incrRefCount(c
->argv
[1]);
4000 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4001 incrRefCount(c
->argv
[2]);
4003 addReply(c
,shared
.czero
);
4007 incrRefCount(c
->argv
[1]);
4008 incrRefCount(c
->argv
[2]);
4011 removeExpire(c
->db
,c
->argv
[1]);
4012 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4015 static void setCommand(redisClient
*c
) {
4016 setGenericCommand(c
,0);
4019 static void setnxCommand(redisClient
*c
) {
4020 setGenericCommand(c
,1);
4023 static int getGenericCommand(redisClient
*c
) {
4026 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4029 if (o
->type
!= REDIS_STRING
) {
4030 addReply(c
,shared
.wrongtypeerr
);
4038 static void getCommand(redisClient
*c
) {
4039 getGenericCommand(c
);
4042 static void getsetCommand(redisClient
*c
) {
4043 if (getGenericCommand(c
) == REDIS_ERR
) return;
4044 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4045 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4047 incrRefCount(c
->argv
[1]);
4049 incrRefCount(c
->argv
[2]);
4051 removeExpire(c
->db
,c
->argv
[1]);
4054 static void mgetCommand(redisClient
*c
) {
4057 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4058 for (j
= 1; j
< c
->argc
; j
++) {
4059 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4061 addReply(c
,shared
.nullbulk
);
4063 if (o
->type
!= REDIS_STRING
) {
4064 addReply(c
,shared
.nullbulk
);
4072 static void msetGenericCommand(redisClient
*c
, int nx
) {
4073 int j
, busykeys
= 0;
4075 if ((c
->argc
% 2) == 0) {
4076 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4079 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4080 * set nothing at all if at least one already key exists. */
4082 for (j
= 1; j
< c
->argc
; j
+= 2) {
4083 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4089 addReply(c
, shared
.czero
);
4093 for (j
= 1; j
< c
->argc
; j
+= 2) {
4096 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4097 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4098 if (retval
== DICT_ERR
) {
4099 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4100 incrRefCount(c
->argv
[j
+1]);
4102 incrRefCount(c
->argv
[j
]);
4103 incrRefCount(c
->argv
[j
+1]);
4105 removeExpire(c
->db
,c
->argv
[j
]);
4107 server
.dirty
+= (c
->argc
-1)/2;
4108 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4111 static void msetCommand(redisClient
*c
) {
4112 msetGenericCommand(c
,0);
4115 static void msetnxCommand(redisClient
*c
) {
4116 msetGenericCommand(c
,1);
4119 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4124 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4126 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4129 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4130 o
= tryObjectEncoding(o
);
4131 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4132 if (retval
== DICT_ERR
) {
4133 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4134 removeExpire(c
->db
,c
->argv
[1]);
4136 incrRefCount(c
->argv
[1]);
4139 addReply(c
,shared
.colon
);
4141 addReply(c
,shared
.crlf
);
4144 static void incrCommand(redisClient
*c
) {
4145 incrDecrCommand(c
,1);
4148 static void decrCommand(redisClient
*c
) {
4149 incrDecrCommand(c
,-1);
4152 static void incrbyCommand(redisClient
*c
) {
4155 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4156 incrDecrCommand(c
,incr
);
4159 static void decrbyCommand(redisClient
*c
) {
4162 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4163 incrDecrCommand(c
,-incr
);
4166 static void appendCommand(redisClient
*c
) {
4171 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4173 /* Create the key */
4174 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4175 incrRefCount(c
->argv
[1]);
4176 incrRefCount(c
->argv
[2]);
4177 totlen
= stringObjectLen(c
->argv
[2]);
4181 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4184 o
= dictGetEntryVal(de
);
4185 if (o
->type
!= REDIS_STRING
) {
4186 addReply(c
,shared
.wrongtypeerr
);
4189 /* If the object is specially encoded or shared we have to make
4191 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4192 robj
*decoded
= getDecodedObject(o
);
4194 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4195 decrRefCount(decoded
);
4196 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4199 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4200 o
->ptr
= sdscatlen(o
->ptr
,
4201 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4203 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4204 (unsigned long) c
->argv
[2]->ptr
);
4206 totlen
= sdslen(o
->ptr
);
4209 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4212 static void substrCommand(redisClient
*c
) {
4214 long start
= atoi(c
->argv
[2]->ptr
);
4215 long end
= atoi(c
->argv
[3]->ptr
);
4216 size_t rangelen
, strlen
;
4219 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4220 checkType(c
,o
,REDIS_STRING
)) return;
4222 o
= getDecodedObject(o
);
4223 strlen
= sdslen(o
->ptr
);
4225 /* convert negative indexes */
4226 if (start
< 0) start
= strlen
+start
;
4227 if (end
< 0) end
= strlen
+end
;
4228 if (start
< 0) start
= 0;
4229 if (end
< 0) end
= 0;
4231 /* indexes sanity checks */
4232 if (start
> end
|| (size_t)start
>= strlen
) {
4233 /* Out of range start or start > end result in null reply */
4234 addReply(c
,shared
.nullbulk
);
4238 if ((size_t)end
>= strlen
) end
= strlen
-1;
4239 rangelen
= (end
-start
)+1;
4241 /* Return the result */
4242 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4243 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4244 addReplySds(c
,range
);
4245 addReply(c
,shared
.crlf
);
4249 /* ========================= Type agnostic commands ========================= */
4251 static void delCommand(redisClient
*c
) {
4254 for (j
= 1; j
< c
->argc
; j
++) {
4255 if (deleteKey(c
->db
,c
->argv
[j
])) {
4260 addReplyLong(c
,deleted
);
4263 static void existsCommand(redisClient
*c
) {
4264 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4267 static void selectCommand(redisClient
*c
) {
4268 int id
= atoi(c
->argv
[1]->ptr
);
4270 if (selectDb(c
,id
) == REDIS_ERR
) {
4271 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4273 addReply(c
,shared
.ok
);
4277 static void randomkeyCommand(redisClient
*c
) {
4282 de
= dictGetRandomKey(c
->db
->dict
);
4283 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4287 addReply(c
,shared
.nullbulk
);
4291 key
= dictGetEntryKey(de
);
4292 if (server
.vm_enabled
) {
4293 key
= dupStringObject(key
);
4294 addReplyBulk(c
,key
);
4297 addReplyBulk(c
,key
);
4301 static void keysCommand(redisClient
*c
) {
4304 sds pattern
= c
->argv
[1]->ptr
;
4305 int plen
= sdslen(pattern
);
4306 unsigned long numkeys
= 0;
4307 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4309 di
= dictGetIterator(c
->db
->dict
);
4311 decrRefCount(lenobj
);
4312 while((de
= dictNext(di
)) != NULL
) {
4313 robj
*keyobj
= dictGetEntryKey(de
);
4315 sds key
= keyobj
->ptr
;
4316 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4317 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4318 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4319 addReplyBulk(c
,keyobj
);
4324 dictReleaseIterator(di
);
4325 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4328 static void dbsizeCommand(redisClient
*c
) {
4330 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4333 static void lastsaveCommand(redisClient
*c
) {
4335 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4338 static void typeCommand(redisClient
*c
) {
4342 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4347 case REDIS_STRING
: type
= "+string"; break;
4348 case REDIS_LIST
: type
= "+list"; break;
4349 case REDIS_SET
: type
= "+set"; break;
4350 case REDIS_ZSET
: type
= "+zset"; break;
4351 case REDIS_HASH
: type
= "+hash"; break;
4352 default: type
= "+unknown"; break;
4355 addReplySds(c
,sdsnew(type
));
4356 addReply(c
,shared
.crlf
);
4359 static void saveCommand(redisClient
*c
) {
4360 if (server
.bgsavechildpid
!= -1) {
4361 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4364 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4365 addReply(c
,shared
.ok
);
4367 addReply(c
,shared
.err
);
4371 static void bgsaveCommand(redisClient
*c
) {
4372 if (server
.bgsavechildpid
!= -1) {
4373 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4376 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4377 char *status
= "+Background saving started\r\n";
4378 addReplySds(c
,sdsnew(status
));
4380 addReply(c
,shared
.err
);
4384 static void shutdownCommand(redisClient
*c
) {
4385 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4386 /* Kill the saving child if there is a background saving in progress.
4387 We want to avoid race conditions, for instance our saving child may
4388 overwrite the synchronous saving did by SHUTDOWN. */
4389 if (server
.bgsavechildpid
!= -1) {
4390 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4391 kill(server
.bgsavechildpid
,SIGKILL
);
4392 rdbRemoveTempFile(server
.bgsavechildpid
);
4394 if (server
.appendonly
) {
4395 /* Append only file: fsync() the AOF and exit */
4396 fsync(server
.appendfd
);
4397 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4400 /* Snapshotting. Perform a SYNC SAVE and exit */
4401 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4402 if (server
.daemonize
)
4403 unlink(server
.pidfile
);
4404 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4405 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4406 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4409 /* Ooops.. error saving! The best we can do is to continue
4410 * operating. Note that if there was a background saving process,
4411 * in the next cron() Redis will be notified that the background
4412 * saving aborted, handling special stuff like slaves pending for
4413 * synchronization... */
4414 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4416 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4421 static void renameGenericCommand(redisClient
*c
, int nx
) {
4424 /* To use the same key as src and dst is probably an error */
4425 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4426 addReply(c
,shared
.sameobjecterr
);
4430 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4434 deleteIfVolatile(c
->db
,c
->argv
[2]);
4435 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4438 addReply(c
,shared
.czero
);
4441 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4443 incrRefCount(c
->argv
[2]);
4445 deleteKey(c
->db
,c
->argv
[1]);
4447 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4450 static void renameCommand(redisClient
*c
) {
4451 renameGenericCommand(c
,0);
4454 static void renamenxCommand(redisClient
*c
) {
4455 renameGenericCommand(c
,1);
4458 static void moveCommand(redisClient
*c
) {
4463 /* Obtain source and target DB pointers */
4466 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4467 addReply(c
,shared
.outofrangeerr
);
4471 selectDb(c
,srcid
); /* Back to the source DB */
4473 /* If the user is moving using as target the same
4474 * DB as the source DB it is probably an error. */
4476 addReply(c
,shared
.sameobjecterr
);
4480 /* Check if the element exists and get a reference */
4481 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4483 addReply(c
,shared
.czero
);
4487 /* Try to add the element to the target DB */
4488 deleteIfVolatile(dst
,c
->argv
[1]);
4489 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4490 addReply(c
,shared
.czero
);
4493 incrRefCount(c
->argv
[1]);
4496 /* OK! key moved, free the entry in the source DB */
4497 deleteKey(src
,c
->argv
[1]);
4499 addReply(c
,shared
.cone
);
4502 /* =================================== Lists ================================ */
4503 static void pushGenericCommand(redisClient
*c
, int where
) {
4507 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4509 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4510 addReply(c
,shared
.cone
);
4513 lobj
= createListObject();
4515 if (where
== REDIS_HEAD
) {
4516 listAddNodeHead(list
,c
->argv
[2]);
4518 listAddNodeTail(list
,c
->argv
[2]);
4520 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4521 incrRefCount(c
->argv
[1]);
4522 incrRefCount(c
->argv
[2]);
4524 if (lobj
->type
!= REDIS_LIST
) {
4525 addReply(c
,shared
.wrongtypeerr
);
4528 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4529 addReply(c
,shared
.cone
);
4533 if (where
== REDIS_HEAD
) {
4534 listAddNodeHead(list
,c
->argv
[2]);
4536 listAddNodeTail(list
,c
->argv
[2]);
4538 incrRefCount(c
->argv
[2]);
4541 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4544 static void lpushCommand(redisClient
*c
) {
4545 pushGenericCommand(c
,REDIS_HEAD
);
4548 static void rpushCommand(redisClient
*c
) {
4549 pushGenericCommand(c
,REDIS_TAIL
);
4552 static void llenCommand(redisClient
*c
) {
4556 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4557 checkType(c
,o
,REDIS_LIST
)) return;
4560 addReplyUlong(c
,listLength(l
));
4563 static void lindexCommand(redisClient
*c
) {
4565 int index
= atoi(c
->argv
[2]->ptr
);
4569 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4570 checkType(c
,o
,REDIS_LIST
)) return;
4573 ln
= listIndex(list
, index
);
4575 addReply(c
,shared
.nullbulk
);
4577 robj
*ele
= listNodeValue(ln
);
4578 addReplyBulk(c
,ele
);
4582 static void lsetCommand(redisClient
*c
) {
4584 int index
= atoi(c
->argv
[2]->ptr
);
4588 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4589 checkType(c
,o
,REDIS_LIST
)) return;
4592 ln
= listIndex(list
, index
);
4594 addReply(c
,shared
.outofrangeerr
);
4596 robj
*ele
= listNodeValue(ln
);
4599 listNodeValue(ln
) = c
->argv
[3];
4600 incrRefCount(c
->argv
[3]);
4601 addReply(c
,shared
.ok
);
4606 static void popGenericCommand(redisClient
*c
, int where
) {
4611 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4612 checkType(c
,o
,REDIS_LIST
)) return;
4615 if (where
== REDIS_HEAD
)
4616 ln
= listFirst(list
);
4618 ln
= listLast(list
);
4621 addReply(c
,shared
.nullbulk
);
4623 robj
*ele
= listNodeValue(ln
);
4624 addReplyBulk(c
,ele
);
4625 listDelNode(list
,ln
);
4626 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4631 static void lpopCommand(redisClient
*c
) {
4632 popGenericCommand(c
,REDIS_HEAD
);
4635 static void rpopCommand(redisClient
*c
) {
4636 popGenericCommand(c
,REDIS_TAIL
);
4639 static void lrangeCommand(redisClient
*c
) {
4641 int start
= atoi(c
->argv
[2]->ptr
);
4642 int end
= atoi(c
->argv
[3]->ptr
);
4649 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4650 || checkType(c
,o
,REDIS_LIST
)) return;
4652 llen
= listLength(list
);
4654 /* convert negative indexes */
4655 if (start
< 0) start
= llen
+start
;
4656 if (end
< 0) end
= llen
+end
;
4657 if (start
< 0) start
= 0;
4658 if (end
< 0) end
= 0;
4660 /* indexes sanity checks */
4661 if (start
> end
|| start
>= llen
) {
4662 /* Out of range start or start > end result in empty list */
4663 addReply(c
,shared
.emptymultibulk
);
4666 if (end
>= llen
) end
= llen
-1;
4667 rangelen
= (end
-start
)+1;
4669 /* Return the result in form of a multi-bulk reply */
4670 ln
= listIndex(list
, start
);
4671 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4672 for (j
= 0; j
< rangelen
; j
++) {
4673 ele
= listNodeValue(ln
);
4674 addReplyBulk(c
,ele
);
4679 static void ltrimCommand(redisClient
*c
) {
4681 int start
= atoi(c
->argv
[2]->ptr
);
4682 int end
= atoi(c
->argv
[3]->ptr
);
4684 int j
, ltrim
, rtrim
;
4688 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4689 checkType(c
,o
,REDIS_LIST
)) return;
4691 llen
= listLength(list
);
4693 /* convert negative indexes */
4694 if (start
< 0) start
= llen
+start
;
4695 if (end
< 0) end
= llen
+end
;
4696 if (start
< 0) start
= 0;
4697 if (end
< 0) end
= 0;
4699 /* indexes sanity checks */
4700 if (start
> end
|| start
>= llen
) {
4701 /* Out of range start or start > end result in empty list */
4705 if (end
>= llen
) end
= llen
-1;
4710 /* Remove list elements to perform the trim */
4711 for (j
= 0; j
< ltrim
; j
++) {
4712 ln
= listFirst(list
);
4713 listDelNode(list
,ln
);
4715 for (j
= 0; j
< rtrim
; j
++) {
4716 ln
= listLast(list
);
4717 listDelNode(list
,ln
);
4719 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4721 addReply(c
,shared
.ok
);
4724 static void lremCommand(redisClient
*c
) {
4727 listNode
*ln
, *next
;
4728 int toremove
= atoi(c
->argv
[2]->ptr
);
4732 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4733 checkType(c
,o
,REDIS_LIST
)) return;
4737 toremove
= -toremove
;
4740 ln
= fromtail
? list
->tail
: list
->head
;
4742 robj
*ele
= listNodeValue(ln
);
4744 next
= fromtail
? ln
->prev
: ln
->next
;
4745 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4746 listDelNode(list
,ln
);
4749 if (toremove
&& removed
== toremove
) break;
4753 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4754 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4757 /* This is the semantic of this command:
4758 * RPOPLPUSH srclist dstlist:
4759 * IF LLEN(srclist) > 0
4760 * element = RPOP srclist
4761 * LPUSH dstlist element
4768 * The idea is to be able to get an element from a list in a reliable way
4769 * since the element is not just returned but pushed against another list
4770 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4772 static void rpoplpushcommand(redisClient
*c
) {
4777 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4778 checkType(c
,sobj
,REDIS_LIST
)) return;
4779 srclist
= sobj
->ptr
;
4780 ln
= listLast(srclist
);
4783 addReply(c
,shared
.nullbulk
);
4785 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4786 robj
*ele
= listNodeValue(ln
);
4789 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4790 addReply(c
,shared
.wrongtypeerr
);
4794 /* Add the element to the target list (unless it's directly
4795 * passed to some BLPOP-ing client */
4796 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4798 /* Create the list if the key does not exist */
4799 dobj
= createListObject();
4800 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4801 incrRefCount(c
->argv
[2]);
4803 dstlist
= dobj
->ptr
;
4804 listAddNodeHead(dstlist
,ele
);
4808 /* Send the element to the client as reply as well */
4809 addReplyBulk(c
,ele
);
4811 /* Finally remove the element from the source list */
4812 listDelNode(srclist
,ln
);
4813 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4818 /* ==================================== Sets ================================ */
4820 static void saddCommand(redisClient
*c
) {
4823 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4825 set
= createSetObject();
4826 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4827 incrRefCount(c
->argv
[1]);
4829 if (set
->type
!= REDIS_SET
) {
4830 addReply(c
,shared
.wrongtypeerr
);
4834 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4835 incrRefCount(c
->argv
[2]);
4837 addReply(c
,shared
.cone
);
4839 addReply(c
,shared
.czero
);
4843 static void sremCommand(redisClient
*c
) {
4846 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4847 checkType(c
,set
,REDIS_SET
)) return;
4849 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4851 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4852 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4853 addReply(c
,shared
.cone
);
4855 addReply(c
,shared
.czero
);
4859 static void smoveCommand(redisClient
*c
) {
4860 robj
*srcset
, *dstset
;
4862 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4863 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4865 /* If the source key does not exist return 0, if it's of the wrong type
4867 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4868 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4871 /* Error if the destination key is not a set as well */
4872 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4873 addReply(c
,shared
.wrongtypeerr
);
4876 /* Remove the element from the source set */
4877 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4878 /* Key not found in the src set! return zero */
4879 addReply(c
,shared
.czero
);
4882 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4883 deleteKey(c
->db
,c
->argv
[1]);
4885 /* Add the element to the destination set */
4887 dstset
= createSetObject();
4888 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4889 incrRefCount(c
->argv
[2]);
4891 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4892 incrRefCount(c
->argv
[3]);
4893 addReply(c
,shared
.cone
);
4896 static void sismemberCommand(redisClient
*c
) {
4899 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4900 checkType(c
,set
,REDIS_SET
)) return;
4902 if (dictFind(set
->ptr
,c
->argv
[2]))
4903 addReply(c
,shared
.cone
);
4905 addReply(c
,shared
.czero
);
4908 static void scardCommand(redisClient
*c
) {
4912 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4913 checkType(c
,o
,REDIS_SET
)) return;
4916 addReplyUlong(c
,dictSize(s
));
4919 static void spopCommand(redisClient
*c
) {
4923 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4924 checkType(c
,set
,REDIS_SET
)) return;
4926 de
= dictGetRandomKey(set
->ptr
);
4928 addReply(c
,shared
.nullbulk
);
4930 robj
*ele
= dictGetEntryKey(de
);
4932 addReplyBulk(c
,ele
);
4933 dictDelete(set
->ptr
,ele
);
4934 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4935 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4940 static void srandmemberCommand(redisClient
*c
) {
4944 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4945 checkType(c
,set
,REDIS_SET
)) return;
4947 de
= dictGetRandomKey(set
->ptr
);
4949 addReply(c
,shared
.nullbulk
);
4951 robj
*ele
= dictGetEntryKey(de
);
4953 addReplyBulk(c
,ele
);
4957 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4958 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4960 return dictSize(*d1
)-dictSize(*d2
);
4963 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4964 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4967 robj
*lenobj
= NULL
, *dstset
= NULL
;
4968 unsigned long j
, cardinality
= 0;
4970 for (j
= 0; j
< setsnum
; j
++) {
4974 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4975 lookupKeyRead(c
->db
,setskeys
[j
]);
4979 if (deleteKey(c
->db
,dstkey
))
4981 addReply(c
,shared
.czero
);
4983 addReply(c
,shared
.emptymultibulk
);
4987 if (setobj
->type
!= REDIS_SET
) {
4989 addReply(c
,shared
.wrongtypeerr
);
4992 dv
[j
] = setobj
->ptr
;
4994 /* Sort sets from the smallest to largest, this will improve our
4995 * algorithm's performace */
4996 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4998 /* The first thing we should output is the total number of elements...
4999 * since this is a multi-bulk write, but at this stage we don't know
5000 * the intersection set size, so we use a trick, append an empty object
5001 * to the output list and save the pointer to later modify it with the
5004 lenobj
= createObject(REDIS_STRING
,NULL
);
5006 decrRefCount(lenobj
);
5008 /* If we have a target key where to store the resulting set
5009 * create this key with an empty set inside */
5010 dstset
= createSetObject();
5013 /* Iterate all the elements of the first (smallest) set, and test
5014 * the element against all the other sets, if at least one set does
5015 * not include the element it is discarded */
5016 di
= dictGetIterator(dv
[0]);
5018 while((de
= dictNext(di
)) != NULL
) {
5021 for (j
= 1; j
< setsnum
; j
++)
5022 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5024 continue; /* at least one set does not contain the member */
5025 ele
= dictGetEntryKey(de
);
5027 addReplyBulk(c
,ele
);
5030 dictAdd(dstset
->ptr
,ele
,NULL
);
5034 dictReleaseIterator(di
);
5037 /* Store the resulting set into the target, if the intersection
5038 * is not an empty set. */
5039 deleteKey(c
->db
,dstkey
);
5040 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5041 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5042 incrRefCount(dstkey
);
5043 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5045 decrRefCount(dstset
);
5046 addReply(c
,shared
.czero
);
5050 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5055 static void sinterCommand(redisClient
*c
) {
5056 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5059 static void sinterstoreCommand(redisClient
*c
) {
5060 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5063 #define REDIS_OP_UNION 0
5064 #define REDIS_OP_DIFF 1
5065 #define REDIS_OP_INTER 2
5067 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5068 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5071 robj
*dstset
= NULL
;
5072 int j
, cardinality
= 0;
5074 for (j
= 0; j
< setsnum
; j
++) {
5078 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5079 lookupKeyRead(c
->db
,setskeys
[j
]);
5084 if (setobj
->type
!= REDIS_SET
) {
5086 addReply(c
,shared
.wrongtypeerr
);
5089 dv
[j
] = setobj
->ptr
;
5092 /* We need a temp set object to store our union. If the dstkey
5093 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5094 * this set object will be the resulting object to set into the target key*/
5095 dstset
= createSetObject();
5097 /* Iterate all the elements of all the sets, add every element a single
5098 * time to the result set */
5099 for (j
= 0; j
< setsnum
; j
++) {
5100 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5101 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5103 di
= dictGetIterator(dv
[j
]);
5105 while((de
= dictNext(di
)) != NULL
) {
5108 /* dictAdd will not add the same element multiple times */
5109 ele
= dictGetEntryKey(de
);
5110 if (op
== REDIS_OP_UNION
|| j
== 0) {
5111 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5115 } else if (op
== REDIS_OP_DIFF
) {
5116 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5121 dictReleaseIterator(di
);
5123 /* result set is empty? Exit asap. */
5124 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5127 /* Output the content of the resulting set, if not in STORE mode */
5129 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5130 di
= dictGetIterator(dstset
->ptr
);
5131 while((de
= dictNext(di
)) != NULL
) {
5134 ele
= dictGetEntryKey(de
);
5135 addReplyBulk(c
,ele
);
5137 dictReleaseIterator(di
);
5138 decrRefCount(dstset
);
5140 /* If we have a target key where to store the resulting set
5141 * create this key with the result set inside */
5142 deleteKey(c
->db
,dstkey
);
5143 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5144 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5145 incrRefCount(dstkey
);
5146 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5148 decrRefCount(dstset
);
5149 addReply(c
,shared
.czero
);
5156 static void sunionCommand(redisClient
*c
) {
5157 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5160 static void sunionstoreCommand(redisClient
*c
) {
5161 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5164 static void sdiffCommand(redisClient
*c
) {
5165 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5168 static void sdiffstoreCommand(redisClient
*c
) {
5169 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5172 /* ==================================== ZSets =============================== */
5174 /* ZSETs are ordered sets using two data structures to hold the same elements
5175 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5178 * The elements are added to an hash table mapping Redis objects to scores.
5179 * At the same time the elements are added to a skip list mapping scores
5180 * to Redis objects (so objects are sorted by scores in this "view"). */
5182 /* This skiplist implementation is almost a C translation of the original
5183 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5184 * Alternative to Balanced Trees", modified in three ways:
5185 * a) this implementation allows for repeated values.
5186 * b) the comparison is not just by key (our 'score') but by satellite data.
5187 * c) there is a back pointer, so it's a doubly linked list with the back
5188 * pointers being only at "level 1". This allows to traverse the list
5189 * from tail to head, useful for ZREVRANGE. */
5191 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5192 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5194 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5196 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5202 static zskiplist
*zslCreate(void) {
5206 zsl
= zmalloc(sizeof(*zsl
));
5209 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5210 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5211 zsl
->header
->forward
[j
] = NULL
;
5213 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5214 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5215 zsl
->header
->span
[j
] = 0;
5217 zsl
->header
->backward
= NULL
;
5222 static void zslFreeNode(zskiplistNode
*node
) {
5223 decrRefCount(node
->obj
);
5224 zfree(node
->forward
);
5229 static void zslFree(zskiplist
*zsl
) {
5230 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5232 zfree(zsl
->header
->forward
);
5233 zfree(zsl
->header
->span
);
5236 next
= node
->forward
[0];
5243 static int zslRandomLevel(void) {
5245 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5247 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5250 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5251 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5252 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5256 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5257 /* store rank that is crossed to reach the insert position */
5258 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5260 while (x
->forward
[i
] &&
5261 (x
->forward
[i
]->score
< score
||
5262 (x
->forward
[i
]->score
== score
&&
5263 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5264 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5269 /* we assume the key is not already inside, since we allow duplicated
5270 * scores, and the re-insertion of score and redis object should never
5271 * happpen since the caller of zslInsert() should test in the hash table
5272 * if the element is already inside or not. */
5273 level
= zslRandomLevel();
5274 if (level
> zsl
->level
) {
5275 for (i
= zsl
->level
; i
< level
; i
++) {
5277 update
[i
] = zsl
->header
;
5278 update
[i
]->span
[i
-1] = zsl
->length
;
5282 x
= zslCreateNode(level
,score
,obj
);
5283 for (i
= 0; i
< level
; i
++) {
5284 x
->forward
[i
] = update
[i
]->forward
[i
];
5285 update
[i
]->forward
[i
] = x
;
5287 /* update span covered by update[i] as x is inserted here */
5289 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5290 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5294 /* increment span for untouched levels */
5295 for (i
= level
; i
< zsl
->level
; i
++) {
5296 update
[i
]->span
[i
-1]++;
5299 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5301 x
->forward
[0]->backward
= x
;
5307 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5308 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5310 for (i
= 0; i
< zsl
->level
; i
++) {
5311 if (update
[i
]->forward
[i
] == x
) {
5313 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5315 update
[i
]->forward
[i
] = x
->forward
[i
];
5317 /* invariant: i > 0, because update[0]->forward[0]
5318 * is always equal to x */
5319 update
[i
]->span
[i
-1] -= 1;
5322 if (x
->forward
[0]) {
5323 x
->forward
[0]->backward
= x
->backward
;
5325 zsl
->tail
= x
->backward
;
5327 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5332 /* Delete an element with matching score/object from the skiplist. */
5333 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5334 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5338 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5339 while (x
->forward
[i
] &&
5340 (x
->forward
[i
]->score
< score
||
5341 (x
->forward
[i
]->score
== score
&&
5342 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5346 /* We may have multiple elements with the same score, what we need
5347 * is to find the element with both the right score and object. */
5349 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5350 zslDeleteNode(zsl
, x
, update
);
5354 return 0; /* not found */
5356 return 0; /* not found */
5359 /* Delete all the elements with score between min and max from the skiplist.
5360 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5361 * Note that this function takes the reference to the hash table view of the
5362 * sorted set, in order to remove the elements from the hash table too. */
5363 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5364 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5365 unsigned long removed
= 0;
5369 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5370 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5374 /* We may have multiple elements with the same score, what we need
5375 * is to find the element with both the right score and object. */
5377 while (x
&& x
->score
<= max
) {
5378 zskiplistNode
*next
= x
->forward
[0];
5379 zslDeleteNode(zsl
, x
, update
);
5380 dictDelete(dict
,x
->obj
);
5385 return removed
; /* not found */
5388 /* Delete all the elements with rank between start and end from the skiplist.
5389 * Start and end are inclusive. Note that start and end need to be 1-based */
5390 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5391 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5392 unsigned long traversed
= 0, removed
= 0;
5396 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5397 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5398 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5406 while (x
&& traversed
<= end
) {
5407 zskiplistNode
*next
= x
->forward
[0];
5408 zslDeleteNode(zsl
, x
, update
);
5409 dictDelete(dict
,x
->obj
);
5418 /* Find the first node having a score equal or greater than the specified one.
5419 * Returns NULL if there is no match. */
5420 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5425 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5426 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5429 /* We may have multiple elements with the same score, what we need
5430 * is to find the element with both the right score and object. */
5431 return x
->forward
[0];
5434 /* Find the rank for an element by both score and key.
5435 * Returns 0 when the element cannot be found, rank otherwise.
5436 * Note that the rank is 1-based due to the span of zsl->header to the
5438 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5440 unsigned long rank
= 0;
5444 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5445 while (x
->forward
[i
] &&
5446 (x
->forward
[i
]->score
< score
||
5447 (x
->forward
[i
]->score
== score
&&
5448 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5449 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5453 /* x might be equal to zsl->header, so test if obj is non-NULL */
5454 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5461 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5462 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5464 unsigned long traversed
= 0;
5468 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5469 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5471 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5474 if (traversed
== rank
) {
5481 /* The actual Z-commands implementations */
5483 /* This generic command implements both ZADD and ZINCRBY.
5484 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5485 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5486 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5491 zsetobj
= lookupKeyWrite(c
->db
,key
);
5492 if (zsetobj
== NULL
) {
5493 zsetobj
= createZsetObject();
5494 dictAdd(c
->db
->dict
,key
,zsetobj
);
5497 if (zsetobj
->type
!= REDIS_ZSET
) {
5498 addReply(c
,shared
.wrongtypeerr
);
5504 /* Ok now since we implement both ZADD and ZINCRBY here the code
5505 * needs to handle the two different conditions. It's all about setting
5506 * '*score', that is, the new score to set, to the right value. */
5507 score
= zmalloc(sizeof(double));
5511 /* Read the old score. If the element was not present starts from 0 */
5512 de
= dictFind(zs
->dict
,ele
);
5514 double *oldscore
= dictGetEntryVal(de
);
5515 *score
= *oldscore
+ scoreval
;
5523 /* What follows is a simple remove and re-insert operation that is common
5524 * to both ZADD and ZINCRBY... */
5525 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5526 /* case 1: New element */
5527 incrRefCount(ele
); /* added to hash */
5528 zslInsert(zs
->zsl
,*score
,ele
);
5529 incrRefCount(ele
); /* added to skiplist */
5532 addReplyDouble(c
,*score
);
5534 addReply(c
,shared
.cone
);
5539 /* case 2: Score update operation */
5540 de
= dictFind(zs
->dict
,ele
);
5541 redisAssert(de
!= NULL
);
5542 oldscore
= dictGetEntryVal(de
);
5543 if (*score
!= *oldscore
) {
5546 /* Remove and insert the element in the skip list with new score */
5547 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5548 redisAssert(deleted
!= 0);
5549 zslInsert(zs
->zsl
,*score
,ele
);
5551 /* Update the score in the hash table */
5552 dictReplace(zs
->dict
,ele
,score
);
5558 addReplyDouble(c
,*score
);
5560 addReply(c
,shared
.czero
);
5564 static void zaddCommand(redisClient
*c
) {
5567 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5568 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5571 static void zincrbyCommand(redisClient
*c
) {
5574 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5575 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5578 static void zremCommand(redisClient
*c
) {
5585 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5586 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5589 de
= dictFind(zs
->dict
,c
->argv
[2]);
5591 addReply(c
,shared
.czero
);
5594 /* Delete from the skiplist */
5595 oldscore
= dictGetEntryVal(de
);
5596 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5597 redisAssert(deleted
!= 0);
5599 /* Delete from the hash table */
5600 dictDelete(zs
->dict
,c
->argv
[2]);
5601 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5602 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5604 addReply(c
,shared
.cone
);
5607 static void zremrangebyscoreCommand(redisClient
*c
) {
5614 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5615 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5617 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5618 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5621 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5622 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5623 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5624 server
.dirty
+= deleted
;
5625 addReplyLong(c
,deleted
);
5628 static void zremrangebyrankCommand(redisClient
*c
) {
5636 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5637 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5639 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5640 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5642 llen
= zs
->zsl
->length
;
5644 /* convert negative indexes */
5645 if (start
< 0) start
= llen
+start
;
5646 if (end
< 0) end
= llen
+end
;
5647 if (start
< 0) start
= 0;
5648 if (end
< 0) end
= 0;
5650 /* indexes sanity checks */
5651 if (start
> end
|| start
>= llen
) {
5652 addReply(c
,shared
.czero
);
5655 if (end
>= llen
) end
= llen
-1;
5657 /* increment start and end because zsl*Rank functions
5658 * use 1-based rank */
5659 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5660 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5661 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5662 server
.dirty
+= deleted
;
5663 addReplyLong(c
, deleted
);
5671 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5672 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5673 unsigned long size1
, size2
;
5674 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5675 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5676 return size1
- size2
;
5679 #define REDIS_AGGR_SUM 1
5680 #define REDIS_AGGR_MIN 2
5681 #define REDIS_AGGR_MAX 3
5683 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5684 if (aggregate
== REDIS_AGGR_SUM
) {
5685 *target
= *target
+ val
;
5686 } else if (aggregate
== REDIS_AGGR_MIN
) {
5687 *target
= val
< *target
? val
: *target
;
5688 } else if (aggregate
== REDIS_AGGR_MAX
) {
5689 *target
= val
> *target
? val
: *target
;
5692 redisPanic("Unknown ZUNION/INTER aggregate type");
5696 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5698 int aggregate
= REDIS_AGGR_SUM
;
5705 /* expect zsetnum input keys to be given */
5706 zsetnum
= atoi(c
->argv
[2]->ptr
);
5708 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5712 /* test if the expected number of keys would overflow */
5713 if (3+zsetnum
> c
->argc
) {
5714 addReply(c
,shared
.syntaxerr
);
5718 /* read keys to be used for input */
5719 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5720 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5721 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5725 if (zsetobj
->type
!= REDIS_ZSET
) {
5727 addReply(c
,shared
.wrongtypeerr
);
5730 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5733 /* default all weights to 1 */
5734 src
[i
].weight
= 1.0;
5737 /* parse optional extra arguments */
5739 int remaining
= c
->argc
- j
;
5742 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5744 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5745 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5748 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5750 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5751 aggregate
= REDIS_AGGR_SUM
;
5752 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5753 aggregate
= REDIS_AGGR_MIN
;
5754 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5755 aggregate
= REDIS_AGGR_MAX
;
5758 addReply(c
,shared
.syntaxerr
);
5764 addReply(c
,shared
.syntaxerr
);
5770 /* sort sets from the smallest to largest, this will improve our
5771 * algorithm's performance */
5772 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5774 dstobj
= createZsetObject();
5775 dstzset
= dstobj
->ptr
;
5777 if (op
== REDIS_OP_INTER
) {
5778 /* skip going over all entries if the smallest zset is NULL or empty */
5779 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5780 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5781 * from small to large, all src[i > 0].dict are non-empty too */
5782 di
= dictGetIterator(src
[0].dict
);
5783 while((de
= dictNext(di
)) != NULL
) {
5784 double *score
= zmalloc(sizeof(double)), value
;
5785 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5787 for (j
= 1; j
< zsetnum
; j
++) {
5788 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5790 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5791 zunionInterAggregate(score
, value
, aggregate
);
5797 /* skip entry when not present in every source dict */
5801 robj
*o
= dictGetEntryKey(de
);
5802 dictAdd(dstzset
->dict
,o
,score
);
5803 incrRefCount(o
); /* added to dictionary */
5804 zslInsert(dstzset
->zsl
,*score
,o
);
5805 incrRefCount(o
); /* added to skiplist */
5808 dictReleaseIterator(di
);
5810 } else if (op
== REDIS_OP_UNION
) {
5811 for (i
= 0; i
< zsetnum
; i
++) {
5812 if (!src
[i
].dict
) continue;
5814 di
= dictGetIterator(src
[i
].dict
);
5815 while((de
= dictNext(di
)) != NULL
) {
5816 /* skip key when already processed */
5817 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5819 double *score
= zmalloc(sizeof(double)), value
;
5820 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5822 /* because the zsets are sorted by size, its only possible
5823 * for sets at larger indices to hold this entry */
5824 for (j
= (i
+1); j
< zsetnum
; j
++) {
5825 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5827 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5828 zunionInterAggregate(score
, value
, aggregate
);
5832 robj
*o
= dictGetEntryKey(de
);
5833 dictAdd(dstzset
->dict
,o
,score
);
5834 incrRefCount(o
); /* added to dictionary */
5835 zslInsert(dstzset
->zsl
,*score
,o
);
5836 incrRefCount(o
); /* added to skiplist */
5838 dictReleaseIterator(di
);
5841 /* unknown operator */
5842 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5845 deleteKey(c
->db
,dstkey
);
5846 if (dstzset
->zsl
->length
) {
5847 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5848 incrRefCount(dstkey
);
5849 addReplyLong(c
, dstzset
->zsl
->length
);
5852 decrRefCount(dstobj
);
5853 addReply(c
, shared
.czero
);
5858 static void zunionCommand(redisClient
*c
) {
5859 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5862 static void zinterCommand(redisClient
*c
) {
5863 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5866 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5878 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5879 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5881 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5883 } else if (c
->argc
>= 5) {
5884 addReply(c
,shared
.syntaxerr
);
5888 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5889 || checkType(c
,o
,REDIS_ZSET
)) return;
5894 /* convert negative indexes */
5895 if (start
< 0) start
= llen
+start
;
5896 if (end
< 0) end
= llen
+end
;
5897 if (start
< 0) start
= 0;
5898 if (end
< 0) end
= 0;
5900 /* indexes sanity checks */
5901 if (start
> end
|| start
>= llen
) {
5902 /* Out of range start or start > end result in empty list */
5903 addReply(c
,shared
.emptymultibulk
);
5906 if (end
>= llen
) end
= llen
-1;
5907 rangelen
= (end
-start
)+1;
5909 /* check if starting point is trivial, before searching
5910 * the element in log(N) time */
5912 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5915 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5918 /* Return the result in form of a multi-bulk reply */
5919 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5920 withscores
? (rangelen
*2) : rangelen
));
5921 for (j
= 0; j
< rangelen
; j
++) {
5923 addReplyBulk(c
,ele
);
5925 addReplyDouble(c
,ln
->score
);
5926 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5930 static void zrangeCommand(redisClient
*c
) {
5931 zrangeGenericCommand(c
,0);
5934 static void zrevrangeCommand(redisClient
*c
) {
5935 zrangeGenericCommand(c
,1);
5938 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5939 * If justcount is non-zero, just the count is returned. */
5940 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5943 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5944 int offset
= 0, limit
= -1;
5948 /* Parse the min-max interval. If one of the values is prefixed
5949 * by the "(" character, it's considered "open". For instance
5950 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5951 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5952 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5953 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5956 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5958 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5959 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5962 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5965 /* Parse "WITHSCORES": note that if the command was called with
5966 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5967 * enter the following paths to parse WITHSCORES and LIMIT. */
5968 if (c
->argc
== 5 || c
->argc
== 8) {
5969 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5974 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5978 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5983 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5984 addReply(c
,shared
.syntaxerr
);
5986 } else if (c
->argc
== (7 + withscores
)) {
5987 offset
= atoi(c
->argv
[5]->ptr
);
5988 limit
= atoi(c
->argv
[6]->ptr
);
5989 if (offset
< 0) offset
= 0;
5992 /* Ok, lookup the key and get the range */
5993 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5995 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5997 if (o
->type
!= REDIS_ZSET
) {
5998 addReply(c
,shared
.wrongtypeerr
);
6000 zset
*zsetobj
= o
->ptr
;
6001 zskiplist
*zsl
= zsetobj
->zsl
;
6003 robj
*ele
, *lenobj
= NULL
;
6004 unsigned long rangelen
= 0;
6006 /* Get the first node with the score >= min, or with
6007 * score > min if 'minex' is true. */
6008 ln
= zslFirstWithScore(zsl
,min
);
6009 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6012 /* No element matching the speciifed interval */
6013 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6017 /* We don't know in advance how many matching elements there
6018 * are in the list, so we push this object that will represent
6019 * the multi-bulk length in the output buffer, and will "fix"
6022 lenobj
= createObject(REDIS_STRING
,NULL
);
6024 decrRefCount(lenobj
);
6027 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6030 ln
= ln
->forward
[0];
6033 if (limit
== 0) break;
6036 addReplyBulk(c
,ele
);
6038 addReplyDouble(c
,ln
->score
);
6040 ln
= ln
->forward
[0];
6042 if (limit
> 0) limit
--;
6045 addReplyLong(c
,(long)rangelen
);
6047 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6048 withscores
? (rangelen
*2) : rangelen
);
6054 static void zrangebyscoreCommand(redisClient
*c
) {
6055 genericZrangebyscoreCommand(c
,0);
6058 static void zcountCommand(redisClient
*c
) {
6059 genericZrangebyscoreCommand(c
,1);
6062 static void zcardCommand(redisClient
*c
) {
6066 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6067 checkType(c
,o
,REDIS_ZSET
)) return;
6070 addReplyUlong(c
,zs
->zsl
->length
);
6073 static void zscoreCommand(redisClient
*c
) {
6078 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6079 checkType(c
,o
,REDIS_ZSET
)) return;
6082 de
= dictFind(zs
->dict
,c
->argv
[2]);
6084 addReply(c
,shared
.nullbulk
);
6086 double *score
= dictGetEntryVal(de
);
6088 addReplyDouble(c
,*score
);
6092 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6100 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6101 checkType(c
,o
,REDIS_ZSET
)) return;
6105 de
= dictFind(zs
->dict
,c
->argv
[2]);
6107 addReply(c
,shared
.nullbulk
);
6111 score
= dictGetEntryVal(de
);
6112 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6115 addReplyLong(c
, zsl
->length
- rank
);
6117 addReplyLong(c
, rank
-1);
6120 addReply(c
,shared
.nullbulk
);
6124 static void zrankCommand(redisClient
*c
) {
6125 zrankGenericCommand(c
, 0);
6128 static void zrevrankCommand(redisClient
*c
) {
6129 zrankGenericCommand(c
, 1);
6132 /* ========================= Hashes utility functions ======================= */
6133 #define REDIS_HASH_KEY 1
6134 #define REDIS_HASH_VALUE 2
6136 /* Check the length of a number of objects to see if we need to convert a
6137 * zipmap to a real hash. Note that we only check string encoded objects
6138 * as their string length can be queried in constant time. */
6139 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6141 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6143 for (i
= start
; i
<= end
; i
++) {
6144 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6145 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6147 convertToRealHash(subject
);
6153 /* Encode given objects in-place when the hash uses a dict. */
6154 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6155 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6156 if (o1
) *o1
= tryObjectEncoding(*o1
);
6157 if (o2
) *o2
= tryObjectEncoding(*o2
);
6161 /* Get the value from a hash identified by key. Returns either a string
6162 * object or NULL if the value cannot be found. The refcount of the object
6163 * is always increased by 1 when the value was found. */
6164 static robj
*hashGet(robj
*o
, robj
*key
) {
6166 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6169 key
= getDecodedObject(key
);
6170 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6171 value
= createStringObject((char*)v
,vlen
);
6175 dictEntry
*de
= dictFind(o
->ptr
,key
);
6177 value
= dictGetEntryVal(de
);
6178 incrRefCount(value
);
6184 /* Test if the key exists in the given hash. Returns 1 if the key
6185 * exists and 0 when it doesn't. */
6186 static int hashExists(robj
*o
, robj
*key
) {
6187 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6188 key
= getDecodedObject(key
);
6189 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6195 if (dictFind(o
->ptr
,key
) != NULL
) {
6202 /* Add an element, discard the old if the key already exists.
6203 * Return 0 on insert and 1 on update. */
6204 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6206 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6207 key
= getDecodedObject(key
);
6208 value
= getDecodedObject(value
);
6209 o
->ptr
= zipmapSet(o
->ptr
,
6210 key
->ptr
,sdslen(key
->ptr
),
6211 value
->ptr
,sdslen(value
->ptr
), &update
);
6213 decrRefCount(value
);
6215 /* Check if the zipmap needs to be upgraded to a real hash table */
6216 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6217 convertToRealHash(o
);
6219 if (dictReplace(o
->ptr
,key
,value
)) {
6226 incrRefCount(value
);
6231 /* Delete an element from a hash.
6232 * Return 1 on deleted and 0 on not found. */
6233 static int hashDelete(robj
*o
, robj
*key
) {
6235 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6236 key
= getDecodedObject(key
);
6237 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6240 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6241 /* Always check if the dictionary needs a resize after a delete. */
6242 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6247 /* Return the number of elements in a hash. */
6248 static unsigned long hashLength(robj
*o
) {
6249 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6250 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6253 /* Structure to hold hash iteration abstration. Note that iteration over
6254 * hashes involves both fields and values. Because it is possible that
6255 * not both are required, store pointers in the iterator to avoid
6256 * unnecessary memory allocation for fields/values. */
6260 unsigned char *zk
, *zv
;
6261 unsigned int zklen
, zvlen
;
6267 static hashIterator
*hashInitIterator(robj
*subject
) {
6268 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6269 hi
->encoding
= subject
->encoding
;
6270 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6271 hi
->zi
= zipmapRewind(subject
->ptr
);
6272 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6273 hi
->di
= dictGetIterator(subject
->ptr
);
6280 static void hashReleaseIterator(hashIterator
*hi
) {
6281 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6282 dictReleaseIterator(hi
->di
);
6287 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6288 * could be found and REDIS_ERR when the iterator reaches the end. */
6289 static int hashNext(hashIterator
*hi
) {
6290 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6291 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6292 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6294 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6299 /* Get key or value object at current iteration position.
6300 * This increases the refcount of the field object by 1. */
6301 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6303 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6304 if (what
& REDIS_HASH_KEY
) {
6305 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6307 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6310 if (what
& REDIS_HASH_KEY
) {
6311 o
= dictGetEntryKey(hi
->de
);
6313 o
= dictGetEntryVal(hi
->de
);
6320 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6321 robj
*o
= lookupKeyWrite(c
->db
,key
);
6323 o
= createHashObject();
6324 dictAdd(c
->db
->dict
,key
,o
);
6327 if (o
->type
!= REDIS_HASH
) {
6328 addReply(c
,shared
.wrongtypeerr
);
6335 /* ============================= Hash commands ============================== */
6336 static void hsetCommand(redisClient
*c
) {
6340 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6341 hashTryConversion(o
,c
->argv
,2,3);
6342 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6343 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6344 addReply(c
, update
? shared
.czero
: shared
.cone
);
6348 static void hsetnxCommand(redisClient
*c
) {
6350 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6351 hashTryConversion(o
,c
->argv
,2,3);
6353 if (hashExists(o
, c
->argv
[2])) {
6354 addReply(c
, shared
.czero
);
6356 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6357 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6358 addReply(c
, shared
.cone
);
6363 static void hmsetCommand(redisClient
*c
) {
6367 if ((c
->argc
% 2) == 1) {
6368 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6372 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6373 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6374 for (i
= 2; i
< c
->argc
; i
+= 2) {
6375 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6376 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6378 addReply(c
, shared
.ok
);
6382 static void hincrbyCommand(redisClient
*c
) {
6383 long long value
, incr
;
6384 robj
*o
, *current
, *new;
6386 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6387 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6388 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6389 if (current
->encoding
== REDIS_ENCODING_RAW
)
6390 value
= strtoll(current
->ptr
,NULL
,10);
6391 else if (current
->encoding
== REDIS_ENCODING_INT
)
6392 value
= (long)current
->ptr
;
6394 redisAssert(1 != 1);
6395 decrRefCount(current
);
6401 new = createStringObjectFromLongLong(value
);
6402 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6403 hashSet(o
,c
->argv
[2],new);
6405 addReplyLongLong(c
,value
);
6409 static void hgetCommand(redisClient
*c
) {
6411 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6412 checkType(c
,o
,REDIS_HASH
)) return;
6414 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6415 addReplyBulk(c
,value
);
6416 decrRefCount(value
);
6418 addReply(c
,shared
.nullbulk
);
6422 static void hmgetCommand(redisClient
*c
) {
6425 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6426 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6427 addReply(c
,shared
.wrongtypeerr
);
6430 /* Note the check for o != NULL happens inside the loop. This is
6431 * done because objects that cannot be found are considered to be
6432 * an empty hash. The reply should then be a series of NULLs. */
6433 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6434 for (i
= 2; i
< c
->argc
; i
++) {
6435 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6436 addReplyBulk(c
,value
);
6437 decrRefCount(value
);
6439 addReply(c
,shared
.nullbulk
);
6444 static void hdelCommand(redisClient
*c
) {
6446 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6447 checkType(c
,o
,REDIS_HASH
)) return;
6449 if (hashDelete(o
,c
->argv
[2])) {
6450 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6451 addReply(c
,shared
.cone
);
6454 addReply(c
,shared
.czero
);
6458 static void hlenCommand(redisClient
*c
) {
6460 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6461 checkType(c
,o
,REDIS_HASH
)) return;
6463 addReplyUlong(c
,hashLength(o
));
6466 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6467 robj
*o
, *lenobj
, *obj
;
6468 unsigned long count
= 0;
6471 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6472 || checkType(c
,o
,REDIS_HASH
)) return;
6474 lenobj
= createObject(REDIS_STRING
,NULL
);
6476 decrRefCount(lenobj
);
6478 hi
= hashInitIterator(o
);
6479 while (hashNext(hi
) != REDIS_ERR
) {
6480 if (flags
& REDIS_HASH_KEY
) {
6481 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6482 addReplyBulk(c
,obj
);
6486 if (flags
& REDIS_HASH_VALUE
) {
6487 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6488 addReplyBulk(c
,obj
);
6493 hashReleaseIterator(hi
);
6495 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6498 static void hkeysCommand(redisClient
*c
) {
6499 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6502 static void hvalsCommand(redisClient
*c
) {
6503 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6506 static void hgetallCommand(redisClient
*c
) {
6507 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6510 static void hexistsCommand(redisClient
*c
) {
6512 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6513 checkType(c
,o
,REDIS_HASH
)) return;
6515 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6518 static void convertToRealHash(robj
*o
) {
6519 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6520 unsigned int klen
, vlen
;
6521 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6523 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6524 p
= zipmapRewind(zm
);
6525 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6526 robj
*keyobj
, *valobj
;
6528 keyobj
= createStringObject((char*)key
,klen
);
6529 valobj
= createStringObject((char*)val
,vlen
);
6530 keyobj
= tryObjectEncoding(keyobj
);
6531 valobj
= tryObjectEncoding(valobj
);
6532 dictAdd(dict
,keyobj
,valobj
);
6534 o
->encoding
= REDIS_ENCODING_HT
;
6539 /* ========================= Non type-specific commands ==================== */
6541 static void flushdbCommand(redisClient
*c
) {
6542 server
.dirty
+= dictSize(c
->db
->dict
);
6543 dictEmpty(c
->db
->dict
);
6544 dictEmpty(c
->db
->expires
);
6545 addReply(c
,shared
.ok
);
6548 static void flushallCommand(redisClient
*c
) {
6549 server
.dirty
+= emptyDb();
6550 addReply(c
,shared
.ok
);
6551 if (server
.bgsavechildpid
!= -1) {
6552 kill(server
.bgsavechildpid
,SIGKILL
);
6553 rdbRemoveTempFile(server
.bgsavechildpid
);
6555 rdbSave(server
.dbfilename
);
6559 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6560 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6562 so
->pattern
= pattern
;
6566 /* Return the value associated to the key with a name obtained
6567 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6568 * The returned object will always have its refcount increased by 1
6569 * when it is non-NULL. */
6570 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6573 robj keyobj
, fieldobj
, *o
;
6574 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6575 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6579 char buf
[REDIS_SORTKEY_MAX
+1];
6580 } keyname
, fieldname
;
6582 /* If the pattern is "#" return the substitution object itself in order
6583 * to implement the "SORT ... GET #" feature. */
6584 spat
= pattern
->ptr
;
6585 if (spat
[0] == '#' && spat
[1] == '\0') {
6586 incrRefCount(subst
);
6590 /* The substitution object may be specially encoded. If so we create
6591 * a decoded object on the fly. Otherwise getDecodedObject will just
6592 * increment the ref count, that we'll decrement later. */
6593 subst
= getDecodedObject(subst
);
6596 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6597 p
= strchr(spat
,'*');
6599 decrRefCount(subst
);
6603 /* Find out if we're dealing with a hash dereference. */
6604 if ((f
= strstr(p
+1, "->")) != NULL
) {
6605 fieldlen
= sdslen(spat
)-(f
-spat
);
6606 /* this also copies \0 character */
6607 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6608 fieldname
.len
= fieldlen
-2;
6614 sublen
= sdslen(ssub
);
6615 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6616 memcpy(keyname
.buf
,spat
,prefixlen
);
6617 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6618 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6619 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6620 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6621 decrRefCount(subst
);
6623 /* Lookup substituted key */
6624 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6625 o
= lookupKeyRead(db
,&keyobj
);
6626 if (o
== NULL
) return NULL
;
6629 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6631 /* Retrieve value from hash by the field name. This operation
6632 * already increases the refcount of the returned object. */
6633 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6634 o
= hashGet(o
, &fieldobj
);
6636 if (o
->type
!= REDIS_STRING
) return NULL
;
6638 /* Every object that this function returns needs to have its refcount
6639 * increased. sortCommand decreases it again. */
6646 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6647 * the additional parameter is not standard but a BSD-specific we have to
6648 * pass sorting parameters via the global 'server' structure */
6649 static int sortCompare(const void *s1
, const void *s2
) {
6650 const redisSortObject
*so1
= s1
, *so2
= s2
;
6653 if (!server
.sort_alpha
) {
6654 /* Numeric sorting. Here it's trivial as we precomputed scores */
6655 if (so1
->u
.score
> so2
->u
.score
) {
6657 } else if (so1
->u
.score
< so2
->u
.score
) {
6663 /* Alphanumeric sorting */
6664 if (server
.sort_bypattern
) {
6665 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6666 /* At least one compare object is NULL */
6667 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6669 else if (so1
->u
.cmpobj
== NULL
)
6674 /* We have both the objects, use strcoll */
6675 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6678 /* Compare elements directly. */
6679 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6682 return server
.sort_desc
? -cmp
: cmp
;
6685 /* The SORT command is the most complex command in Redis. Warning: this code
6686 * is optimized for speed and a bit less for readability */
6687 static void sortCommand(redisClient
*c
) {
6690 int desc
= 0, alpha
= 0;
6691 int limit_start
= 0, limit_count
= -1, start
, end
;
6692 int j
, dontsort
= 0, vectorlen
;
6693 int getop
= 0; /* GET operation counter */
6694 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6695 redisSortObject
*vector
; /* Resulting vector to sort */
6697 /* Lookup the key to sort. It must be of the right types */
6698 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6699 if (sortval
== NULL
) {
6700 addReply(c
,shared
.emptymultibulk
);
6703 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6704 sortval
->type
!= REDIS_ZSET
)
6706 addReply(c
,shared
.wrongtypeerr
);
6710 /* Create a list of operations to perform for every sorted element.
6711 * Operations can be GET/DEL/INCR/DECR */
6712 operations
= listCreate();
6713 listSetFreeMethod(operations
,zfree
);
6716 /* Now we need to protect sortval incrementing its count, in the future
6717 * SORT may have options able to overwrite/delete keys during the sorting
6718 * and the sorted key itself may get destroied */
6719 incrRefCount(sortval
);
6721 /* The SORT command has an SQL-alike syntax, parse it */
6722 while(j
< c
->argc
) {
6723 int leftargs
= c
->argc
-j
-1;
6724 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6726 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6728 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6730 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6731 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6732 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6734 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6735 storekey
= c
->argv
[j
+1];
6737 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6738 sortby
= c
->argv
[j
+1];
6739 /* If the BY pattern does not contain '*', i.e. it is constant,
6740 * we don't need to sort nor to lookup the weight keys. */
6741 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6743 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6744 listAddNodeTail(operations
,createSortOperation(
6745 REDIS_SORT_GET
,c
->argv
[j
+1]));
6749 decrRefCount(sortval
);
6750 listRelease(operations
);
6751 addReply(c
,shared
.syntaxerr
);
6757 /* Load the sorting vector with all the objects to sort */
6758 switch(sortval
->type
) {
6759 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6760 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6761 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6762 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6764 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6767 if (sortval
->type
== REDIS_LIST
) {
6768 list
*list
= sortval
->ptr
;
6772 listRewind(list
,&li
);
6773 while((ln
= listNext(&li
))) {
6774 robj
*ele
= ln
->value
;
6775 vector
[j
].obj
= ele
;
6776 vector
[j
].u
.score
= 0;
6777 vector
[j
].u
.cmpobj
= NULL
;
6785 if (sortval
->type
== REDIS_SET
) {
6788 zset
*zs
= sortval
->ptr
;
6792 di
= dictGetIterator(set
);
6793 while((setele
= dictNext(di
)) != NULL
) {
6794 vector
[j
].obj
= dictGetEntryKey(setele
);
6795 vector
[j
].u
.score
= 0;
6796 vector
[j
].u
.cmpobj
= NULL
;
6799 dictReleaseIterator(di
);
6801 redisAssert(j
== vectorlen
);
6803 /* Now it's time to load the right scores in the sorting vector */
6804 if (dontsort
== 0) {
6805 for (j
= 0; j
< vectorlen
; j
++) {
6808 /* lookup value to sort by */
6809 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6810 if (!byval
) continue;
6812 /* use object itself to sort by */
6813 byval
= vector
[j
].obj
;
6817 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6819 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6820 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6821 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6822 /* Don't need to decode the object if it's
6823 * integer-encoded (the only encoding supported) so
6824 * far. We can just cast it */
6825 vector
[j
].u
.score
= (long)byval
->ptr
;
6827 redisAssert(1 != 1);
6831 /* when the object was retrieved using lookupKeyByPattern,
6832 * its refcount needs to be decreased. */
6834 decrRefCount(byval
);
6839 /* We are ready to sort the vector... perform a bit of sanity check
6840 * on the LIMIT option too. We'll use a partial version of quicksort. */
6841 start
= (limit_start
< 0) ? 0 : limit_start
;
6842 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6843 if (start
>= vectorlen
) {
6844 start
= vectorlen
-1;
6847 if (end
>= vectorlen
) end
= vectorlen
-1;
6849 if (dontsort
== 0) {
6850 server
.sort_desc
= desc
;
6851 server
.sort_alpha
= alpha
;
6852 server
.sort_bypattern
= sortby
? 1 : 0;
6853 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6854 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6856 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6859 /* Send command output to the output buffer, performing the specified
6860 * GET/DEL/INCR/DECR operations if any. */
6861 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6862 if (storekey
== NULL
) {
6863 /* STORE option not specified, sent the sorting result to client */
6864 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6865 for (j
= start
; j
<= end
; j
++) {
6869 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6870 listRewind(operations
,&li
);
6871 while((ln
= listNext(&li
))) {
6872 redisSortOperation
*sop
= ln
->value
;
6873 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6876 if (sop
->type
== REDIS_SORT_GET
) {
6878 addReply(c
,shared
.nullbulk
);
6880 addReplyBulk(c
,val
);
6884 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6889 robj
*listObject
= createListObject();
6890 list
*listPtr
= (list
*) listObject
->ptr
;
6892 /* STORE option specified, set the sorting result as a List object */
6893 for (j
= start
; j
<= end
; j
++) {
6898 listAddNodeTail(listPtr
,vector
[j
].obj
);
6899 incrRefCount(vector
[j
].obj
);
6901 listRewind(operations
,&li
);
6902 while((ln
= listNext(&li
))) {
6903 redisSortOperation
*sop
= ln
->value
;
6904 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6907 if (sop
->type
== REDIS_SORT_GET
) {
6909 listAddNodeTail(listPtr
,createStringObject("",0));
6911 /* We should do a incrRefCount on val because it is
6912 * added to the list, but also a decrRefCount because
6913 * it is returned by lookupKeyByPattern. This results
6914 * in doing nothing at all. */
6915 listAddNodeTail(listPtr
,val
);
6918 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6922 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6923 incrRefCount(storekey
);
6925 /* Note: we add 1 because the DB is dirty anyway since even if the
6926 * SORT result is empty a new key is set and maybe the old content
6928 server
.dirty
+= 1+outputlen
;
6929 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6933 decrRefCount(sortval
);
6934 listRelease(operations
);
6935 for (j
= 0; j
< vectorlen
; j
++) {
6936 if (alpha
&& vector
[j
].u
.cmpobj
)
6937 decrRefCount(vector
[j
].u
.cmpobj
);
6942 /* Convert an amount of bytes into a human readable string in the form
6943 * of 100B, 2G, 100M, 4K, and so forth. */
6944 static void bytesToHuman(char *s
, unsigned long long n
) {
6949 sprintf(s
,"%lluB",n
);
6951 } else if (n
< (1024*1024)) {
6952 d
= (double)n
/(1024);
6953 sprintf(s
,"%.2fK",d
);
6954 } else if (n
< (1024LL*1024*1024)) {
6955 d
= (double)n
/(1024*1024);
6956 sprintf(s
,"%.2fM",d
);
6957 } else if (n
< (1024LL*1024*1024*1024)) {
6958 d
= (double)n
/(1024LL*1024*1024);
6959 sprintf(s
,"%.2fG",d
);
6963 /* Create the string returned by the INFO command. This is decoupled
6964 * by the INFO command itself as we need to report the same information
6965 * on memory corruption problems. */
6966 static sds
genRedisInfoString(void) {
6968 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6972 bytesToHuman(hmem
,zmalloc_used_memory());
6973 info
= sdscatprintf(sdsempty(),
6974 "redis_version:%s\r\n"
6976 "multiplexing_api:%s\r\n"
6977 "process_id:%ld\r\n"
6978 "uptime_in_seconds:%ld\r\n"
6979 "uptime_in_days:%ld\r\n"
6980 "connected_clients:%d\r\n"
6981 "connected_slaves:%d\r\n"
6982 "blocked_clients:%d\r\n"
6983 "used_memory:%zu\r\n"
6984 "used_memory_human:%s\r\n"
6985 "changes_since_last_save:%lld\r\n"
6986 "bgsave_in_progress:%d\r\n"
6987 "last_save_time:%ld\r\n"
6988 "bgrewriteaof_in_progress:%d\r\n"
6989 "total_connections_received:%lld\r\n"
6990 "total_commands_processed:%lld\r\n"
6991 "expired_keys:%lld\r\n"
6992 "hash_max_zipmap_entries:%ld\r\n"
6993 "hash_max_zipmap_value:%ld\r\n"
6994 "pubsub_channels:%ld\r\n"
6995 "pubsub_patterns:%u\r\n"
6999 (sizeof(long) == 8) ? "64" : "32",
7004 listLength(server
.clients
)-listLength(server
.slaves
),
7005 listLength(server
.slaves
),
7006 server
.blpop_blocked_clients
,
7007 zmalloc_used_memory(),
7010 server
.bgsavechildpid
!= -1,
7012 server
.bgrewritechildpid
!= -1,
7013 server
.stat_numconnections
,
7014 server
.stat_numcommands
,
7015 server
.stat_expiredkeys
,
7016 server
.hash_max_zipmap_entries
,
7017 server
.hash_max_zipmap_value
,
7018 dictSize(server
.pubsub_channels
),
7019 listLength(server
.pubsub_patterns
),
7020 server
.vm_enabled
!= 0,
7021 server
.masterhost
== NULL
? "master" : "slave"
7023 if (server
.masterhost
) {
7024 info
= sdscatprintf(info
,
7025 "master_host:%s\r\n"
7026 "master_port:%d\r\n"
7027 "master_link_status:%s\r\n"
7028 "master_last_io_seconds_ago:%d\r\n"
7031 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7033 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7036 if (server
.vm_enabled
) {
7038 info
= sdscatprintf(info
,
7039 "vm_conf_max_memory:%llu\r\n"
7040 "vm_conf_page_size:%llu\r\n"
7041 "vm_conf_pages:%llu\r\n"
7042 "vm_stats_used_pages:%llu\r\n"
7043 "vm_stats_swapped_objects:%llu\r\n"
7044 "vm_stats_swappin_count:%llu\r\n"
7045 "vm_stats_swappout_count:%llu\r\n"
7046 "vm_stats_io_newjobs_len:%lu\r\n"
7047 "vm_stats_io_processing_len:%lu\r\n"
7048 "vm_stats_io_processed_len:%lu\r\n"
7049 "vm_stats_io_active_threads:%lu\r\n"
7050 "vm_stats_blocked_clients:%lu\r\n"
7051 ,(unsigned long long) server
.vm_max_memory
,
7052 (unsigned long long) server
.vm_page_size
,
7053 (unsigned long long) server
.vm_pages
,
7054 (unsigned long long) server
.vm_stats_used_pages
,
7055 (unsigned long long) server
.vm_stats_swapped_objects
,
7056 (unsigned long long) server
.vm_stats_swapins
,
7057 (unsigned long long) server
.vm_stats_swapouts
,
7058 (unsigned long) listLength(server
.io_newjobs
),
7059 (unsigned long) listLength(server
.io_processing
),
7060 (unsigned long) listLength(server
.io_processed
),
7061 (unsigned long) server
.io_active_threads
,
7062 (unsigned long) server
.vm_blocked_clients
7066 for (j
= 0; j
< server
.dbnum
; j
++) {
7067 long long keys
, vkeys
;
7069 keys
= dictSize(server
.db
[j
].dict
);
7070 vkeys
= dictSize(server
.db
[j
].expires
);
7071 if (keys
|| vkeys
) {
7072 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7079 static void infoCommand(redisClient
*c
) {
7080 sds info
= genRedisInfoString();
7081 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7082 (unsigned long)sdslen(info
)));
7083 addReplySds(c
,info
);
7084 addReply(c
,shared
.crlf
);
7087 static void monitorCommand(redisClient
*c
) {
7088 /* ignore MONITOR if aleady slave or in monitor mode */
7089 if (c
->flags
& REDIS_SLAVE
) return;
7091 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7093 listAddNodeTail(server
.monitors
,c
);
7094 addReply(c
,shared
.ok
);
7097 /* ================================= Expire ================================= */
7098 static int removeExpire(redisDb
*db
, robj
*key
) {
7099 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7106 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7107 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7115 /* Return the expire time of the specified key, or -1 if no expire
7116 * is associated with this key (i.e. the key is non volatile) */
7117 static time_t getExpire(redisDb
*db
, robj
*key
) {
7120 /* No expire? return ASAP */
7121 if (dictSize(db
->expires
) == 0 ||
7122 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7124 return (time_t) dictGetEntryVal(de
);
7127 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7131 /* No expire? return ASAP */
7132 if (dictSize(db
->expires
) == 0 ||
7133 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7135 /* Lookup the expire */
7136 when
= (time_t) dictGetEntryVal(de
);
7137 if (time(NULL
) <= when
) return 0;
7139 /* Delete the key */
7140 dictDelete(db
->expires
,key
);
7141 server
.stat_expiredkeys
++;
7142 return dictDelete(db
->dict
,key
) == DICT_OK
;
7145 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7148 /* No expire? return ASAP */
7149 if (dictSize(db
->expires
) == 0 ||
7150 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7152 /* Delete the key */
7154 server
.stat_expiredkeys
++;
7155 dictDelete(db
->expires
,key
);
7156 return dictDelete(db
->dict
,key
) == DICT_OK
;
7159 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7163 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7167 de
= dictFind(c
->db
->dict
,key
);
7169 addReply(c
,shared
.czero
);
7173 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7174 addReply(c
, shared
.cone
);
7177 time_t when
= time(NULL
)+seconds
;
7178 if (setExpire(c
->db
,key
,when
)) {
7179 addReply(c
,shared
.cone
);
7182 addReply(c
,shared
.czero
);
7188 static void expireCommand(redisClient
*c
) {
7189 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7192 static void expireatCommand(redisClient
*c
) {
7193 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7196 static void ttlCommand(redisClient
*c
) {
7200 expire
= getExpire(c
->db
,c
->argv
[1]);
7202 ttl
= (int) (expire
-time(NULL
));
7203 if (ttl
< 0) ttl
= -1;
7205 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7208 /* ================================ MULTI/EXEC ============================== */
7210 /* Client state initialization for MULTI/EXEC */
7211 static void initClientMultiState(redisClient
*c
) {
7212 c
->mstate
.commands
= NULL
;
7213 c
->mstate
.count
= 0;
7216 /* Release all the resources associated with MULTI/EXEC state */
7217 static void freeClientMultiState(redisClient
*c
) {
7220 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7222 multiCmd
*mc
= c
->mstate
.commands
+j
;
7224 for (i
= 0; i
< mc
->argc
; i
++)
7225 decrRefCount(mc
->argv
[i
]);
7228 zfree(c
->mstate
.commands
);
7231 /* Add a new command into the MULTI commands queue */
7232 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7236 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7237 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7238 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7241 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7242 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7243 for (j
= 0; j
< c
->argc
; j
++)
7244 incrRefCount(mc
->argv
[j
]);
7248 static void multiCommand(redisClient
*c
) {
7249 c
->flags
|= REDIS_MULTI
;
7250 addReply(c
,shared
.ok
);
7253 static void discardCommand(redisClient
*c
) {
7254 if (!(c
->flags
& REDIS_MULTI
)) {
7255 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7259 freeClientMultiState(c
);
7260 initClientMultiState(c
);
7261 c
->flags
&= (~REDIS_MULTI
);
7262 addReply(c
,shared
.ok
);
7265 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7266 * implememntation for more information. */
7267 static void execCommandReplicateMulti(redisClient
*c
) {
7268 struct redisCommand
*cmd
;
7269 robj
*multistring
= createStringObject("MULTI",5);
7271 cmd
= lookupCommand("multi");
7272 if (server
.appendonly
)
7273 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7274 if (listLength(server
.slaves
))
7275 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7276 decrRefCount(multistring
);
7279 static void execCommand(redisClient
*c
) {
7284 if (!(c
->flags
& REDIS_MULTI
)) {
7285 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7289 /* Replicate a MULTI request now that we are sure the block is executed.
7290 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7291 * both the AOF and the replication link will have the same consistency
7292 * and atomicity guarantees. */
7293 execCommandReplicateMulti(c
);
7295 /* Exec all the queued commands */
7296 orig_argv
= c
->argv
;
7297 orig_argc
= c
->argc
;
7298 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7299 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7300 c
->argc
= c
->mstate
.commands
[j
].argc
;
7301 c
->argv
= c
->mstate
.commands
[j
].argv
;
7302 call(c
,c
->mstate
.commands
[j
].cmd
);
7304 c
->argv
= orig_argv
;
7305 c
->argc
= orig_argc
;
7306 freeClientMultiState(c
);
7307 initClientMultiState(c
);
7308 c
->flags
&= (~REDIS_MULTI
);
7309 /* Make sure the EXEC command is always replicated / AOF, since we
7310 * always send the MULTI command (we can't know beforehand if the
7311 * next operations will contain at least a modification to the DB). */
7315 /* =========================== Blocking Operations ========================= */
7317 /* Currently Redis blocking operations support is limited to list POP ops,
7318 * so the current implementation is not fully generic, but it is also not
7319 * completely specific so it will not require a rewrite to support new
7320 * kind of blocking operations in the future.
7322 * Still it's important to note that list blocking operations can be already
7323 * used as a notification mechanism in order to implement other blocking
7324 * operations at application level, so there must be a very strong evidence
7325 * of usefulness and generality before new blocking operations are implemented.
7327 * This is how the current blocking POP works, we use BLPOP as example:
7328 * - If the user calls BLPOP and the key exists and contains a non empty list
7329 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7330 * if there is not to block.
7331 * - If instead BLPOP is called and the key does not exists or the list is
7332 * empty we need to block. In order to do so we remove the notification for
7333 * new data to read in the client socket (so that we'll not serve new
7334 * requests if the blocking request is not served). Also we put the client
7335 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7336 * blocking for this keys.
7337 * - If a PUSH operation against a key with blocked clients waiting is
7338 * performed, we serve the first in the list: basically instead to push
7339 * the new element inside the list we return it to the (first / oldest)
7340 * blocking client, unblock the client, and remove it form the list.
7342 * The above comment and the source code should be enough in order to understand
7343 * the implementation and modify / fix it later.
7346 /* Set a client in blocking mode for the specified key, with the specified
7348 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7353 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7354 c
->blockingkeysnum
= numkeys
;
7355 c
->blockingto
= timeout
;
7356 for (j
= 0; j
< numkeys
; j
++) {
7357 /* Add the key in the client structure, to map clients -> keys */
7358 c
->blockingkeys
[j
] = keys
[j
];
7359 incrRefCount(keys
[j
]);
7361 /* And in the other "side", to map keys -> clients */
7362 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7366 /* For every key we take a list of clients blocked for it */
7368 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7369 incrRefCount(keys
[j
]);
7370 assert(retval
== DICT_OK
);
7372 l
= dictGetEntryVal(de
);
7374 listAddNodeTail(l
,c
);
7376 /* Mark the client as a blocked client */
7377 c
->flags
|= REDIS_BLOCKED
;
7378 server
.blpop_blocked_clients
++;
7381 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7382 static void unblockClientWaitingData(redisClient
*c
) {
7387 assert(c
->blockingkeys
!= NULL
);
7388 /* The client may wait for multiple keys, so unblock it for every key. */
7389 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7390 /* Remove this client from the list of clients waiting for this key. */
7391 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7393 l
= dictGetEntryVal(de
);
7394 listDelNode(l
,listSearchKey(l
,c
));
7395 /* If the list is empty we need to remove it to avoid wasting memory */
7396 if (listLength(l
) == 0)
7397 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7398 decrRefCount(c
->blockingkeys
[j
]);
7400 /* Cleanup the client structure */
7401 zfree(c
->blockingkeys
);
7402 c
->blockingkeys
= NULL
;
7403 c
->flags
&= (~REDIS_BLOCKED
);
7404 server
.blpop_blocked_clients
--;
7405 /* We want to process data if there is some command waiting
7406 * in the input buffer. Note that this is safe even if
7407 * unblockClientWaitingData() gets called from freeClient() because
7408 * freeClient() will be smart enough to call this function
7409 * *after* c->querybuf was set to NULL. */
7410 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7413 /* This should be called from any function PUSHing into lists.
7414 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7415 * 'ele' is the element pushed.
7417 * If the function returns 0 there was no client waiting for a list push
7420 * If the function returns 1 there was a client waiting for a list push
7421 * against this key, the element was passed to this client thus it's not
7422 * needed to actually add it to the list and the caller should return asap. */
7423 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7424 struct dictEntry
*de
;
7425 redisClient
*receiver
;
7429 de
= dictFind(c
->db
->blockingkeys
,key
);
7430 if (de
== NULL
) return 0;
7431 l
= dictGetEntryVal(de
);
7434 receiver
= ln
->value
;
7436 addReplySds(receiver
,sdsnew("*2\r\n"));
7437 addReplyBulk(receiver
,key
);
7438 addReplyBulk(receiver
,ele
);
7439 unblockClientWaitingData(receiver
);
7443 /* Blocking RPOP/LPOP */
7444 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7449 for (j
= 1; j
< c
->argc
-1; j
++) {
7450 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7452 if (o
->type
!= REDIS_LIST
) {
7453 addReply(c
,shared
.wrongtypeerr
);
7456 list
*list
= o
->ptr
;
7457 if (listLength(list
) != 0) {
7458 /* If the list contains elements fall back to the usual
7459 * non-blocking POP operation */
7460 robj
*argv
[2], **orig_argv
;
7463 /* We need to alter the command arguments before to call
7464 * popGenericCommand() as the command takes a single key. */
7465 orig_argv
= c
->argv
;
7466 orig_argc
= c
->argc
;
7467 argv
[1] = c
->argv
[j
];
7471 /* Also the return value is different, we need to output
7472 * the multi bulk reply header and the key name. The
7473 * "real" command will add the last element (the value)
7474 * for us. If this souds like an hack to you it's just
7475 * because it is... */
7476 addReplySds(c
,sdsnew("*2\r\n"));
7477 addReplyBulk(c
,argv
[1]);
7478 popGenericCommand(c
,where
);
7480 /* Fix the client structure with the original stuff */
7481 c
->argv
= orig_argv
;
7482 c
->argc
= orig_argc
;
7488 /* If the list is empty or the key does not exists we must block */
7489 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7490 if (timeout
> 0) timeout
+= time(NULL
);
7491 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7494 static void blpopCommand(redisClient
*c
) {
7495 blockingPopGenericCommand(c
,REDIS_HEAD
);
7498 static void brpopCommand(redisClient
*c
) {
7499 blockingPopGenericCommand(c
,REDIS_TAIL
);
7502 /* =============================== Replication ============================= */
7504 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7505 ssize_t nwritten
, ret
= size
;
7506 time_t start
= time(NULL
);
7510 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7511 nwritten
= write(fd
,ptr
,size
);
7512 if (nwritten
== -1) return -1;
7516 if ((time(NULL
)-start
) > timeout
) {
7524 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7525 ssize_t nread
, totread
= 0;
7526 time_t start
= time(NULL
);
7530 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7531 nread
= read(fd
,ptr
,size
);
7532 if (nread
== -1) return -1;
7537 if ((time(NULL
)-start
) > timeout
) {
7545 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7552 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7555 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7566 static void syncCommand(redisClient
*c
) {
7567 /* ignore SYNC if aleady slave or in monitor mode */
7568 if (c
->flags
& REDIS_SLAVE
) return;
7570 /* SYNC can't be issued when the server has pending data to send to
7571 * the client about already issued commands. We need a fresh reply
7572 * buffer registering the differences between the BGSAVE and the current
7573 * dataset, so that we can copy to other slaves if needed. */
7574 if (listLength(c
->reply
) != 0) {
7575 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7579 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7580 /* Here we need to check if there is a background saving operation
7581 * in progress, or if it is required to start one */
7582 if (server
.bgsavechildpid
!= -1) {
7583 /* Ok a background save is in progress. Let's check if it is a good
7584 * one for replication, i.e. if there is another slave that is
7585 * registering differences since the server forked to save */
7590 listRewind(server
.slaves
,&li
);
7591 while((ln
= listNext(&li
))) {
7593 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7596 /* Perfect, the server is already registering differences for
7597 * another slave. Set the right state, and copy the buffer. */
7598 listRelease(c
->reply
);
7599 c
->reply
= listDup(slave
->reply
);
7600 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7601 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7603 /* No way, we need to wait for the next BGSAVE in order to
7604 * register differences */
7605 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7606 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7609 /* Ok we don't have a BGSAVE in progress, let's start one */
7610 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7611 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7612 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7613 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7616 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7619 c
->flags
|= REDIS_SLAVE
;
7621 listAddNodeTail(server
.slaves
,c
);
7625 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7626 redisClient
*slave
= privdata
;
7628 REDIS_NOTUSED(mask
);
7629 char buf
[REDIS_IOBUF_LEN
];
7630 ssize_t nwritten
, buflen
;
7632 if (slave
->repldboff
== 0) {
7633 /* Write the bulk write count before to transfer the DB. In theory here
7634 * we don't know how much room there is in the output buffer of the
7635 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7636 * operations) will never be smaller than the few bytes we need. */
7639 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7641 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7649 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7650 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7652 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7653 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7657 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7658 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7663 slave
->repldboff
+= nwritten
;
7664 if (slave
->repldboff
== slave
->repldbsize
) {
7665 close(slave
->repldbfd
);
7666 slave
->repldbfd
= -1;
7667 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7668 slave
->replstate
= REDIS_REPL_ONLINE
;
7669 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7670 sendReplyToClient
, slave
) == AE_ERR
) {
7674 addReplySds(slave
,sdsempty());
7675 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7679 /* This function is called at the end of every backgrond saving.
7680 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7681 * otherwise REDIS_ERR is passed to the function.
7683 * The goal of this function is to handle slaves waiting for a successful
7684 * background saving in order to perform non-blocking synchronization. */
7685 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7687 int startbgsave
= 0;
7690 listRewind(server
.slaves
,&li
);
7691 while((ln
= listNext(&li
))) {
7692 redisClient
*slave
= ln
->value
;
7694 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7696 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7697 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7698 struct redis_stat buf
;
7700 if (bgsaveerr
!= REDIS_OK
) {
7702 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7705 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7706 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7708 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7711 slave
->repldboff
= 0;
7712 slave
->repldbsize
= buf
.st_size
;
7713 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7714 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7715 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7722 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7725 listRewind(server
.slaves
,&li
);
7726 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7727 while((ln
= listNext(&li
))) {
7728 redisClient
*slave
= ln
->value
;
7730 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7737 static int syncWithMaster(void) {
7738 char buf
[1024], tmpfile
[256], authcmd
[1024];
7740 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7741 int dfd
, maxtries
= 5;
7744 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7749 /* AUTH with the master if required. */
7750 if(server
.masterauth
) {
7751 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7752 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7754 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7758 /* Read the AUTH result. */
7759 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7761 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7765 if (buf
[0] != '+') {
7767 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7772 /* Issue the SYNC command */
7773 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7775 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7779 /* Read the bulk write count */
7780 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7782 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7786 if (buf
[0] != '$') {
7788 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7791 dumpsize
= strtol(buf
+1,NULL
,10);
7792 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7793 /* Read the bulk write data on a temp file */
7795 snprintf(tmpfile
,256,
7796 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7797 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7798 if (dfd
!= -1) break;
7803 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7807 int nread
, nwritten
;
7809 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7811 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7817 nwritten
= write(dfd
,buf
,nread
);
7818 if (nwritten
== -1) {
7819 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7827 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7828 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7834 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7835 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7839 server
.master
= createClient(fd
);
7840 server
.master
->flags
|= REDIS_MASTER
;
7841 server
.master
->authenticated
= 1;
7842 server
.replstate
= REDIS_REPL_CONNECTED
;
7846 static void slaveofCommand(redisClient
*c
) {
7847 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7848 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7849 if (server
.masterhost
) {
7850 sdsfree(server
.masterhost
);
7851 server
.masterhost
= NULL
;
7852 if (server
.master
) freeClient(server
.master
);
7853 server
.replstate
= REDIS_REPL_NONE
;
7854 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7857 sdsfree(server
.masterhost
);
7858 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7859 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7860 if (server
.master
) freeClient(server
.master
);
7861 server
.replstate
= REDIS_REPL_CONNECT
;
7862 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7863 server
.masterhost
, server
.masterport
);
7865 addReply(c
,shared
.ok
);
7868 /* ============================ Maxmemory directive ======================== */
7870 /* Try to free one object form the pre-allocated objects free list.
7871 * This is useful under low mem conditions as by default we take 1 million
7872 * free objects allocated. On success REDIS_OK is returned, otherwise
7874 static int tryFreeOneObjectFromFreelist(void) {
7877 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7878 if (listLength(server
.objfreelist
)) {
7879 listNode
*head
= listFirst(server
.objfreelist
);
7880 o
= listNodeValue(head
);
7881 listDelNode(server
.objfreelist
,head
);
7882 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7886 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7891 /* This function gets called when 'maxmemory' is set on the config file to limit
7892 * the max memory used by the server, and we are out of memory.
7893 * This function will try to, in order:
7895 * - Free objects from the free list
7896 * - Try to remove keys with an EXPIRE set
7898 * It is not possible to free enough memory to reach used-memory < maxmemory
7899 * the server will start refusing commands that will enlarge even more the
7902 static void freeMemoryIfNeeded(void) {
7903 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7904 int j
, k
, freed
= 0;
7906 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7907 for (j
= 0; j
< server
.dbnum
; j
++) {
7909 robj
*minkey
= NULL
;
7910 struct dictEntry
*de
;
7912 if (dictSize(server
.db
[j
].expires
)) {
7914 /* From a sample of three keys drop the one nearest to
7915 * the natural expire */
7916 for (k
= 0; k
< 3; k
++) {
7919 de
= dictGetRandomKey(server
.db
[j
].expires
);
7920 t
= (time_t) dictGetEntryVal(de
);
7921 if (minttl
== -1 || t
< minttl
) {
7922 minkey
= dictGetEntryKey(de
);
7926 deleteKey(server
.db
+j
,minkey
);
7929 if (!freed
) return; /* nothing to free... */
7933 /* ============================== Append Only file ========================== */
7935 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7936 sds buf
= sdsempty();
7942 /* The DB this command was targetting is not the same as the last command
7943 * we appendend. To issue a SELECT command is needed. */
7944 if (dictid
!= server
.appendseldb
) {
7947 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7948 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7949 (unsigned long)strlen(seldb
),seldb
);
7950 server
.appendseldb
= dictid
;
7953 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7954 * EXPIREs into EXPIREATs calls */
7955 if (cmd
->proc
== expireCommand
) {
7958 tmpargv
[0] = createStringObject("EXPIREAT",8);
7959 tmpargv
[1] = argv
[1];
7960 incrRefCount(argv
[1]);
7961 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7962 tmpargv
[2] = createObject(REDIS_STRING
,
7963 sdscatprintf(sdsempty(),"%ld",when
));
7967 /* Append the actual command */
7968 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7969 for (j
= 0; j
< argc
; j
++) {
7972 o
= getDecodedObject(o
);
7973 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7974 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7975 buf
= sdscatlen(buf
,"\r\n",2);
7979 /* Free the objects from the modified argv for EXPIREAT */
7980 if (cmd
->proc
== expireCommand
) {
7981 for (j
= 0; j
< 3; j
++)
7982 decrRefCount(argv
[j
]);
7985 /* We want to perform a single write. This should be guaranteed atomic
7986 * at least if the filesystem we are writing is a real physical one.
7987 * While this will save us against the server being killed I don't think
7988 * there is much to do about the whole server stopping for power problems
7990 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7991 if (nwritten
!= (signed)sdslen(buf
)) {
7992 /* Ooops, we are in troubles. The best thing to do for now is
7993 * to simply exit instead to give the illusion that everything is
7994 * working as expected. */
7995 if (nwritten
== -1) {
7996 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7998 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8002 /* If a background append only file rewriting is in progress we want to
8003 * accumulate the differences between the child DB and the current one
8004 * in a buffer, so that when the child process will do its work we
8005 * can append the differences to the new append only file. */
8006 if (server
.bgrewritechildpid
!= -1)
8007 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8011 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8012 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8013 now
-server
.lastfsync
> 1))
8015 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8016 server
.lastfsync
= now
;
8020 /* In Redis commands are always executed in the context of a client, so in
8021 * order to load the append only file we need to create a fake client. */
8022 static struct redisClient
*createFakeClient(void) {
8023 struct redisClient
*c
= zmalloc(sizeof(*c
));
8027 c
->querybuf
= sdsempty();
8031 /* We set the fake client as a slave waiting for the synchronization
8032 * so that Redis will not try to send replies to this client. */
8033 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8034 c
->reply
= listCreate();
8035 listSetFreeMethod(c
->reply
,decrRefCount
);
8036 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8040 static void freeFakeClient(struct redisClient
*c
) {
8041 sdsfree(c
->querybuf
);
8042 listRelease(c
->reply
);
8046 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8047 * error (the append only file is zero-length) REDIS_ERR is returned. On
8048 * fatal error an error message is logged and the program exists. */
8049 int loadAppendOnlyFile(char *filename
) {
8050 struct redisClient
*fakeClient
;
8051 FILE *fp
= fopen(filename
,"r");
8052 struct redis_stat sb
;
8053 unsigned long long loadedkeys
= 0;
8055 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8059 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8063 fakeClient
= createFakeClient();
8070 struct redisCommand
*cmd
;
8072 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8078 if (buf
[0] != '*') goto fmterr
;
8080 argv
= zmalloc(sizeof(robj
*)*argc
);
8081 for (j
= 0; j
< argc
; j
++) {
8082 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8083 if (buf
[0] != '$') goto fmterr
;
8084 len
= strtol(buf
+1,NULL
,10);
8085 argsds
= sdsnewlen(NULL
,len
);
8086 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8087 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8088 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8091 /* Command lookup */
8092 cmd
= lookupCommand(argv
[0]->ptr
);
8094 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8097 /* Try object encoding */
8098 if (cmd
->flags
& REDIS_CMD_BULK
)
8099 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8100 /* Run the command in the context of a fake client */
8101 fakeClient
->argc
= argc
;
8102 fakeClient
->argv
= argv
;
8103 cmd
->proc(fakeClient
);
8104 /* Discard the reply objects list from the fake client */
8105 while(listLength(fakeClient
->reply
))
8106 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8107 /* Clean up, ready for the next command */
8108 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8110 /* Handle swapping while loading big datasets when VM is on */
8112 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8113 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8114 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8119 freeFakeClient(fakeClient
);
8124 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8126 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8130 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8134 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8135 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8139 /* Avoid the incr/decr ref count business if possible to help
8140 * copy-on-write (we are often in a child process when this function
8142 * Also makes sure that key objects don't get incrRefCount-ed when VM
8144 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8145 obj
= getDecodedObject(obj
);
8148 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8149 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8150 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8152 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8153 if (decrrc
) decrRefCount(obj
);
8156 if (decrrc
) decrRefCount(obj
);
8160 /* Write binary-safe string into a file in the bulkformat
8161 * $<count>\r\n<payload>\r\n */
8162 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8165 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8166 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8167 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8168 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8172 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8173 static int fwriteBulkDouble(FILE *fp
, double d
) {
8174 char buf
[128], dbuf
[128];
8176 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8177 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8178 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8179 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8183 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8184 static int fwriteBulkLong(FILE *fp
, long l
) {
8185 char buf
[128], lbuf
[128];
8187 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8188 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8189 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8190 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8194 /* Write a sequence of commands able to fully rebuild the dataset into
8195 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8196 static int rewriteAppendOnlyFile(char *filename
) {
8197 dictIterator
*di
= NULL
;
8202 time_t now
= time(NULL
);
8204 /* Note that we have to use a different temp name here compared to the
8205 * one used by rewriteAppendOnlyFileBackground() function. */
8206 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8207 fp
= fopen(tmpfile
,"w");
8209 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8212 for (j
= 0; j
< server
.dbnum
; j
++) {
8213 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8214 redisDb
*db
= server
.db
+j
;
8216 if (dictSize(d
) == 0) continue;
8217 di
= dictGetIterator(d
);
8223 /* SELECT the new DB */
8224 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8225 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8227 /* Iterate this DB writing every entry */
8228 while((de
= dictNext(di
)) != NULL
) {
8233 key
= dictGetEntryKey(de
);
8234 /* If the value for this key is swapped, load a preview in memory.
8235 * We use a "swapped" flag to remember if we need to free the
8236 * value object instead to just increment the ref count anyway
8237 * in order to avoid copy-on-write of pages if we are forked() */
8238 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8239 key
->storage
== REDIS_VM_SWAPPING
) {
8240 o
= dictGetEntryVal(de
);
8243 o
= vmPreviewObject(key
);
8246 expiretime
= getExpire(db
,key
);
8248 /* Save the key and associated value */
8249 if (o
->type
== REDIS_STRING
) {
8250 /* Emit a SET command */
8251 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8252 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8254 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8255 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8256 } else if (o
->type
== REDIS_LIST
) {
8257 /* Emit the RPUSHes needed to rebuild the list */
8258 list
*list
= o
->ptr
;
8262 listRewind(list
,&li
);
8263 while((ln
= listNext(&li
))) {
8264 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8265 robj
*eleobj
= listNodeValue(ln
);
8267 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8268 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8269 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8271 } else if (o
->type
== REDIS_SET
) {
8272 /* Emit the SADDs needed to rebuild the set */
8274 dictIterator
*di
= dictGetIterator(set
);
8277 while((de
= dictNext(di
)) != NULL
) {
8278 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8279 robj
*eleobj
= dictGetEntryKey(de
);
8281 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8282 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8283 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8285 dictReleaseIterator(di
);
8286 } else if (o
->type
== REDIS_ZSET
) {
8287 /* Emit the ZADDs needed to rebuild the sorted set */
8289 dictIterator
*di
= dictGetIterator(zs
->dict
);
8292 while((de
= dictNext(di
)) != NULL
) {
8293 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8294 robj
*eleobj
= dictGetEntryKey(de
);
8295 double *score
= dictGetEntryVal(de
);
8297 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8298 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8299 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8300 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8302 dictReleaseIterator(di
);
8303 } else if (o
->type
== REDIS_HASH
) {
8304 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8306 /* Emit the HSETs needed to rebuild the hash */
8307 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8308 unsigned char *p
= zipmapRewind(o
->ptr
);
8309 unsigned char *field
, *val
;
8310 unsigned int flen
, vlen
;
8312 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8313 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8314 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8315 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8317 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8321 dictIterator
*di
= dictGetIterator(o
->ptr
);
8324 while((de
= dictNext(di
)) != NULL
) {
8325 robj
*field
= dictGetEntryKey(de
);
8326 robj
*val
= dictGetEntryVal(de
);
8328 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8329 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8330 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8331 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8333 dictReleaseIterator(di
);
8336 redisPanic("Unknown object type");
8338 /* Save the expire time */
8339 if (expiretime
!= -1) {
8340 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8341 /* If this key is already expired skip it */
8342 if (expiretime
< now
) continue;
8343 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8344 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8345 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8347 if (swapped
) decrRefCount(o
);
8349 dictReleaseIterator(di
);
8352 /* Make sure data will not remain on the OS's output buffers */
8357 /* Use RENAME to make sure the DB file is changed atomically only
8358 * if the generate DB file is ok. */
8359 if (rename(tmpfile
,filename
) == -1) {
8360 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8364 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8370 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8371 if (di
) dictReleaseIterator(di
);
8375 /* This is how rewriting of the append only file in background works:
8377 * 1) The user calls BGREWRITEAOF
8378 * 2) Redis calls this function, that forks():
8379 * 2a) the child rewrite the append only file in a temp file.
8380 * 2b) the parent accumulates differences in server.bgrewritebuf.
8381 * 3) When the child finished '2a' exists.
8382 * 4) The parent will trap the exit code, if it's OK, will append the
8383 * data accumulated into server.bgrewritebuf into the temp file, and
8384 * finally will rename(2) the temp file in the actual file name.
8385 * The the new file is reopened as the new append only file. Profit!
8387 static int rewriteAppendOnlyFileBackground(void) {
8390 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8391 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8392 if ((childpid
= fork()) == 0) {
8396 if (server
.vm_enabled
) vmReopenSwapFile();
8398 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8399 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8406 if (childpid
== -1) {
8407 redisLog(REDIS_WARNING
,
8408 "Can't rewrite append only file in background: fork: %s",
8412 redisLog(REDIS_NOTICE
,
8413 "Background append only file rewriting started by pid %d",childpid
);
8414 server
.bgrewritechildpid
= childpid
;
8415 updateDictResizePolicy();
8416 /* We set appendseldb to -1 in order to force the next call to the
8417 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8418 * accumulated by the parent into server.bgrewritebuf will start
8419 * with a SELECT statement and it will be safe to merge. */
8420 server
.appendseldb
= -1;
8423 return REDIS_OK
; /* unreached */
8426 static void bgrewriteaofCommand(redisClient
*c
) {
8427 if (server
.bgrewritechildpid
!= -1) {
8428 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8431 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8432 char *status
= "+Background append only file rewriting started\r\n";
8433 addReplySds(c
,sdsnew(status
));
8435 addReply(c
,shared
.err
);
8439 static void aofRemoveTempFile(pid_t childpid
) {
8442 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8446 /* Virtual Memory is composed mainly of two subsystems:
8447 * - Blocking Virutal Memory
8448 * - Threaded Virtual Memory I/O
8449 * The two parts are not fully decoupled, but functions are split among two
8450 * different sections of the source code (delimited by comments) in order to
8451 * make more clear what functionality is about the blocking VM and what about
8452 * the threaded (not blocking) VM.
8456 * Redis VM is a blocking VM (one that blocks reading swapped values from
8457 * disk into memory when a value swapped out is needed in memory) that is made
8458 * unblocking by trying to examine the command argument vector in order to
8459 * load in background values that will likely be needed in order to exec
8460 * the command. The command is executed only once all the relevant keys
8461 * are loaded into memory.
8463 * This basically is almost as simple of a blocking VM, but almost as parallel
8464 * as a fully non-blocking VM.
8467 /* =================== Virtual Memory - Blocking Side ====================== */
8469 /* substitute the first occurrence of '%p' with the process pid in the
8470 * swap file name. */
8471 static void expandVmSwapFilename(void) {
8472 char *p
= strstr(server
.vm_swap_file
,"%p");
8478 new = sdscat(new,server
.vm_swap_file
);
8479 new = sdscatprintf(new,"%ld",(long) getpid());
8480 new = sdscat(new,p
+2);
8481 zfree(server
.vm_swap_file
);
8482 server
.vm_swap_file
= new;
8485 static void vmInit(void) {
8490 if (server
.vm_max_threads
!= 0)
8491 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8493 expandVmSwapFilename();
8494 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8495 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8496 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8498 if (server
.vm_fp
== NULL
) {
8499 redisLog(REDIS_WARNING
,
8500 "Impossible to open the swap file: %s. Exiting.",
8504 server
.vm_fd
= fileno(server
.vm_fp
);
8505 server
.vm_next_page
= 0;
8506 server
.vm_near_pages
= 0;
8507 server
.vm_stats_used_pages
= 0;
8508 server
.vm_stats_swapped_objects
= 0;
8509 server
.vm_stats_swapouts
= 0;
8510 server
.vm_stats_swapins
= 0;
8511 totsize
= server
.vm_pages
*server
.vm_page_size
;
8512 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8513 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8514 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8518 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8520 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8521 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8522 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8523 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8525 /* Initialize threaded I/O (used by Virtual Memory) */
8526 server
.io_newjobs
= listCreate();
8527 server
.io_processing
= listCreate();
8528 server
.io_processed
= listCreate();
8529 server
.io_ready_clients
= listCreate();
8530 pthread_mutex_init(&server
.io_mutex
,NULL
);
8531 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8532 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8533 server
.io_active_threads
= 0;
8534 if (pipe(pipefds
) == -1) {
8535 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8539 server
.io_ready_pipe_read
= pipefds
[0];
8540 server
.io_ready_pipe_write
= pipefds
[1];
8541 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8542 /* LZF requires a lot of stack */
8543 pthread_attr_init(&server
.io_threads_attr
);
8544 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8545 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8546 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8547 /* Listen for events in the threaded I/O pipe */
8548 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8549 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8550 oom("creating file event");
8553 /* Mark the page as used */
8554 static void vmMarkPageUsed(off_t page
) {
8555 off_t byte
= page
/8;
8557 redisAssert(vmFreePage(page
) == 1);
8558 server
.vm_bitmap
[byte
] |= 1<<bit
;
8561 /* Mark N contiguous pages as used, with 'page' being the first. */
8562 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8565 for (j
= 0; j
< count
; j
++)
8566 vmMarkPageUsed(page
+j
);
8567 server
.vm_stats_used_pages
+= count
;
8568 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8569 (long long)count
, (long long)page
);
8572 /* Mark the page as free */
8573 static void vmMarkPageFree(off_t page
) {
8574 off_t byte
= page
/8;
8576 redisAssert(vmFreePage(page
) == 0);
8577 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8580 /* Mark N contiguous pages as free, with 'page' being the first. */
8581 static void vmMarkPagesFree(off_t page
, off_t count
) {
8584 for (j
= 0; j
< count
; j
++)
8585 vmMarkPageFree(page
+j
);
8586 server
.vm_stats_used_pages
-= count
;
8587 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8588 (long long)count
, (long long)page
);
8591 /* Test if the page is free */
8592 static int vmFreePage(off_t page
) {
8593 off_t byte
= page
/8;
8595 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8598 /* Find N contiguous free pages storing the first page of the cluster in *first.
8599 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8600 * REDIS_ERR is returned.
8602 * This function uses a simple algorithm: we try to allocate
8603 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8604 * again from the start of the swap file searching for free spaces.
8606 * If it looks pretty clear that there are no free pages near our offset
8607 * we try to find less populated places doing a forward jump of
8608 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8609 * without hurry, and then we jump again and so forth...
8611 * This function can be improved using a free list to avoid to guess
8612 * too much, since we could collect data about freed pages.
8614 * note: I implemented this function just after watching an episode of
8615 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8617 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8618 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8620 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8621 server
.vm_near_pages
= 0;
8622 server
.vm_next_page
= 0;
8624 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8625 base
= server
.vm_next_page
;
8627 while(offset
< server
.vm_pages
) {
8628 off_t
this = base
+offset
;
8630 /* If we overflow, restart from page zero */
8631 if (this >= server
.vm_pages
) {
8632 this -= server
.vm_pages
;
8634 /* Just overflowed, what we found on tail is no longer
8635 * interesting, as it's no longer contiguous. */
8639 if (vmFreePage(this)) {
8640 /* This is a free page */
8642 /* Already got N free pages? Return to the caller, with success */
8644 *first
= this-(n
-1);
8645 server
.vm_next_page
= this+1;
8646 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8650 /* The current one is not a free page */
8654 /* Fast-forward if the current page is not free and we already
8655 * searched enough near this place. */
8657 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8658 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8660 /* Note that even if we rewind after the jump, we are don't need
8661 * to make sure numfree is set to zero as we only jump *if* it
8662 * is set to zero. */
8664 /* Otherwise just check the next page */
8671 /* Write the specified object at the specified page of the swap file */
8672 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8673 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8674 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8675 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8676 redisLog(REDIS_WARNING
,
8677 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8681 rdbSaveObject(server
.vm_fp
,o
);
8682 fflush(server
.vm_fp
);
8683 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8687 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8688 * needed to later retrieve the object into the key object.
8689 * If we can't find enough contiguous empty pages to swap the object on disk
8690 * REDIS_ERR is returned. */
8691 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8692 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8695 assert(key
->storage
== REDIS_VM_MEMORY
);
8696 assert(key
->refcount
== 1);
8697 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8698 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8699 key
->vm
.page
= page
;
8700 key
->vm
.usedpages
= pages
;
8701 key
->storage
= REDIS_VM_SWAPPED
;
8702 key
->vtype
= val
->type
;
8703 decrRefCount(val
); /* Deallocate the object from memory. */
8704 vmMarkPagesUsed(page
,pages
);
8705 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8706 (unsigned char*) key
->ptr
,
8707 (unsigned long long) page
, (unsigned long long) pages
);
8708 server
.vm_stats_swapped_objects
++;
8709 server
.vm_stats_swapouts
++;
8713 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8716 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8717 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8718 redisLog(REDIS_WARNING
,
8719 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8723 o
= rdbLoadObject(type
,server
.vm_fp
);
8725 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8728 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8732 /* Load the value object relative to the 'key' object from swap to memory.
8733 * The newly allocated object is returned.
8735 * If preview is true the unserialized object is returned to the caller but
8736 * no changes are made to the key object, nor the pages are marked as freed */
8737 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8740 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8741 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8743 key
->storage
= REDIS_VM_MEMORY
;
8744 key
->vm
.atime
= server
.unixtime
;
8745 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8746 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8747 (unsigned char*) key
->ptr
);
8748 server
.vm_stats_swapped_objects
--;
8750 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8751 (unsigned char*) key
->ptr
);
8753 server
.vm_stats_swapins
++;
8757 /* Plain object loading, from swap to memory */
8758 static robj
*vmLoadObject(robj
*key
) {
8759 /* If we are loading the object in background, stop it, we
8760 * need to load this object synchronously ASAP. */
8761 if (key
->storage
== REDIS_VM_LOADING
)
8762 vmCancelThreadedIOJob(key
);
8763 return vmGenericLoadObject(key
,0);
8766 /* Just load the value on disk, without to modify the key.
8767 * This is useful when we want to perform some operation on the value
8768 * without to really bring it from swap to memory, like while saving the
8769 * dataset or rewriting the append only log. */
8770 static robj
*vmPreviewObject(robj
*key
) {
8771 return vmGenericLoadObject(key
,1);
8774 /* How a good candidate is this object for swapping?
8775 * The better candidate it is, the greater the returned value.
8777 * Currently we try to perform a fast estimation of the object size in
8778 * memory, and combine it with aging informations.
8780 * Basically swappability = idle-time * log(estimated size)
8782 * Bigger objects are preferred over smaller objects, but not
8783 * proportionally, this is why we use the logarithm. This algorithm is
8784 * just a first try and will probably be tuned later. */
8785 static double computeObjectSwappability(robj
*o
) {
8786 time_t age
= server
.unixtime
- o
->vm
.atime
;
8790 struct dictEntry
*de
;
8793 if (age
<= 0) return 0;
8796 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8799 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8804 listNode
*ln
= listFirst(l
);
8806 asize
= sizeof(list
);
8808 robj
*ele
= ln
->value
;
8811 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8812 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8814 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8819 z
= (o
->type
== REDIS_ZSET
);
8820 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8822 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8823 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8828 de
= dictGetRandomKey(d
);
8829 ele
= dictGetEntryKey(de
);
8830 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8831 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8833 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8834 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8838 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8839 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8840 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8841 unsigned int klen
, vlen
;
8842 unsigned char *key
, *val
;
8844 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8848 asize
= len
*(klen
+vlen
+3);
8849 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8851 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8856 de
= dictGetRandomKey(d
);
8857 ele
= dictGetEntryKey(de
);
8858 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8859 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8861 ele
= dictGetEntryVal(de
);
8862 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8863 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8865 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8870 return (double)age
*log(1+asize
);
8873 /* Try to swap an object that's a good candidate for swapping.
8874 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8875 * to swap any object at all.
8877 * If 'usethreaded' is true, Redis will try to swap the object in background
8878 * using I/O threads. */
8879 static int vmSwapOneObject(int usethreads
) {
8881 struct dictEntry
*best
= NULL
;
8882 double best_swappability
= 0;
8883 redisDb
*best_db
= NULL
;
8886 for (j
= 0; j
< server
.dbnum
; j
++) {
8887 redisDb
*db
= server
.db
+j
;
8888 /* Why maxtries is set to 100?
8889 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8890 * are swappable objects */
8893 if (dictSize(db
->dict
) == 0) continue;
8894 for (i
= 0; i
< 5; i
++) {
8896 double swappability
;
8898 if (maxtries
) maxtries
--;
8899 de
= dictGetRandomKey(db
->dict
);
8900 key
= dictGetEntryKey(de
);
8901 val
= dictGetEntryVal(de
);
8902 /* Only swap objects that are currently in memory.
8904 * Also don't swap shared objects if threaded VM is on, as we
8905 * try to ensure that the main thread does not touch the
8906 * object while the I/O thread is using it, but we can't
8907 * control other keys without adding additional mutex. */
8908 if (key
->storage
!= REDIS_VM_MEMORY
||
8909 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8910 if (maxtries
) i
--; /* don't count this try */
8913 swappability
= computeObjectSwappability(val
);
8914 if (!best
|| swappability
> best_swappability
) {
8916 best_swappability
= swappability
;
8921 if (best
== NULL
) return REDIS_ERR
;
8922 key
= dictGetEntryKey(best
);
8923 val
= dictGetEntryVal(best
);
8925 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8926 key
->ptr
, best_swappability
);
8928 /* Unshare the key if needed */
8929 if (key
->refcount
> 1) {
8930 robj
*newkey
= dupStringObject(key
);
8932 key
= dictGetEntryKey(best
) = newkey
;
8936 vmSwapObjectThreaded(key
,val
,best_db
);
8939 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8940 dictGetEntryVal(best
) = NULL
;
8948 static int vmSwapOneObjectBlocking() {
8949 return vmSwapOneObject(0);
8952 static int vmSwapOneObjectThreaded() {
8953 return vmSwapOneObject(1);
8956 /* Return true if it's safe to swap out objects in a given moment.
8957 * Basically we don't want to swap objects out while there is a BGSAVE
8958 * or a BGAEOREWRITE running in backgroud. */
8959 static int vmCanSwapOut(void) {
8960 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8963 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8964 * and was deleted. Otherwise 0 is returned. */
8965 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8969 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8970 foundkey
= dictGetEntryKey(de
);
8971 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8976 /* =================== Virtual Memory - Threaded I/O ======================= */
8978 static void freeIOJob(iojob
*j
) {
8979 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8980 j
->type
== REDIS_IOJOB_DO_SWAP
||
8981 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8982 decrRefCount(j
->val
);
8983 /* We don't decrRefCount the j->key field as we did't incremented
8984 * the count creating IO Jobs. This is because the key field here is
8985 * just used as an indentifier and if a key is removed the Job should
8986 * never be touched again. */
8990 /* Every time a thread finished a Job, it writes a byte into the write side
8991 * of an unix pipe in order to "awake" the main thread, and this function
8993 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8997 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8999 REDIS_NOTUSED(mask
);
9000 REDIS_NOTUSED(privdata
);
9002 /* For every byte we read in the read side of the pipe, there is one
9003 * I/O job completed to process. */
9004 while((retval
= read(fd
,buf
,1)) == 1) {
9008 struct dictEntry
*de
;
9010 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9012 /* Get the processed element (the oldest one) */
9014 assert(listLength(server
.io_processed
) != 0);
9015 if (toprocess
== -1) {
9016 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9017 if (toprocess
<= 0) toprocess
= 1;
9019 ln
= listFirst(server
.io_processed
);
9021 listDelNode(server
.io_processed
,ln
);
9023 /* If this job is marked as canceled, just ignore it */
9028 /* Post process it in the main thread, as there are things we
9029 * can do just here to avoid race conditions and/or invasive locks */
9030 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
);
9031 de
= dictFind(j
->db
->dict
,j
->key
);
9033 key
= dictGetEntryKey(de
);
9034 if (j
->type
== REDIS_IOJOB_LOAD
) {
9037 /* Key loaded, bring it at home */
9038 key
->storage
= REDIS_VM_MEMORY
;
9039 key
->vm
.atime
= server
.unixtime
;
9040 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9041 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9042 (unsigned char*) key
->ptr
);
9043 server
.vm_stats_swapped_objects
--;
9044 server
.vm_stats_swapins
++;
9045 dictGetEntryVal(de
) = j
->val
;
9046 incrRefCount(j
->val
);
9049 /* Handle clients waiting for this key to be loaded. */
9050 handleClientsBlockedOnSwappedKey(db
,key
);
9051 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9052 /* Now we know the amount of pages required to swap this object.
9053 * Let's find some space for it, and queue this task again
9054 * rebranded as REDIS_IOJOB_DO_SWAP. */
9055 if (!vmCanSwapOut() ||
9056 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9058 /* Ooops... no space or we can't swap as there is
9059 * a fork()ed Redis trying to save stuff on disk. */
9061 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9063 /* Note that we need to mark this pages as used now,
9064 * if the job will be canceled, we'll mark them as freed
9066 vmMarkPagesUsed(j
->page
,j
->pages
);
9067 j
->type
= REDIS_IOJOB_DO_SWAP
;
9072 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9075 /* Key swapped. We can finally free some memory. */
9076 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9077 printf("key->storage: %d\n",key
->storage
);
9078 printf("key->name: %s\n",(char*)key
->ptr
);
9079 printf("key->refcount: %d\n",key
->refcount
);
9080 printf("val: %p\n",(void*)j
->val
);
9081 printf("val->type: %d\n",j
->val
->type
);
9082 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9084 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9085 val
= dictGetEntryVal(de
);
9086 key
->vm
.page
= j
->page
;
9087 key
->vm
.usedpages
= j
->pages
;
9088 key
->storage
= REDIS_VM_SWAPPED
;
9089 key
->vtype
= j
->val
->type
;
9090 decrRefCount(val
); /* Deallocate the object from memory. */
9091 dictGetEntryVal(de
) = NULL
;
9092 redisLog(REDIS_DEBUG
,
9093 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9094 (unsigned char*) key
->ptr
,
9095 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9096 server
.vm_stats_swapped_objects
++;
9097 server
.vm_stats_swapouts
++;
9099 /* Put a few more swap requests in queue if we are still
9101 if (trytoswap
&& vmCanSwapOut() &&
9102 zmalloc_used_memory() > server
.vm_max_memory
)
9107 more
= listLength(server
.io_newjobs
) <
9108 (unsigned) server
.vm_max_threads
;
9110 /* Don't waste CPU time if swappable objects are rare. */
9111 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9119 if (processed
== toprocess
) return;
9121 if (retval
< 0 && errno
!= EAGAIN
) {
9122 redisLog(REDIS_WARNING
,
9123 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9128 static void lockThreadedIO(void) {
9129 pthread_mutex_lock(&server
.io_mutex
);
9132 static void unlockThreadedIO(void) {
9133 pthread_mutex_unlock(&server
.io_mutex
);
9136 /* Remove the specified object from the threaded I/O queue if still not
9137 * processed, otherwise make sure to flag it as canceled. */
9138 static void vmCancelThreadedIOJob(robj
*o
) {
9140 server
.io_newjobs
, /* 0 */
9141 server
.io_processing
, /* 1 */
9142 server
.io_processed
/* 2 */
9146 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9149 /* Search for a matching key in one of the queues */
9150 for (i
= 0; i
< 3; i
++) {
9154 listRewind(lists
[i
],&li
);
9155 while ((ln
= listNext(&li
)) != NULL
) {
9156 iojob
*job
= ln
->value
;
9158 if (job
->canceled
) continue; /* Skip this, already canceled. */
9159 if (job
->key
== o
) {
9160 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9161 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9162 /* Mark the pages as free since the swap didn't happened
9163 * or happened but is now discarded. */
9164 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9165 vmMarkPagesFree(job
->page
,job
->pages
);
9166 /* Cancel the job. It depends on the list the job is
9169 case 0: /* io_newjobs */
9170 /* If the job was yet not processed the best thing to do
9171 * is to remove it from the queue at all */
9173 listDelNode(lists
[i
],ln
);
9175 case 1: /* io_processing */
9176 /* Oh Shi- the thread is messing with the Job:
9178 * Probably it's accessing the object if this is a
9179 * PREPARE_SWAP or DO_SWAP job.
9180 * If it's a LOAD job it may be reading from disk and
9181 * if we don't wait for the job to terminate before to
9182 * cancel it, maybe in a few microseconds data can be
9183 * corrupted in this pages. So the short story is:
9185 * Better to wait for the job to move into the
9186 * next queue (processed)... */
9188 /* We try again and again until the job is completed. */
9190 /* But let's wait some time for the I/O thread
9191 * to finish with this job. After all this condition
9192 * should be very rare. */
9195 case 2: /* io_processed */
9196 /* The job was already processed, that's easy...
9197 * just mark it as canceled so that we'll ignore it
9198 * when processing completed jobs. */
9202 /* Finally we have to adjust the storage type of the object
9203 * in order to "UNDO" the operaiton. */
9204 if (o
->storage
== REDIS_VM_LOADING
)
9205 o
->storage
= REDIS_VM_SWAPPED
;
9206 else if (o
->storage
== REDIS_VM_SWAPPING
)
9207 o
->storage
= REDIS_VM_MEMORY
;
9214 assert(1 != 1); /* We should never reach this */
9217 static void *IOThreadEntryPoint(void *arg
) {
9222 pthread_detach(pthread_self());
9224 /* Get a new job to process */
9226 if (listLength(server
.io_newjobs
) == 0) {
9227 /* No new jobs in queue, exit. */
9228 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9229 (long) pthread_self());
9230 server
.io_active_threads
--;
9234 ln
= listFirst(server
.io_newjobs
);
9236 listDelNode(server
.io_newjobs
,ln
);
9237 /* Add the job in the processing queue */
9238 j
->thread
= pthread_self();
9239 listAddNodeTail(server
.io_processing
,j
);
9240 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9242 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9243 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9245 /* Process the Job */
9246 if (j
->type
== REDIS_IOJOB_LOAD
) {
9247 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9248 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9249 FILE *fp
= fopen("/dev/null","w+");
9250 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9252 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9253 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9257 /* Done: insert the job into the processed queue */
9258 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9259 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9261 listDelNode(server
.io_processing
,ln
);
9262 listAddNodeTail(server
.io_processed
,j
);
9265 /* Signal the main thread there is new stuff to process */
9266 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9268 return NULL
; /* never reached */
9271 static void spawnIOThread(void) {
9273 sigset_t mask
, omask
;
9277 sigaddset(&mask
,SIGCHLD
);
9278 sigaddset(&mask
,SIGHUP
);
9279 sigaddset(&mask
,SIGPIPE
);
9280 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9281 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9282 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9286 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9287 server
.io_active_threads
++;
9290 /* We need to wait for the last thread to exit before we are able to
9291 * fork() in order to BGSAVE or BGREWRITEAOF. */
9292 static void waitEmptyIOJobsQueue(void) {
9294 int io_processed_len
;
9297 if (listLength(server
.io_newjobs
) == 0 &&
9298 listLength(server
.io_processing
) == 0 &&
9299 server
.io_active_threads
== 0)
9304 /* While waiting for empty jobs queue condition we post-process some
9305 * finshed job, as I/O threads may be hanging trying to write against
9306 * the io_ready_pipe_write FD but there are so much pending jobs that
9308 io_processed_len
= listLength(server
.io_processed
);
9310 if (io_processed_len
) {
9311 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9312 usleep(1000); /* 1 millisecond */
9314 usleep(10000); /* 10 milliseconds */
9319 static void vmReopenSwapFile(void) {
9320 /* Note: we don't close the old one as we are in the child process
9321 * and don't want to mess at all with the original file object. */
9322 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9323 if (server
.vm_fp
== NULL
) {
9324 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9325 server
.vm_swap_file
);
9328 server
.vm_fd
= fileno(server
.vm_fp
);
9331 /* This function must be called while with threaded IO locked */
9332 static void queueIOJob(iojob
*j
) {
9333 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9334 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9335 listAddNodeTail(server
.io_newjobs
,j
);
9336 if (server
.io_active_threads
< server
.vm_max_threads
)
9340 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9343 assert(key
->storage
== REDIS_VM_MEMORY
);
9344 assert(key
->refcount
== 1);
9346 j
= zmalloc(sizeof(*j
));
9347 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9353 j
->thread
= (pthread_t
) -1;
9354 key
->storage
= REDIS_VM_SWAPPING
;
9362 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9364 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9365 * If there is not already a job loading the key, it is craeted.
9366 * The key is added to the io_keys list in the client structure, and also
9367 * in the hash table mapping swapped keys to waiting clients, that is,
9368 * server.io_waited_keys. */
9369 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9370 struct dictEntry
*de
;
9374 /* If the key does not exist or is already in RAM we don't need to
9375 * block the client at all. */
9376 de
= dictFind(c
->db
->dict
,key
);
9377 if (de
== NULL
) return 0;
9378 o
= dictGetEntryKey(de
);
9379 if (o
->storage
== REDIS_VM_MEMORY
) {
9381 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9382 /* We were swapping the key, undo it! */
9383 vmCancelThreadedIOJob(o
);
9387 /* OK: the key is either swapped, or being loaded just now. */
9389 /* Add the key to the list of keys this client is waiting for.
9390 * This maps clients to keys they are waiting for. */
9391 listAddNodeTail(c
->io_keys
,key
);
9394 /* Add the client to the swapped keys => clients waiting map. */
9395 de
= dictFind(c
->db
->io_keys
,key
);
9399 /* For every key we take a list of clients blocked for it */
9401 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9403 assert(retval
== DICT_OK
);
9405 l
= dictGetEntryVal(de
);
9407 listAddNodeTail(l
,c
);
9409 /* Are we already loading the key from disk? If not create a job */
9410 if (o
->storage
== REDIS_VM_SWAPPED
) {
9413 o
->storage
= REDIS_VM_LOADING
;
9414 j
= zmalloc(sizeof(*j
));
9415 j
->type
= REDIS_IOJOB_LOAD
;
9418 j
->key
->vtype
= o
->vtype
;
9419 j
->page
= o
->vm
.page
;
9422 j
->thread
= (pthread_t
) -1;
9430 /* Preload keys needed for the ZUNION and ZINTER commands. */
9431 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9433 num
= atoi(c
->argv
[2]->ptr
);
9434 for (i
= 0; i
< num
; i
++) {
9435 waitForSwappedKey(c
,c
->argv
[3+i
]);
9439 /* Is this client attempting to run a command against swapped keys?
9440 * If so, block it ASAP, load the keys in background, then resume it.
9442 * The important idea about this function is that it can fail! If keys will
9443 * still be swapped when the client is resumed, this key lookups will
9444 * just block loading keys from disk. In practical terms this should only
9445 * happen with SORT BY command or if there is a bug in this function.
9447 * Return 1 if the client is marked as blocked, 0 if the client can
9448 * continue as the keys it is going to access appear to be in memory. */
9449 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9452 if (cmd
->vm_preload_proc
!= NULL
) {
9453 cmd
->vm_preload_proc(c
);
9455 if (cmd
->vm_firstkey
== 0) return 0;
9456 last
= cmd
->vm_lastkey
;
9457 if (last
< 0) last
= c
->argc
+last
;
9458 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9459 waitForSwappedKey(c
,c
->argv
[j
]);
9462 /* If the client was blocked for at least one key, mark it as blocked. */
9463 if (listLength(c
->io_keys
)) {
9464 c
->flags
|= REDIS_IO_WAIT
;
9465 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9466 server
.vm_blocked_clients
++;
9473 /* Remove the 'key' from the list of blocked keys for a given client.
9475 * The function returns 1 when there are no longer blocking keys after
9476 * the current one was removed (and the client can be unblocked). */
9477 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9481 struct dictEntry
*de
;
9483 /* Remove the key from the list of keys this client is waiting for. */
9484 listRewind(c
->io_keys
,&li
);
9485 while ((ln
= listNext(&li
)) != NULL
) {
9486 if (compareStringObjects(ln
->value
,key
) == 0) {
9487 listDelNode(c
->io_keys
,ln
);
9493 /* Remove the client form the key => waiting clients map. */
9494 de
= dictFind(c
->db
->io_keys
,key
);
9496 l
= dictGetEntryVal(de
);
9497 ln
= listSearchKey(l
,c
);
9500 if (listLength(l
) == 0)
9501 dictDelete(c
->db
->io_keys
,key
);
9503 return listLength(c
->io_keys
) == 0;
9506 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9507 struct dictEntry
*de
;
9512 de
= dictFind(db
->io_keys
,key
);
9515 l
= dictGetEntryVal(de
);
9516 len
= listLength(l
);
9517 /* Note: we can't use something like while(listLength(l)) as the list
9518 * can be freed by the calling function when we remove the last element. */
9521 redisClient
*c
= ln
->value
;
9523 if (dontWaitForSwappedKey(c
,key
)) {
9524 /* Put the client in the list of clients ready to go as we
9525 * loaded all the keys about it. */
9526 listAddNodeTail(server
.io_ready_clients
,c
);
9531 /* =========================== Remote Configuration ========================= */
9533 static void configSetCommand(redisClient
*c
) {
9534 robj
*o
= getDecodedObject(c
->argv
[3]);
9535 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9536 zfree(server
.dbfilename
);
9537 server
.dbfilename
= zstrdup(o
->ptr
);
9538 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9539 zfree(server
.requirepass
);
9540 server
.requirepass
= zstrdup(o
->ptr
);
9541 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9542 zfree(server
.masterauth
);
9543 server
.masterauth
= zstrdup(o
->ptr
);
9544 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9545 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9547 addReplySds(c
,sdscatprintf(sdsempty(),
9548 "-ERR not supported CONFIG parameter %s\r\n",
9549 (char*)c
->argv
[2]->ptr
));
9554 addReply(c
,shared
.ok
);
9557 static void configGetCommand(redisClient
*c
) {
9558 robj
*o
= getDecodedObject(c
->argv
[2]);
9559 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9560 char *pattern
= o
->ptr
;
9564 decrRefCount(lenobj
);
9566 if (stringmatch(pattern
,"dbfilename",0)) {
9567 addReplyBulkCString(c
,"dbfilename");
9568 addReplyBulkCString(c
,server
.dbfilename
);
9571 if (stringmatch(pattern
,"requirepass",0)) {
9572 addReplyBulkCString(c
,"requirepass");
9573 addReplyBulkCString(c
,server
.requirepass
);
9576 if (stringmatch(pattern
,"masterauth",0)) {
9577 addReplyBulkCString(c
,"masterauth");
9578 addReplyBulkCString(c
,server
.masterauth
);
9581 if (stringmatch(pattern
,"maxmemory",0)) {
9584 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9585 addReplyBulkCString(c
,"maxmemory");
9586 addReplyBulkCString(c
,buf
);
9590 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9593 static void configCommand(redisClient
*c
) {
9594 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9595 if (c
->argc
!= 4) goto badarity
;
9596 configSetCommand(c
);
9597 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9598 if (c
->argc
!= 3) goto badarity
;
9599 configGetCommand(c
);
9600 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9601 if (c
->argc
!= 2) goto badarity
;
9602 server
.stat_numcommands
= 0;
9603 server
.stat_numconnections
= 0;
9604 server
.stat_expiredkeys
= 0;
9605 server
.stat_starttime
= time(NULL
);
9606 addReply(c
,shared
.ok
);
9608 addReplySds(c
,sdscatprintf(sdsempty(),
9609 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9614 addReplySds(c
,sdscatprintf(sdsempty(),
9615 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9616 (char*) c
->argv
[1]->ptr
));
9619 /* =========================== Pubsub implementation ======================== */
9621 static void freePubsubPattern(void *p
) {
9622 pubsubPattern
*pat
= p
;
9624 decrRefCount(pat
->pattern
);
9628 static int listMatchPubsubPattern(void *a
, void *b
) {
9629 pubsubPattern
*pa
= a
, *pb
= b
;
9631 return (pa
->client
== pb
->client
) &&
9632 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9635 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9636 * 0 if the client was already subscribed to that channel. */
9637 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9638 struct dictEntry
*de
;
9639 list
*clients
= NULL
;
9642 /* Add the channel to the client -> channels hash table */
9643 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9645 incrRefCount(channel
);
9646 /* Add the client to the channel -> list of clients hash table */
9647 de
= dictFind(server
.pubsub_channels
,channel
);
9649 clients
= listCreate();
9650 dictAdd(server
.pubsub_channels
,channel
,clients
);
9651 incrRefCount(channel
);
9653 clients
= dictGetEntryVal(de
);
9655 listAddNodeTail(clients
,c
);
9657 /* Notify the client */
9658 addReply(c
,shared
.mbulk3
);
9659 addReply(c
,shared
.subscribebulk
);
9660 addReplyBulk(c
,channel
);
9661 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9665 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9666 * 0 if the client was not subscribed to the specified channel. */
9667 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9668 struct dictEntry
*de
;
9673 /* Remove the channel from the client -> channels hash table */
9674 incrRefCount(channel
); /* channel may be just a pointer to the same object
9675 we have in the hash tables. Protect it... */
9676 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9678 /* Remove the client from the channel -> clients list hash table */
9679 de
= dictFind(server
.pubsub_channels
,channel
);
9681 clients
= dictGetEntryVal(de
);
9682 ln
= listSearchKey(clients
,c
);
9684 listDelNode(clients
,ln
);
9685 if (listLength(clients
) == 0) {
9686 /* Free the list and associated hash entry at all if this was
9687 * the latest client, so that it will be possible to abuse
9688 * Redis PUBSUB creating millions of channels. */
9689 dictDelete(server
.pubsub_channels
,channel
);
9692 /* Notify the client */
9694 addReply(c
,shared
.mbulk3
);
9695 addReply(c
,shared
.unsubscribebulk
);
9696 addReplyBulk(c
,channel
);
9697 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9698 listLength(c
->pubsub_patterns
));
9701 decrRefCount(channel
); /* it is finally safe to release it */
9705 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9706 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9709 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9712 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9713 incrRefCount(pattern
);
9714 pat
= zmalloc(sizeof(*pat
));
9715 pat
->pattern
= getDecodedObject(pattern
);
9717 listAddNodeTail(server
.pubsub_patterns
,pat
);
9719 /* Notify the client */
9720 addReply(c
,shared
.mbulk3
);
9721 addReply(c
,shared
.psubscribebulk
);
9722 addReplyBulk(c
,pattern
);
9723 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9727 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9728 * 0 if the client was not subscribed to the specified channel. */
9729 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9734 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9735 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9737 listDelNode(c
->pubsub_patterns
,ln
);
9739 pat
.pattern
= pattern
;
9740 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9741 listDelNode(server
.pubsub_patterns
,ln
);
9743 /* Notify the client */
9745 addReply(c
,shared
.mbulk3
);
9746 addReply(c
,shared
.punsubscribebulk
);
9747 addReplyBulk(c
,pattern
);
9748 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9749 listLength(c
->pubsub_patterns
));
9751 decrRefCount(pattern
);
9755 /* Unsubscribe from all the channels. Return the number of channels the
9756 * client was subscribed from. */
9757 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9758 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9762 while((de
= dictNext(di
)) != NULL
) {
9763 robj
*channel
= dictGetEntryKey(de
);
9765 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9767 dictReleaseIterator(di
);
9771 /* Unsubscribe from all the patterns. Return the number of patterns the
9772 * client was subscribed from. */
9773 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9778 listRewind(c
->pubsub_patterns
,&li
);
9779 while ((ln
= listNext(&li
)) != NULL
) {
9780 robj
*pattern
= ln
->value
;
9782 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9787 /* Publish a message */
9788 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9790 struct dictEntry
*de
;
9794 /* Send to clients listening for that channel */
9795 de
= dictFind(server
.pubsub_channels
,channel
);
9797 list
*list
= dictGetEntryVal(de
);
9801 listRewind(list
,&li
);
9802 while ((ln
= listNext(&li
)) != NULL
) {
9803 redisClient
*c
= ln
->value
;
9805 addReply(c
,shared
.mbulk3
);
9806 addReply(c
,shared
.messagebulk
);
9807 addReplyBulk(c
,channel
);
9808 addReplyBulk(c
,message
);
9812 /* Send to clients listening to matching channels */
9813 if (listLength(server
.pubsub_patterns
)) {
9814 listRewind(server
.pubsub_patterns
,&li
);
9815 channel
= getDecodedObject(channel
);
9816 while ((ln
= listNext(&li
)) != NULL
) {
9817 pubsubPattern
*pat
= ln
->value
;
9819 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9820 sdslen(pat
->pattern
->ptr
),
9821 (char*)channel
->ptr
,
9822 sdslen(channel
->ptr
),0)) {
9823 addReply(pat
->client
,shared
.mbulk4
);
9824 addReply(pat
->client
,shared
.pmessagebulk
);
9825 addReplyBulk(pat
->client
,pat
->pattern
);
9826 addReplyBulk(pat
->client
,channel
);
9827 addReplyBulk(pat
->client
,message
);
9831 decrRefCount(channel
);
9836 static void subscribeCommand(redisClient
*c
) {
9839 for (j
= 1; j
< c
->argc
; j
++)
9840 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9843 static void unsubscribeCommand(redisClient
*c
) {
9845 pubsubUnsubscribeAllChannels(c
,1);
9850 for (j
= 1; j
< c
->argc
; j
++)
9851 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9855 static void psubscribeCommand(redisClient
*c
) {
9858 for (j
= 1; j
< c
->argc
; j
++)
9859 pubsubSubscribePattern(c
,c
->argv
[j
]);
9862 static void punsubscribeCommand(redisClient
*c
) {
9864 pubsubUnsubscribeAllPatterns(c
,1);
9869 for (j
= 1; j
< c
->argc
; j
++)
9870 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9874 static void publishCommand(redisClient
*c
) {
9875 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9876 addReplyLong(c
,receivers
);
9879 /* ================================= Debugging ============================== */
9881 static void debugCommand(redisClient
*c
) {
9882 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9884 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9885 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9886 addReply(c
,shared
.err
);
9890 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9891 addReply(c
,shared
.err
);
9894 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9895 addReply(c
,shared
.ok
);
9896 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9898 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9899 addReply(c
,shared
.err
);
9902 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9903 addReply(c
,shared
.ok
);
9904 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9905 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9909 addReply(c
,shared
.nokeyerr
);
9912 key
= dictGetEntryKey(de
);
9913 val
= dictGetEntryVal(de
);
9914 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9915 key
->storage
== REDIS_VM_SWAPPING
)) {
9919 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9920 strenc
= strencoding
[val
->encoding
];
9922 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9925 addReplySds(c
,sdscatprintf(sdsempty(),
9926 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9927 "encoding:%s serializedlength:%lld\r\n",
9928 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9929 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9931 addReplySds(c
,sdscatprintf(sdsempty(),
9932 "+Key at:%p refcount:%d, value swapped at: page %llu "
9933 "using %llu pages\r\n",
9934 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9935 (unsigned long long) key
->vm
.usedpages
));
9937 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9938 lookupKeyRead(c
->db
,c
->argv
[2]);
9939 addReply(c
,shared
.ok
);
9940 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9941 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9944 if (!server
.vm_enabled
) {
9945 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9949 addReply(c
,shared
.nokeyerr
);
9952 key
= dictGetEntryKey(de
);
9953 val
= dictGetEntryVal(de
);
9954 /* If the key is shared we want to create a copy */
9955 if (key
->refcount
> 1) {
9956 robj
*newkey
= dupStringObject(key
);
9958 key
= dictGetEntryKey(de
) = newkey
;
9961 if (key
->storage
!= REDIS_VM_MEMORY
) {
9962 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9963 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9964 dictGetEntryVal(de
) = NULL
;
9965 addReply(c
,shared
.ok
);
9967 addReply(c
,shared
.err
);
9970 addReplySds(c
,sdsnew(
9971 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9975 static void _redisAssert(char *estr
, char *file
, int line
) {
9976 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9977 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9978 #ifdef HAVE_BACKTRACE
9979 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9984 static void _redisPanic(char *msg
, char *file
, int line
) {
9985 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
9986 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
9987 #ifdef HAVE_BACKTRACE
9988 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9993 /* =================================== Main! ================================ */
9996 int linuxOvercommitMemoryValue(void) {
9997 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10000 if (!fp
) return -1;
10001 if (fgets(buf
,64,fp
) == NULL
) {
10010 void linuxOvercommitMemoryWarning(void) {
10011 if (linuxOvercommitMemoryValue() == 0) {
10012 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
10015 #endif /* __linux__ */
10017 static void daemonize(void) {
10021 if (fork() != 0) exit(0); /* parent exits */
10022 setsid(); /* create a new session */
10024 /* Every output goes to /dev/null. If Redis is daemonized but
10025 * the 'logfile' is set to 'stdout' in the configuration file
10026 * it will not log at all. */
10027 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10028 dup2(fd
, STDIN_FILENO
);
10029 dup2(fd
, STDOUT_FILENO
);
10030 dup2(fd
, STDERR_FILENO
);
10031 if (fd
> STDERR_FILENO
) close(fd
);
10033 /* Try to write the pid file */
10034 fp
= fopen(server
.pidfile
,"w");
10036 fprintf(fp
,"%d\n",getpid());
10041 static void version() {
10042 printf("Redis server version %s\n", REDIS_VERSION
);
10046 static void usage() {
10047 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10048 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10052 int main(int argc
, char **argv
) {
10055 initServerConfig();
10057 if (strcmp(argv
[1], "-v") == 0 ||
10058 strcmp(argv
[1], "--version") == 0) version();
10059 if (strcmp(argv
[1], "--help") == 0) usage();
10060 resetServerSaveParams();
10061 loadServerConfig(argv
[1]);
10062 } else if ((argc
> 2)) {
10065 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'");
10067 if (server
.daemonize
) daemonize();
10069 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10071 linuxOvercommitMemoryWarning();
10073 start
= time(NULL
);
10074 if (server
.appendonly
) {
10075 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10076 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10078 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10079 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10081 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10082 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10084 aeDeleteEventLoop(server
.el
);
10088 /* ============================= Backtrace support ========================= */
10090 #ifdef HAVE_BACKTRACE
10091 static char *findFuncName(void *pointer
, unsigned long *offset
);
10093 static void *getMcontextEip(ucontext_t
*uc
) {
10094 #if defined(__FreeBSD__)
10095 return (void*) uc
->uc_mcontext
.mc_eip
;
10096 #elif defined(__dietlibc__)
10097 return (void*) uc
->uc_mcontext
.eip
;
10098 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10100 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10102 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10104 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10105 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10106 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10108 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10110 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10111 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10112 #elif defined(__ia64__) /* Linux IA64 */
10113 return (void*) uc
->uc_mcontext
.sc_ip
;
10119 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10121 char **messages
= NULL
;
10122 int i
, trace_size
= 0;
10123 unsigned long offset
=0;
10124 ucontext_t
*uc
= (ucontext_t
*) secret
;
10126 REDIS_NOTUSED(info
);
10128 redisLog(REDIS_WARNING
,
10129 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10130 infostring
= genRedisInfoString();
10131 redisLog(REDIS_WARNING
, "%s",infostring
);
10132 /* It's not safe to sdsfree() the returned string under memory
10133 * corruption conditions. Let it leak as we are going to abort */
10135 trace_size
= backtrace(trace
, 100);
10136 /* overwrite sigaction with caller's address */
10137 if (getMcontextEip(uc
) != NULL
) {
10138 trace
[1] = getMcontextEip(uc
);
10140 messages
= backtrace_symbols(trace
, trace_size
);
10142 for (i
=1; i
<trace_size
; ++i
) {
10143 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10145 p
= strchr(messages
[i
],'+');
10146 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10147 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10149 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10152 /* free(messages); Don't call free() with possibly corrupted memory. */
10156 static void setupSigSegvAction(void) {
10157 struct sigaction act
;
10159 sigemptyset (&act
.sa_mask
);
10160 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10161 * is used. Otherwise, sa_handler is used */
10162 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10163 act
.sa_sigaction
= segvHandler
;
10164 sigaction (SIGSEGV
, &act
, NULL
);
10165 sigaction (SIGBUS
, &act
, NULL
);
10166 sigaction (SIGFPE
, &act
, NULL
);
10167 sigaction (SIGILL
, &act
, NULL
);
10168 sigaction (SIGBUS
, &act
, NULL
);
10172 #include "staticsymbols.h"
10173 /* This function try to convert a pointer into a function name. It's used in
10174 * oreder to provide a backtrace under segmentation fault that's able to
10175 * display functions declared as static (otherwise the backtrace is useless). */
10176 static char *findFuncName(void *pointer
, unsigned long *offset
){
10178 unsigned long off
, minoff
= 0;
10180 /* Try to match against the Symbol with the smallest offset */
10181 for (i
=0; symsTable
[i
].pointer
; i
++) {
10182 unsigned long lp
= (unsigned long) pointer
;
10184 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10185 off
=lp
-symsTable
[i
].pointer
;
10186 if (ret
< 0 || off
< minoff
) {
10192 if (ret
== -1) return NULL
;
10194 return symsTable
[ret
].name
;
10196 #else /* HAVE_BACKTRACE */
10197 static void setupSigSegvAction(void) {
10199 #endif /* HAVE_BACKTRACE */