2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.8"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117 #define REDIS_STRING 0
123 /* Objects encoding. Some kind of objects like Strings and Hashes can be
124 * internally represented in multiple ways. The 'encoding' field of the object
125 * is set to one of this fields for this object. */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
128 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
129 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131 static char* strencoding
[] = {
132 "raw", "int", "zipmap", "hashtable"
135 /* Object types only used for dumping to disk */
136 #define REDIS_EXPIRETIME 253
137 #define REDIS_SELECTDB 254
138 #define REDIS_EOF 255
140 /* Defines related to the dump file format. To store 32 bits lengths for short
141 * keys requires a lot of space, so we check the most significant 2 bits of
142 * the first byte to interpreter the length:
144 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
145 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
146 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
147 * 11|000000 this means: specially encoded object will follow. The six bits
148 * number specify the kind of object that follows.
149 * See the REDIS_RDB_ENC_* defines.
151 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
152 * values, will fit inside. */
153 #define REDIS_RDB_6BITLEN 0
154 #define REDIS_RDB_14BITLEN 1
155 #define REDIS_RDB_32BITLEN 2
156 #define REDIS_RDB_ENCVAL 3
157 #define REDIS_RDB_LENERR UINT_MAX
159 /* When a length of a string object stored on disk has the first two bits
160 * set, the remaining two bits specify a special encoding for the object
161 * accordingly to the following defines: */
162 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
163 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
164 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
165 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167 /* Virtual memory object->where field. */
168 #define REDIS_VM_MEMORY 0 /* The object is on memory */
169 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
170 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
171 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173 /* Virtual memory static configuration stuff.
174 * Check vmFindContiguousPages() to know more about this magic numbers. */
175 #define REDIS_VM_MAX_NEAR_PAGES 65536
176 #define REDIS_VM_MAX_RANDOM_JUMP 4096
177 #define REDIS_VM_MAX_THREADS 32
178 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
179 /* The following is the *percentage* of completed I/O jobs to process when the
180 * handelr is called. While Virtual Memory I/O operations are performed by
181 * threads, this operations must be processed by the main thread when completed
182 * in order to take effect. */
183 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
186 #define REDIS_SLAVE 1 /* This client is a slave server */
187 #define REDIS_MASTER 2 /* This client is a master server */
188 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
189 #define REDIS_MULTI 8 /* This client is in a MULTI context */
190 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
191 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 /* Slave replication state - slave side */
194 #define REDIS_REPL_NONE 0 /* No active replication */
195 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
196 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
198 /* Slave replication state - from the point of view of master
199 * Note that in SEND_BULK and ONLINE state the slave receives new updates
200 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
201 * to start the next background saving in order to send updates to it. */
202 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
203 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
204 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
205 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
207 /* List related stuff */
211 /* Sort operations */
212 #define REDIS_SORT_GET 0
213 #define REDIS_SORT_ASC 1
214 #define REDIS_SORT_DESC 2
215 #define REDIS_SORTKEY_MAX 1024
218 #define REDIS_DEBUG 0
219 #define REDIS_VERBOSE 1
220 #define REDIS_NOTICE 2
221 #define REDIS_WARNING 3
223 /* Anti-warning macro... */
224 #define REDIS_NOTUSED(V) ((void) V)
226 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
227 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
229 /* Append only defines */
230 #define APPENDFSYNC_NO 0
231 #define APPENDFSYNC_ALWAYS 1
232 #define APPENDFSYNC_EVERYSEC 2
234 /* Hashes related defaults */
235 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
236 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
238 /* We can print the stacktrace, so our assert is defined this way: */
239 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
240 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
241 static void _redisAssert(char *estr
, char *file
, int line
);
242 static void _redisPanic(char *msg
, char *file
, int line
);
244 /*================================= Data types ============================== */
246 /* A redis object, that is a type able to hold a string / list / set */
248 /* The VM object structure */
249 struct redisObjectVM
{
250 off_t page
; /* the page at witch the object is stored on disk */
251 off_t usedpages
; /* number of pages used on disk */
252 time_t atime
; /* Last access time */
255 /* The actual Redis Object */
256 typedef struct redisObject
{
259 unsigned char encoding
;
260 unsigned char storage
; /* If this object is a key, where is the value?
261 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
262 unsigned char vtype
; /* If this object is a key, and value is swapped out,
263 * this is the type of the swapped out object. */
265 /* VM fields, this are only allocated if VM is active, otherwise the
266 * object allocation function will just allocate
267 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
268 * Redis without VM active will not have any overhead. */
269 struct redisObjectVM vm
;
272 /* Macro used to initalize a Redis object allocated on the stack.
273 * Note that this macro is taken near the structure definition to make sure
274 * we'll update it when the structure is changed, to avoid bugs like
275 * bug #85 introduced exactly in this way. */
276 #define initStaticStringObject(_var,_ptr) do { \
278 _var.type = REDIS_STRING; \
279 _var.encoding = REDIS_ENCODING_RAW; \
281 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
284 typedef struct redisDb
{
285 dict
*dict
; /* The keyspace for this DB */
286 dict
*expires
; /* Timeout of keys with a timeout set */
287 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
288 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
292 /* Client MULTI/EXEC state */
293 typedef struct multiCmd
{
296 struct redisCommand
*cmd
;
299 typedef struct multiState
{
300 multiCmd
*commands
; /* Array of MULTI commands */
301 int count
; /* Total number of MULTI commands */
304 /* With multiplexing we need to take per-clinet state.
305 * Clients are taken in a liked list. */
306 typedef struct redisClient
{
311 robj
**argv
, **mbargv
;
313 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
314 int multibulk
; /* multi bulk command format active */
317 time_t lastinteraction
; /* time of the last interaction, used for timeout */
318 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
319 int slaveseldb
; /* slave selected db, if this client is a slave */
320 int authenticated
; /* when requirepass is non-NULL */
321 int replstate
; /* replication state if this is a slave */
322 int repldbfd
; /* replication DB file descriptor */
323 long repldboff
; /* replication DB file offset */
324 off_t repldbsize
; /* replication DB file size */
325 multiState mstate
; /* MULTI/EXEC state */
326 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
327 * operation such as BLPOP. Otherwise NULL. */
328 int blockingkeysnum
; /* Number of blocking keys */
329 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
330 * is >= blockingto then the operation timed out. */
331 list
*io_keys
; /* Keys this client is waiting to be loaded from the
332 * swap file in order to continue. */
333 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
334 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
342 /* Global server state structure */
347 long long dirty
; /* changes to DB from the last save */
349 list
*slaves
, *monitors
;
350 char neterr
[ANET_ERR_LEN
];
352 int cronloops
; /* number of times the cron function run */
353 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
354 time_t lastsave
; /* Unix time of last save succeeede */
355 /* Fields used only for stats */
356 time_t stat_starttime
; /* server start time */
357 long long stat_numcommands
; /* number of processed commands */
358 long long stat_numconnections
; /* number of connections received */
359 long long stat_expiredkeys
; /* number of expired keys */
372 pid_t bgsavechildpid
;
373 pid_t bgrewritechildpid
;
374 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
385 /* Replication related */
390 redisClient
*master
; /* client that is master for this slave */
392 unsigned int maxclients
;
393 unsigned long long maxmemory
;
394 unsigned int blpop_blocked_clients
;
395 unsigned int vm_blocked_clients
;
396 /* Sort parameters - qsort_r() is only available under BSD so we
397 * have to take this state global, in order to pass it to sortCompare() */
401 /* Virtual memory configuration */
406 unsigned long long vm_max_memory
;
408 size_t hash_max_zipmap_entries
;
409 size_t hash_max_zipmap_value
;
410 /* Virtual memory state */
413 off_t vm_next_page
; /* Next probably empty page */
414 off_t vm_near_pages
; /* Number of pages allocated sequentially */
415 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
416 time_t unixtime
; /* Unix time sampled every second. */
417 /* Virtual memory I/O threads stuff */
418 /* An I/O thread process an element taken from the io_jobs queue and
419 * put the result of the operation in the io_done list. While the
420 * job is being processed, it's put on io_processing queue. */
421 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
422 list
*io_processing
; /* List of VM I/O jobs being processed */
423 list
*io_processed
; /* List of VM I/O jobs already processed */
424 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
425 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
426 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
427 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
428 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
429 int io_active_threads
; /* Number of running I/O threads */
430 int vm_max_threads
; /* Max number of I/O threads running at the same time */
431 /* Our main thread is blocked on the event loop, locking for sockets ready
432 * to be read or written, so when a threaded I/O operation is ready to be
433 * processed by the main thread, the I/O thread will use a unix pipe to
434 * awake the main thread. The followings are the two pipe FDs. */
435 int io_ready_pipe_read
;
436 int io_ready_pipe_write
;
437 /* Virtual memory stats */
438 unsigned long long vm_stats_used_pages
;
439 unsigned long long vm_stats_swapped_objects
;
440 unsigned long long vm_stats_swapouts
;
441 unsigned long long vm_stats_swapins
;
443 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
444 list
*pubsub_patterns
; /* A list of pubsub_patterns */
449 typedef struct pubsubPattern
{
454 typedef void redisCommandProc(redisClient
*c
);
455 struct redisCommand
{
457 redisCommandProc
*proc
;
460 /* Use a function to determine which keys need to be loaded
461 * in the background prior to executing this command. Takes precedence
462 * over vm_firstkey and others, ignored when NULL */
463 redisCommandProc
*vm_preload_proc
;
464 /* What keys should be loaded in background when calling this command? */
465 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
466 int vm_lastkey
; /* THe last argument that's a key */
467 int vm_keystep
; /* The step between first and last key */
470 struct redisFunctionSym
{
472 unsigned long pointer
;
475 typedef struct _redisSortObject
{
483 typedef struct _redisSortOperation
{
486 } redisSortOperation
;
488 /* ZSETs use a specialized version of Skiplists */
490 typedef struct zskiplistNode
{
491 struct zskiplistNode
**forward
;
492 struct zskiplistNode
*backward
;
498 typedef struct zskiplist
{
499 struct zskiplistNode
*header
, *tail
;
500 unsigned long length
;
504 typedef struct zset
{
509 /* Our shared "common" objects */
511 #define REDIS_SHARED_INTEGERS 10000
512 struct sharedObjectsStruct
{
513 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
514 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
515 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
516 *outofrangeerr
, *plus
,
517 *select0
, *select1
, *select2
, *select3
, *select4
,
518 *select5
, *select6
, *select7
, *select8
, *select9
,
519 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
520 *psubscribebulk
, *punsubscribebulk
, *integers
[REDIS_SHARED_INTEGERS
];
523 /* Global vars that are actally used as constants. The following double
524 * values are used for double on-disk serialization, and are initialized
525 * at runtime to avoid strange compiler optimizations. */
527 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
529 /* VM threaded I/O request message */
530 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
531 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
532 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
533 typedef struct iojob
{
534 int type
; /* Request type, REDIS_IOJOB_* */
535 redisDb
*db
;/* Redis database */
536 robj
*key
; /* This I/O request is about swapping this key */
537 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
538 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
539 off_t page
; /* Swap page where to read/write the object */
540 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
541 int canceled
; /* True if this command was canceled by blocking side of VM */
542 pthread_t thread
; /* ID of the thread processing this entry */
545 /*================================ Prototypes =============================== */
547 static void freeStringObject(robj
*o
);
548 static void freeListObject(robj
*o
);
549 static void freeSetObject(robj
*o
);
550 static void decrRefCount(void *o
);
551 static robj
*createObject(int type
, void *ptr
);
552 static void freeClient(redisClient
*c
);
553 static int rdbLoad(char *filename
);
554 static void addReply(redisClient
*c
, robj
*obj
);
555 static void addReplySds(redisClient
*c
, sds s
);
556 static void incrRefCount(robj
*o
);
557 static int rdbSaveBackground(char *filename
);
558 static robj
*createStringObject(char *ptr
, size_t len
);
559 static robj
*dupStringObject(robj
*o
);
560 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
561 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
562 static int syncWithMaster(void);
563 static robj
*tryObjectEncoding(robj
*o
);
564 static robj
*getDecodedObject(robj
*o
);
565 static int removeExpire(redisDb
*db
, robj
*key
);
566 static int expireIfNeeded(redisDb
*db
, robj
*key
);
567 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
568 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
569 static int deleteKey(redisDb
*db
, robj
*key
);
570 static time_t getExpire(redisDb
*db
, robj
*key
);
571 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
572 static void updateSlavesWaitingBgsave(int bgsaveerr
);
573 static void freeMemoryIfNeeded(void);
574 static int processCommand(redisClient
*c
);
575 static void setupSigSegvAction(void);
576 static void rdbRemoveTempFile(pid_t childpid
);
577 static void aofRemoveTempFile(pid_t childpid
);
578 static size_t stringObjectLen(robj
*o
);
579 static void processInputBuffer(redisClient
*c
);
580 static zskiplist
*zslCreate(void);
581 static void zslFree(zskiplist
*zsl
);
582 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
583 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
584 static void initClientMultiState(redisClient
*c
);
585 static void freeClientMultiState(redisClient
*c
);
586 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
587 static void unblockClientWaitingData(redisClient
*c
);
588 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
589 static void vmInit(void);
590 static void vmMarkPagesFree(off_t page
, off_t count
);
591 static robj
*vmLoadObject(robj
*key
);
592 static robj
*vmPreviewObject(robj
*key
);
593 static int vmSwapOneObjectBlocking(void);
594 static int vmSwapOneObjectThreaded(void);
595 static int vmCanSwapOut(void);
596 static int tryFreeOneObjectFromFreelist(void);
597 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
598 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static void vmCancelThreadedIOJob(robj
*o
);
600 static void lockThreadedIO(void);
601 static void unlockThreadedIO(void);
602 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
603 static void freeIOJob(iojob
*j
);
604 static void queueIOJob(iojob
*j
);
605 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
606 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
607 static void waitEmptyIOJobsQueue(void);
608 static void vmReopenSwapFile(void);
609 static int vmFreePage(off_t page
);
610 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
611 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
612 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
613 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
614 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
615 static struct redisCommand
*lookupCommand(char *name
);
616 static void call(redisClient
*c
, struct redisCommand
*cmd
);
617 static void resetClient(redisClient
*c
);
618 static void convertToRealHash(robj
*o
);
619 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
620 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
621 static void freePubsubPattern(void *p
);
622 static int listMatchPubsubPattern(void *a
, void *b
);
623 static int compareStringObjects(robj
*a
, robj
*b
);
626 static void authCommand(redisClient
*c
);
627 static void pingCommand(redisClient
*c
);
628 static void echoCommand(redisClient
*c
);
629 static void setCommand(redisClient
*c
);
630 static void setnxCommand(redisClient
*c
);
631 static void getCommand(redisClient
*c
);
632 static void delCommand(redisClient
*c
);
633 static void existsCommand(redisClient
*c
);
634 static void incrCommand(redisClient
*c
);
635 static void decrCommand(redisClient
*c
);
636 static void incrbyCommand(redisClient
*c
);
637 static void decrbyCommand(redisClient
*c
);
638 static void selectCommand(redisClient
*c
);
639 static void randomkeyCommand(redisClient
*c
);
640 static void keysCommand(redisClient
*c
);
641 static void dbsizeCommand(redisClient
*c
);
642 static void lastsaveCommand(redisClient
*c
);
643 static void saveCommand(redisClient
*c
);
644 static void bgsaveCommand(redisClient
*c
);
645 static void bgrewriteaofCommand(redisClient
*c
);
646 static void shutdownCommand(redisClient
*c
);
647 static void moveCommand(redisClient
*c
);
648 static void renameCommand(redisClient
*c
);
649 static void renamenxCommand(redisClient
*c
);
650 static void lpushCommand(redisClient
*c
);
651 static void rpushCommand(redisClient
*c
);
652 static void lpopCommand(redisClient
*c
);
653 static void rpopCommand(redisClient
*c
);
654 static void llenCommand(redisClient
*c
);
655 static void lindexCommand(redisClient
*c
);
656 static void lrangeCommand(redisClient
*c
);
657 static void ltrimCommand(redisClient
*c
);
658 static void typeCommand(redisClient
*c
);
659 static void lsetCommand(redisClient
*c
);
660 static void saddCommand(redisClient
*c
);
661 static void sremCommand(redisClient
*c
);
662 static void smoveCommand(redisClient
*c
);
663 static void sismemberCommand(redisClient
*c
);
664 static void scardCommand(redisClient
*c
);
665 static void spopCommand(redisClient
*c
);
666 static void srandmemberCommand(redisClient
*c
);
667 static void sinterCommand(redisClient
*c
);
668 static void sinterstoreCommand(redisClient
*c
);
669 static void sunionCommand(redisClient
*c
);
670 static void sunionstoreCommand(redisClient
*c
);
671 static void sdiffCommand(redisClient
*c
);
672 static void sdiffstoreCommand(redisClient
*c
);
673 static void syncCommand(redisClient
*c
);
674 static void flushdbCommand(redisClient
*c
);
675 static void flushallCommand(redisClient
*c
);
676 static void sortCommand(redisClient
*c
);
677 static void lremCommand(redisClient
*c
);
678 static void rpoplpushcommand(redisClient
*c
);
679 static void infoCommand(redisClient
*c
);
680 static void mgetCommand(redisClient
*c
);
681 static void monitorCommand(redisClient
*c
);
682 static void expireCommand(redisClient
*c
);
683 static void expireatCommand(redisClient
*c
);
684 static void getsetCommand(redisClient
*c
);
685 static void ttlCommand(redisClient
*c
);
686 static void slaveofCommand(redisClient
*c
);
687 static void debugCommand(redisClient
*c
);
688 static void msetCommand(redisClient
*c
);
689 static void msetnxCommand(redisClient
*c
);
690 static void zaddCommand(redisClient
*c
);
691 static void zincrbyCommand(redisClient
*c
);
692 static void zrangeCommand(redisClient
*c
);
693 static void zrangebyscoreCommand(redisClient
*c
);
694 static void zcountCommand(redisClient
*c
);
695 static void zrevrangeCommand(redisClient
*c
);
696 static void zcardCommand(redisClient
*c
);
697 static void zremCommand(redisClient
*c
);
698 static void zscoreCommand(redisClient
*c
);
699 static void zremrangebyscoreCommand(redisClient
*c
);
700 static void multiCommand(redisClient
*c
);
701 static void execCommand(redisClient
*c
);
702 static void discardCommand(redisClient
*c
);
703 static void blpopCommand(redisClient
*c
);
704 static void brpopCommand(redisClient
*c
);
705 static void appendCommand(redisClient
*c
);
706 static void substrCommand(redisClient
*c
);
707 static void zrankCommand(redisClient
*c
);
708 static void zrevrankCommand(redisClient
*c
);
709 static void hsetCommand(redisClient
*c
);
710 static void hsetnxCommand(redisClient
*c
);
711 static void hgetCommand(redisClient
*c
);
712 static void hmsetCommand(redisClient
*c
);
713 static void hmgetCommand(redisClient
*c
);
714 static void hdelCommand(redisClient
*c
);
715 static void hlenCommand(redisClient
*c
);
716 static void zremrangebyrankCommand(redisClient
*c
);
717 static void zunionCommand(redisClient
*c
);
718 static void zinterCommand(redisClient
*c
);
719 static void hkeysCommand(redisClient
*c
);
720 static void hvalsCommand(redisClient
*c
);
721 static void hgetallCommand(redisClient
*c
);
722 static void hexistsCommand(redisClient
*c
);
723 static void configCommand(redisClient
*c
);
724 static void hincrbyCommand(redisClient
*c
);
725 static void subscribeCommand(redisClient
*c
);
726 static void unsubscribeCommand(redisClient
*c
);
727 static void psubscribeCommand(redisClient
*c
);
728 static void punsubscribeCommand(redisClient
*c
);
729 static void publishCommand(redisClient
*c
);
731 /*================================= Globals ================================= */
734 static struct redisServer server
; /* server global state */
735 static struct redisCommand cmdTable
[] = {
736 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
737 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
738 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
739 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
740 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
742 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
743 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
744 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
746 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
747 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
748 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
755 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
758 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
759 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
760 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
761 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
762 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
763 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
764 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
765 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
766 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
767 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
768 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
769 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
770 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
771 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
772 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
774 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
775 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
776 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
779 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
780 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
784 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
785 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
786 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
787 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
788 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
789 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
791 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
792 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
795 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
796 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
797 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
798 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
799 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
802 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
803 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
804 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
805 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
806 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
807 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
809 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
810 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
817 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
823 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
825 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
830 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
833 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
836 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
841 {NULL
,NULL
,0,0,NULL
,0,0,0}
844 /*============================ Utility functions ============================ */
846 /* Glob-style pattern matching. */
847 static int stringmatchlen(const char *pattern
, int patternLen
,
848 const char *string
, int stringLen
, int nocase
)
853 while (pattern
[1] == '*') {
858 return 1; /* match */
860 if (stringmatchlen(pattern
+1, patternLen
-1,
861 string
, stringLen
, nocase
))
862 return 1; /* match */
866 return 0; /* no match */
870 return 0; /* no match */
880 not = pattern
[0] == '^';
887 if (pattern
[0] == '\\') {
890 if (pattern
[0] == string
[0])
892 } else if (pattern
[0] == ']') {
894 } else if (patternLen
== 0) {
898 } else if (pattern
[1] == '-' && patternLen
>= 3) {
899 int start
= pattern
[0];
900 int end
= pattern
[2];
908 start
= tolower(start
);
914 if (c
>= start
&& c
<= end
)
918 if (pattern
[0] == string
[0])
921 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
931 return 0; /* no match */
937 if (patternLen
>= 2) {
944 if (pattern
[0] != string
[0])
945 return 0; /* no match */
947 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
948 return 0; /* no match */
956 if (stringLen
== 0) {
957 while(*pattern
== '*') {
964 if (patternLen
== 0 && stringLen
== 0)
969 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
970 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
973 static void redisLog(int level
, const char *fmt
, ...) {
977 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
981 if (level
>= server
.verbosity
) {
987 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
988 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
989 vfprintf(fp
, fmt
, ap
);
995 if (server
.logfile
) fclose(fp
);
998 /*====================== Hash table type implementation ==================== */
1000 /* This is an hash table type that uses the SDS dynamic strings libary as
1001 * keys and radis objects as values (objects can hold SDS strings,
1004 static void dictVanillaFree(void *privdata
, void *val
)
1006 DICT_NOTUSED(privdata
);
1010 static void dictListDestructor(void *privdata
, void *val
)
1012 DICT_NOTUSED(privdata
);
1013 listRelease((list
*)val
);
1016 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1020 DICT_NOTUSED(privdata
);
1022 l1
= sdslen((sds
)key1
);
1023 l2
= sdslen((sds
)key2
);
1024 if (l1
!= l2
) return 0;
1025 return memcmp(key1
, key2
, l1
) == 0;
1028 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1030 DICT_NOTUSED(privdata
);
1032 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1036 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1039 const robj
*o1
= key1
, *o2
= key2
;
1040 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1043 static unsigned int dictObjHash(const void *key
) {
1044 const robj
*o
= key
;
1045 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1048 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1051 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1054 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1055 o2
->encoding
== REDIS_ENCODING_INT
&&
1056 o1
->ptr
== o2
->ptr
) return 1;
1058 o1
= getDecodedObject(o1
);
1059 o2
= getDecodedObject(o2
);
1060 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1066 static unsigned int dictEncObjHash(const void *key
) {
1067 robj
*o
= (robj
*) key
;
1069 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1070 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1072 if (o
->encoding
== REDIS_ENCODING_INT
) {
1076 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1077 return dictGenHashFunction((unsigned char*)buf
, len
);
1081 o
= getDecodedObject(o
);
1082 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1089 /* Sets type and expires */
1090 static dictType setDictType
= {
1091 dictEncObjHash
, /* hash function */
1094 dictEncObjKeyCompare
, /* key compare */
1095 dictRedisObjectDestructor
, /* key destructor */
1096 NULL
/* val destructor */
1099 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1100 static dictType zsetDictType
= {
1101 dictEncObjHash
, /* hash function */
1104 dictEncObjKeyCompare
, /* key compare */
1105 dictRedisObjectDestructor
, /* key destructor */
1106 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1110 static dictType dbDictType
= {
1111 dictObjHash
, /* hash function */
1114 dictObjKeyCompare
, /* key compare */
1115 dictRedisObjectDestructor
, /* key destructor */
1116 dictRedisObjectDestructor
/* val destructor */
1120 static dictType keyptrDictType
= {
1121 dictObjHash
, /* hash function */
1124 dictObjKeyCompare
, /* key compare */
1125 dictRedisObjectDestructor
, /* key destructor */
1126 NULL
/* val destructor */
1129 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1130 static dictType hashDictType
= {
1131 dictEncObjHash
, /* hash function */
1134 dictEncObjKeyCompare
, /* key compare */
1135 dictRedisObjectDestructor
, /* key destructor */
1136 dictRedisObjectDestructor
/* val destructor */
1139 /* Keylist hash table type has unencoded redis objects as keys and
1140 * lists as values. It's used for blocking operations (BLPOP) and to
1141 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1142 static dictType keylistDictType
= {
1143 dictObjHash
, /* hash function */
1146 dictObjKeyCompare
, /* key compare */
1147 dictRedisObjectDestructor
, /* key destructor */
1148 dictListDestructor
/* val destructor */
1151 static void version();
1153 /* ========================= Random utility functions ======================= */
1155 /* Redis generally does not try to recover from out of memory conditions
1156 * when allocating objects or strings, it is not clear if it will be possible
1157 * to report this condition to the client since the networking layer itself
1158 * is based on heap allocation for send buffers, so we simply abort.
1159 * At least the code will be simpler to read... */
1160 static void oom(const char *msg
) {
1161 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1166 /* ====================== Redis server networking stuff ===================== */
1167 static void closeTimedoutClients(void) {
1170 time_t now
= time(NULL
);
1173 listRewind(server
.clients
,&li
);
1174 while ((ln
= listNext(&li
)) != NULL
) {
1175 c
= listNodeValue(ln
);
1176 if (server
.maxidletime
&&
1177 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1178 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1179 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1180 listLength(c
->pubsub_patterns
) == 0 &&
1181 (now
- c
->lastinteraction
> server
.maxidletime
))
1183 redisLog(REDIS_VERBOSE
,"Closing idle client");
1185 } else if (c
->flags
& REDIS_BLOCKED
) {
1186 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1187 addReply(c
,shared
.nullmultibulk
);
1188 unblockClientWaitingData(c
);
1194 static int htNeedsResize(dict
*dict
) {
1195 long long size
, used
;
1197 size
= dictSlots(dict
);
1198 used
= dictSize(dict
);
1199 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1200 (used
*100/size
< REDIS_HT_MINFILL
));
1203 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1204 * we resize the hash table to save memory */
1205 static void tryResizeHashTables(void) {
1208 for (j
= 0; j
< server
.dbnum
; j
++) {
1209 if (htNeedsResize(server
.db
[j
].dict
))
1210 dictResize(server
.db
[j
].dict
);
1211 if (htNeedsResize(server
.db
[j
].expires
))
1212 dictResize(server
.db
[j
].expires
);
1216 /* Our hash table implementation performs rehashing incrementally while
1217 * we write/read from the hash table. Still if the server is idle, the hash
1218 * table will use two tables for a long time. So we try to use 1 millisecond
1219 * of CPU time at every serverCron() loop in order to rehash some key. */
1220 static void incrementallyRehash(void) {
1223 for (j
= 0; j
< server
.dbnum
; j
++) {
1224 if (dictIsRehashing(server
.db
[j
].dict
)) {
1225 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1226 break; /* already used our millisecond for this loop... */
1231 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1232 void backgroundSaveDoneHandler(int statloc
) {
1233 int exitcode
= WEXITSTATUS(statloc
);
1234 int bysignal
= WIFSIGNALED(statloc
);
1236 if (!bysignal
&& exitcode
== 0) {
1237 redisLog(REDIS_NOTICE
,
1238 "Background saving terminated with success");
1240 server
.lastsave
= time(NULL
);
1241 } else if (!bysignal
&& exitcode
!= 0) {
1242 redisLog(REDIS_WARNING
, "Background saving error");
1244 redisLog(REDIS_WARNING
,
1245 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1246 rdbRemoveTempFile(server
.bgsavechildpid
);
1248 server
.bgsavechildpid
= -1;
1249 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1250 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1251 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1254 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1256 void backgroundRewriteDoneHandler(int statloc
) {
1257 int exitcode
= WEXITSTATUS(statloc
);
1258 int bysignal
= WIFSIGNALED(statloc
);
1260 if (!bysignal
&& exitcode
== 0) {
1264 redisLog(REDIS_NOTICE
,
1265 "Background append only file rewriting terminated with success");
1266 /* Now it's time to flush the differences accumulated by the parent */
1267 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1268 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1270 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1273 /* Flush our data... */
1274 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1275 (signed) sdslen(server
.bgrewritebuf
)) {
1276 redisLog(REDIS_WARNING
, "Error or short write trying to flush the parent diff of the append log file in the child temp file: %s", strerror(errno
));
1280 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1281 /* Now our work is to rename the temp file into the stable file. And
1282 * switch the file descriptor used by the server for append only. */
1283 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1284 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1288 /* Mission completed... almost */
1289 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1290 if (server
.appendfd
!= -1) {
1291 /* If append only is actually enabled... */
1292 close(server
.appendfd
);
1293 server
.appendfd
= fd
;
1295 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1296 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1298 /* If append only is disabled we just generate a dump in this
1299 * format. Why not? */
1302 } else if (!bysignal
&& exitcode
!= 0) {
1303 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1305 redisLog(REDIS_WARNING
,
1306 "Background append only file rewriting terminated by signal %d",
1310 sdsfree(server
.bgrewritebuf
);
1311 server
.bgrewritebuf
= sdsempty();
1312 aofRemoveTempFile(server
.bgrewritechildpid
);
1313 server
.bgrewritechildpid
= -1;
1316 /* This function is called once a background process of some kind terminates,
1317 * as we want to avoid resizing the hash tables when there is a child in order
1318 * to play well with copy-on-write (otherwise when a resize happens lots of
1319 * memory pages are copied). The goal of this function is to update the ability
1320 * for dict.c to resize the hash tables accordingly to the fact we have o not
1321 * running childs. */
1322 static void updateDictResizePolicy(void) {
1323 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1326 dictDisableResize();
1329 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1330 int j
, loops
= server
.cronloops
++;
1331 REDIS_NOTUSED(eventLoop
);
1333 REDIS_NOTUSED(clientData
);
1335 /* We take a cached value of the unix time in the global state because
1336 * with virtual memory and aging there is to store the current time
1337 * in objects at every object access, and accuracy is not needed.
1338 * To access a global var is faster than calling time(NULL) */
1339 server
.unixtime
= time(NULL
);
1341 /* Show some info about non-empty databases */
1342 for (j
= 0; j
< server
.dbnum
; j
++) {
1343 long long size
, used
, vkeys
;
1345 size
= dictSlots(server
.db
[j
].dict
);
1346 used
= dictSize(server
.db
[j
].dict
);
1347 vkeys
= dictSize(server
.db
[j
].expires
);
1348 if (!(loops
% 50) && (used
|| vkeys
)) {
1349 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1350 /* dictPrintStats(server.dict); */
1354 /* We don't want to resize the hash tables while a bacground saving
1355 * is in progress: the saving child is created using fork() that is
1356 * implemented with a copy-on-write semantic in most modern systems, so
1357 * if we resize the HT while there is the saving child at work actually
1358 * a lot of memory movements in the parent will cause a lot of pages
1360 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1361 if (!(loops
% 10)) tryResizeHashTables();
1362 if (server
.activerehashing
) incrementallyRehash();
1365 /* Show information about connected clients */
1366 if (!(loops
% 50)) {
1367 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1368 listLength(server
.clients
)-listLength(server
.slaves
),
1369 listLength(server
.slaves
),
1370 zmalloc_used_memory());
1373 /* Close connections of timedout clients */
1374 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1375 closeTimedoutClients();
1377 /* Check if a background saving or AOF rewrite in progress terminated */
1378 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1382 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1383 if (pid
== server
.bgsavechildpid
) {
1384 backgroundSaveDoneHandler(statloc
);
1386 backgroundRewriteDoneHandler(statloc
);
1388 updateDictResizePolicy();
1391 /* If there is not a background saving in progress check if
1392 * we have to save now */
1393 time_t now
= time(NULL
);
1394 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1395 struct saveparam
*sp
= server
.saveparams
+j
;
1397 if (server
.dirty
>= sp
->changes
&&
1398 now
-server
.lastsave
> sp
->seconds
) {
1399 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1400 sp
->changes
, sp
->seconds
);
1401 rdbSaveBackground(server
.dbfilename
);
1407 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1408 * will use few CPU cycles if there are few expiring keys, otherwise
1409 * it will get more aggressive to avoid that too much memory is used by
1410 * keys that can be removed from the keyspace. */
1411 for (j
= 0; j
< server
.dbnum
; j
++) {
1413 redisDb
*db
= server
.db
+j
;
1415 /* Continue to expire if at the end of the cycle more than 25%
1416 * of the keys were expired. */
1418 long num
= dictSize(db
->expires
);
1419 time_t now
= time(NULL
);
1422 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1423 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1428 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1429 t
= (time_t) dictGetEntryVal(de
);
1431 deleteKey(db
,dictGetEntryKey(de
));
1433 server
.stat_expiredkeys
++;
1436 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1439 /* Swap a few keys on disk if we are over the memory limit and VM
1440 * is enbled. Try to free objects from the free list first. */
1441 if (vmCanSwapOut()) {
1442 while (server
.vm_enabled
&& zmalloc_used_memory() >
1443 server
.vm_max_memory
)
1447 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1448 retval
= (server
.vm_max_threads
== 0) ?
1449 vmSwapOneObjectBlocking() :
1450 vmSwapOneObjectThreaded();
1451 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1452 zmalloc_used_memory() >
1453 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1455 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1457 /* Note that when using threade I/O we free just one object,
1458 * because anyway when the I/O thread in charge to swap this
1459 * object out will finish, the handler of completed jobs
1460 * will try to swap more objects if we are still out of memory. */
1461 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1465 /* Check if we should connect to a MASTER */
1466 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1467 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1468 if (syncWithMaster() == REDIS_OK
) {
1469 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1475 /* This function gets called every time Redis is entering the
1476 * main loop of the event driven library, that is, before to sleep
1477 * for ready file descriptors. */
1478 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1479 REDIS_NOTUSED(eventLoop
);
1481 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1485 listRewind(server
.io_ready_clients
,&li
);
1486 while((ln
= listNext(&li
))) {
1487 redisClient
*c
= ln
->value
;
1488 struct redisCommand
*cmd
;
1490 /* Resume the client. */
1491 listDelNode(server
.io_ready_clients
,ln
);
1492 c
->flags
&= (~REDIS_IO_WAIT
);
1493 server
.vm_blocked_clients
--;
1494 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1495 readQueryFromClient
, c
);
1496 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1497 assert(cmd
!= NULL
);
1500 /* There may be more data to process in the input buffer. */
1501 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1502 processInputBuffer(c
);
1507 static void createSharedObjects(void) {
1510 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1511 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1512 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1513 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1514 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1515 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1516 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1517 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1518 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1519 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1520 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1521 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1522 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1523 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1524 "-ERR no such key\r\n"));
1525 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1526 "-ERR syntax error\r\n"));
1527 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1528 "-ERR source and destination objects are the same\r\n"));
1529 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1530 "-ERR index out of range\r\n"));
1531 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1532 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1533 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1534 shared
.select0
= createStringObject("select 0\r\n",10);
1535 shared
.select1
= createStringObject("select 1\r\n",10);
1536 shared
.select2
= createStringObject("select 2\r\n",10);
1537 shared
.select3
= createStringObject("select 3\r\n",10);
1538 shared
.select4
= createStringObject("select 4\r\n",10);
1539 shared
.select5
= createStringObject("select 5\r\n",10);
1540 shared
.select6
= createStringObject("select 6\r\n",10);
1541 shared
.select7
= createStringObject("select 7\r\n",10);
1542 shared
.select8
= createStringObject("select 8\r\n",10);
1543 shared
.select9
= createStringObject("select 9\r\n",10);
1544 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1545 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1546 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1547 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1548 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1549 shared
.mbulk3
= createStringObject("*3\r\n",4);
1550 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1551 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1552 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1556 static void appendServerSaveParams(time_t seconds
, int changes
) {
1557 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1558 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1559 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1560 server
.saveparamslen
++;
1563 static void resetServerSaveParams() {
1564 zfree(server
.saveparams
);
1565 server
.saveparams
= NULL
;
1566 server
.saveparamslen
= 0;
1569 static void initServerConfig() {
1570 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1571 server
.port
= REDIS_SERVERPORT
;
1572 server
.verbosity
= REDIS_VERBOSE
;
1573 server
.maxidletime
= REDIS_MAXIDLETIME
;
1574 server
.saveparams
= NULL
;
1575 server
.logfile
= NULL
; /* NULL = log on standard output */
1576 server
.bindaddr
= NULL
;
1577 server
.glueoutputbuf
= 1;
1578 server
.daemonize
= 0;
1579 server
.appendonly
= 0;
1580 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1581 server
.lastfsync
= time(NULL
);
1582 server
.appendfd
= -1;
1583 server
.appendseldb
= -1; /* Make sure the first time will not match */
1584 server
.pidfile
= zstrdup("/var/run/redis.pid");
1585 server
.dbfilename
= zstrdup("dump.rdb");
1586 server
.appendfilename
= zstrdup("appendonly.aof");
1587 server
.requirepass
= NULL
;
1588 server
.shareobjects
= 0;
1589 server
.rdbcompression
= 1;
1590 server
.activerehashing
= 1;
1591 server
.maxclients
= 0;
1592 server
.blpop_blocked_clients
= 0;
1593 server
.maxmemory
= 0;
1594 server
.vm_enabled
= 0;
1595 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1596 server
.vm_page_size
= 256; /* 256 bytes per page */
1597 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1598 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1599 server
.vm_max_threads
= 4;
1600 server
.vm_blocked_clients
= 0;
1601 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1602 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1604 resetServerSaveParams();
1606 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1607 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1608 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1609 /* Replication related */
1611 server
.masterauth
= NULL
;
1612 server
.masterhost
= NULL
;
1613 server
.masterport
= 6379;
1614 server
.master
= NULL
;
1615 server
.replstate
= REDIS_REPL_NONE
;
1617 /* Double constants initialization */
1619 R_PosInf
= 1.0/R_Zero
;
1620 R_NegInf
= -1.0/R_Zero
;
1621 R_Nan
= R_Zero
/R_Zero
;
1624 static void initServer() {
1627 signal(SIGHUP
, SIG_IGN
);
1628 signal(SIGPIPE
, SIG_IGN
);
1629 setupSigSegvAction();
1631 server
.devnull
= fopen("/dev/null","w");
1632 if (server
.devnull
== NULL
) {
1633 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1636 server
.clients
= listCreate();
1637 server
.slaves
= listCreate();
1638 server
.monitors
= listCreate();
1639 server
.objfreelist
= listCreate();
1640 createSharedObjects();
1641 server
.el
= aeCreateEventLoop();
1642 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1643 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1644 if (server
.fd
== -1) {
1645 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1648 for (j
= 0; j
< server
.dbnum
; j
++) {
1649 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1650 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1651 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1652 if (server
.vm_enabled
)
1653 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1654 server
.db
[j
].id
= j
;
1656 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1657 server
.pubsub_patterns
= listCreate();
1658 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1659 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1660 server
.cronloops
= 0;
1661 server
.bgsavechildpid
= -1;
1662 server
.bgrewritechildpid
= -1;
1663 server
.bgrewritebuf
= sdsempty();
1664 server
.lastsave
= time(NULL
);
1666 server
.stat_numcommands
= 0;
1667 server
.stat_numconnections
= 0;
1668 server
.stat_expiredkeys
= 0;
1669 server
.stat_starttime
= time(NULL
);
1670 server
.unixtime
= time(NULL
);
1671 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1672 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1673 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1675 if (server
.appendonly
) {
1676 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1677 if (server
.appendfd
== -1) {
1678 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1684 if (server
.vm_enabled
) vmInit();
1687 /* Empty the whole database */
1688 static long long emptyDb() {
1690 long long removed
= 0;
1692 for (j
= 0; j
< server
.dbnum
; j
++) {
1693 removed
+= dictSize(server
.db
[j
].dict
);
1694 dictEmpty(server
.db
[j
].dict
);
1695 dictEmpty(server
.db
[j
].expires
);
1700 static int yesnotoi(char *s
) {
1701 if (!strcasecmp(s
,"yes")) return 1;
1702 else if (!strcasecmp(s
,"no")) return 0;
1706 /* I agree, this is a very rudimental way to load a configuration...
1707 will improve later if the config gets more complex */
1708 static void loadServerConfig(char *filename
) {
1710 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1714 if (filename
[0] == '-' && filename
[1] == '\0')
1717 if ((fp
= fopen(filename
,"r")) == NULL
) {
1718 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1723 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1729 line
= sdstrim(line
," \t\r\n");
1731 /* Skip comments and blank lines*/
1732 if (line
[0] == '#' || line
[0] == '\0') {
1737 /* Split into arguments */
1738 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1739 sdstolower(argv
[0]);
1741 /* Execute config directives */
1742 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1743 server
.maxidletime
= atoi(argv
[1]);
1744 if (server
.maxidletime
< 0) {
1745 err
= "Invalid timeout value"; goto loaderr
;
1747 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1748 server
.port
= atoi(argv
[1]);
1749 if (server
.port
< 1 || server
.port
> 65535) {
1750 err
= "Invalid port"; goto loaderr
;
1752 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1753 server
.bindaddr
= zstrdup(argv
[1]);
1754 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1755 int seconds
= atoi(argv
[1]);
1756 int changes
= atoi(argv
[2]);
1757 if (seconds
< 1 || changes
< 0) {
1758 err
= "Invalid save parameters"; goto loaderr
;
1760 appendServerSaveParams(seconds
,changes
);
1761 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1762 if (chdir(argv
[1]) == -1) {
1763 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1764 argv
[1], strerror(errno
));
1767 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1768 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1769 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1770 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1771 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1773 err
= "Invalid log level. Must be one of debug, notice, warning";
1776 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1779 server
.logfile
= zstrdup(argv
[1]);
1780 if (!strcasecmp(server
.logfile
,"stdout")) {
1781 zfree(server
.logfile
);
1782 server
.logfile
= NULL
;
1784 if (server
.logfile
) {
1785 /* Test if we are able to open the file. The server will not
1786 * be able to abort just for this problem later... */
1787 logfp
= fopen(server
.logfile
,"a");
1788 if (logfp
== NULL
) {
1789 err
= sdscatprintf(sdsempty(),
1790 "Can't open the log file: %s", strerror(errno
));
1795 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1796 server
.dbnum
= atoi(argv
[1]);
1797 if (server
.dbnum
< 1) {
1798 err
= "Invalid number of databases"; goto loaderr
;
1800 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1801 loadServerConfig(argv
[1]);
1802 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1803 server
.maxclients
= atoi(argv
[1]);
1804 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1805 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1806 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1807 server
.masterhost
= sdsnew(argv
[1]);
1808 server
.masterport
= atoi(argv
[2]);
1809 server
.replstate
= REDIS_REPL_CONNECT
;
1810 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1811 server
.masterauth
= zstrdup(argv
[1]);
1812 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1813 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1814 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1816 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1817 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1818 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1820 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1821 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1822 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1824 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1825 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1826 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1828 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1829 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1830 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1832 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1833 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1834 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1836 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1837 if (!strcasecmp(argv
[1],"no")) {
1838 server
.appendfsync
= APPENDFSYNC_NO
;
1839 } else if (!strcasecmp(argv
[1],"always")) {
1840 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1841 } else if (!strcasecmp(argv
[1],"everysec")) {
1842 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1844 err
= "argument must be 'no', 'always' or 'everysec'";
1847 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1848 server
.requirepass
= zstrdup(argv
[1]);
1849 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1850 zfree(server
.pidfile
);
1851 server
.pidfile
= zstrdup(argv
[1]);
1852 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1853 zfree(server
.dbfilename
);
1854 server
.dbfilename
= zstrdup(argv
[1]);
1855 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1856 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1857 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1859 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1860 zfree(server
.vm_swap_file
);
1861 server
.vm_swap_file
= zstrdup(argv
[1]);
1862 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1863 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1864 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1865 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1866 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1867 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1868 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1869 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1870 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1871 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1872 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1873 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1874 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1875 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1877 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1879 for (j
= 0; j
< argc
; j
++)
1884 if (fp
!= stdin
) fclose(fp
);
1888 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1889 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1890 fprintf(stderr
, ">>> '%s'\n", line
);
1891 fprintf(stderr
, "%s\n", err
);
1895 static void freeClientArgv(redisClient
*c
) {
1898 for (j
= 0; j
< c
->argc
; j
++)
1899 decrRefCount(c
->argv
[j
]);
1900 for (j
= 0; j
< c
->mbargc
; j
++)
1901 decrRefCount(c
->mbargv
[j
]);
1906 static void freeClient(redisClient
*c
) {
1909 /* Note that if the client we are freeing is blocked into a blocking
1910 * call, we have to set querybuf to NULL *before* to call
1911 * unblockClientWaitingData() to avoid processInputBuffer() will get
1912 * called. Also it is important to remove the file events after
1913 * this, because this call adds the READABLE event. */
1914 sdsfree(c
->querybuf
);
1916 if (c
->flags
& REDIS_BLOCKED
)
1917 unblockClientWaitingData(c
);
1919 /* Unsubscribe from all the pubsub channels */
1920 pubsubUnsubscribeAllChannels(c
,0);
1921 pubsubUnsubscribeAllPatterns(c
,0);
1922 dictRelease(c
->pubsub_channels
);
1923 listRelease(c
->pubsub_patterns
);
1924 /* Obvious cleanup */
1925 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1926 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1927 listRelease(c
->reply
);
1930 /* Remove from the list of clients */
1931 ln
= listSearchKey(server
.clients
,c
);
1932 redisAssert(ln
!= NULL
);
1933 listDelNode(server
.clients
,ln
);
1934 /* Remove from the list of clients waiting for swapped keys */
1935 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1936 ln
= listSearchKey(server
.io_ready_clients
,c
);
1938 listDelNode(server
.io_ready_clients
,ln
);
1939 server
.vm_blocked_clients
--;
1942 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1943 ln
= listFirst(c
->io_keys
);
1944 dontWaitForSwappedKey(c
,ln
->value
);
1946 listRelease(c
->io_keys
);
1947 /* Master/slave cleanup */
1948 if (c
->flags
& REDIS_SLAVE
) {
1949 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1951 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1952 ln
= listSearchKey(l
,c
);
1953 redisAssert(ln
!= NULL
);
1956 if (c
->flags
& REDIS_MASTER
) {
1957 server
.master
= NULL
;
1958 server
.replstate
= REDIS_REPL_CONNECT
;
1960 /* Release memory */
1963 freeClientMultiState(c
);
1967 #define GLUEREPLY_UP_TO (1024)
1968 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1970 char buf
[GLUEREPLY_UP_TO
];
1975 listRewind(c
->reply
,&li
);
1976 while((ln
= listNext(&li
))) {
1980 objlen
= sdslen(o
->ptr
);
1981 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1982 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1984 listDelNode(c
->reply
,ln
);
1986 if (copylen
== 0) return;
1990 /* Now the output buffer is empty, add the new single element */
1991 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1992 listAddNodeHead(c
->reply
,o
);
1995 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1996 redisClient
*c
= privdata
;
1997 int nwritten
= 0, totwritten
= 0, objlen
;
2000 REDIS_NOTUSED(mask
);
2002 /* Use writev() if we have enough buffers to send */
2003 if (!server
.glueoutputbuf
&&
2004 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2005 !(c
->flags
& REDIS_MASTER
))
2007 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2011 while(listLength(c
->reply
)) {
2012 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2013 glueReplyBuffersIfNeeded(c
);
2015 o
= listNodeValue(listFirst(c
->reply
));
2016 objlen
= sdslen(o
->ptr
);
2019 listDelNode(c
->reply
,listFirst(c
->reply
));
2023 if (c
->flags
& REDIS_MASTER
) {
2024 /* Don't reply to a master */
2025 nwritten
= objlen
- c
->sentlen
;
2027 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2028 if (nwritten
<= 0) break;
2030 c
->sentlen
+= nwritten
;
2031 totwritten
+= nwritten
;
2032 /* If we fully sent the object on head go to the next one */
2033 if (c
->sentlen
== objlen
) {
2034 listDelNode(c
->reply
,listFirst(c
->reply
));
2037 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2038 * bytes, in a single threaded server it's a good idea to serve
2039 * other clients as well, even if a very large request comes from
2040 * super fast link that is always able to accept data (in real world
2041 * scenario think about 'KEYS *' against the loopback interfae) */
2042 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2044 if (nwritten
== -1) {
2045 if (errno
== EAGAIN
) {
2048 redisLog(REDIS_VERBOSE
,
2049 "Error writing to client: %s", strerror(errno
));
2054 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2055 if (listLength(c
->reply
) == 0) {
2057 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2061 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2063 redisClient
*c
= privdata
;
2064 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2066 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2067 int offset
, ion
= 0;
2069 REDIS_NOTUSED(mask
);
2072 while (listLength(c
->reply
)) {
2073 offset
= c
->sentlen
;
2077 /* fill-in the iov[] array */
2078 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2079 o
= listNodeValue(node
);
2080 objlen
= sdslen(o
->ptr
);
2082 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2085 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2086 break; /* no more iovecs */
2088 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2089 iov
[ion
].iov_len
= objlen
- offset
;
2090 willwrite
+= objlen
- offset
;
2091 offset
= 0; /* just for the first item */
2098 /* write all collected blocks at once */
2099 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2100 if (errno
!= EAGAIN
) {
2101 redisLog(REDIS_VERBOSE
,
2102 "Error writing to client: %s", strerror(errno
));
2109 totwritten
+= nwritten
;
2110 offset
= c
->sentlen
;
2112 /* remove written robjs from c->reply */
2113 while (nwritten
&& listLength(c
->reply
)) {
2114 o
= listNodeValue(listFirst(c
->reply
));
2115 objlen
= sdslen(o
->ptr
);
2117 if(nwritten
>= objlen
- offset
) {
2118 listDelNode(c
->reply
, listFirst(c
->reply
));
2119 nwritten
-= objlen
- offset
;
2123 c
->sentlen
+= nwritten
;
2131 c
->lastinteraction
= time(NULL
);
2133 if (listLength(c
->reply
) == 0) {
2135 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2139 static struct redisCommand
*lookupCommand(char *name
) {
2141 while(cmdTable
[j
].name
!= NULL
) {
2142 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2148 /* resetClient prepare the client to process the next command */
2149 static void resetClient(redisClient
*c
) {
2155 /* Call() is the core of Redis execution of a command */
2156 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2159 dirty
= server
.dirty
;
2161 dirty
= server
.dirty
-dirty
;
2163 if (server
.appendonly
&& dirty
)
2164 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2165 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2166 listLength(server
.slaves
))
2167 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2168 if (listLength(server
.monitors
))
2169 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2170 server
.stat_numcommands
++;
2173 /* If this function gets called we already read a whole
2174 * command, argments are in the client argv/argc fields.
2175 * processCommand() execute the command or prepare the
2176 * server for a bulk read from the client.
2178 * If 1 is returned the client is still alive and valid and
2179 * and other operations can be performed by the caller. Otherwise
2180 * if 0 is returned the client was destroied (i.e. after QUIT). */
2181 static int processCommand(redisClient
*c
) {
2182 struct redisCommand
*cmd
;
2184 /* Free some memory if needed (maxmemory setting) */
2185 if (server
.maxmemory
) freeMemoryIfNeeded();
2187 /* Handle the multi bulk command type. This is an alternative protocol
2188 * supported by Redis in order to receive commands that are composed of
2189 * multiple binary-safe "bulk" arguments. The latency of processing is
2190 * a bit higher but this allows things like multi-sets, so if this
2191 * protocol is used only for MSET and similar commands this is a big win. */
2192 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2193 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2194 if (c
->multibulk
<= 0) {
2198 decrRefCount(c
->argv
[c
->argc
-1]);
2202 } else if (c
->multibulk
) {
2203 if (c
->bulklen
== -1) {
2204 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2205 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2209 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2210 decrRefCount(c
->argv
[0]);
2211 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2213 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2218 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2222 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2223 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2227 if (c
->multibulk
== 0) {
2231 /* Here we need to swap the multi-bulk argc/argv with the
2232 * normal argc/argv of the client structure. */
2234 c
->argv
= c
->mbargv
;
2235 c
->mbargv
= auxargv
;
2238 c
->argc
= c
->mbargc
;
2239 c
->mbargc
= auxargc
;
2241 /* We need to set bulklen to something different than -1
2242 * in order for the code below to process the command without
2243 * to try to read the last argument of a bulk command as
2244 * a special argument. */
2246 /* continue below and process the command */
2253 /* -- end of multi bulk commands processing -- */
2255 /* The QUIT command is handled as a special case. Normal command
2256 * procs are unable to close the client connection safely */
2257 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2262 /* Now lookup the command and check ASAP about trivial error conditions
2263 * such wrong arity, bad command name and so forth. */
2264 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2267 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2268 (char*)c
->argv
[0]->ptr
));
2271 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2272 (c
->argc
< -cmd
->arity
)) {
2274 sdscatprintf(sdsempty(),
2275 "-ERR wrong number of arguments for '%s' command\r\n",
2279 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2280 /* This is a bulk command, we have to read the last argument yet. */
2281 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2283 decrRefCount(c
->argv
[c
->argc
-1]);
2284 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2286 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2291 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2292 /* It is possible that the bulk read is already in the
2293 * buffer. Check this condition and handle it accordingly.
2294 * This is just a fast path, alternative to call processInputBuffer().
2295 * It's a good idea since the code is small and this condition
2296 * happens most of the times. */
2297 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2298 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2300 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2302 /* Otherwise return... there is to read the last argument
2303 * from the socket. */
2307 /* Let's try to encode the bulk object to save space. */
2308 if (cmd
->flags
& REDIS_CMD_BULK
)
2309 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2311 /* Check if the user is authenticated */
2312 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2313 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2318 /* Handle the maxmemory directive */
2319 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2320 zmalloc_used_memory() > server
.maxmemory
)
2322 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2327 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2328 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2330 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2331 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2332 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2337 /* Exec the command */
2338 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2339 queueMultiCommand(c
,cmd
);
2340 addReply(c
,shared
.queued
);
2342 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2343 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2347 /* Prepare the client for the next command */
2352 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2357 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2358 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2359 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2360 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2363 if (argc
<= REDIS_STATIC_ARGS
) {
2366 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2369 lenobj
= createObject(REDIS_STRING
,
2370 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2371 lenobj
->refcount
= 0;
2372 outv
[outc
++] = lenobj
;
2373 for (j
= 0; j
< argc
; j
++) {
2374 lenobj
= createObject(REDIS_STRING
,
2375 sdscatprintf(sdsempty(),"$%lu\r\n",
2376 (unsigned long) stringObjectLen(argv
[j
])));
2377 lenobj
->refcount
= 0;
2378 outv
[outc
++] = lenobj
;
2379 outv
[outc
++] = argv
[j
];
2380 outv
[outc
++] = shared
.crlf
;
2383 /* Increment all the refcounts at start and decrement at end in order to
2384 * be sure to free objects if there is no slave in a replication state
2385 * able to be feed with commands */
2386 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2387 listRewind(slaves
,&li
);
2388 while((ln
= listNext(&li
))) {
2389 redisClient
*slave
= ln
->value
;
2391 /* Don't feed slaves that are still waiting for BGSAVE to start */
2392 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2394 /* Feed all the other slaves, MONITORs and so on */
2395 if (slave
->slaveseldb
!= dictid
) {
2399 case 0: selectcmd
= shared
.select0
; break;
2400 case 1: selectcmd
= shared
.select1
; break;
2401 case 2: selectcmd
= shared
.select2
; break;
2402 case 3: selectcmd
= shared
.select3
; break;
2403 case 4: selectcmd
= shared
.select4
; break;
2404 case 5: selectcmd
= shared
.select5
; break;
2405 case 6: selectcmd
= shared
.select6
; break;
2406 case 7: selectcmd
= shared
.select7
; break;
2407 case 8: selectcmd
= shared
.select8
; break;
2408 case 9: selectcmd
= shared
.select9
; break;
2410 selectcmd
= createObject(REDIS_STRING
,
2411 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2412 selectcmd
->refcount
= 0;
2415 addReply(slave
,selectcmd
);
2416 slave
->slaveseldb
= dictid
;
2418 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2420 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2421 if (outv
!= static_outv
) zfree(outv
);
2424 static void processInputBuffer(redisClient
*c
) {
2426 /* Before to process the input buffer, make sure the client is not
2427 * waitig for a blocking operation such as BLPOP. Note that the first
2428 * iteration the client is never blocked, otherwise the processInputBuffer
2429 * would not be called at all, but after the execution of the first commands
2430 * in the input buffer the client may be blocked, and the "goto again"
2431 * will try to reiterate. The following line will make it return asap. */
2432 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2433 if (c
->bulklen
== -1) {
2434 /* Read the first line of the query */
2435 char *p
= strchr(c
->querybuf
,'\n');
2442 query
= c
->querybuf
;
2443 c
->querybuf
= sdsempty();
2444 querylen
= 1+(p
-(query
));
2445 if (sdslen(query
) > querylen
) {
2446 /* leave data after the first line of the query in the buffer */
2447 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2449 *p
= '\0'; /* remove "\n" */
2450 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2451 sdsupdatelen(query
);
2453 /* Now we can split the query in arguments */
2454 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2457 if (c
->argv
) zfree(c
->argv
);
2458 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2460 for (j
= 0; j
< argc
; j
++) {
2461 if (sdslen(argv
[j
])) {
2462 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2470 /* Execute the command. If the client is still valid
2471 * after processCommand() return and there is something
2472 * on the query buffer try to process the next command. */
2473 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2475 /* Nothing to process, argc == 0. Just process the query
2476 * buffer if it's not empty or return to the caller */
2477 if (sdslen(c
->querybuf
)) goto again
;
2480 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2481 redisLog(REDIS_VERBOSE
, "Client protocol error");
2486 /* Bulk read handling. Note that if we are at this point
2487 the client already sent a command terminated with a newline,
2488 we are reading the bulk data that is actually the last
2489 argument of the command. */
2490 int qbl
= sdslen(c
->querybuf
);
2492 if (c
->bulklen
<= qbl
) {
2493 /* Copy everything but the final CRLF as final argument */
2494 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2496 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2497 /* Process the command. If the client is still valid after
2498 * the processing and there is more data in the buffer
2499 * try to parse it. */
2500 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2506 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2507 redisClient
*c
= (redisClient
*) privdata
;
2508 char buf
[REDIS_IOBUF_LEN
];
2511 REDIS_NOTUSED(mask
);
2513 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2515 if (errno
== EAGAIN
) {
2518 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2522 } else if (nread
== 0) {
2523 redisLog(REDIS_VERBOSE
, "Client closed connection");
2528 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2529 c
->lastinteraction
= time(NULL
);
2533 processInputBuffer(c
);
2536 static int selectDb(redisClient
*c
, int id
) {
2537 if (id
< 0 || id
>= server
.dbnum
)
2539 c
->db
= &server
.db
[id
];
2543 static void *dupClientReplyValue(void *o
) {
2544 incrRefCount((robj
*)o
);
2548 static int listMatchObjects(void *a
, void *b
) {
2549 return compareStringObjects(a
,b
) == 0;
2552 static redisClient
*createClient(int fd
) {
2553 redisClient
*c
= zmalloc(sizeof(*c
));
2555 anetNonBlock(NULL
,fd
);
2556 anetTcpNoDelay(NULL
,fd
);
2557 if (!c
) return NULL
;
2560 c
->querybuf
= sdsempty();
2569 c
->lastinteraction
= time(NULL
);
2570 c
->authenticated
= 0;
2571 c
->replstate
= REDIS_REPL_NONE
;
2572 c
->reply
= listCreate();
2573 listSetFreeMethod(c
->reply
,decrRefCount
);
2574 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2575 c
->blockingkeys
= NULL
;
2576 c
->blockingkeysnum
= 0;
2577 c
->io_keys
= listCreate();
2578 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2579 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2580 c
->pubsub_patterns
= listCreate();
2581 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2582 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2583 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2584 readQueryFromClient
, c
) == AE_ERR
) {
2588 listAddNodeTail(server
.clients
,c
);
2589 initClientMultiState(c
);
2593 static void addReply(redisClient
*c
, robj
*obj
) {
2594 if (listLength(c
->reply
) == 0 &&
2595 (c
->replstate
== REDIS_REPL_NONE
||
2596 c
->replstate
== REDIS_REPL_ONLINE
) &&
2597 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2598 sendReplyToClient
, c
) == AE_ERR
) return;
2600 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2601 obj
= dupStringObject(obj
);
2602 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2604 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2607 static void addReplySds(redisClient
*c
, sds s
) {
2608 robj
*o
= createObject(REDIS_STRING
,s
);
2613 static void addReplyDouble(redisClient
*c
, double d
) {
2616 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2617 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2618 (unsigned long) strlen(buf
),buf
));
2621 static void addReplyLong(redisClient
*c
, long l
) {
2626 addReply(c
,shared
.czero
);
2628 } else if (l
== 1) {
2629 addReply(c
,shared
.cone
);
2632 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2633 addReplySds(c
,sdsnewlen(buf
,len
));
2636 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2641 addReply(c
,shared
.czero
);
2643 } else if (ll
== 1) {
2644 addReply(c
,shared
.cone
);
2647 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2648 addReplySds(c
,sdsnewlen(buf
,len
));
2651 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2656 addReply(c
,shared
.czero
);
2658 } else if (ul
== 1) {
2659 addReply(c
,shared
.cone
);
2662 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2663 addReplySds(c
,sdsnewlen(buf
,len
));
2666 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2669 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2670 len
= sdslen(obj
->ptr
);
2672 long n
= (long)obj
->ptr
;
2674 /* Compute how many bytes will take this integer as a radix 10 string */
2680 while((n
= n
/10) != 0) {
2684 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2687 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2688 addReplyBulkLen(c
,obj
);
2690 addReply(c
,shared
.crlf
);
2693 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2694 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2696 addReply(c
,shared
.nullbulk
);
2698 robj
*o
= createStringObject(s
,strlen(s
));
2704 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2709 REDIS_NOTUSED(mask
);
2710 REDIS_NOTUSED(privdata
);
2712 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2713 if (cfd
== AE_ERR
) {
2714 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2717 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2718 if ((c
= createClient(cfd
)) == NULL
) {
2719 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2720 close(cfd
); /* May be already closed, just ingore errors */
2723 /* If maxclient directive is set and this is one client more... close the
2724 * connection. Note that we create the client instead to check before
2725 * for this condition, since now the socket is already set in nonblocking
2726 * mode and we can send an error for free using the Kernel I/O */
2727 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2728 char *err
= "-ERR max number of clients reached\r\n";
2730 /* That's a best effort error message, don't check write errors */
2731 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2732 /* Nothing to do, Just to avoid the warning... */
2737 server
.stat_numconnections
++;
2740 /* ======================= Redis objects implementation ===================== */
2742 static robj
*createObject(int type
, void *ptr
) {
2745 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2746 if (listLength(server
.objfreelist
)) {
2747 listNode
*head
= listFirst(server
.objfreelist
);
2748 o
= listNodeValue(head
);
2749 listDelNode(server
.objfreelist
,head
);
2750 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2752 if (server
.vm_enabled
) {
2753 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2754 o
= zmalloc(sizeof(*o
));
2756 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2760 o
->encoding
= REDIS_ENCODING_RAW
;
2763 if (server
.vm_enabled
) {
2764 /* Note that this code may run in the context of an I/O thread
2765 * and accessing to server.unixtime in theory is an error
2766 * (no locks). But in practice this is safe, and even if we read
2767 * garbage Redis will not fail, as it's just a statistical info */
2768 o
->vm
.atime
= server
.unixtime
;
2769 o
->storage
= REDIS_VM_MEMORY
;
2774 static robj
*createStringObject(char *ptr
, size_t len
) {
2775 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2778 static robj
*createStringObjectFromLongLong(long long value
) {
2780 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2781 incrRefCount(shared
.integers
[value
]);
2782 o
= shared
.integers
[value
];
2784 o
= createObject(REDIS_STRING
, NULL
);
2785 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2786 o
->encoding
= REDIS_ENCODING_INT
;
2787 o
->ptr
= (void*)((long)value
);
2789 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2795 static robj
*dupStringObject(robj
*o
) {
2796 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2797 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2800 static robj
*createListObject(void) {
2801 list
*l
= listCreate();
2803 listSetFreeMethod(l
,decrRefCount
);
2804 return createObject(REDIS_LIST
,l
);
2807 static robj
*createSetObject(void) {
2808 dict
*d
= dictCreate(&setDictType
,NULL
);
2809 return createObject(REDIS_SET
,d
);
2812 static robj
*createHashObject(void) {
2813 /* All the Hashes start as zipmaps. Will be automatically converted
2814 * into hash tables if there are enough elements or big elements
2816 unsigned char *zm
= zipmapNew();
2817 robj
*o
= createObject(REDIS_HASH
,zm
);
2818 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2822 static robj
*createZsetObject(void) {
2823 zset
*zs
= zmalloc(sizeof(*zs
));
2825 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2826 zs
->zsl
= zslCreate();
2827 return createObject(REDIS_ZSET
,zs
);
2830 static void freeStringObject(robj
*o
) {
2831 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2836 static void freeListObject(robj
*o
) {
2837 listRelease((list
*) o
->ptr
);
2840 static void freeSetObject(robj
*o
) {
2841 dictRelease((dict
*) o
->ptr
);
2844 static void freeZsetObject(robj
*o
) {
2847 dictRelease(zs
->dict
);
2852 static void freeHashObject(robj
*o
) {
2853 switch (o
->encoding
) {
2854 case REDIS_ENCODING_HT
:
2855 dictRelease((dict
*) o
->ptr
);
2857 case REDIS_ENCODING_ZIPMAP
:
2861 redisPanic("Unknown hash encoding type");
2866 static void incrRefCount(robj
*o
) {
2870 static void decrRefCount(void *obj
) {
2873 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2874 /* Object is a key of a swapped out value, or in the process of being
2876 if (server
.vm_enabled
&&
2877 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2879 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2880 redisAssert(o
->type
== REDIS_STRING
);
2881 freeStringObject(o
);
2882 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2883 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2884 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2885 !listAddNodeHead(server
.objfreelist
,o
))
2887 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2888 server
.vm_stats_swapped_objects
--;
2891 /* Object is in memory, or in the process of being swapped out. */
2892 if (--(o
->refcount
) == 0) {
2893 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2894 vmCancelThreadedIOJob(obj
);
2896 case REDIS_STRING
: freeStringObject(o
); break;
2897 case REDIS_LIST
: freeListObject(o
); break;
2898 case REDIS_SET
: freeSetObject(o
); break;
2899 case REDIS_ZSET
: freeZsetObject(o
); break;
2900 case REDIS_HASH
: freeHashObject(o
); break;
2901 default: redisPanic("Unknown object type"); break;
2903 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2904 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2905 !listAddNodeHead(server
.objfreelist
,o
))
2907 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2911 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2912 dictEntry
*de
= dictFind(db
->dict
,key
);
2914 robj
*key
= dictGetEntryKey(de
);
2915 robj
*val
= dictGetEntryVal(de
);
2917 if (server
.vm_enabled
) {
2918 if (key
->storage
== REDIS_VM_MEMORY
||
2919 key
->storage
== REDIS_VM_SWAPPING
)
2921 /* If we were swapping the object out, stop it, this key
2923 if (key
->storage
== REDIS_VM_SWAPPING
)
2924 vmCancelThreadedIOJob(key
);
2925 /* Update the access time of the key for the aging algorithm. */
2926 key
->vm
.atime
= server
.unixtime
;
2928 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2930 /* Our value was swapped on disk. Bring it at home. */
2931 redisAssert(val
== NULL
);
2932 val
= vmLoadObject(key
);
2933 dictGetEntryVal(de
) = val
;
2935 /* Clients blocked by the VM subsystem may be waiting for
2937 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2946 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2947 expireIfNeeded(db
,key
);
2948 return lookupKey(db
,key
);
2951 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2952 deleteIfVolatile(db
,key
);
2953 return lookupKey(db
,key
);
2956 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2957 robj
*o
= lookupKeyRead(c
->db
, key
);
2958 if (!o
) addReply(c
,reply
);
2962 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2963 robj
*o
= lookupKeyWrite(c
->db
, key
);
2964 if (!o
) addReply(c
,reply
);
2968 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2969 if (o
->type
!= type
) {
2970 addReply(c
,shared
.wrongtypeerr
);
2976 static int deleteKey(redisDb
*db
, robj
*key
) {
2979 /* We need to protect key from destruction: after the first dictDelete()
2980 * it may happen that 'key' is no longer valid if we don't increment
2981 * it's count. This may happen when we get the object reference directly
2982 * from the hash table with dictRandomKey() or dict iterators */
2984 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2985 retval
= dictDelete(db
->dict
,key
);
2988 return retval
== DICT_OK
;
2991 /* Check if the nul-terminated string 's' can be represented by a long
2992 * (that is, is a number that fits into long without any other space or
2993 * character before or after the digits).
2995 * If so, the function returns REDIS_OK and *longval is set to the value
2996 * of the number. Otherwise REDIS_ERR is returned */
2997 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2998 char buf
[32], *endptr
;
3002 value
= strtol(s
, &endptr
, 10);
3003 if (endptr
[0] != '\0') return REDIS_ERR
;
3004 slen
= snprintf(buf
,32,"%ld",value
);
3006 /* If the number converted back into a string is not identical
3007 * then it's not possible to encode the string as integer */
3008 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3009 if (longval
) *longval
= value
;
3013 /* Try to encode a string object in order to save space */
3014 static robj
*tryObjectEncoding(robj
*o
) {
3018 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3019 return o
; /* Already encoded */
3021 /* It's not safe to encode shared objects: shared objects can be shared
3022 * everywhere in the "object space" of Redis. Encoded objects can only
3023 * appear as "values" (and not, for instance, as keys) */
3024 if (o
->refcount
> 1) return o
;
3026 /* Currently we try to encode only strings */
3027 redisAssert(o
->type
== REDIS_STRING
);
3029 /* Check if we can represent this string as a long integer */
3030 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3032 /* Ok, this object can be encoded */
3033 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3035 incrRefCount(shared
.integers
[value
]);
3036 return shared
.integers
[value
];
3038 o
->encoding
= REDIS_ENCODING_INT
;
3040 o
->ptr
= (void*) value
;
3045 /* Get a decoded version of an encoded object (returned as a new object).
3046 * If the object is already raw-encoded just increment the ref count. */
3047 static robj
*getDecodedObject(robj
*o
) {
3050 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3054 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3057 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3058 dec
= createStringObject(buf
,strlen(buf
));
3061 redisPanic("Unknown encoding type");
3065 /* Compare two string objects via strcmp() or alike.
3066 * Note that the objects may be integer-encoded. In such a case we
3067 * use snprintf() to get a string representation of the numbers on the stack
3068 * and compare the strings, it's much faster than calling getDecodedObject().
3070 * Important note: if objects are not integer encoded, but binary-safe strings,
3071 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3073 static int compareStringObjects(robj
*a
, robj
*b
) {
3074 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3075 char bufa
[128], bufb
[128], *astr
, *bstr
;
3078 if (a
== b
) return 0;
3079 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3080 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3086 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3087 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3093 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3096 static size_t stringObjectLen(robj
*o
) {
3097 redisAssert(o
->type
== REDIS_STRING
);
3098 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3099 return sdslen(o
->ptr
);
3103 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3107 static int getDoubleFromObject(robj
*o
, double *target
) {
3114 redisAssert(o
->type
== REDIS_STRING
);
3115 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3116 value
= strtod(o
->ptr
, &eptr
);
3117 if (eptr
[0] != '\0') return REDIS_ERR
;
3118 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3119 value
= (long)o
->ptr
;
3121 redisAssert(1 != 1);
3129 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3131 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3133 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3135 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3144 static int getLongLongFromObject(robj
*o
, long long *target
) {
3151 redisAssert(o
->type
== REDIS_STRING
);
3152 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3153 value
= strtoll(o
->ptr
, &eptr
, 10);
3154 if (eptr
[0] != '\0') return REDIS_ERR
;
3155 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3156 value
= (long)o
->ptr
;
3158 redisAssert(1 != 1);
3166 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3168 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3170 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3172 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3181 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3184 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3185 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3187 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3189 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3198 /*============================ RDB saving/loading =========================== */
3200 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3201 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3205 static int rdbSaveTime(FILE *fp
, time_t t
) {
3206 int32_t t32
= (int32_t) t
;
3207 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3211 /* check rdbLoadLen() comments for more info */
3212 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3213 unsigned char buf
[2];
3216 /* Save a 6 bit len */
3217 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3218 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3219 } else if (len
< (1<<14)) {
3220 /* Save a 14 bit len */
3221 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3223 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3225 /* Save a 32 bit len */
3226 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3227 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3229 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3234 /* String objects in the form "2391" "-100" without any space and with a
3235 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3236 * encoded as integers to save space */
3237 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3239 char *endptr
, buf
[32];
3241 /* Check if it's possible to encode this value as a number */
3242 value
= strtoll(s
, &endptr
, 10);
3243 if (endptr
[0] != '\0') return 0;
3244 snprintf(buf
,32,"%lld",value
);
3246 /* If the number converted back into a string is not identical
3247 * then it's not possible to encode the string as integer */
3248 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3250 /* Finally check if it fits in our ranges */
3251 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3252 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3253 enc
[1] = value
&0xFF;
3255 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3256 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3257 enc
[1] = value
&0xFF;
3258 enc
[2] = (value
>>8)&0xFF;
3260 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3261 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3262 enc
[1] = value
&0xFF;
3263 enc
[2] = (value
>>8)&0xFF;
3264 enc
[3] = (value
>>16)&0xFF;
3265 enc
[4] = (value
>>24)&0xFF;
3272 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3273 size_t comprlen
, outlen
;
3277 /* We require at least four bytes compression for this to be worth it */
3278 if (len
<= 4) return 0;
3280 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3281 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3282 if (comprlen
== 0) {
3286 /* Data compressed! Let's save it on disk */
3287 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3288 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3289 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3290 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3291 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3300 /* Save a string objet as [len][data] on disk. If the object is a string
3301 * representation of an integer value we try to safe it in a special form */
3302 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3305 /* Try integer encoding */
3307 unsigned char buf
[5];
3308 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3309 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3314 /* Try LZF compression - under 20 bytes it's unable to compress even
3315 * aaaaaaaaaaaaaaaaaa so skip it */
3316 if (server
.rdbcompression
&& len
> 20) {
3319 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3320 if (retval
== -1) return -1;
3321 if (retval
> 0) return 0;
3322 /* retval == 0 means data can't be compressed, save the old way */
3325 /* Store verbatim */
3326 if (rdbSaveLen(fp
,len
) == -1) return -1;
3327 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3331 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3332 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3335 /* Avoid incr/decr ref count business when possible.
3336 * This plays well with copy-on-write given that we are probably
3337 * in a child process (BGSAVE). Also this makes sure key objects
3338 * of swapped objects are not incRefCount-ed (an assert does not allow
3339 * this in order to avoid bugs) */
3340 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3341 obj
= getDecodedObject(obj
);
3342 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3345 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3350 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3351 * 8 bit integer specifing the length of the representation.
3352 * This 8 bit integer has special values in order to specify the following
3358 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3359 unsigned char buf
[128];
3365 } else if (!isfinite(val
)) {
3367 buf
[0] = (val
< 0) ? 255 : 254;
3369 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3370 buf
[0] = strlen((char*)buf
+1);
3373 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3377 /* Save a Redis object. */
3378 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3379 if (o
->type
== REDIS_STRING
) {
3380 /* Save a string value */
3381 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3382 } else if (o
->type
== REDIS_LIST
) {
3383 /* Save a list value */
3384 list
*list
= o
->ptr
;
3388 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3389 listRewind(list
,&li
);
3390 while((ln
= listNext(&li
))) {
3391 robj
*eleobj
= listNodeValue(ln
);
3393 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3395 } else if (o
->type
== REDIS_SET
) {
3396 /* Save a set value */
3398 dictIterator
*di
= dictGetIterator(set
);
3401 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3402 while((de
= dictNext(di
)) != NULL
) {
3403 robj
*eleobj
= dictGetEntryKey(de
);
3405 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3407 dictReleaseIterator(di
);
3408 } else if (o
->type
== REDIS_ZSET
) {
3409 /* Save a set value */
3411 dictIterator
*di
= dictGetIterator(zs
->dict
);
3414 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3415 while((de
= dictNext(di
)) != NULL
) {
3416 robj
*eleobj
= dictGetEntryKey(de
);
3417 double *score
= dictGetEntryVal(de
);
3419 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3420 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3422 dictReleaseIterator(di
);
3423 } else if (o
->type
== REDIS_HASH
) {
3424 /* Save a hash value */
3425 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3426 unsigned char *p
= zipmapRewind(o
->ptr
);
3427 unsigned int count
= zipmapLen(o
->ptr
);
3428 unsigned char *key
, *val
;
3429 unsigned int klen
, vlen
;
3431 if (rdbSaveLen(fp
,count
) == -1) return -1;
3432 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3433 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3434 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3437 dictIterator
*di
= dictGetIterator(o
->ptr
);
3440 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3441 while((de
= dictNext(di
)) != NULL
) {
3442 robj
*key
= dictGetEntryKey(de
);
3443 robj
*val
= dictGetEntryVal(de
);
3445 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3446 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3448 dictReleaseIterator(di
);
3451 redisPanic("Unknown object type");
3456 /* Return the length the object will have on disk if saved with
3457 * the rdbSaveObject() function. Currently we use a trick to get
3458 * this length with very little changes to the code. In the future
3459 * we could switch to a faster solution. */
3460 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3461 if (fp
== NULL
) fp
= server
.devnull
;
3463 assert(rdbSaveObject(fp
,o
) != 1);
3467 /* Return the number of pages required to save this object in the swap file */
3468 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3469 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3471 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3474 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3475 static int rdbSave(char *filename
) {
3476 dictIterator
*di
= NULL
;
3481 time_t now
= time(NULL
);
3483 /* Wait for I/O therads to terminate, just in case this is a
3484 * foreground-saving, to avoid seeking the swap file descriptor at the
3486 if (server
.vm_enabled
)
3487 waitEmptyIOJobsQueue();
3489 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3490 fp
= fopen(tmpfile
,"w");
3492 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3495 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3496 for (j
= 0; j
< server
.dbnum
; j
++) {
3497 redisDb
*db
= server
.db
+j
;
3499 if (dictSize(d
) == 0) continue;
3500 di
= dictGetIterator(d
);
3506 /* Write the SELECT DB opcode */
3507 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3508 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3510 /* Iterate this DB writing every entry */
3511 while((de
= dictNext(di
)) != NULL
) {
3512 robj
*key
= dictGetEntryKey(de
);
3513 robj
*o
= dictGetEntryVal(de
);
3514 time_t expiretime
= getExpire(db
,key
);
3516 /* Save the expire time */
3517 if (expiretime
!= -1) {
3518 /* If this key is already expired skip it */
3519 if (expiretime
< now
) continue;
3520 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3521 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3523 /* Save the key and associated value. This requires special
3524 * handling if the value is swapped out. */
3525 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3526 key
->storage
== REDIS_VM_SWAPPING
) {
3527 /* Save type, key, value */
3528 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3529 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3530 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3532 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3534 /* Get a preview of the object in memory */
3535 po
= vmPreviewObject(key
);
3536 /* Save type, key, value */
3537 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3538 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3539 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3540 /* Remove the loaded object from memory */
3544 dictReleaseIterator(di
);
3547 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3549 /* Make sure data will not remain on the OS's output buffers */
3554 /* Use RENAME to make sure the DB file is changed atomically only
3555 * if the generate DB file is ok. */
3556 if (rename(tmpfile
,filename
) == -1) {
3557 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3561 redisLog(REDIS_NOTICE
,"DB saved on disk");
3563 server
.lastsave
= time(NULL
);
3569 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3570 if (di
) dictReleaseIterator(di
);
3574 static int rdbSaveBackground(char *filename
) {
3577 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3578 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3579 if ((childpid
= fork()) == 0) {
3581 if (server
.vm_enabled
) vmReopenSwapFile();
3583 if (rdbSave(filename
) == REDIS_OK
) {
3590 if (childpid
== -1) {
3591 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3595 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3596 server
.bgsavechildpid
= childpid
;
3597 updateDictResizePolicy();
3600 return REDIS_OK
; /* unreached */
3603 static void rdbRemoveTempFile(pid_t childpid
) {
3606 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3610 static int rdbLoadType(FILE *fp
) {
3612 if (fread(&type
,1,1,fp
) == 0) return -1;
3616 static time_t rdbLoadTime(FILE *fp
) {
3618 if (fread(&t32
,4,1,fp
) == 0) return -1;
3619 return (time_t) t32
;
3622 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3623 * of this file for a description of how this are stored on disk.
3625 * isencoded is set to 1 if the readed length is not actually a length but
3626 * an "encoding type", check the above comments for more info */
3627 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3628 unsigned char buf
[2];
3632 if (isencoded
) *isencoded
= 0;
3633 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3634 type
= (buf
[0]&0xC0)>>6;
3635 if (type
== REDIS_RDB_6BITLEN
) {
3636 /* Read a 6 bit len */
3638 } else if (type
== REDIS_RDB_ENCVAL
) {
3639 /* Read a 6 bit len encoding type */
3640 if (isencoded
) *isencoded
= 1;
3642 } else if (type
== REDIS_RDB_14BITLEN
) {
3643 /* Read a 14 bit len */
3644 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3645 return ((buf
[0]&0x3F)<<8)|buf
[1];
3647 /* Read a 32 bit len */
3648 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3653 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3654 unsigned char enc
[4];
3657 if (enctype
== REDIS_RDB_ENC_INT8
) {
3658 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3659 val
= (signed char)enc
[0];
3660 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3662 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3663 v
= enc
[0]|(enc
[1]<<8);
3665 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3667 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3668 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3671 val
= 0; /* anti-warning */
3672 redisPanic("Unknown RDB integer encoding type");
3674 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3677 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3678 unsigned int len
, clen
;
3679 unsigned char *c
= NULL
;
3682 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3683 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3684 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3685 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3686 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3687 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3689 return createObject(REDIS_STRING
,val
);
3696 static robj
*rdbLoadStringObject(FILE*fp
) {
3701 len
= rdbLoadLen(fp
,&isencoded
);
3704 case REDIS_RDB_ENC_INT8
:
3705 case REDIS_RDB_ENC_INT16
:
3706 case REDIS_RDB_ENC_INT32
:
3707 return rdbLoadIntegerObject(fp
,len
);
3708 case REDIS_RDB_ENC_LZF
:
3709 return rdbLoadLzfStringObject(fp
);
3711 redisPanic("Unknown RDB encoding type");
3715 if (len
== REDIS_RDB_LENERR
) return NULL
;
3716 val
= sdsnewlen(NULL
,len
);
3717 if (len
&& fread(val
,len
,1,fp
) == 0) {
3721 return createObject(REDIS_STRING
,val
);
3724 /* For information about double serialization check rdbSaveDoubleValue() */
3725 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3729 if (fread(&len
,1,1,fp
) == 0) return -1;
3731 case 255: *val
= R_NegInf
; return 0;
3732 case 254: *val
= R_PosInf
; return 0;
3733 case 253: *val
= R_Nan
; return 0;
3735 if (fread(buf
,len
,1,fp
) == 0) return -1;
3737 sscanf(buf
, "%lg", val
);
3742 /* Load a Redis object of the specified type from the specified file.
3743 * On success a newly allocated object is returned, otherwise NULL. */
3744 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3747 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3748 if (type
== REDIS_STRING
) {
3749 /* Read string value */
3750 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3751 o
= tryObjectEncoding(o
);
3752 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3753 /* Read list/set value */
3756 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3757 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3758 /* It's faster to expand the dict to the right size asap in order
3759 * to avoid rehashing */
3760 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3761 dictExpand(o
->ptr
,listlen
);
3762 /* Load every single element of the list/set */
3766 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3767 ele
= tryObjectEncoding(ele
);
3768 if (type
== REDIS_LIST
) {
3769 listAddNodeTail((list
*)o
->ptr
,ele
);
3771 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3774 } else if (type
== REDIS_ZSET
) {
3775 /* Read list/set value */
3779 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3780 o
= createZsetObject();
3782 /* Load every single element of the list/set */
3785 double *score
= zmalloc(sizeof(double));
3787 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3788 ele
= tryObjectEncoding(ele
);
3789 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3790 dictAdd(zs
->dict
,ele
,score
);
3791 zslInsert(zs
->zsl
,*score
,ele
);
3792 incrRefCount(ele
); /* added to skiplist */
3794 } else if (type
== REDIS_HASH
) {
3797 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3798 o
= createHashObject();
3799 /* Too many entries? Use an hash table. */
3800 if (hashlen
> server
.hash_max_zipmap_entries
)
3801 convertToRealHash(o
);
3802 /* Load every key/value, then set it into the zipmap or hash
3803 * table, as needed. */
3807 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3808 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3809 /* If we are using a zipmap and there are too big values
3810 * the object is converted to real hash table encoding. */
3811 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3812 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3813 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3815 convertToRealHash(o
);
3818 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3819 unsigned char *zm
= o
->ptr
;
3821 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3822 val
->ptr
,sdslen(val
->ptr
),NULL
);
3827 key
= tryObjectEncoding(key
);
3828 val
= tryObjectEncoding(val
);
3829 dictAdd((dict
*)o
->ptr
,key
,val
);
3833 redisPanic("Unknown object type");
3838 static int rdbLoad(char *filename
) {
3840 robj
*keyobj
= NULL
;
3842 int type
, retval
, rdbver
;
3843 dict
*d
= server
.db
[0].dict
;
3844 redisDb
*db
= server
.db
+0;
3846 time_t expiretime
= -1, now
= time(NULL
);
3847 long long loadedkeys
= 0;
3849 fp
= fopen(filename
,"r");
3850 if (!fp
) return REDIS_ERR
;
3851 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3853 if (memcmp(buf
,"REDIS",5) != 0) {
3855 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3858 rdbver
= atoi(buf
+5);
3861 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3868 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3869 if (type
== REDIS_EXPIRETIME
) {
3870 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3871 /* We read the time so we need to read the object type again */
3872 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3874 if (type
== REDIS_EOF
) break;
3875 /* Handle SELECT DB opcode as a special case */
3876 if (type
== REDIS_SELECTDB
) {
3877 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3879 if (dbid
>= (unsigned)server
.dbnum
) {
3880 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3883 db
= server
.db
+dbid
;
3888 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3890 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3891 /* Add the new object in the hash table */
3892 retval
= dictAdd(d
,keyobj
,o
);
3893 if (retval
== DICT_ERR
) {
3894 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3897 /* Set the expire time if needed */
3898 if (expiretime
!= -1) {
3899 setExpire(db
,keyobj
,expiretime
);
3900 /* Delete this key if already expired */
3901 if (expiretime
< now
) deleteKey(db
,keyobj
);
3905 /* Handle swapping while loading big datasets when VM is on */
3907 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3908 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3909 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3916 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3917 if (keyobj
) decrRefCount(keyobj
);
3918 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3920 return REDIS_ERR
; /* Just to avoid warning */
3923 /*================================== Commands =============================== */
3925 static void authCommand(redisClient
*c
) {
3926 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3927 c
->authenticated
= 1;
3928 addReply(c
,shared
.ok
);
3930 c
->authenticated
= 0;
3931 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3935 static void pingCommand(redisClient
*c
) {
3936 addReply(c
,shared
.pong
);
3939 static void echoCommand(redisClient
*c
) {
3940 addReplyBulk(c
,c
->argv
[1]);
3943 /*=================================== Strings =============================== */
3945 static void setGenericCommand(redisClient
*c
, int nx
) {
3948 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3949 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3950 if (retval
== DICT_ERR
) {
3952 /* If the key is about a swapped value, we want a new key object
3953 * to overwrite the old. So we delete the old key in the database.
3954 * This will also make sure that swap pages about the old object
3955 * will be marked as free. */
3956 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3957 incrRefCount(c
->argv
[1]);
3958 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3959 incrRefCount(c
->argv
[2]);
3961 addReply(c
,shared
.czero
);
3965 incrRefCount(c
->argv
[1]);
3966 incrRefCount(c
->argv
[2]);
3969 removeExpire(c
->db
,c
->argv
[1]);
3970 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3973 static void setCommand(redisClient
*c
) {
3974 setGenericCommand(c
,0);
3977 static void setnxCommand(redisClient
*c
) {
3978 setGenericCommand(c
,1);
3981 static int getGenericCommand(redisClient
*c
) {
3984 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3987 if (o
->type
!= REDIS_STRING
) {
3988 addReply(c
,shared
.wrongtypeerr
);
3996 static void getCommand(redisClient
*c
) {
3997 getGenericCommand(c
);
4000 static void getsetCommand(redisClient
*c
) {
4001 if (getGenericCommand(c
) == REDIS_ERR
) return;
4002 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4003 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4005 incrRefCount(c
->argv
[1]);
4007 incrRefCount(c
->argv
[2]);
4009 removeExpire(c
->db
,c
->argv
[1]);
4012 static void mgetCommand(redisClient
*c
) {
4015 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4016 for (j
= 1; j
< c
->argc
; j
++) {
4017 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4019 addReply(c
,shared
.nullbulk
);
4021 if (o
->type
!= REDIS_STRING
) {
4022 addReply(c
,shared
.nullbulk
);
4030 static void msetGenericCommand(redisClient
*c
, int nx
) {
4031 int j
, busykeys
= 0;
4033 if ((c
->argc
% 2) == 0) {
4034 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4037 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4038 * set nothing at all if at least one already key exists. */
4040 for (j
= 1; j
< c
->argc
; j
+= 2) {
4041 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4047 addReply(c
, shared
.czero
);
4051 for (j
= 1; j
< c
->argc
; j
+= 2) {
4054 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4055 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4056 if (retval
== DICT_ERR
) {
4057 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4058 incrRefCount(c
->argv
[j
+1]);
4060 incrRefCount(c
->argv
[j
]);
4061 incrRefCount(c
->argv
[j
+1]);
4063 removeExpire(c
->db
,c
->argv
[j
]);
4065 server
.dirty
+= (c
->argc
-1)/2;
4066 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4069 static void msetCommand(redisClient
*c
) {
4070 msetGenericCommand(c
,0);
4073 static void msetnxCommand(redisClient
*c
) {
4074 msetGenericCommand(c
,1);
4077 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4082 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4084 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4087 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4088 o
= tryObjectEncoding(o
);
4089 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4090 if (retval
== DICT_ERR
) {
4091 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4092 removeExpire(c
->db
,c
->argv
[1]);
4094 incrRefCount(c
->argv
[1]);
4097 addReply(c
,shared
.colon
);
4099 addReply(c
,shared
.crlf
);
4102 static void incrCommand(redisClient
*c
) {
4103 incrDecrCommand(c
,1);
4106 static void decrCommand(redisClient
*c
) {
4107 incrDecrCommand(c
,-1);
4110 static void incrbyCommand(redisClient
*c
) {
4113 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4114 incrDecrCommand(c
,incr
);
4117 static void decrbyCommand(redisClient
*c
) {
4120 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4121 incrDecrCommand(c
,-incr
);
4124 static void appendCommand(redisClient
*c
) {
4129 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4131 /* Create the key */
4132 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4133 incrRefCount(c
->argv
[1]);
4134 incrRefCount(c
->argv
[2]);
4135 totlen
= stringObjectLen(c
->argv
[2]);
4139 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4142 o
= dictGetEntryVal(de
);
4143 if (o
->type
!= REDIS_STRING
) {
4144 addReply(c
,shared
.wrongtypeerr
);
4147 /* If the object is specially encoded or shared we have to make
4149 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4150 robj
*decoded
= getDecodedObject(o
);
4152 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4153 decrRefCount(decoded
);
4154 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4157 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4158 o
->ptr
= sdscatlen(o
->ptr
,
4159 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4161 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4162 (unsigned long) c
->argv
[2]->ptr
);
4164 totlen
= sdslen(o
->ptr
);
4167 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4170 static void substrCommand(redisClient
*c
) {
4172 long start
= atoi(c
->argv
[2]->ptr
);
4173 long end
= atoi(c
->argv
[3]->ptr
);
4174 size_t rangelen
, strlen
;
4177 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4178 checkType(c
,o
,REDIS_STRING
)) return;
4180 o
= getDecodedObject(o
);
4181 strlen
= sdslen(o
->ptr
);
4183 /* convert negative indexes */
4184 if (start
< 0) start
= strlen
+start
;
4185 if (end
< 0) end
= strlen
+end
;
4186 if (start
< 0) start
= 0;
4187 if (end
< 0) end
= 0;
4189 /* indexes sanity checks */
4190 if (start
> end
|| (size_t)start
>= strlen
) {
4191 /* Out of range start or start > end result in null reply */
4192 addReply(c
,shared
.nullbulk
);
4196 if ((size_t)end
>= strlen
) end
= strlen
-1;
4197 rangelen
= (end
-start
)+1;
4199 /* Return the result */
4200 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4201 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4202 addReplySds(c
,range
);
4203 addReply(c
,shared
.crlf
);
4207 /* ========================= Type agnostic commands ========================= */
4209 static void delCommand(redisClient
*c
) {
4212 for (j
= 1; j
< c
->argc
; j
++) {
4213 if (deleteKey(c
->db
,c
->argv
[j
])) {
4218 addReplyLong(c
,deleted
);
4221 static void existsCommand(redisClient
*c
) {
4222 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4225 static void selectCommand(redisClient
*c
) {
4226 int id
= atoi(c
->argv
[1]->ptr
);
4228 if (selectDb(c
,id
) == REDIS_ERR
) {
4229 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4231 addReply(c
,shared
.ok
);
4235 static void randomkeyCommand(redisClient
*c
) {
4239 de
= dictGetRandomKey(c
->db
->dict
);
4240 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4243 addReply(c
,shared
.plus
);
4244 addReply(c
,shared
.crlf
);
4246 addReply(c
,shared
.plus
);
4247 addReply(c
,dictGetEntryKey(de
));
4248 addReply(c
,shared
.crlf
);
4252 static void keysCommand(redisClient
*c
) {
4255 sds pattern
= c
->argv
[1]->ptr
;
4256 int plen
= sdslen(pattern
);
4257 unsigned long numkeys
= 0;
4258 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4260 di
= dictGetIterator(c
->db
->dict
);
4262 decrRefCount(lenobj
);
4263 while((de
= dictNext(di
)) != NULL
) {
4264 robj
*keyobj
= dictGetEntryKey(de
);
4266 sds key
= keyobj
->ptr
;
4267 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4268 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4269 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4270 addReplyBulk(c
,keyobj
);
4275 dictReleaseIterator(di
);
4276 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4279 static void dbsizeCommand(redisClient
*c
) {
4281 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4284 static void lastsaveCommand(redisClient
*c
) {
4286 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4289 static void typeCommand(redisClient
*c
) {
4293 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4298 case REDIS_STRING
: type
= "+string"; break;
4299 case REDIS_LIST
: type
= "+list"; break;
4300 case REDIS_SET
: type
= "+set"; break;
4301 case REDIS_ZSET
: type
= "+zset"; break;
4302 case REDIS_HASH
: type
= "+hash"; break;
4303 default: type
= "+unknown"; break;
4306 addReplySds(c
,sdsnew(type
));
4307 addReply(c
,shared
.crlf
);
4310 static void saveCommand(redisClient
*c
) {
4311 if (server
.bgsavechildpid
!= -1) {
4312 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4315 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4316 addReply(c
,shared
.ok
);
4318 addReply(c
,shared
.err
);
4322 static void bgsaveCommand(redisClient
*c
) {
4323 if (server
.bgsavechildpid
!= -1) {
4324 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4327 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4328 char *status
= "+Background saving started\r\n";
4329 addReplySds(c
,sdsnew(status
));
4331 addReply(c
,shared
.err
);
4335 static void shutdownCommand(redisClient
*c
) {
4336 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4337 /* Kill the saving child if there is a background saving in progress.
4338 We want to avoid race conditions, for instance our saving child may
4339 overwrite the synchronous saving did by SHUTDOWN. */
4340 if (server
.bgsavechildpid
!= -1) {
4341 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4342 kill(server
.bgsavechildpid
,SIGKILL
);
4343 rdbRemoveTempFile(server
.bgsavechildpid
);
4345 if (server
.appendonly
) {
4346 /* Append only file: fsync() the AOF and exit */
4347 fsync(server
.appendfd
);
4348 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4351 /* Snapshotting. Perform a SYNC SAVE and exit */
4352 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4353 if (server
.daemonize
)
4354 unlink(server
.pidfile
);
4355 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4356 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4357 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4360 /* Ooops.. error saving! The best we can do is to continue
4361 * operating. Note that if there was a background saving process,
4362 * in the next cron() Redis will be notified that the background
4363 * saving aborted, handling special stuff like slaves pending for
4364 * synchronization... */
4365 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4367 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4372 static void renameGenericCommand(redisClient
*c
, int nx
) {
4375 /* To use the same key as src and dst is probably an error */
4376 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4377 addReply(c
,shared
.sameobjecterr
);
4381 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4385 deleteIfVolatile(c
->db
,c
->argv
[2]);
4386 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4389 addReply(c
,shared
.czero
);
4392 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4394 incrRefCount(c
->argv
[2]);
4396 deleteKey(c
->db
,c
->argv
[1]);
4398 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4401 static void renameCommand(redisClient
*c
) {
4402 renameGenericCommand(c
,0);
4405 static void renamenxCommand(redisClient
*c
) {
4406 renameGenericCommand(c
,1);
4409 static void moveCommand(redisClient
*c
) {
4414 /* Obtain source and target DB pointers */
4417 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4418 addReply(c
,shared
.outofrangeerr
);
4422 selectDb(c
,srcid
); /* Back to the source DB */
4424 /* If the user is moving using as target the same
4425 * DB as the source DB it is probably an error. */
4427 addReply(c
,shared
.sameobjecterr
);
4431 /* Check if the element exists and get a reference */
4432 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4434 addReply(c
,shared
.czero
);
4438 /* Try to add the element to the target DB */
4439 deleteIfVolatile(dst
,c
->argv
[1]);
4440 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4441 addReply(c
,shared
.czero
);
4444 incrRefCount(c
->argv
[1]);
4447 /* OK! key moved, free the entry in the source DB */
4448 deleteKey(src
,c
->argv
[1]);
4450 addReply(c
,shared
.cone
);
4453 /* =================================== Lists ================================ */
4454 static void pushGenericCommand(redisClient
*c
, int where
) {
4458 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4460 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4461 addReply(c
,shared
.cone
);
4464 lobj
= createListObject();
4466 if (where
== REDIS_HEAD
) {
4467 listAddNodeHead(list
,c
->argv
[2]);
4469 listAddNodeTail(list
,c
->argv
[2]);
4471 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4472 incrRefCount(c
->argv
[1]);
4473 incrRefCount(c
->argv
[2]);
4475 if (lobj
->type
!= REDIS_LIST
) {
4476 addReply(c
,shared
.wrongtypeerr
);
4479 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4480 addReply(c
,shared
.cone
);
4484 if (where
== REDIS_HEAD
) {
4485 listAddNodeHead(list
,c
->argv
[2]);
4487 listAddNodeTail(list
,c
->argv
[2]);
4489 incrRefCount(c
->argv
[2]);
4492 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4495 static void lpushCommand(redisClient
*c
) {
4496 pushGenericCommand(c
,REDIS_HEAD
);
4499 static void rpushCommand(redisClient
*c
) {
4500 pushGenericCommand(c
,REDIS_TAIL
);
4503 static void llenCommand(redisClient
*c
) {
4507 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4508 checkType(c
,o
,REDIS_LIST
)) return;
4511 addReplyUlong(c
,listLength(l
));
4514 static void lindexCommand(redisClient
*c
) {
4516 int index
= atoi(c
->argv
[2]->ptr
);
4520 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4521 checkType(c
,o
,REDIS_LIST
)) return;
4524 ln
= listIndex(list
, index
);
4526 addReply(c
,shared
.nullbulk
);
4528 robj
*ele
= listNodeValue(ln
);
4529 addReplyBulk(c
,ele
);
4533 static void lsetCommand(redisClient
*c
) {
4535 int index
= atoi(c
->argv
[2]->ptr
);
4539 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4540 checkType(c
,o
,REDIS_LIST
)) return;
4543 ln
= listIndex(list
, index
);
4545 addReply(c
,shared
.outofrangeerr
);
4547 robj
*ele
= listNodeValue(ln
);
4550 listNodeValue(ln
) = c
->argv
[3];
4551 incrRefCount(c
->argv
[3]);
4552 addReply(c
,shared
.ok
);
4557 static void popGenericCommand(redisClient
*c
, int where
) {
4562 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4563 checkType(c
,o
,REDIS_LIST
)) return;
4566 if (where
== REDIS_HEAD
)
4567 ln
= listFirst(list
);
4569 ln
= listLast(list
);
4572 addReply(c
,shared
.nullbulk
);
4574 robj
*ele
= listNodeValue(ln
);
4575 addReplyBulk(c
,ele
);
4576 listDelNode(list
,ln
);
4577 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4582 static void lpopCommand(redisClient
*c
) {
4583 popGenericCommand(c
,REDIS_HEAD
);
4586 static void rpopCommand(redisClient
*c
) {
4587 popGenericCommand(c
,REDIS_TAIL
);
4590 static void lrangeCommand(redisClient
*c
) {
4592 int start
= atoi(c
->argv
[2]->ptr
);
4593 int end
= atoi(c
->argv
[3]->ptr
);
4600 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4601 || checkType(c
,o
,REDIS_LIST
)) return;
4603 llen
= listLength(list
);
4605 /* convert negative indexes */
4606 if (start
< 0) start
= llen
+start
;
4607 if (end
< 0) end
= llen
+end
;
4608 if (start
< 0) start
= 0;
4609 if (end
< 0) end
= 0;
4611 /* indexes sanity checks */
4612 if (start
> end
|| start
>= llen
) {
4613 /* Out of range start or start > end result in empty list */
4614 addReply(c
,shared
.emptymultibulk
);
4617 if (end
>= llen
) end
= llen
-1;
4618 rangelen
= (end
-start
)+1;
4620 /* Return the result in form of a multi-bulk reply */
4621 ln
= listIndex(list
, start
);
4622 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4623 for (j
= 0; j
< rangelen
; j
++) {
4624 ele
= listNodeValue(ln
);
4625 addReplyBulk(c
,ele
);
4630 static void ltrimCommand(redisClient
*c
) {
4632 int start
= atoi(c
->argv
[2]->ptr
);
4633 int end
= atoi(c
->argv
[3]->ptr
);
4635 int j
, ltrim
, rtrim
;
4639 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4640 checkType(c
,o
,REDIS_LIST
)) return;
4642 llen
= listLength(list
);
4644 /* convert negative indexes */
4645 if (start
< 0) start
= llen
+start
;
4646 if (end
< 0) end
= llen
+end
;
4647 if (start
< 0) start
= 0;
4648 if (end
< 0) end
= 0;
4650 /* indexes sanity checks */
4651 if (start
> end
|| start
>= llen
) {
4652 /* Out of range start or start > end result in empty list */
4656 if (end
>= llen
) end
= llen
-1;
4661 /* Remove list elements to perform the trim */
4662 for (j
= 0; j
< ltrim
; j
++) {
4663 ln
= listFirst(list
);
4664 listDelNode(list
,ln
);
4666 for (j
= 0; j
< rtrim
; j
++) {
4667 ln
= listLast(list
);
4668 listDelNode(list
,ln
);
4670 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4672 addReply(c
,shared
.ok
);
4675 static void lremCommand(redisClient
*c
) {
4678 listNode
*ln
, *next
;
4679 int toremove
= atoi(c
->argv
[2]->ptr
);
4683 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4684 checkType(c
,o
,REDIS_LIST
)) return;
4688 toremove
= -toremove
;
4691 ln
= fromtail
? list
->tail
: list
->head
;
4693 robj
*ele
= listNodeValue(ln
);
4695 next
= fromtail
? ln
->prev
: ln
->next
;
4696 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4697 listDelNode(list
,ln
);
4700 if (toremove
&& removed
== toremove
) break;
4704 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4705 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4708 /* This is the semantic of this command:
4709 * RPOPLPUSH srclist dstlist:
4710 * IF LLEN(srclist) > 0
4711 * element = RPOP srclist
4712 * LPUSH dstlist element
4719 * The idea is to be able to get an element from a list in a reliable way
4720 * since the element is not just returned but pushed against another list
4721 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4723 static void rpoplpushcommand(redisClient
*c
) {
4728 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4729 checkType(c
,sobj
,REDIS_LIST
)) return;
4730 srclist
= sobj
->ptr
;
4731 ln
= listLast(srclist
);
4734 addReply(c
,shared
.nullbulk
);
4736 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4737 robj
*ele
= listNodeValue(ln
);
4740 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4741 addReply(c
,shared
.wrongtypeerr
);
4745 /* Add the element to the target list (unless it's directly
4746 * passed to some BLPOP-ing client */
4747 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4749 /* Create the list if the key does not exist */
4750 dobj
= createListObject();
4751 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4752 incrRefCount(c
->argv
[2]);
4754 dstlist
= dobj
->ptr
;
4755 listAddNodeHead(dstlist
,ele
);
4759 /* Send the element to the client as reply as well */
4760 addReplyBulk(c
,ele
);
4762 /* Finally remove the element from the source list */
4763 listDelNode(srclist
,ln
);
4764 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4769 /* ==================================== Sets ================================ */
4771 static void saddCommand(redisClient
*c
) {
4774 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4776 set
= createSetObject();
4777 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4778 incrRefCount(c
->argv
[1]);
4780 if (set
->type
!= REDIS_SET
) {
4781 addReply(c
,shared
.wrongtypeerr
);
4785 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4786 incrRefCount(c
->argv
[2]);
4788 addReply(c
,shared
.cone
);
4790 addReply(c
,shared
.czero
);
4794 static void sremCommand(redisClient
*c
) {
4797 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4798 checkType(c
,set
,REDIS_SET
)) return;
4800 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4802 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4803 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4804 addReply(c
,shared
.cone
);
4806 addReply(c
,shared
.czero
);
4810 static void smoveCommand(redisClient
*c
) {
4811 robj
*srcset
, *dstset
;
4813 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4814 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4816 /* If the source key does not exist return 0, if it's of the wrong type
4818 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4819 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4822 /* Error if the destination key is not a set as well */
4823 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4824 addReply(c
,shared
.wrongtypeerr
);
4827 /* Remove the element from the source set */
4828 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4829 /* Key not found in the src set! return zero */
4830 addReply(c
,shared
.czero
);
4833 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4834 deleteKey(c
->db
,c
->argv
[1]);
4836 /* Add the element to the destination set */
4838 dstset
= createSetObject();
4839 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4840 incrRefCount(c
->argv
[2]);
4842 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4843 incrRefCount(c
->argv
[3]);
4844 addReply(c
,shared
.cone
);
4847 static void sismemberCommand(redisClient
*c
) {
4850 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4851 checkType(c
,set
,REDIS_SET
)) return;
4853 if (dictFind(set
->ptr
,c
->argv
[2]))
4854 addReply(c
,shared
.cone
);
4856 addReply(c
,shared
.czero
);
4859 static void scardCommand(redisClient
*c
) {
4863 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4864 checkType(c
,o
,REDIS_SET
)) return;
4867 addReplyUlong(c
,dictSize(s
));
4870 static void spopCommand(redisClient
*c
) {
4874 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4875 checkType(c
,set
,REDIS_SET
)) return;
4877 de
= dictGetRandomKey(set
->ptr
);
4879 addReply(c
,shared
.nullbulk
);
4881 robj
*ele
= dictGetEntryKey(de
);
4883 addReplyBulk(c
,ele
);
4884 dictDelete(set
->ptr
,ele
);
4885 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4886 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4891 static void srandmemberCommand(redisClient
*c
) {
4895 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4896 checkType(c
,set
,REDIS_SET
)) return;
4898 de
= dictGetRandomKey(set
->ptr
);
4900 addReply(c
,shared
.nullbulk
);
4902 robj
*ele
= dictGetEntryKey(de
);
4904 addReplyBulk(c
,ele
);
4908 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4909 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4911 return dictSize(*d1
)-dictSize(*d2
);
4914 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4915 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4918 robj
*lenobj
= NULL
, *dstset
= NULL
;
4919 unsigned long j
, cardinality
= 0;
4921 for (j
= 0; j
< setsnum
; j
++) {
4925 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4926 lookupKeyRead(c
->db
,setskeys
[j
]);
4930 if (deleteKey(c
->db
,dstkey
))
4932 addReply(c
,shared
.czero
);
4934 addReply(c
,shared
.emptymultibulk
);
4938 if (setobj
->type
!= REDIS_SET
) {
4940 addReply(c
,shared
.wrongtypeerr
);
4943 dv
[j
] = setobj
->ptr
;
4945 /* Sort sets from the smallest to largest, this will improve our
4946 * algorithm's performace */
4947 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4949 /* The first thing we should output is the total number of elements...
4950 * since this is a multi-bulk write, but at this stage we don't know
4951 * the intersection set size, so we use a trick, append an empty object
4952 * to the output list and save the pointer to later modify it with the
4955 lenobj
= createObject(REDIS_STRING
,NULL
);
4957 decrRefCount(lenobj
);
4959 /* If we have a target key where to store the resulting set
4960 * create this key with an empty set inside */
4961 dstset
= createSetObject();
4964 /* Iterate all the elements of the first (smallest) set, and test
4965 * the element against all the other sets, if at least one set does
4966 * not include the element it is discarded */
4967 di
= dictGetIterator(dv
[0]);
4969 while((de
= dictNext(di
)) != NULL
) {
4972 for (j
= 1; j
< setsnum
; j
++)
4973 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4975 continue; /* at least one set does not contain the member */
4976 ele
= dictGetEntryKey(de
);
4978 addReplyBulk(c
,ele
);
4981 dictAdd(dstset
->ptr
,ele
,NULL
);
4985 dictReleaseIterator(di
);
4988 /* Store the resulting set into the target, if the intersection
4989 * is not an empty set. */
4990 deleteKey(c
->db
,dstkey
);
4991 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4992 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4993 incrRefCount(dstkey
);
4994 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4996 decrRefCount(dstset
);
4997 addReply(c
,shared
.czero
);
5001 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5006 static void sinterCommand(redisClient
*c
) {
5007 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5010 static void sinterstoreCommand(redisClient
*c
) {
5011 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5014 #define REDIS_OP_UNION 0
5015 #define REDIS_OP_DIFF 1
5016 #define REDIS_OP_INTER 2
5018 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5019 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5022 robj
*dstset
= NULL
;
5023 int j
, cardinality
= 0;
5025 for (j
= 0; j
< setsnum
; j
++) {
5029 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5030 lookupKeyRead(c
->db
,setskeys
[j
]);
5035 if (setobj
->type
!= REDIS_SET
) {
5037 addReply(c
,shared
.wrongtypeerr
);
5040 dv
[j
] = setobj
->ptr
;
5043 /* We need a temp set object to store our union. If the dstkey
5044 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5045 * this set object will be the resulting object to set into the target key*/
5046 dstset
= createSetObject();
5048 /* Iterate all the elements of all the sets, add every element a single
5049 * time to the result set */
5050 for (j
= 0; j
< setsnum
; j
++) {
5051 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5052 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5054 di
= dictGetIterator(dv
[j
]);
5056 while((de
= dictNext(di
)) != NULL
) {
5059 /* dictAdd will not add the same element multiple times */
5060 ele
= dictGetEntryKey(de
);
5061 if (op
== REDIS_OP_UNION
|| j
== 0) {
5062 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5066 } else if (op
== REDIS_OP_DIFF
) {
5067 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5072 dictReleaseIterator(di
);
5074 /* result set is empty? Exit asap. */
5075 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5078 /* Output the content of the resulting set, if not in STORE mode */
5080 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5081 di
= dictGetIterator(dstset
->ptr
);
5082 while((de
= dictNext(di
)) != NULL
) {
5085 ele
= dictGetEntryKey(de
);
5086 addReplyBulk(c
,ele
);
5088 dictReleaseIterator(di
);
5089 decrRefCount(dstset
);
5091 /* If we have a target key where to store the resulting set
5092 * create this key with the result set inside */
5093 deleteKey(c
->db
,dstkey
);
5094 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5095 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5096 incrRefCount(dstkey
);
5097 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5099 decrRefCount(dstset
);
5100 addReply(c
,shared
.czero
);
5107 static void sunionCommand(redisClient
*c
) {
5108 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5111 static void sunionstoreCommand(redisClient
*c
) {
5112 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5115 static void sdiffCommand(redisClient
*c
) {
5116 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5119 static void sdiffstoreCommand(redisClient
*c
) {
5120 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5123 /* ==================================== ZSets =============================== */
5125 /* ZSETs are ordered sets using two data structures to hold the same elements
5126 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5129 * The elements are added to an hash table mapping Redis objects to scores.
5130 * At the same time the elements are added to a skip list mapping scores
5131 * to Redis objects (so objects are sorted by scores in this "view"). */
5133 /* This skiplist implementation is almost a C translation of the original
5134 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5135 * Alternative to Balanced Trees", modified in three ways:
5136 * a) this implementation allows for repeated values.
5137 * b) the comparison is not just by key (our 'score') but by satellite data.
5138 * c) there is a back pointer, so it's a doubly linked list with the back
5139 * pointers being only at "level 1". This allows to traverse the list
5140 * from tail to head, useful for ZREVRANGE. */
5142 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5143 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5145 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5147 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5153 static zskiplist
*zslCreate(void) {
5157 zsl
= zmalloc(sizeof(*zsl
));
5160 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5161 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5162 zsl
->header
->forward
[j
] = NULL
;
5164 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5165 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5166 zsl
->header
->span
[j
] = 0;
5168 zsl
->header
->backward
= NULL
;
5173 static void zslFreeNode(zskiplistNode
*node
) {
5174 decrRefCount(node
->obj
);
5175 zfree(node
->forward
);
5180 static void zslFree(zskiplist
*zsl
) {
5181 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5183 zfree(zsl
->header
->forward
);
5184 zfree(zsl
->header
->span
);
5187 next
= node
->forward
[0];
5194 static int zslRandomLevel(void) {
5196 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5198 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5201 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5202 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5203 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5207 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5208 /* store rank that is crossed to reach the insert position */
5209 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5211 while (x
->forward
[i
] &&
5212 (x
->forward
[i
]->score
< score
||
5213 (x
->forward
[i
]->score
== score
&&
5214 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5215 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5220 /* we assume the key is not already inside, since we allow duplicated
5221 * scores, and the re-insertion of score and redis object should never
5222 * happpen since the caller of zslInsert() should test in the hash table
5223 * if the element is already inside or not. */
5224 level
= zslRandomLevel();
5225 if (level
> zsl
->level
) {
5226 for (i
= zsl
->level
; i
< level
; i
++) {
5228 update
[i
] = zsl
->header
;
5229 update
[i
]->span
[i
-1] = zsl
->length
;
5233 x
= zslCreateNode(level
,score
,obj
);
5234 for (i
= 0; i
< level
; i
++) {
5235 x
->forward
[i
] = update
[i
]->forward
[i
];
5236 update
[i
]->forward
[i
] = x
;
5238 /* update span covered by update[i] as x is inserted here */
5240 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5241 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5245 /* increment span for untouched levels */
5246 for (i
= level
; i
< zsl
->level
; i
++) {
5247 update
[i
]->span
[i
-1]++;
5250 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5252 x
->forward
[0]->backward
= x
;
5258 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5259 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5261 for (i
= 0; i
< zsl
->level
; i
++) {
5262 if (update
[i
]->forward
[i
] == x
) {
5264 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5266 update
[i
]->forward
[i
] = x
->forward
[i
];
5268 /* invariant: i > 0, because update[0]->forward[0]
5269 * is always equal to x */
5270 update
[i
]->span
[i
-1] -= 1;
5273 if (x
->forward
[0]) {
5274 x
->forward
[0]->backward
= x
->backward
;
5276 zsl
->tail
= x
->backward
;
5278 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5283 /* Delete an element with matching score/object from the skiplist. */
5284 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5285 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5289 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5290 while (x
->forward
[i
] &&
5291 (x
->forward
[i
]->score
< score
||
5292 (x
->forward
[i
]->score
== score
&&
5293 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5297 /* We may have multiple elements with the same score, what we need
5298 * is to find the element with both the right score and object. */
5300 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5301 zslDeleteNode(zsl
, x
, update
);
5305 return 0; /* not found */
5307 return 0; /* not found */
5310 /* Delete all the elements with score between min and max from the skiplist.
5311 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5312 * Note that this function takes the reference to the hash table view of the
5313 * sorted set, in order to remove the elements from the hash table too. */
5314 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5315 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5316 unsigned long removed
= 0;
5320 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5321 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5325 /* We may have multiple elements with the same score, what we need
5326 * is to find the element with both the right score and object. */
5328 while (x
&& x
->score
<= max
) {
5329 zskiplistNode
*next
= x
->forward
[0];
5330 zslDeleteNode(zsl
, x
, update
);
5331 dictDelete(dict
,x
->obj
);
5336 return removed
; /* not found */
5339 /* Delete all the elements with rank between start and end from the skiplist.
5340 * Start and end are inclusive. Note that start and end need to be 1-based */
5341 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5342 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5343 unsigned long traversed
= 0, removed
= 0;
5347 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5348 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5349 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5357 while (x
&& traversed
<= end
) {
5358 zskiplistNode
*next
= x
->forward
[0];
5359 zslDeleteNode(zsl
, x
, update
);
5360 dictDelete(dict
,x
->obj
);
5369 /* Find the first node having a score equal or greater than the specified one.
5370 * Returns NULL if there is no match. */
5371 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5376 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5377 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5380 /* We may have multiple elements with the same score, what we need
5381 * is to find the element with both the right score and object. */
5382 return x
->forward
[0];
5385 /* Find the rank for an element by both score and key.
5386 * Returns 0 when the element cannot be found, rank otherwise.
5387 * Note that the rank is 1-based due to the span of zsl->header to the
5389 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5391 unsigned long rank
= 0;
5395 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5396 while (x
->forward
[i
] &&
5397 (x
->forward
[i
]->score
< score
||
5398 (x
->forward
[i
]->score
== score
&&
5399 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5400 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5404 /* x might be equal to zsl->header, so test if obj is non-NULL */
5405 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5412 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5413 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5415 unsigned long traversed
= 0;
5419 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5420 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5422 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5425 if (traversed
== rank
) {
5432 /* The actual Z-commands implementations */
5434 /* This generic command implements both ZADD and ZINCRBY.
5435 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5436 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5437 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5442 zsetobj
= lookupKeyWrite(c
->db
,key
);
5443 if (zsetobj
== NULL
) {
5444 zsetobj
= createZsetObject();
5445 dictAdd(c
->db
->dict
,key
,zsetobj
);
5448 if (zsetobj
->type
!= REDIS_ZSET
) {
5449 addReply(c
,shared
.wrongtypeerr
);
5455 /* Ok now since we implement both ZADD and ZINCRBY here the code
5456 * needs to handle the two different conditions. It's all about setting
5457 * '*score', that is, the new score to set, to the right value. */
5458 score
= zmalloc(sizeof(double));
5462 /* Read the old score. If the element was not present starts from 0 */
5463 de
= dictFind(zs
->dict
,ele
);
5465 double *oldscore
= dictGetEntryVal(de
);
5466 *score
= *oldscore
+ scoreval
;
5474 /* What follows is a simple remove and re-insert operation that is common
5475 * to both ZADD and ZINCRBY... */
5476 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5477 /* case 1: New element */
5478 incrRefCount(ele
); /* added to hash */
5479 zslInsert(zs
->zsl
,*score
,ele
);
5480 incrRefCount(ele
); /* added to skiplist */
5483 addReplyDouble(c
,*score
);
5485 addReply(c
,shared
.cone
);
5490 /* case 2: Score update operation */
5491 de
= dictFind(zs
->dict
,ele
);
5492 redisAssert(de
!= NULL
);
5493 oldscore
= dictGetEntryVal(de
);
5494 if (*score
!= *oldscore
) {
5497 /* Remove and insert the element in the skip list with new score */
5498 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5499 redisAssert(deleted
!= 0);
5500 zslInsert(zs
->zsl
,*score
,ele
);
5502 /* Update the score in the hash table */
5503 dictReplace(zs
->dict
,ele
,score
);
5509 addReplyDouble(c
,*score
);
5511 addReply(c
,shared
.czero
);
5515 static void zaddCommand(redisClient
*c
) {
5518 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5519 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5522 static void zincrbyCommand(redisClient
*c
) {
5525 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5526 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5529 static void zremCommand(redisClient
*c
) {
5536 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5537 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5540 de
= dictFind(zs
->dict
,c
->argv
[2]);
5542 addReply(c
,shared
.czero
);
5545 /* Delete from the skiplist */
5546 oldscore
= dictGetEntryVal(de
);
5547 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5548 redisAssert(deleted
!= 0);
5550 /* Delete from the hash table */
5551 dictDelete(zs
->dict
,c
->argv
[2]);
5552 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5553 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5555 addReply(c
,shared
.cone
);
5558 static void zremrangebyscoreCommand(redisClient
*c
) {
5565 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5566 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5568 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5569 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5572 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5573 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5574 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5575 server
.dirty
+= deleted
;
5576 addReplyLong(c
,deleted
);
5579 static void zremrangebyrankCommand(redisClient
*c
) {
5587 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5588 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5590 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5591 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5593 llen
= zs
->zsl
->length
;
5595 /* convert negative indexes */
5596 if (start
< 0) start
= llen
+start
;
5597 if (end
< 0) end
= llen
+end
;
5598 if (start
< 0) start
= 0;
5599 if (end
< 0) end
= 0;
5601 /* indexes sanity checks */
5602 if (start
> end
|| start
>= llen
) {
5603 addReply(c
,shared
.czero
);
5606 if (end
>= llen
) end
= llen
-1;
5608 /* increment start and end because zsl*Rank functions
5609 * use 1-based rank */
5610 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5611 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5612 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5613 server
.dirty
+= deleted
;
5614 addReplyLong(c
, deleted
);
5622 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5623 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5624 unsigned long size1
, size2
;
5625 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5626 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5627 return size1
- size2
;
5630 #define REDIS_AGGR_SUM 1
5631 #define REDIS_AGGR_MIN 2
5632 #define REDIS_AGGR_MAX 3
5634 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5635 if (aggregate
== REDIS_AGGR_SUM
) {
5636 *target
= *target
+ val
;
5637 } else if (aggregate
== REDIS_AGGR_MIN
) {
5638 *target
= val
< *target
? val
: *target
;
5639 } else if (aggregate
== REDIS_AGGR_MAX
) {
5640 *target
= val
> *target
? val
: *target
;
5643 redisPanic("Unknown ZUNION/INTER aggregate type");
5647 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5649 int aggregate
= REDIS_AGGR_SUM
;
5656 /* expect zsetnum input keys to be given */
5657 zsetnum
= atoi(c
->argv
[2]->ptr
);
5659 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5663 /* test if the expected number of keys would overflow */
5664 if (3+zsetnum
> c
->argc
) {
5665 addReply(c
,shared
.syntaxerr
);
5669 /* read keys to be used for input */
5670 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5671 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5672 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5676 if (zsetobj
->type
!= REDIS_ZSET
) {
5678 addReply(c
,shared
.wrongtypeerr
);
5681 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5684 /* default all weights to 1 */
5685 src
[i
].weight
= 1.0;
5688 /* parse optional extra arguments */
5690 int remaining
= c
->argc
- j
;
5693 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5695 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5696 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5699 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5701 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5702 aggregate
= REDIS_AGGR_SUM
;
5703 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5704 aggregate
= REDIS_AGGR_MIN
;
5705 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5706 aggregate
= REDIS_AGGR_MAX
;
5709 addReply(c
,shared
.syntaxerr
);
5715 addReply(c
,shared
.syntaxerr
);
5721 /* sort sets from the smallest to largest, this will improve our
5722 * algorithm's performance */
5723 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5725 dstobj
= createZsetObject();
5726 dstzset
= dstobj
->ptr
;
5728 if (op
== REDIS_OP_INTER
) {
5729 /* skip going over all entries if the smallest zset is NULL or empty */
5730 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5731 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5732 * from small to large, all src[i > 0].dict are non-empty too */
5733 di
= dictGetIterator(src
[0].dict
);
5734 while((de
= dictNext(di
)) != NULL
) {
5735 double *score
= zmalloc(sizeof(double)), value
;
5736 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5738 for (j
= 1; j
< zsetnum
; j
++) {
5739 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5741 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5742 zunionInterAggregate(score
, value
, aggregate
);
5748 /* skip entry when not present in every source dict */
5752 robj
*o
= dictGetEntryKey(de
);
5753 dictAdd(dstzset
->dict
,o
,score
);
5754 incrRefCount(o
); /* added to dictionary */
5755 zslInsert(dstzset
->zsl
,*score
,o
);
5756 incrRefCount(o
); /* added to skiplist */
5759 dictReleaseIterator(di
);
5761 } else if (op
== REDIS_OP_UNION
) {
5762 for (i
= 0; i
< zsetnum
; i
++) {
5763 if (!src
[i
].dict
) continue;
5765 di
= dictGetIterator(src
[i
].dict
);
5766 while((de
= dictNext(di
)) != NULL
) {
5767 /* skip key when already processed */
5768 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5770 double *score
= zmalloc(sizeof(double)), value
;
5771 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5773 /* because the zsets are sorted by size, its only possible
5774 * for sets at larger indices to hold this entry */
5775 for (j
= (i
+1); j
< zsetnum
; j
++) {
5776 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5778 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5779 zunionInterAggregate(score
, value
, aggregate
);
5783 robj
*o
= dictGetEntryKey(de
);
5784 dictAdd(dstzset
->dict
,o
,score
);
5785 incrRefCount(o
); /* added to dictionary */
5786 zslInsert(dstzset
->zsl
,*score
,o
);
5787 incrRefCount(o
); /* added to skiplist */
5789 dictReleaseIterator(di
);
5792 /* unknown operator */
5793 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5796 deleteKey(c
->db
,dstkey
);
5797 if (dstzset
->zsl
->length
) {
5798 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5799 incrRefCount(dstkey
);
5800 addReplyLong(c
, dstzset
->zsl
->length
);
5803 decrRefCount(dstobj
);
5804 addReply(c
, shared
.czero
);
5809 static void zunionCommand(redisClient
*c
) {
5810 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5813 static void zinterCommand(redisClient
*c
) {
5814 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5817 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5829 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5830 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5832 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5834 } else if (c
->argc
>= 5) {
5835 addReply(c
,shared
.syntaxerr
);
5839 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5840 || checkType(c
,o
,REDIS_ZSET
)) return;
5845 /* convert negative indexes */
5846 if (start
< 0) start
= llen
+start
;
5847 if (end
< 0) end
= llen
+end
;
5848 if (start
< 0) start
= 0;
5849 if (end
< 0) end
= 0;
5851 /* indexes sanity checks */
5852 if (start
> end
|| start
>= llen
) {
5853 /* Out of range start or start > end result in empty list */
5854 addReply(c
,shared
.emptymultibulk
);
5857 if (end
>= llen
) end
= llen
-1;
5858 rangelen
= (end
-start
)+1;
5860 /* check if starting point is trivial, before searching
5861 * the element in log(N) time */
5863 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5866 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5869 /* Return the result in form of a multi-bulk reply */
5870 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5871 withscores
? (rangelen
*2) : rangelen
));
5872 for (j
= 0; j
< rangelen
; j
++) {
5874 addReplyBulk(c
,ele
);
5876 addReplyDouble(c
,ln
->score
);
5877 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5881 static void zrangeCommand(redisClient
*c
) {
5882 zrangeGenericCommand(c
,0);
5885 static void zrevrangeCommand(redisClient
*c
) {
5886 zrangeGenericCommand(c
,1);
5889 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5890 * If justcount is non-zero, just the count is returned. */
5891 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5894 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5895 int offset
= 0, limit
= -1;
5899 /* Parse the min-max interval. If one of the values is prefixed
5900 * by the "(" character, it's considered "open". For instance
5901 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5902 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5903 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5904 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5907 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5909 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5910 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5913 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5916 /* Parse "WITHSCORES": note that if the command was called with
5917 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5918 * enter the following paths to parse WITHSCORES and LIMIT. */
5919 if (c
->argc
== 5 || c
->argc
== 8) {
5920 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5925 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5929 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5934 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5935 addReply(c
,shared
.syntaxerr
);
5937 } else if (c
->argc
== (7 + withscores
)) {
5938 offset
= atoi(c
->argv
[5]->ptr
);
5939 limit
= atoi(c
->argv
[6]->ptr
);
5940 if (offset
< 0) offset
= 0;
5943 /* Ok, lookup the key and get the range */
5944 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5946 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5948 if (o
->type
!= REDIS_ZSET
) {
5949 addReply(c
,shared
.wrongtypeerr
);
5951 zset
*zsetobj
= o
->ptr
;
5952 zskiplist
*zsl
= zsetobj
->zsl
;
5954 robj
*ele
, *lenobj
= NULL
;
5955 unsigned long rangelen
= 0;
5957 /* Get the first node with the score >= min, or with
5958 * score > min if 'minex' is true. */
5959 ln
= zslFirstWithScore(zsl
,min
);
5960 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5963 /* No element matching the speciifed interval */
5964 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5968 /* We don't know in advance how many matching elements there
5969 * are in the list, so we push this object that will represent
5970 * the multi-bulk length in the output buffer, and will "fix"
5973 lenobj
= createObject(REDIS_STRING
,NULL
);
5975 decrRefCount(lenobj
);
5978 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5981 ln
= ln
->forward
[0];
5984 if (limit
== 0) break;
5987 addReplyBulk(c
,ele
);
5989 addReplyDouble(c
,ln
->score
);
5991 ln
= ln
->forward
[0];
5993 if (limit
> 0) limit
--;
5996 addReplyLong(c
,(long)rangelen
);
5998 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5999 withscores
? (rangelen
*2) : rangelen
);
6005 static void zrangebyscoreCommand(redisClient
*c
) {
6006 genericZrangebyscoreCommand(c
,0);
6009 static void zcountCommand(redisClient
*c
) {
6010 genericZrangebyscoreCommand(c
,1);
6013 static void zcardCommand(redisClient
*c
) {
6017 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6018 checkType(c
,o
,REDIS_ZSET
)) return;
6021 addReplyUlong(c
,zs
->zsl
->length
);
6024 static void zscoreCommand(redisClient
*c
) {
6029 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6030 checkType(c
,o
,REDIS_ZSET
)) return;
6033 de
= dictFind(zs
->dict
,c
->argv
[2]);
6035 addReply(c
,shared
.nullbulk
);
6037 double *score
= dictGetEntryVal(de
);
6039 addReplyDouble(c
,*score
);
6043 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6051 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6052 checkType(c
,o
,REDIS_ZSET
)) return;
6056 de
= dictFind(zs
->dict
,c
->argv
[2]);
6058 addReply(c
,shared
.nullbulk
);
6062 score
= dictGetEntryVal(de
);
6063 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6066 addReplyLong(c
, zsl
->length
- rank
);
6068 addReplyLong(c
, rank
-1);
6071 addReply(c
,shared
.nullbulk
);
6075 static void zrankCommand(redisClient
*c
) {
6076 zrankGenericCommand(c
, 0);
6079 static void zrevrankCommand(redisClient
*c
) {
6080 zrankGenericCommand(c
, 1);
6083 /* ========================= Hashes utility functions ======================= */
6084 #define REDIS_HASH_KEY 1
6085 #define REDIS_HASH_VALUE 2
6087 /* Check the length of a number of objects to see if we need to convert a
6088 * zipmap to a real hash. Note that we only check string encoded objects
6089 * as their string length can be queried in constant time. */
6090 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6092 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6094 for (i
= start
; i
<= end
; i
++) {
6095 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6096 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6098 convertToRealHash(subject
);
6104 /* Encode given objects in-place when the hash uses a dict. */
6105 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6106 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6107 if (o1
) *o1
= tryObjectEncoding(*o1
);
6108 if (o2
) *o2
= tryObjectEncoding(*o2
);
6112 /* Get the value from a hash identified by key. Returns either a string
6113 * object or NULL if the value cannot be found. The refcount of the object
6114 * is always increased by 1 when the value was found. */
6115 static robj
*hashGet(robj
*o
, robj
*key
) {
6117 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6120 key
= getDecodedObject(key
);
6121 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6122 value
= createStringObject((char*)v
,vlen
);
6126 dictEntry
*de
= dictFind(o
->ptr
,key
);
6128 value
= dictGetEntryVal(de
);
6129 incrRefCount(value
);
6135 /* Test if the key exists in the given hash. Returns 1 if the key
6136 * exists and 0 when it doesn't. */
6137 static int hashExists(robj
*o
, robj
*key
) {
6138 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6139 key
= getDecodedObject(key
);
6140 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6146 if (dictFind(o
->ptr
,key
) != NULL
) {
6153 /* Add an element, discard the old if the key already exists.
6154 * Return 0 on insert and 1 on update. */
6155 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6157 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6158 key
= getDecodedObject(key
);
6159 value
= getDecodedObject(value
);
6160 o
->ptr
= zipmapSet(o
->ptr
,
6161 key
->ptr
,sdslen(key
->ptr
),
6162 value
->ptr
,sdslen(value
->ptr
), &update
);
6164 decrRefCount(value
);
6166 /* Check if the zipmap needs to be upgraded to a real hash table */
6167 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6168 convertToRealHash(o
);
6170 if (dictReplace(o
->ptr
,key
,value
)) {
6177 incrRefCount(value
);
6182 /* Delete an element from a hash.
6183 * Return 1 on deleted and 0 on not found. */
6184 static int hashDelete(robj
*o
, robj
*key
) {
6186 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6187 key
= getDecodedObject(key
);
6188 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6191 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6192 /* Always check if the dictionary needs a resize after a delete. */
6193 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6198 /* Return the number of elements in a hash. */
6199 static unsigned long hashLength(robj
*o
) {
6200 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6201 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6204 /* Structure to hold hash iteration abstration. Note that iteration over
6205 * hashes involves both fields and values. Because it is possible that
6206 * not both are required, store pointers in the iterator to avoid
6207 * unnecessary memory allocation for fields/values. */
6211 unsigned char *zk
, *zv
;
6212 unsigned int zklen
, zvlen
;
6218 static hashIterator
*hashInitIterator(robj
*subject
) {
6219 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6220 hi
->encoding
= subject
->encoding
;
6221 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6222 hi
->zi
= zipmapRewind(subject
->ptr
);
6223 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6224 hi
->di
= dictGetIterator(subject
->ptr
);
6231 static void hashReleaseIterator(hashIterator
*hi
) {
6232 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6233 dictReleaseIterator(hi
->di
);
6238 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6239 * could be found and REDIS_ERR when the iterator reaches the end. */
6240 static int hashNext(hashIterator
*hi
) {
6241 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6242 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6243 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6245 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6250 /* Get key or value object at current iteration position.
6251 * This increases the refcount of the field object by 1. */
6252 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6254 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6255 if (what
& REDIS_HASH_KEY
) {
6256 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6258 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6261 if (what
& REDIS_HASH_KEY
) {
6262 o
= dictGetEntryKey(hi
->de
);
6264 o
= dictGetEntryVal(hi
->de
);
6271 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6272 robj
*o
= lookupKeyWrite(c
->db
,key
);
6274 o
= createHashObject();
6275 dictAdd(c
->db
->dict
,key
,o
);
6278 if (o
->type
!= REDIS_HASH
) {
6279 addReply(c
,shared
.wrongtypeerr
);
6286 /* ============================= Hash commands ============================== */
6287 static void hsetCommand(redisClient
*c
) {
6291 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6292 hashTryConversion(o
,c
->argv
,2,3);
6293 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6294 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6295 addReply(c
, update
? shared
.czero
: shared
.cone
);
6299 static void hsetnxCommand(redisClient
*c
) {
6301 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6302 hashTryConversion(o
,c
->argv
,2,3);
6304 if (hashExists(o
, c
->argv
[2])) {
6305 addReply(c
, shared
.czero
);
6307 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6308 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6309 addReply(c
, shared
.cone
);
6314 static void hmsetCommand(redisClient
*c
) {
6318 if ((c
->argc
% 2) == 1) {
6319 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6323 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6324 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6325 for (i
= 2; i
< c
->argc
; i
+= 2) {
6326 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6327 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6329 addReply(c
, shared
.ok
);
6333 static void hincrbyCommand(redisClient
*c
) {
6334 long long value
, incr
;
6335 robj
*o
, *current
, *new;
6337 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6338 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6339 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6340 if (current
->encoding
== REDIS_ENCODING_RAW
)
6341 value
= strtoll(current
->ptr
,NULL
,10);
6342 else if (current
->encoding
== REDIS_ENCODING_INT
)
6343 value
= (long)current
->ptr
;
6345 redisAssert(1 != 1);
6346 decrRefCount(current
);
6352 new = createStringObjectFromLongLong(value
);
6353 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6354 hashSet(o
,c
->argv
[2],new);
6356 addReplyLongLong(c
,value
);
6360 static void hgetCommand(redisClient
*c
) {
6362 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6363 checkType(c
,o
,REDIS_HASH
)) return;
6365 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6366 addReplyBulk(c
,value
);
6367 decrRefCount(value
);
6369 addReply(c
,shared
.nullbulk
);
6373 static void hmgetCommand(redisClient
*c
) {
6376 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6377 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6378 addReply(c
,shared
.wrongtypeerr
);
6381 /* Note the check for o != NULL happens inside the loop. This is
6382 * done because objects that cannot be found are considered to be
6383 * an empty hash. The reply should then be a series of NULLs. */
6384 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6385 for (i
= 2; i
< c
->argc
; i
++) {
6386 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6387 addReplyBulk(c
,value
);
6388 decrRefCount(value
);
6390 addReply(c
,shared
.nullbulk
);
6395 static void hdelCommand(redisClient
*c
) {
6397 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6398 checkType(c
,o
,REDIS_HASH
)) return;
6400 if (hashDelete(o
,c
->argv
[2])) {
6401 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6402 addReply(c
,shared
.cone
);
6405 addReply(c
,shared
.czero
);
6409 static void hlenCommand(redisClient
*c
) {
6411 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6412 checkType(c
,o
,REDIS_HASH
)) return;
6414 addReplyUlong(c
,hashLength(o
));
6417 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6418 robj
*o
, *lenobj
, *obj
;
6419 unsigned long count
= 0;
6422 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6423 || checkType(c
,o
,REDIS_HASH
)) return;
6425 lenobj
= createObject(REDIS_STRING
,NULL
);
6427 decrRefCount(lenobj
);
6429 hi
= hashInitIterator(o
);
6430 while (hashNext(hi
) != REDIS_ERR
) {
6431 if (flags
& REDIS_HASH_KEY
) {
6432 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6433 addReplyBulk(c
,obj
);
6437 if (flags
& REDIS_HASH_VALUE
) {
6438 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6439 addReplyBulk(c
,obj
);
6444 hashReleaseIterator(hi
);
6446 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6449 static void hkeysCommand(redisClient
*c
) {
6450 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6453 static void hvalsCommand(redisClient
*c
) {
6454 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6457 static void hgetallCommand(redisClient
*c
) {
6458 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6461 static void hexistsCommand(redisClient
*c
) {
6463 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6464 checkType(c
,o
,REDIS_HASH
)) return;
6466 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6469 static void convertToRealHash(robj
*o
) {
6470 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6471 unsigned int klen
, vlen
;
6472 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6474 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6475 p
= zipmapRewind(zm
);
6476 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6477 robj
*keyobj
, *valobj
;
6479 keyobj
= createStringObject((char*)key
,klen
);
6480 valobj
= createStringObject((char*)val
,vlen
);
6481 keyobj
= tryObjectEncoding(keyobj
);
6482 valobj
= tryObjectEncoding(valobj
);
6483 dictAdd(dict
,keyobj
,valobj
);
6485 o
->encoding
= REDIS_ENCODING_HT
;
6490 /* ========================= Non type-specific commands ==================== */
6492 static void flushdbCommand(redisClient
*c
) {
6493 server
.dirty
+= dictSize(c
->db
->dict
);
6494 dictEmpty(c
->db
->dict
);
6495 dictEmpty(c
->db
->expires
);
6496 addReply(c
,shared
.ok
);
6499 static void flushallCommand(redisClient
*c
) {
6500 server
.dirty
+= emptyDb();
6501 addReply(c
,shared
.ok
);
6502 if (server
.bgsavechildpid
!= -1) {
6503 kill(server
.bgsavechildpid
,SIGKILL
);
6504 rdbRemoveTempFile(server
.bgsavechildpid
);
6506 rdbSave(server
.dbfilename
);
6510 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6511 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6513 so
->pattern
= pattern
;
6517 /* Return the value associated to the key with a name obtained
6518 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6519 * The returned object will always have its refcount increased by 1
6520 * when it is non-NULL. */
6521 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6524 robj keyobj
, fieldobj
, *o
;
6525 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6526 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6530 char buf
[REDIS_SORTKEY_MAX
+1];
6531 } keyname
, fieldname
;
6533 /* If the pattern is "#" return the substitution object itself in order
6534 * to implement the "SORT ... GET #" feature. */
6535 spat
= pattern
->ptr
;
6536 if (spat
[0] == '#' && spat
[1] == '\0') {
6537 incrRefCount(subst
);
6541 /* The substitution object may be specially encoded. If so we create
6542 * a decoded object on the fly. Otherwise getDecodedObject will just
6543 * increment the ref count, that we'll decrement later. */
6544 subst
= getDecodedObject(subst
);
6547 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6548 p
= strchr(spat
,'*');
6550 decrRefCount(subst
);
6554 /* Find out if we're dealing with a hash dereference. */
6555 if ((f
= strstr(p
+1, "->")) != NULL
) {
6556 fieldlen
= sdslen(spat
)-(f
-spat
);
6557 /* this also copies \0 character */
6558 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6559 fieldname
.len
= fieldlen
-2;
6565 sublen
= sdslen(ssub
);
6566 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6567 memcpy(keyname
.buf
,spat
,prefixlen
);
6568 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6569 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6570 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6571 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6572 decrRefCount(subst
);
6574 /* Lookup substituted key */
6575 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6576 o
= lookupKeyRead(db
,&keyobj
);
6577 if (o
== NULL
) return NULL
;
6580 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6582 /* Retrieve value from hash by the field name. This operation
6583 * already increases the refcount of the returned object. */
6584 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6585 o
= hashGet(o
, &fieldobj
);
6587 if (o
->type
!= REDIS_STRING
) return NULL
;
6589 /* Every object that this function returns needs to have its refcount
6590 * increased. sortCommand decreases it again. */
6597 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6598 * the additional parameter is not standard but a BSD-specific we have to
6599 * pass sorting parameters via the global 'server' structure */
6600 static int sortCompare(const void *s1
, const void *s2
) {
6601 const redisSortObject
*so1
= s1
, *so2
= s2
;
6604 if (!server
.sort_alpha
) {
6605 /* Numeric sorting. Here it's trivial as we precomputed scores */
6606 if (so1
->u
.score
> so2
->u
.score
) {
6608 } else if (so1
->u
.score
< so2
->u
.score
) {
6614 /* Alphanumeric sorting */
6615 if (server
.sort_bypattern
) {
6616 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6617 /* At least one compare object is NULL */
6618 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6620 else if (so1
->u
.cmpobj
== NULL
)
6625 /* We have both the objects, use strcoll */
6626 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6629 /* Compare elements directly. */
6630 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6633 return server
.sort_desc
? -cmp
: cmp
;
6636 /* The SORT command is the most complex command in Redis. Warning: this code
6637 * is optimized for speed and a bit less for readability */
6638 static void sortCommand(redisClient
*c
) {
6641 int desc
= 0, alpha
= 0;
6642 int limit_start
= 0, limit_count
= -1, start
, end
;
6643 int j
, dontsort
= 0, vectorlen
;
6644 int getop
= 0; /* GET operation counter */
6645 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6646 redisSortObject
*vector
; /* Resulting vector to sort */
6648 /* Lookup the key to sort. It must be of the right types */
6649 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6650 if (sortval
== NULL
) {
6651 addReply(c
,shared
.emptymultibulk
);
6654 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6655 sortval
->type
!= REDIS_ZSET
)
6657 addReply(c
,shared
.wrongtypeerr
);
6661 /* Create a list of operations to perform for every sorted element.
6662 * Operations can be GET/DEL/INCR/DECR */
6663 operations
= listCreate();
6664 listSetFreeMethod(operations
,zfree
);
6667 /* Now we need to protect sortval incrementing its count, in the future
6668 * SORT may have options able to overwrite/delete keys during the sorting
6669 * and the sorted key itself may get destroied */
6670 incrRefCount(sortval
);
6672 /* The SORT command has an SQL-alike syntax, parse it */
6673 while(j
< c
->argc
) {
6674 int leftargs
= c
->argc
-j
-1;
6675 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6677 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6679 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6681 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6682 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6683 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6685 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6686 storekey
= c
->argv
[j
+1];
6688 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6689 sortby
= c
->argv
[j
+1];
6690 /* If the BY pattern does not contain '*', i.e. it is constant,
6691 * we don't need to sort nor to lookup the weight keys. */
6692 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6694 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6695 listAddNodeTail(operations
,createSortOperation(
6696 REDIS_SORT_GET
,c
->argv
[j
+1]));
6700 decrRefCount(sortval
);
6701 listRelease(operations
);
6702 addReply(c
,shared
.syntaxerr
);
6708 /* Load the sorting vector with all the objects to sort */
6709 switch(sortval
->type
) {
6710 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6711 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6712 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6713 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6715 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6718 if (sortval
->type
== REDIS_LIST
) {
6719 list
*list
= sortval
->ptr
;
6723 listRewind(list
,&li
);
6724 while((ln
= listNext(&li
))) {
6725 robj
*ele
= ln
->value
;
6726 vector
[j
].obj
= ele
;
6727 vector
[j
].u
.score
= 0;
6728 vector
[j
].u
.cmpobj
= NULL
;
6736 if (sortval
->type
== REDIS_SET
) {
6739 zset
*zs
= sortval
->ptr
;
6743 di
= dictGetIterator(set
);
6744 while((setele
= dictNext(di
)) != NULL
) {
6745 vector
[j
].obj
= dictGetEntryKey(setele
);
6746 vector
[j
].u
.score
= 0;
6747 vector
[j
].u
.cmpobj
= NULL
;
6750 dictReleaseIterator(di
);
6752 redisAssert(j
== vectorlen
);
6754 /* Now it's time to load the right scores in the sorting vector */
6755 if (dontsort
== 0) {
6756 for (j
= 0; j
< vectorlen
; j
++) {
6759 /* lookup value to sort by */
6760 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6761 if (!byval
) continue;
6763 /* use object itself to sort by */
6764 byval
= vector
[j
].obj
;
6768 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6770 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6771 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6772 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6773 /* Don't need to decode the object if it's
6774 * integer-encoded (the only encoding supported) so
6775 * far. We can just cast it */
6776 vector
[j
].u
.score
= (long)byval
->ptr
;
6778 redisAssert(1 != 1);
6782 /* when the object was retrieved using lookupKeyByPattern,
6783 * its refcount needs to be decreased. */
6785 decrRefCount(byval
);
6790 /* We are ready to sort the vector... perform a bit of sanity check
6791 * on the LIMIT option too. We'll use a partial version of quicksort. */
6792 start
= (limit_start
< 0) ? 0 : limit_start
;
6793 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6794 if (start
>= vectorlen
) {
6795 start
= vectorlen
-1;
6798 if (end
>= vectorlen
) end
= vectorlen
-1;
6800 if (dontsort
== 0) {
6801 server
.sort_desc
= desc
;
6802 server
.sort_alpha
= alpha
;
6803 server
.sort_bypattern
= sortby
? 1 : 0;
6804 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6805 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6807 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6810 /* Send command output to the output buffer, performing the specified
6811 * GET/DEL/INCR/DECR operations if any. */
6812 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6813 if (storekey
== NULL
) {
6814 /* STORE option not specified, sent the sorting result to client */
6815 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6816 for (j
= start
; j
<= end
; j
++) {
6820 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6821 listRewind(operations
,&li
);
6822 while((ln
= listNext(&li
))) {
6823 redisSortOperation
*sop
= ln
->value
;
6824 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6827 if (sop
->type
== REDIS_SORT_GET
) {
6829 addReply(c
,shared
.nullbulk
);
6831 addReplyBulk(c
,val
);
6835 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6840 robj
*listObject
= createListObject();
6841 list
*listPtr
= (list
*) listObject
->ptr
;
6843 /* STORE option specified, set the sorting result as a List object */
6844 for (j
= start
; j
<= end
; j
++) {
6849 listAddNodeTail(listPtr
,vector
[j
].obj
);
6850 incrRefCount(vector
[j
].obj
);
6852 listRewind(operations
,&li
);
6853 while((ln
= listNext(&li
))) {
6854 redisSortOperation
*sop
= ln
->value
;
6855 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6858 if (sop
->type
== REDIS_SORT_GET
) {
6860 listAddNodeTail(listPtr
,createStringObject("",0));
6862 /* We should do a incrRefCount on val because it is
6863 * added to the list, but also a decrRefCount because
6864 * it is returned by lookupKeyByPattern. This results
6865 * in doing nothing at all. */
6866 listAddNodeTail(listPtr
,val
);
6869 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6873 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6874 incrRefCount(storekey
);
6876 /* Note: we add 1 because the DB is dirty anyway since even if the
6877 * SORT result is empty a new key is set and maybe the old content
6879 server
.dirty
+= 1+outputlen
;
6880 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6884 decrRefCount(sortval
);
6885 listRelease(operations
);
6886 for (j
= 0; j
< vectorlen
; j
++) {
6887 if (alpha
&& vector
[j
].u
.cmpobj
)
6888 decrRefCount(vector
[j
].u
.cmpobj
);
6893 /* Convert an amount of bytes into a human readable string in the form
6894 * of 100B, 2G, 100M, 4K, and so forth. */
6895 static void bytesToHuman(char *s
, unsigned long long n
) {
6900 sprintf(s
,"%lluB",n
);
6902 } else if (n
< (1024*1024)) {
6903 d
= (double)n
/(1024);
6904 sprintf(s
,"%.2fK",d
);
6905 } else if (n
< (1024LL*1024*1024)) {
6906 d
= (double)n
/(1024*1024);
6907 sprintf(s
,"%.2fM",d
);
6908 } else if (n
< (1024LL*1024*1024*1024)) {
6909 d
= (double)n
/(1024LL*1024*1024);
6910 sprintf(s
,"%.2fG",d
);
6914 /* Create the string returned by the INFO command. This is decoupled
6915 * by the INFO command itself as we need to report the same information
6916 * on memory corruption problems. */
6917 static sds
genRedisInfoString(void) {
6919 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6923 bytesToHuman(hmem
,zmalloc_used_memory());
6924 info
= sdscatprintf(sdsempty(),
6925 "redis_version:%s\r\n"
6927 "multiplexing_api:%s\r\n"
6928 "process_id:%ld\r\n"
6929 "uptime_in_seconds:%ld\r\n"
6930 "uptime_in_days:%ld\r\n"
6931 "connected_clients:%d\r\n"
6932 "connected_slaves:%d\r\n"
6933 "blocked_clients:%d\r\n"
6934 "used_memory:%zu\r\n"
6935 "used_memory_human:%s\r\n"
6936 "changes_since_last_save:%lld\r\n"
6937 "bgsave_in_progress:%d\r\n"
6938 "last_save_time:%ld\r\n"
6939 "bgrewriteaof_in_progress:%d\r\n"
6940 "total_connections_received:%lld\r\n"
6941 "total_commands_processed:%lld\r\n"
6942 "expired_keys:%lld\r\n"
6943 "hash_max_zipmap_entries:%ld\r\n"
6944 "hash_max_zipmap_value:%ld\r\n"
6945 "pubsub_channels:%ld\r\n"
6946 "pubsub_patterns:%u\r\n"
6950 (sizeof(long) == 8) ? "64" : "32",
6955 listLength(server
.clients
)-listLength(server
.slaves
),
6956 listLength(server
.slaves
),
6957 server
.blpop_blocked_clients
,
6958 zmalloc_used_memory(),
6961 server
.bgsavechildpid
!= -1,
6963 server
.bgrewritechildpid
!= -1,
6964 server
.stat_numconnections
,
6965 server
.stat_numcommands
,
6966 server
.stat_expiredkeys
,
6967 server
.hash_max_zipmap_entries
,
6968 server
.hash_max_zipmap_value
,
6969 dictSize(server
.pubsub_channels
),
6970 listLength(server
.pubsub_patterns
),
6971 server
.vm_enabled
!= 0,
6972 server
.masterhost
== NULL
? "master" : "slave"
6974 if (server
.masterhost
) {
6975 info
= sdscatprintf(info
,
6976 "master_host:%s\r\n"
6977 "master_port:%d\r\n"
6978 "master_link_status:%s\r\n"
6979 "master_last_io_seconds_ago:%d\r\n"
6982 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6984 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6987 if (server
.vm_enabled
) {
6989 info
= sdscatprintf(info
,
6990 "vm_conf_max_memory:%llu\r\n"
6991 "vm_conf_page_size:%llu\r\n"
6992 "vm_conf_pages:%llu\r\n"
6993 "vm_stats_used_pages:%llu\r\n"
6994 "vm_stats_swapped_objects:%llu\r\n"
6995 "vm_stats_swappin_count:%llu\r\n"
6996 "vm_stats_swappout_count:%llu\r\n"
6997 "vm_stats_io_newjobs_len:%lu\r\n"
6998 "vm_stats_io_processing_len:%lu\r\n"
6999 "vm_stats_io_processed_len:%lu\r\n"
7000 "vm_stats_io_active_threads:%lu\r\n"
7001 "vm_stats_blocked_clients:%lu\r\n"
7002 ,(unsigned long long) server
.vm_max_memory
,
7003 (unsigned long long) server
.vm_page_size
,
7004 (unsigned long long) server
.vm_pages
,
7005 (unsigned long long) server
.vm_stats_used_pages
,
7006 (unsigned long long) server
.vm_stats_swapped_objects
,
7007 (unsigned long long) server
.vm_stats_swapins
,
7008 (unsigned long long) server
.vm_stats_swapouts
,
7009 (unsigned long) listLength(server
.io_newjobs
),
7010 (unsigned long) listLength(server
.io_processing
),
7011 (unsigned long) listLength(server
.io_processed
),
7012 (unsigned long) server
.io_active_threads
,
7013 (unsigned long) server
.vm_blocked_clients
7017 for (j
= 0; j
< server
.dbnum
; j
++) {
7018 long long keys
, vkeys
;
7020 keys
= dictSize(server
.db
[j
].dict
);
7021 vkeys
= dictSize(server
.db
[j
].expires
);
7022 if (keys
|| vkeys
) {
7023 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7030 static void infoCommand(redisClient
*c
) {
7031 sds info
= genRedisInfoString();
7032 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7033 (unsigned long)sdslen(info
)));
7034 addReplySds(c
,info
);
7035 addReply(c
,shared
.crlf
);
7038 static void monitorCommand(redisClient
*c
) {
7039 /* ignore MONITOR if aleady slave or in monitor mode */
7040 if (c
->flags
& REDIS_SLAVE
) return;
7042 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7044 listAddNodeTail(server
.monitors
,c
);
7045 addReply(c
,shared
.ok
);
7048 /* ================================= Expire ================================= */
7049 static int removeExpire(redisDb
*db
, robj
*key
) {
7050 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7057 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7058 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7066 /* Return the expire time of the specified key, or -1 if no expire
7067 * is associated with this key (i.e. the key is non volatile) */
7068 static time_t getExpire(redisDb
*db
, robj
*key
) {
7071 /* No expire? return ASAP */
7072 if (dictSize(db
->expires
) == 0 ||
7073 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7075 return (time_t) dictGetEntryVal(de
);
7078 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7082 /* No expire? return ASAP */
7083 if (dictSize(db
->expires
) == 0 ||
7084 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7086 /* Lookup the expire */
7087 when
= (time_t) dictGetEntryVal(de
);
7088 if (time(NULL
) <= when
) return 0;
7090 /* Delete the key */
7091 dictDelete(db
->expires
,key
);
7092 server
.stat_expiredkeys
++;
7093 return dictDelete(db
->dict
,key
) == DICT_OK
;
7096 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7099 /* No expire? return ASAP */
7100 if (dictSize(db
->expires
) == 0 ||
7101 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7103 /* Delete the key */
7105 server
.stat_expiredkeys
++;
7106 dictDelete(db
->expires
,key
);
7107 return dictDelete(db
->dict
,key
) == DICT_OK
;
7110 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7114 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7118 de
= dictFind(c
->db
->dict
,key
);
7120 addReply(c
,shared
.czero
);
7124 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7125 addReply(c
, shared
.cone
);
7128 time_t when
= time(NULL
)+seconds
;
7129 if (setExpire(c
->db
,key
,when
)) {
7130 addReply(c
,shared
.cone
);
7133 addReply(c
,shared
.czero
);
7139 static void expireCommand(redisClient
*c
) {
7140 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7143 static void expireatCommand(redisClient
*c
) {
7144 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7147 static void ttlCommand(redisClient
*c
) {
7151 expire
= getExpire(c
->db
,c
->argv
[1]);
7153 ttl
= (int) (expire
-time(NULL
));
7154 if (ttl
< 0) ttl
= -1;
7156 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7159 /* ================================ MULTI/EXEC ============================== */
7161 /* Client state initialization for MULTI/EXEC */
7162 static void initClientMultiState(redisClient
*c
) {
7163 c
->mstate
.commands
= NULL
;
7164 c
->mstate
.count
= 0;
7167 /* Release all the resources associated with MULTI/EXEC state */
7168 static void freeClientMultiState(redisClient
*c
) {
7171 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7173 multiCmd
*mc
= c
->mstate
.commands
+j
;
7175 for (i
= 0; i
< mc
->argc
; i
++)
7176 decrRefCount(mc
->argv
[i
]);
7179 zfree(c
->mstate
.commands
);
7182 /* Add a new command into the MULTI commands queue */
7183 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7187 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7188 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7189 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7192 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7193 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7194 for (j
= 0; j
< c
->argc
; j
++)
7195 incrRefCount(mc
->argv
[j
]);
7199 static void multiCommand(redisClient
*c
) {
7200 c
->flags
|= REDIS_MULTI
;
7201 addReply(c
,shared
.ok
);
7204 static void discardCommand(redisClient
*c
) {
7205 if (!(c
->flags
& REDIS_MULTI
)) {
7206 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7210 freeClientMultiState(c
);
7211 initClientMultiState(c
);
7212 c
->flags
&= (~REDIS_MULTI
);
7213 addReply(c
,shared
.ok
);
7216 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7217 * implememntation for more information. */
7218 static void execCommandReplicateMulti(redisClient
*c
) {
7219 struct redisCommand
*cmd
;
7220 robj
*multistring
= createStringObject("MULTI",5);
7222 cmd
= lookupCommand("multi");
7223 if (server
.appendonly
)
7224 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7225 if (listLength(server
.slaves
))
7226 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7227 decrRefCount(multistring
);
7230 static void execCommand(redisClient
*c
) {
7235 if (!(c
->flags
& REDIS_MULTI
)) {
7236 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7240 /* Replicate a MULTI request now that we are sure the block is executed.
7241 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7242 * both the AOF and the replication link will have the same consistency
7243 * and atomicity guarantees. */
7244 execCommandReplicateMulti(c
);
7246 /* Exec all the queued commands */
7247 orig_argv
= c
->argv
;
7248 orig_argc
= c
->argc
;
7249 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7250 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7251 c
->argc
= c
->mstate
.commands
[j
].argc
;
7252 c
->argv
= c
->mstate
.commands
[j
].argv
;
7253 call(c
,c
->mstate
.commands
[j
].cmd
);
7255 c
->argv
= orig_argv
;
7256 c
->argc
= orig_argc
;
7257 freeClientMultiState(c
);
7258 initClientMultiState(c
);
7259 c
->flags
&= (~REDIS_MULTI
);
7260 /* Make sure the EXEC command is always replicated / AOF, since we
7261 * always send the MULTI command (we can't know beforehand if the
7262 * next operations will contain at least a modification to the DB). */
7266 /* =========================== Blocking Operations ========================= */
7268 /* Currently Redis blocking operations support is limited to list POP ops,
7269 * so the current implementation is not fully generic, but it is also not
7270 * completely specific so it will not require a rewrite to support new
7271 * kind of blocking operations in the future.
7273 * Still it's important to note that list blocking operations can be already
7274 * used as a notification mechanism in order to implement other blocking
7275 * operations at application level, so there must be a very strong evidence
7276 * of usefulness and generality before new blocking operations are implemented.
7278 * This is how the current blocking POP works, we use BLPOP as example:
7279 * - If the user calls BLPOP and the key exists and contains a non empty list
7280 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7281 * if there is not to block.
7282 * - If instead BLPOP is called and the key does not exists or the list is
7283 * empty we need to block. In order to do so we remove the notification for
7284 * new data to read in the client socket (so that we'll not serve new
7285 * requests if the blocking request is not served). Also we put the client
7286 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7287 * blocking for this keys.
7288 * - If a PUSH operation against a key with blocked clients waiting is
7289 * performed, we serve the first in the list: basically instead to push
7290 * the new element inside the list we return it to the (first / oldest)
7291 * blocking client, unblock the client, and remove it form the list.
7293 * The above comment and the source code should be enough in order to understand
7294 * the implementation and modify / fix it later.
7297 /* Set a client in blocking mode for the specified key, with the specified
7299 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7304 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7305 c
->blockingkeysnum
= numkeys
;
7306 c
->blockingto
= timeout
;
7307 for (j
= 0; j
< numkeys
; j
++) {
7308 /* Add the key in the client structure, to map clients -> keys */
7309 c
->blockingkeys
[j
] = keys
[j
];
7310 incrRefCount(keys
[j
]);
7312 /* And in the other "side", to map keys -> clients */
7313 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7317 /* For every key we take a list of clients blocked for it */
7319 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7320 incrRefCount(keys
[j
]);
7321 assert(retval
== DICT_OK
);
7323 l
= dictGetEntryVal(de
);
7325 listAddNodeTail(l
,c
);
7327 /* Mark the client as a blocked client */
7328 c
->flags
|= REDIS_BLOCKED
;
7329 server
.blpop_blocked_clients
++;
7332 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7333 static void unblockClientWaitingData(redisClient
*c
) {
7338 assert(c
->blockingkeys
!= NULL
);
7339 /* The client may wait for multiple keys, so unblock it for every key. */
7340 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7341 /* Remove this client from the list of clients waiting for this key. */
7342 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7344 l
= dictGetEntryVal(de
);
7345 listDelNode(l
,listSearchKey(l
,c
));
7346 /* If the list is empty we need to remove it to avoid wasting memory */
7347 if (listLength(l
) == 0)
7348 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7349 decrRefCount(c
->blockingkeys
[j
]);
7351 /* Cleanup the client structure */
7352 zfree(c
->blockingkeys
);
7353 c
->blockingkeys
= NULL
;
7354 c
->flags
&= (~REDIS_BLOCKED
);
7355 server
.blpop_blocked_clients
--;
7356 /* We want to process data if there is some command waiting
7357 * in the input buffer. Note that this is safe even if
7358 * unblockClientWaitingData() gets called from freeClient() because
7359 * freeClient() will be smart enough to call this function
7360 * *after* c->querybuf was set to NULL. */
7361 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7364 /* This should be called from any function PUSHing into lists.
7365 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7366 * 'ele' is the element pushed.
7368 * If the function returns 0 there was no client waiting for a list push
7371 * If the function returns 1 there was a client waiting for a list push
7372 * against this key, the element was passed to this client thus it's not
7373 * needed to actually add it to the list and the caller should return asap. */
7374 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7375 struct dictEntry
*de
;
7376 redisClient
*receiver
;
7380 de
= dictFind(c
->db
->blockingkeys
,key
);
7381 if (de
== NULL
) return 0;
7382 l
= dictGetEntryVal(de
);
7385 receiver
= ln
->value
;
7387 addReplySds(receiver
,sdsnew("*2\r\n"));
7388 addReplyBulk(receiver
,key
);
7389 addReplyBulk(receiver
,ele
);
7390 unblockClientWaitingData(receiver
);
7394 /* Blocking RPOP/LPOP */
7395 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7400 for (j
= 1; j
< c
->argc
-1; j
++) {
7401 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7403 if (o
->type
!= REDIS_LIST
) {
7404 addReply(c
,shared
.wrongtypeerr
);
7407 list
*list
= o
->ptr
;
7408 if (listLength(list
) != 0) {
7409 /* If the list contains elements fall back to the usual
7410 * non-blocking POP operation */
7411 robj
*argv
[2], **orig_argv
;
7414 /* We need to alter the command arguments before to call
7415 * popGenericCommand() as the command takes a single key. */
7416 orig_argv
= c
->argv
;
7417 orig_argc
= c
->argc
;
7418 argv
[1] = c
->argv
[j
];
7422 /* Also the return value is different, we need to output
7423 * the multi bulk reply header and the key name. The
7424 * "real" command will add the last element (the value)
7425 * for us. If this souds like an hack to you it's just
7426 * because it is... */
7427 addReplySds(c
,sdsnew("*2\r\n"));
7428 addReplyBulk(c
,argv
[1]);
7429 popGenericCommand(c
,where
);
7431 /* Fix the client structure with the original stuff */
7432 c
->argv
= orig_argv
;
7433 c
->argc
= orig_argc
;
7439 /* If the list is empty or the key does not exists we must block */
7440 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7441 if (timeout
> 0) timeout
+= time(NULL
);
7442 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7445 static void blpopCommand(redisClient
*c
) {
7446 blockingPopGenericCommand(c
,REDIS_HEAD
);
7449 static void brpopCommand(redisClient
*c
) {
7450 blockingPopGenericCommand(c
,REDIS_TAIL
);
7453 /* =============================== Replication ============================= */
7455 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7456 ssize_t nwritten
, ret
= size
;
7457 time_t start
= time(NULL
);
7461 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7462 nwritten
= write(fd
,ptr
,size
);
7463 if (nwritten
== -1) return -1;
7467 if ((time(NULL
)-start
) > timeout
) {
7475 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7476 ssize_t nread
, totread
= 0;
7477 time_t start
= time(NULL
);
7481 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7482 nread
= read(fd
,ptr
,size
);
7483 if (nread
== -1) return -1;
7488 if ((time(NULL
)-start
) > timeout
) {
7496 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7503 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7506 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7517 static void syncCommand(redisClient
*c
) {
7518 /* ignore SYNC if aleady slave or in monitor mode */
7519 if (c
->flags
& REDIS_SLAVE
) return;
7521 /* SYNC can't be issued when the server has pending data to send to
7522 * the client about already issued commands. We need a fresh reply
7523 * buffer registering the differences between the BGSAVE and the current
7524 * dataset, so that we can copy to other slaves if needed. */
7525 if (listLength(c
->reply
) != 0) {
7526 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7530 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7531 /* Here we need to check if there is a background saving operation
7532 * in progress, or if it is required to start one */
7533 if (server
.bgsavechildpid
!= -1) {
7534 /* Ok a background save is in progress. Let's check if it is a good
7535 * one for replication, i.e. if there is another slave that is
7536 * registering differences since the server forked to save */
7541 listRewind(server
.slaves
,&li
);
7542 while((ln
= listNext(&li
))) {
7544 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7547 /* Perfect, the server is already registering differences for
7548 * another slave. Set the right state, and copy the buffer. */
7549 listRelease(c
->reply
);
7550 c
->reply
= listDup(slave
->reply
);
7551 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7552 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7554 /* No way, we need to wait for the next BGSAVE in order to
7555 * register differences */
7556 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7557 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7560 /* Ok we don't have a BGSAVE in progress, let's start one */
7561 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7562 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7563 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7564 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7567 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7570 c
->flags
|= REDIS_SLAVE
;
7572 listAddNodeTail(server
.slaves
,c
);
7576 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7577 redisClient
*slave
= privdata
;
7579 REDIS_NOTUSED(mask
);
7580 char buf
[REDIS_IOBUF_LEN
];
7581 ssize_t nwritten
, buflen
;
7583 if (slave
->repldboff
== 0) {
7584 /* Write the bulk write count before to transfer the DB. In theory here
7585 * we don't know how much room there is in the output buffer of the
7586 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7587 * operations) will never be smaller than the few bytes we need. */
7590 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7592 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7600 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7601 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7603 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7604 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7608 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7609 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7614 slave
->repldboff
+= nwritten
;
7615 if (slave
->repldboff
== slave
->repldbsize
) {
7616 close(slave
->repldbfd
);
7617 slave
->repldbfd
= -1;
7618 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7619 slave
->replstate
= REDIS_REPL_ONLINE
;
7620 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7621 sendReplyToClient
, slave
) == AE_ERR
) {
7625 addReplySds(slave
,sdsempty());
7626 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7630 /* This function is called at the end of every backgrond saving.
7631 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7632 * otherwise REDIS_ERR is passed to the function.
7634 * The goal of this function is to handle slaves waiting for a successful
7635 * background saving in order to perform non-blocking synchronization. */
7636 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7638 int startbgsave
= 0;
7641 listRewind(server
.slaves
,&li
);
7642 while((ln
= listNext(&li
))) {
7643 redisClient
*slave
= ln
->value
;
7645 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7647 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7648 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7649 struct redis_stat buf
;
7651 if (bgsaveerr
!= REDIS_OK
) {
7653 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7656 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7657 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7659 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7662 slave
->repldboff
= 0;
7663 slave
->repldbsize
= buf
.st_size
;
7664 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7665 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7666 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7673 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7676 listRewind(server
.slaves
,&li
);
7677 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7678 while((ln
= listNext(&li
))) {
7679 redisClient
*slave
= ln
->value
;
7681 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7688 static int syncWithMaster(void) {
7689 char buf
[1024], tmpfile
[256], authcmd
[1024];
7691 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7692 int dfd
, maxtries
= 5;
7695 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7700 /* AUTH with the master if required. */
7701 if(server
.masterauth
) {
7702 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7703 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7705 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7709 /* Read the AUTH result. */
7710 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7712 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7716 if (buf
[0] != '+') {
7718 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7723 /* Issue the SYNC command */
7724 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7726 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7730 /* Read the bulk write count */
7731 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7733 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7737 if (buf
[0] != '$') {
7739 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7742 dumpsize
= strtol(buf
+1,NULL
,10);
7743 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7744 /* Read the bulk write data on a temp file */
7746 snprintf(tmpfile
,256,
7747 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7748 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7749 if (dfd
!= -1) break;
7754 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7758 int nread
, nwritten
;
7760 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7762 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7768 nwritten
= write(dfd
,buf
,nread
);
7769 if (nwritten
== -1) {
7770 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7778 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7779 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7785 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7786 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7790 server
.master
= createClient(fd
);
7791 server
.master
->flags
|= REDIS_MASTER
;
7792 server
.master
->authenticated
= 1;
7793 server
.replstate
= REDIS_REPL_CONNECTED
;
7797 static void slaveofCommand(redisClient
*c
) {
7798 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7799 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7800 if (server
.masterhost
) {
7801 sdsfree(server
.masterhost
);
7802 server
.masterhost
= NULL
;
7803 if (server
.master
) freeClient(server
.master
);
7804 server
.replstate
= REDIS_REPL_NONE
;
7805 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7808 sdsfree(server
.masterhost
);
7809 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7810 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7811 if (server
.master
) freeClient(server
.master
);
7812 server
.replstate
= REDIS_REPL_CONNECT
;
7813 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7814 server
.masterhost
, server
.masterport
);
7816 addReply(c
,shared
.ok
);
7819 /* ============================ Maxmemory directive ======================== */
7821 /* Try to free one object form the pre-allocated objects free list.
7822 * This is useful under low mem conditions as by default we take 1 million
7823 * free objects allocated. On success REDIS_OK is returned, otherwise
7825 static int tryFreeOneObjectFromFreelist(void) {
7828 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7829 if (listLength(server
.objfreelist
)) {
7830 listNode
*head
= listFirst(server
.objfreelist
);
7831 o
= listNodeValue(head
);
7832 listDelNode(server
.objfreelist
,head
);
7833 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7837 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7842 /* This function gets called when 'maxmemory' is set on the config file to limit
7843 * the max memory used by the server, and we are out of memory.
7844 * This function will try to, in order:
7846 * - Free objects from the free list
7847 * - Try to remove keys with an EXPIRE set
7849 * It is not possible to free enough memory to reach used-memory < maxmemory
7850 * the server will start refusing commands that will enlarge even more the
7853 static void freeMemoryIfNeeded(void) {
7854 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7855 int j
, k
, freed
= 0;
7857 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7858 for (j
= 0; j
< server
.dbnum
; j
++) {
7860 robj
*minkey
= NULL
;
7861 struct dictEntry
*de
;
7863 if (dictSize(server
.db
[j
].expires
)) {
7865 /* From a sample of three keys drop the one nearest to
7866 * the natural expire */
7867 for (k
= 0; k
< 3; k
++) {
7870 de
= dictGetRandomKey(server
.db
[j
].expires
);
7871 t
= (time_t) dictGetEntryVal(de
);
7872 if (minttl
== -1 || t
< minttl
) {
7873 minkey
= dictGetEntryKey(de
);
7877 deleteKey(server
.db
+j
,minkey
);
7880 if (!freed
) return; /* nothing to free... */
7884 /* ============================== Append Only file ========================== */
7886 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7887 sds buf
= sdsempty();
7893 /* The DB this command was targetting is not the same as the last command
7894 * we appendend. To issue a SELECT command is needed. */
7895 if (dictid
!= server
.appendseldb
) {
7898 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7899 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7900 (unsigned long)strlen(seldb
),seldb
);
7901 server
.appendseldb
= dictid
;
7904 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7905 * EXPIREs into EXPIREATs calls */
7906 if (cmd
->proc
== expireCommand
) {
7909 tmpargv
[0] = createStringObject("EXPIREAT",8);
7910 tmpargv
[1] = argv
[1];
7911 incrRefCount(argv
[1]);
7912 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7913 tmpargv
[2] = createObject(REDIS_STRING
,
7914 sdscatprintf(sdsempty(),"%ld",when
));
7918 /* Append the actual command */
7919 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7920 for (j
= 0; j
< argc
; j
++) {
7923 o
= getDecodedObject(o
);
7924 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7925 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7926 buf
= sdscatlen(buf
,"\r\n",2);
7930 /* Free the objects from the modified argv for EXPIREAT */
7931 if (cmd
->proc
== expireCommand
) {
7932 for (j
= 0; j
< 3; j
++)
7933 decrRefCount(argv
[j
]);
7936 /* We want to perform a single write. This should be guaranteed atomic
7937 * at least if the filesystem we are writing is a real physical one.
7938 * While this will save us against the server being killed I don't think
7939 * there is much to do about the whole server stopping for power problems
7941 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7942 if (nwritten
!= (signed)sdslen(buf
)) {
7943 /* Ooops, we are in troubles. The best thing to do for now is
7944 * to simply exit instead to give the illusion that everything is
7945 * working as expected. */
7946 if (nwritten
== -1) {
7947 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7949 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7953 /* If a background append only file rewriting is in progress we want to
7954 * accumulate the differences between the child DB and the current one
7955 * in a buffer, so that when the child process will do its work we
7956 * can append the differences to the new append only file. */
7957 if (server
.bgrewritechildpid
!= -1)
7958 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7962 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7963 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7964 now
-server
.lastfsync
> 1))
7966 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7967 server
.lastfsync
= now
;
7971 /* In Redis commands are always executed in the context of a client, so in
7972 * order to load the append only file we need to create a fake client. */
7973 static struct redisClient
*createFakeClient(void) {
7974 struct redisClient
*c
= zmalloc(sizeof(*c
));
7978 c
->querybuf
= sdsempty();
7982 /* We set the fake client as a slave waiting for the synchronization
7983 * so that Redis will not try to send replies to this client. */
7984 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7985 c
->reply
= listCreate();
7986 listSetFreeMethod(c
->reply
,decrRefCount
);
7987 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7991 static void freeFakeClient(struct redisClient
*c
) {
7992 sdsfree(c
->querybuf
);
7993 listRelease(c
->reply
);
7997 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7998 * error (the append only file is zero-length) REDIS_ERR is returned. On
7999 * fatal error an error message is logged and the program exists. */
8000 int loadAppendOnlyFile(char *filename
) {
8001 struct redisClient
*fakeClient
;
8002 FILE *fp
= fopen(filename
,"r");
8003 struct redis_stat sb
;
8004 unsigned long long loadedkeys
= 0;
8006 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8010 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8014 fakeClient
= createFakeClient();
8021 struct redisCommand
*cmd
;
8023 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8029 if (buf
[0] != '*') goto fmterr
;
8031 argv
= zmalloc(sizeof(robj
*)*argc
);
8032 for (j
= 0; j
< argc
; j
++) {
8033 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8034 if (buf
[0] != '$') goto fmterr
;
8035 len
= strtol(buf
+1,NULL
,10);
8036 argsds
= sdsnewlen(NULL
,len
);
8037 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8038 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8039 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8042 /* Command lookup */
8043 cmd
= lookupCommand(argv
[0]->ptr
);
8045 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8048 /* Try object encoding */
8049 if (cmd
->flags
& REDIS_CMD_BULK
)
8050 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8051 /* Run the command in the context of a fake client */
8052 fakeClient
->argc
= argc
;
8053 fakeClient
->argv
= argv
;
8054 cmd
->proc(fakeClient
);
8055 /* Discard the reply objects list from the fake client */
8056 while(listLength(fakeClient
->reply
))
8057 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8058 /* Clean up, ready for the next command */
8059 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8061 /* Handle swapping while loading big datasets when VM is on */
8063 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8064 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8065 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8070 freeFakeClient(fakeClient
);
8075 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8077 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8081 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8085 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8086 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8090 /* Avoid the incr/decr ref count business if possible to help
8091 * copy-on-write (we are often in a child process when this function
8093 * Also makes sure that key objects don't get incrRefCount-ed when VM
8095 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8096 obj
= getDecodedObject(obj
);
8099 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8100 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8101 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8103 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8104 if (decrrc
) decrRefCount(obj
);
8107 if (decrrc
) decrRefCount(obj
);
8111 /* Write binary-safe string into a file in the bulkformat
8112 * $<count>\r\n<payload>\r\n */
8113 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8116 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8117 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8118 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8119 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8123 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8124 static int fwriteBulkDouble(FILE *fp
, double d
) {
8125 char buf
[128], dbuf
[128];
8127 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8128 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8129 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8130 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8134 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8135 static int fwriteBulkLong(FILE *fp
, long l
) {
8136 char buf
[128], lbuf
[128];
8138 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8139 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8140 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8141 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8145 /* Write a sequence of commands able to fully rebuild the dataset into
8146 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8147 static int rewriteAppendOnlyFile(char *filename
) {
8148 dictIterator
*di
= NULL
;
8153 time_t now
= time(NULL
);
8155 /* Note that we have to use a different temp name here compared to the
8156 * one used by rewriteAppendOnlyFileBackground() function. */
8157 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8158 fp
= fopen(tmpfile
,"w");
8160 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8163 for (j
= 0; j
< server
.dbnum
; j
++) {
8164 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8165 redisDb
*db
= server
.db
+j
;
8167 if (dictSize(d
) == 0) continue;
8168 di
= dictGetIterator(d
);
8174 /* SELECT the new DB */
8175 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8176 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8178 /* Iterate this DB writing every entry */
8179 while((de
= dictNext(di
)) != NULL
) {
8184 key
= dictGetEntryKey(de
);
8185 /* If the value for this key is swapped, load a preview in memory.
8186 * We use a "swapped" flag to remember if we need to free the
8187 * value object instead to just increment the ref count anyway
8188 * in order to avoid copy-on-write of pages if we are forked() */
8189 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8190 key
->storage
== REDIS_VM_SWAPPING
) {
8191 o
= dictGetEntryVal(de
);
8194 o
= vmPreviewObject(key
);
8197 expiretime
= getExpire(db
,key
);
8199 /* Save the key and associated value */
8200 if (o
->type
== REDIS_STRING
) {
8201 /* Emit a SET command */
8202 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8203 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8205 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8206 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8207 } else if (o
->type
== REDIS_LIST
) {
8208 /* Emit the RPUSHes needed to rebuild the list */
8209 list
*list
= o
->ptr
;
8213 listRewind(list
,&li
);
8214 while((ln
= listNext(&li
))) {
8215 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8216 robj
*eleobj
= listNodeValue(ln
);
8218 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8219 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8220 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8222 } else if (o
->type
== REDIS_SET
) {
8223 /* Emit the SADDs needed to rebuild the set */
8225 dictIterator
*di
= dictGetIterator(set
);
8228 while((de
= dictNext(di
)) != NULL
) {
8229 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8230 robj
*eleobj
= dictGetEntryKey(de
);
8232 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8233 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8234 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8236 dictReleaseIterator(di
);
8237 } else if (o
->type
== REDIS_ZSET
) {
8238 /* Emit the ZADDs needed to rebuild the sorted set */
8240 dictIterator
*di
= dictGetIterator(zs
->dict
);
8243 while((de
= dictNext(di
)) != NULL
) {
8244 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8245 robj
*eleobj
= dictGetEntryKey(de
);
8246 double *score
= dictGetEntryVal(de
);
8248 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8249 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8250 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8251 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8253 dictReleaseIterator(di
);
8254 } else if (o
->type
== REDIS_HASH
) {
8255 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8257 /* Emit the HSETs needed to rebuild the hash */
8258 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8259 unsigned char *p
= zipmapRewind(o
->ptr
);
8260 unsigned char *field
, *val
;
8261 unsigned int flen
, vlen
;
8263 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8264 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8265 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8266 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8268 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8272 dictIterator
*di
= dictGetIterator(o
->ptr
);
8275 while((de
= dictNext(di
)) != NULL
) {
8276 robj
*field
= dictGetEntryKey(de
);
8277 robj
*val
= dictGetEntryVal(de
);
8279 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8280 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8281 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8282 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8284 dictReleaseIterator(di
);
8287 redisPanic("Unknown object type");
8289 /* Save the expire time */
8290 if (expiretime
!= -1) {
8291 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8292 /* If this key is already expired skip it */
8293 if (expiretime
< now
) continue;
8294 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8295 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8296 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8298 if (swapped
) decrRefCount(o
);
8300 dictReleaseIterator(di
);
8303 /* Make sure data will not remain on the OS's output buffers */
8308 /* Use RENAME to make sure the DB file is changed atomically only
8309 * if the generate DB file is ok. */
8310 if (rename(tmpfile
,filename
) == -1) {
8311 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8315 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8321 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8322 if (di
) dictReleaseIterator(di
);
8326 /* This is how rewriting of the append only file in background works:
8328 * 1) The user calls BGREWRITEAOF
8329 * 2) Redis calls this function, that forks():
8330 * 2a) the child rewrite the append only file in a temp file.
8331 * 2b) the parent accumulates differences in server.bgrewritebuf.
8332 * 3) When the child finished '2a' exists.
8333 * 4) The parent will trap the exit code, if it's OK, will append the
8334 * data accumulated into server.bgrewritebuf into the temp file, and
8335 * finally will rename(2) the temp file in the actual file name.
8336 * The the new file is reopened as the new append only file. Profit!
8338 static int rewriteAppendOnlyFileBackground(void) {
8341 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8342 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8343 if ((childpid
= fork()) == 0) {
8347 if (server
.vm_enabled
) vmReopenSwapFile();
8349 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8350 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8357 if (childpid
== -1) {
8358 redisLog(REDIS_WARNING
,
8359 "Can't rewrite append only file in background: fork: %s",
8363 redisLog(REDIS_NOTICE
,
8364 "Background append only file rewriting started by pid %d",childpid
);
8365 server
.bgrewritechildpid
= childpid
;
8366 updateDictResizePolicy();
8367 /* We set appendseldb to -1 in order to force the next call to the
8368 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8369 * accumulated by the parent into server.bgrewritebuf will start
8370 * with a SELECT statement and it will be safe to merge. */
8371 server
.appendseldb
= -1;
8374 return REDIS_OK
; /* unreached */
8377 static void bgrewriteaofCommand(redisClient
*c
) {
8378 if (server
.bgrewritechildpid
!= -1) {
8379 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8382 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8383 char *status
= "+Background append only file rewriting started\r\n";
8384 addReplySds(c
,sdsnew(status
));
8386 addReply(c
,shared
.err
);
8390 static void aofRemoveTempFile(pid_t childpid
) {
8393 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8397 /* Virtual Memory is composed mainly of two subsystems:
8398 * - Blocking Virutal Memory
8399 * - Threaded Virtual Memory I/O
8400 * The two parts are not fully decoupled, but functions are split among two
8401 * different sections of the source code (delimited by comments) in order to
8402 * make more clear what functionality is about the blocking VM and what about
8403 * the threaded (not blocking) VM.
8407 * Redis VM is a blocking VM (one that blocks reading swapped values from
8408 * disk into memory when a value swapped out is needed in memory) that is made
8409 * unblocking by trying to examine the command argument vector in order to
8410 * load in background values that will likely be needed in order to exec
8411 * the command. The command is executed only once all the relevant keys
8412 * are loaded into memory.
8414 * This basically is almost as simple of a blocking VM, but almost as parallel
8415 * as a fully non-blocking VM.
8418 /* =================== Virtual Memory - Blocking Side ====================== */
8420 /* substitute the first occurrence of '%p' with the process pid in the
8421 * swap file name. */
8422 static void expandVmSwapFilename(void) {
8423 char *p
= strstr(server
.vm_swap_file
,"%p");
8429 new = sdscat(new,server
.vm_swap_file
);
8430 new = sdscatprintf(new,"%ld",(long) getpid());
8431 new = sdscat(new,p
+2);
8432 zfree(server
.vm_swap_file
);
8433 server
.vm_swap_file
= new;
8436 static void vmInit(void) {
8441 if (server
.vm_max_threads
!= 0)
8442 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8444 expandVmSwapFilename();
8445 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8446 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8447 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8449 if (server
.vm_fp
== NULL
) {
8450 redisLog(REDIS_WARNING
,
8451 "Impossible to open the swap file: %s. Exiting.",
8455 server
.vm_fd
= fileno(server
.vm_fp
);
8456 server
.vm_next_page
= 0;
8457 server
.vm_near_pages
= 0;
8458 server
.vm_stats_used_pages
= 0;
8459 server
.vm_stats_swapped_objects
= 0;
8460 server
.vm_stats_swapouts
= 0;
8461 server
.vm_stats_swapins
= 0;
8462 totsize
= server
.vm_pages
*server
.vm_page_size
;
8463 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8464 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8465 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8469 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8471 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8472 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8473 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8474 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8476 /* Initialize threaded I/O (used by Virtual Memory) */
8477 server
.io_newjobs
= listCreate();
8478 server
.io_processing
= listCreate();
8479 server
.io_processed
= listCreate();
8480 server
.io_ready_clients
= listCreate();
8481 pthread_mutex_init(&server
.io_mutex
,NULL
);
8482 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8483 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8484 server
.io_active_threads
= 0;
8485 if (pipe(pipefds
) == -1) {
8486 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8490 server
.io_ready_pipe_read
= pipefds
[0];
8491 server
.io_ready_pipe_write
= pipefds
[1];
8492 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8493 /* LZF requires a lot of stack */
8494 pthread_attr_init(&server
.io_threads_attr
);
8495 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8496 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8497 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8498 /* Listen for events in the threaded I/O pipe */
8499 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8500 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8501 oom("creating file event");
8504 /* Mark the page as used */
8505 static void vmMarkPageUsed(off_t page
) {
8506 off_t byte
= page
/8;
8508 redisAssert(vmFreePage(page
) == 1);
8509 server
.vm_bitmap
[byte
] |= 1<<bit
;
8512 /* Mark N contiguous pages as used, with 'page' being the first. */
8513 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8516 for (j
= 0; j
< count
; j
++)
8517 vmMarkPageUsed(page
+j
);
8518 server
.vm_stats_used_pages
+= count
;
8519 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8520 (long long)count
, (long long)page
);
8523 /* Mark the page as free */
8524 static void vmMarkPageFree(off_t page
) {
8525 off_t byte
= page
/8;
8527 redisAssert(vmFreePage(page
) == 0);
8528 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8531 /* Mark N contiguous pages as free, with 'page' being the first. */
8532 static void vmMarkPagesFree(off_t page
, off_t count
) {
8535 for (j
= 0; j
< count
; j
++)
8536 vmMarkPageFree(page
+j
);
8537 server
.vm_stats_used_pages
-= count
;
8538 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8539 (long long)count
, (long long)page
);
8542 /* Test if the page is free */
8543 static int vmFreePage(off_t page
) {
8544 off_t byte
= page
/8;
8546 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8549 /* Find N contiguous free pages storing the first page of the cluster in *first.
8550 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8551 * REDIS_ERR is returned.
8553 * This function uses a simple algorithm: we try to allocate
8554 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8555 * again from the start of the swap file searching for free spaces.
8557 * If it looks pretty clear that there are no free pages near our offset
8558 * we try to find less populated places doing a forward jump of
8559 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8560 * without hurry, and then we jump again and so forth...
8562 * This function can be improved using a free list to avoid to guess
8563 * too much, since we could collect data about freed pages.
8565 * note: I implemented this function just after watching an episode of
8566 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8568 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8569 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8571 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8572 server
.vm_near_pages
= 0;
8573 server
.vm_next_page
= 0;
8575 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8576 base
= server
.vm_next_page
;
8578 while(offset
< server
.vm_pages
) {
8579 off_t
this = base
+offset
;
8581 /* If we overflow, restart from page zero */
8582 if (this >= server
.vm_pages
) {
8583 this -= server
.vm_pages
;
8585 /* Just overflowed, what we found on tail is no longer
8586 * interesting, as it's no longer contiguous. */
8590 if (vmFreePage(this)) {
8591 /* This is a free page */
8593 /* Already got N free pages? Return to the caller, with success */
8595 *first
= this-(n
-1);
8596 server
.vm_next_page
= this+1;
8597 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8601 /* The current one is not a free page */
8605 /* Fast-forward if the current page is not free and we already
8606 * searched enough near this place. */
8608 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8609 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8611 /* Note that even if we rewind after the jump, we are don't need
8612 * to make sure numfree is set to zero as we only jump *if* it
8613 * is set to zero. */
8615 /* Otherwise just check the next page */
8622 /* Write the specified object at the specified page of the swap file */
8623 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8624 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8625 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8626 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8627 redisLog(REDIS_WARNING
,
8628 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8632 rdbSaveObject(server
.vm_fp
,o
);
8633 fflush(server
.vm_fp
);
8634 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8638 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8639 * needed to later retrieve the object into the key object.
8640 * If we can't find enough contiguous empty pages to swap the object on disk
8641 * REDIS_ERR is returned. */
8642 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8643 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8646 assert(key
->storage
== REDIS_VM_MEMORY
);
8647 assert(key
->refcount
== 1);
8648 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8649 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8650 key
->vm
.page
= page
;
8651 key
->vm
.usedpages
= pages
;
8652 key
->storage
= REDIS_VM_SWAPPED
;
8653 key
->vtype
= val
->type
;
8654 decrRefCount(val
); /* Deallocate the object from memory. */
8655 vmMarkPagesUsed(page
,pages
);
8656 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8657 (unsigned char*) key
->ptr
,
8658 (unsigned long long) page
, (unsigned long long) pages
);
8659 server
.vm_stats_swapped_objects
++;
8660 server
.vm_stats_swapouts
++;
8664 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8667 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8668 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8669 redisLog(REDIS_WARNING
,
8670 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8674 o
= rdbLoadObject(type
,server
.vm_fp
);
8676 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8679 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8683 /* Load the value object relative to the 'key' object from swap to memory.
8684 * The newly allocated object is returned.
8686 * If preview is true the unserialized object is returned to the caller but
8687 * no changes are made to the key object, nor the pages are marked as freed */
8688 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8691 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8692 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8694 key
->storage
= REDIS_VM_MEMORY
;
8695 key
->vm
.atime
= server
.unixtime
;
8696 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8697 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8698 (unsigned char*) key
->ptr
);
8699 server
.vm_stats_swapped_objects
--;
8701 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8702 (unsigned char*) key
->ptr
);
8704 server
.vm_stats_swapins
++;
8708 /* Plain object loading, from swap to memory */
8709 static robj
*vmLoadObject(robj
*key
) {
8710 /* If we are loading the object in background, stop it, we
8711 * need to load this object synchronously ASAP. */
8712 if (key
->storage
== REDIS_VM_LOADING
)
8713 vmCancelThreadedIOJob(key
);
8714 return vmGenericLoadObject(key
,0);
8717 /* Just load the value on disk, without to modify the key.
8718 * This is useful when we want to perform some operation on the value
8719 * without to really bring it from swap to memory, like while saving the
8720 * dataset or rewriting the append only log. */
8721 static robj
*vmPreviewObject(robj
*key
) {
8722 return vmGenericLoadObject(key
,1);
8725 /* How a good candidate is this object for swapping?
8726 * The better candidate it is, the greater the returned value.
8728 * Currently we try to perform a fast estimation of the object size in
8729 * memory, and combine it with aging informations.
8731 * Basically swappability = idle-time * log(estimated size)
8733 * Bigger objects are preferred over smaller objects, but not
8734 * proportionally, this is why we use the logarithm. This algorithm is
8735 * just a first try and will probably be tuned later. */
8736 static double computeObjectSwappability(robj
*o
) {
8737 time_t age
= server
.unixtime
- o
->vm
.atime
;
8741 struct dictEntry
*de
;
8744 if (age
<= 0) return 0;
8747 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8750 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8755 listNode
*ln
= listFirst(l
);
8757 asize
= sizeof(list
);
8759 robj
*ele
= ln
->value
;
8762 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8763 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8765 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8770 z
= (o
->type
== REDIS_ZSET
);
8771 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8773 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8774 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8779 de
= dictGetRandomKey(d
);
8780 ele
= dictGetEntryKey(de
);
8781 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8782 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8784 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8785 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8789 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8790 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8791 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8792 unsigned int klen
, vlen
;
8793 unsigned char *key
, *val
;
8795 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8799 asize
= len
*(klen
+vlen
+3);
8800 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8802 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8807 de
= dictGetRandomKey(d
);
8808 ele
= dictGetEntryKey(de
);
8809 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8810 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8812 ele
= dictGetEntryVal(de
);
8813 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8814 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8816 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8821 return (double)age
*log(1+asize
);
8824 /* Try to swap an object that's a good candidate for swapping.
8825 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8826 * to swap any object at all.
8828 * If 'usethreaded' is true, Redis will try to swap the object in background
8829 * using I/O threads. */
8830 static int vmSwapOneObject(int usethreads
) {
8832 struct dictEntry
*best
= NULL
;
8833 double best_swappability
= 0;
8834 redisDb
*best_db
= NULL
;
8837 for (j
= 0; j
< server
.dbnum
; j
++) {
8838 redisDb
*db
= server
.db
+j
;
8839 /* Why maxtries is set to 100?
8840 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8841 * are swappable objects */
8844 if (dictSize(db
->dict
) == 0) continue;
8845 for (i
= 0; i
< 5; i
++) {
8847 double swappability
;
8849 if (maxtries
) maxtries
--;
8850 de
= dictGetRandomKey(db
->dict
);
8851 key
= dictGetEntryKey(de
);
8852 val
= dictGetEntryVal(de
);
8853 /* Only swap objects that are currently in memory.
8855 * Also don't swap shared objects if threaded VM is on, as we
8856 * try to ensure that the main thread does not touch the
8857 * object while the I/O thread is using it, but we can't
8858 * control other keys without adding additional mutex. */
8859 if (key
->storage
!= REDIS_VM_MEMORY
||
8860 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8861 if (maxtries
) i
--; /* don't count this try */
8864 swappability
= computeObjectSwappability(val
);
8865 if (!best
|| swappability
> best_swappability
) {
8867 best_swappability
= swappability
;
8872 if (best
== NULL
) return REDIS_ERR
;
8873 key
= dictGetEntryKey(best
);
8874 val
= dictGetEntryVal(best
);
8876 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8877 key
->ptr
, best_swappability
);
8879 /* Unshare the key if needed */
8880 if (key
->refcount
> 1) {
8881 robj
*newkey
= dupStringObject(key
);
8883 key
= dictGetEntryKey(best
) = newkey
;
8887 vmSwapObjectThreaded(key
,val
,best_db
);
8890 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8891 dictGetEntryVal(best
) = NULL
;
8899 static int vmSwapOneObjectBlocking() {
8900 return vmSwapOneObject(0);
8903 static int vmSwapOneObjectThreaded() {
8904 return vmSwapOneObject(1);
8907 /* Return true if it's safe to swap out objects in a given moment.
8908 * Basically we don't want to swap objects out while there is a BGSAVE
8909 * or a BGAEOREWRITE running in backgroud. */
8910 static int vmCanSwapOut(void) {
8911 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8914 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8915 * and was deleted. Otherwise 0 is returned. */
8916 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8920 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8921 foundkey
= dictGetEntryKey(de
);
8922 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8927 /* =================== Virtual Memory - Threaded I/O ======================= */
8929 static void freeIOJob(iojob
*j
) {
8930 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8931 j
->type
== REDIS_IOJOB_DO_SWAP
||
8932 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8933 decrRefCount(j
->val
);
8934 /* We don't decrRefCount the j->key field as we did't incremented
8935 * the count creating IO Jobs. This is because the key field here is
8936 * just used as an indentifier and if a key is removed the Job should
8937 * never be touched again. */
8941 /* Every time a thread finished a Job, it writes a byte into the write side
8942 * of an unix pipe in order to "awake" the main thread, and this function
8944 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8948 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8950 REDIS_NOTUSED(mask
);
8951 REDIS_NOTUSED(privdata
);
8953 /* For every byte we read in the read side of the pipe, there is one
8954 * I/O job completed to process. */
8955 while((retval
= read(fd
,buf
,1)) == 1) {
8959 struct dictEntry
*de
;
8961 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8963 /* Get the processed element (the oldest one) */
8965 assert(listLength(server
.io_processed
) != 0);
8966 if (toprocess
== -1) {
8967 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8968 if (toprocess
<= 0) toprocess
= 1;
8970 ln
= listFirst(server
.io_processed
);
8972 listDelNode(server
.io_processed
,ln
);
8974 /* If this job is marked as canceled, just ignore it */
8979 /* Post process it in the main thread, as there are things we
8980 * can do just here to avoid race conditions and/or invasive locks */
8981 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
);
8982 de
= dictFind(j
->db
->dict
,j
->key
);
8984 key
= dictGetEntryKey(de
);
8985 if (j
->type
== REDIS_IOJOB_LOAD
) {
8988 /* Key loaded, bring it at home */
8989 key
->storage
= REDIS_VM_MEMORY
;
8990 key
->vm
.atime
= server
.unixtime
;
8991 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8992 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8993 (unsigned char*) key
->ptr
);
8994 server
.vm_stats_swapped_objects
--;
8995 server
.vm_stats_swapins
++;
8996 dictGetEntryVal(de
) = j
->val
;
8997 incrRefCount(j
->val
);
9000 /* Handle clients waiting for this key to be loaded. */
9001 handleClientsBlockedOnSwappedKey(db
,key
);
9002 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9003 /* Now we know the amount of pages required to swap this object.
9004 * Let's find some space for it, and queue this task again
9005 * rebranded as REDIS_IOJOB_DO_SWAP. */
9006 if (!vmCanSwapOut() ||
9007 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9009 /* Ooops... no space or we can't swap as there is
9010 * a fork()ed Redis trying to save stuff on disk. */
9012 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9014 /* Note that we need to mark this pages as used now,
9015 * if the job will be canceled, we'll mark them as freed
9017 vmMarkPagesUsed(j
->page
,j
->pages
);
9018 j
->type
= REDIS_IOJOB_DO_SWAP
;
9023 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9026 /* Key swapped. We can finally free some memory. */
9027 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9028 printf("key->storage: %d\n",key
->storage
);
9029 printf("key->name: %s\n",(char*)key
->ptr
);
9030 printf("key->refcount: %d\n",key
->refcount
);
9031 printf("val: %p\n",(void*)j
->val
);
9032 printf("val->type: %d\n",j
->val
->type
);
9033 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9035 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9036 val
= dictGetEntryVal(de
);
9037 key
->vm
.page
= j
->page
;
9038 key
->vm
.usedpages
= j
->pages
;
9039 key
->storage
= REDIS_VM_SWAPPED
;
9040 key
->vtype
= j
->val
->type
;
9041 decrRefCount(val
); /* Deallocate the object from memory. */
9042 dictGetEntryVal(de
) = NULL
;
9043 redisLog(REDIS_DEBUG
,
9044 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9045 (unsigned char*) key
->ptr
,
9046 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9047 server
.vm_stats_swapped_objects
++;
9048 server
.vm_stats_swapouts
++;
9050 /* Put a few more swap requests in queue if we are still
9052 if (trytoswap
&& vmCanSwapOut() &&
9053 zmalloc_used_memory() > server
.vm_max_memory
)
9058 more
= listLength(server
.io_newjobs
) <
9059 (unsigned) server
.vm_max_threads
;
9061 /* Don't waste CPU time if swappable objects are rare. */
9062 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9070 if (processed
== toprocess
) return;
9072 if (retval
< 0 && errno
!= EAGAIN
) {
9073 redisLog(REDIS_WARNING
,
9074 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9079 static void lockThreadedIO(void) {
9080 pthread_mutex_lock(&server
.io_mutex
);
9083 static void unlockThreadedIO(void) {
9084 pthread_mutex_unlock(&server
.io_mutex
);
9087 /* Remove the specified object from the threaded I/O queue if still not
9088 * processed, otherwise make sure to flag it as canceled. */
9089 static void vmCancelThreadedIOJob(robj
*o
) {
9091 server
.io_newjobs
, /* 0 */
9092 server
.io_processing
, /* 1 */
9093 server
.io_processed
/* 2 */
9097 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9100 /* Search for a matching key in one of the queues */
9101 for (i
= 0; i
< 3; i
++) {
9105 listRewind(lists
[i
],&li
);
9106 while ((ln
= listNext(&li
)) != NULL
) {
9107 iojob
*job
= ln
->value
;
9109 if (job
->canceled
) continue; /* Skip this, already canceled. */
9110 if (job
->key
== o
) {
9111 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9112 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9113 /* Mark the pages as free since the swap didn't happened
9114 * or happened but is now discarded. */
9115 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9116 vmMarkPagesFree(job
->page
,job
->pages
);
9117 /* Cancel the job. It depends on the list the job is
9120 case 0: /* io_newjobs */
9121 /* If the job was yet not processed the best thing to do
9122 * is to remove it from the queue at all */
9124 listDelNode(lists
[i
],ln
);
9126 case 1: /* io_processing */
9127 /* Oh Shi- the thread is messing with the Job:
9129 * Probably it's accessing the object if this is a
9130 * PREPARE_SWAP or DO_SWAP job.
9131 * If it's a LOAD job it may be reading from disk and
9132 * if we don't wait for the job to terminate before to
9133 * cancel it, maybe in a few microseconds data can be
9134 * corrupted in this pages. So the short story is:
9136 * Better to wait for the job to move into the
9137 * next queue (processed)... */
9139 /* We try again and again until the job is completed. */
9141 /* But let's wait some time for the I/O thread
9142 * to finish with this job. After all this condition
9143 * should be very rare. */
9146 case 2: /* io_processed */
9147 /* The job was already processed, that's easy...
9148 * just mark it as canceled so that we'll ignore it
9149 * when processing completed jobs. */
9153 /* Finally we have to adjust the storage type of the object
9154 * in order to "UNDO" the operaiton. */
9155 if (o
->storage
== REDIS_VM_LOADING
)
9156 o
->storage
= REDIS_VM_SWAPPED
;
9157 else if (o
->storage
== REDIS_VM_SWAPPING
)
9158 o
->storage
= REDIS_VM_MEMORY
;
9165 assert(1 != 1); /* We should never reach this */
9168 static void *IOThreadEntryPoint(void *arg
) {
9173 pthread_detach(pthread_self());
9175 /* Get a new job to process */
9177 if (listLength(server
.io_newjobs
) == 0) {
9178 /* No new jobs in queue, exit. */
9179 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9180 (long) pthread_self());
9181 server
.io_active_threads
--;
9185 ln
= listFirst(server
.io_newjobs
);
9187 listDelNode(server
.io_newjobs
,ln
);
9188 /* Add the job in the processing queue */
9189 j
->thread
= pthread_self();
9190 listAddNodeTail(server
.io_processing
,j
);
9191 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9193 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9194 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9196 /* Process the Job */
9197 if (j
->type
== REDIS_IOJOB_LOAD
) {
9198 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9199 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9200 FILE *fp
= fopen("/dev/null","w+");
9201 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9203 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9204 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9208 /* Done: insert the job into the processed queue */
9209 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9210 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9212 listDelNode(server
.io_processing
,ln
);
9213 listAddNodeTail(server
.io_processed
,j
);
9216 /* Signal the main thread there is new stuff to process */
9217 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9219 return NULL
; /* never reached */
9222 static void spawnIOThread(void) {
9224 sigset_t mask
, omask
;
9228 sigaddset(&mask
,SIGCHLD
);
9229 sigaddset(&mask
,SIGHUP
);
9230 sigaddset(&mask
,SIGPIPE
);
9231 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9232 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9233 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9237 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9238 server
.io_active_threads
++;
9241 /* We need to wait for the last thread to exit before we are able to
9242 * fork() in order to BGSAVE or BGREWRITEAOF. */
9243 static void waitEmptyIOJobsQueue(void) {
9245 int io_processed_len
;
9248 if (listLength(server
.io_newjobs
) == 0 &&
9249 listLength(server
.io_processing
) == 0 &&
9250 server
.io_active_threads
== 0)
9255 /* While waiting for empty jobs queue condition we post-process some
9256 * finshed job, as I/O threads may be hanging trying to write against
9257 * the io_ready_pipe_write FD but there are so much pending jobs that
9259 io_processed_len
= listLength(server
.io_processed
);
9261 if (io_processed_len
) {
9262 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9263 usleep(1000); /* 1 millisecond */
9265 usleep(10000); /* 10 milliseconds */
9270 static void vmReopenSwapFile(void) {
9271 /* Note: we don't close the old one as we are in the child process
9272 * and don't want to mess at all with the original file object. */
9273 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9274 if (server
.vm_fp
== NULL
) {
9275 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9276 server
.vm_swap_file
);
9279 server
.vm_fd
= fileno(server
.vm_fp
);
9282 /* This function must be called while with threaded IO locked */
9283 static void queueIOJob(iojob
*j
) {
9284 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9285 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9286 listAddNodeTail(server
.io_newjobs
,j
);
9287 if (server
.io_active_threads
< server
.vm_max_threads
)
9291 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9294 assert(key
->storage
== REDIS_VM_MEMORY
);
9295 assert(key
->refcount
== 1);
9297 j
= zmalloc(sizeof(*j
));
9298 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9304 j
->thread
= (pthread_t
) -1;
9305 key
->storage
= REDIS_VM_SWAPPING
;
9313 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9315 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9316 * If there is not already a job loading the key, it is craeted.
9317 * The key is added to the io_keys list in the client structure, and also
9318 * in the hash table mapping swapped keys to waiting clients, that is,
9319 * server.io_waited_keys. */
9320 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9321 struct dictEntry
*de
;
9325 /* If the key does not exist or is already in RAM we don't need to
9326 * block the client at all. */
9327 de
= dictFind(c
->db
->dict
,key
);
9328 if (de
== NULL
) return 0;
9329 o
= dictGetEntryKey(de
);
9330 if (o
->storage
== REDIS_VM_MEMORY
) {
9332 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9333 /* We were swapping the key, undo it! */
9334 vmCancelThreadedIOJob(o
);
9338 /* OK: the key is either swapped, or being loaded just now. */
9340 /* Add the key to the list of keys this client is waiting for.
9341 * This maps clients to keys they are waiting for. */
9342 listAddNodeTail(c
->io_keys
,key
);
9345 /* Add the client to the swapped keys => clients waiting map. */
9346 de
= dictFind(c
->db
->io_keys
,key
);
9350 /* For every key we take a list of clients blocked for it */
9352 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9354 assert(retval
== DICT_OK
);
9356 l
= dictGetEntryVal(de
);
9358 listAddNodeTail(l
,c
);
9360 /* Are we already loading the key from disk? If not create a job */
9361 if (o
->storage
== REDIS_VM_SWAPPED
) {
9364 o
->storage
= REDIS_VM_LOADING
;
9365 j
= zmalloc(sizeof(*j
));
9366 j
->type
= REDIS_IOJOB_LOAD
;
9369 j
->key
->vtype
= o
->vtype
;
9370 j
->page
= o
->vm
.page
;
9373 j
->thread
= (pthread_t
) -1;
9381 /* Preload keys needed for the ZUNION and ZINTER commands. */
9382 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9384 num
= atoi(c
->argv
[2]->ptr
);
9385 for (i
= 0; i
< num
; i
++) {
9386 waitForSwappedKey(c
,c
->argv
[3+i
]);
9390 /* Is this client attempting to run a command against swapped keys?
9391 * If so, block it ASAP, load the keys in background, then resume it.
9393 * The important idea about this function is that it can fail! If keys will
9394 * still be swapped when the client is resumed, this key lookups will
9395 * just block loading keys from disk. In practical terms this should only
9396 * happen with SORT BY command or if there is a bug in this function.
9398 * Return 1 if the client is marked as blocked, 0 if the client can
9399 * continue as the keys it is going to access appear to be in memory. */
9400 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9403 if (cmd
->vm_preload_proc
!= NULL
) {
9404 cmd
->vm_preload_proc(c
);
9406 if (cmd
->vm_firstkey
== 0) return 0;
9407 last
= cmd
->vm_lastkey
;
9408 if (last
< 0) last
= c
->argc
+last
;
9409 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9410 waitForSwappedKey(c
,c
->argv
[j
]);
9413 /* If the client was blocked for at least one key, mark it as blocked. */
9414 if (listLength(c
->io_keys
)) {
9415 c
->flags
|= REDIS_IO_WAIT
;
9416 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9417 server
.vm_blocked_clients
++;
9424 /* Remove the 'key' from the list of blocked keys for a given client.
9426 * The function returns 1 when there are no longer blocking keys after
9427 * the current one was removed (and the client can be unblocked). */
9428 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9432 struct dictEntry
*de
;
9434 /* Remove the key from the list of keys this client is waiting for. */
9435 listRewind(c
->io_keys
,&li
);
9436 while ((ln
= listNext(&li
)) != NULL
) {
9437 if (compareStringObjects(ln
->value
,key
) == 0) {
9438 listDelNode(c
->io_keys
,ln
);
9444 /* Remove the client form the key => waiting clients map. */
9445 de
= dictFind(c
->db
->io_keys
,key
);
9447 l
= dictGetEntryVal(de
);
9448 ln
= listSearchKey(l
,c
);
9451 if (listLength(l
) == 0)
9452 dictDelete(c
->db
->io_keys
,key
);
9454 return listLength(c
->io_keys
) == 0;
9457 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9458 struct dictEntry
*de
;
9463 de
= dictFind(db
->io_keys
,key
);
9466 l
= dictGetEntryVal(de
);
9467 len
= listLength(l
);
9468 /* Note: we can't use something like while(listLength(l)) as the list
9469 * can be freed by the calling function when we remove the last element. */
9472 redisClient
*c
= ln
->value
;
9474 if (dontWaitForSwappedKey(c
,key
)) {
9475 /* Put the client in the list of clients ready to go as we
9476 * loaded all the keys about it. */
9477 listAddNodeTail(server
.io_ready_clients
,c
);
9482 /* =========================== Remote Configuration ========================= */
9484 static void configSetCommand(redisClient
*c
) {
9485 robj
*o
= getDecodedObject(c
->argv
[3]);
9486 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9487 zfree(server
.dbfilename
);
9488 server
.dbfilename
= zstrdup(o
->ptr
);
9489 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9490 zfree(server
.requirepass
);
9491 server
.requirepass
= zstrdup(o
->ptr
);
9492 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9493 zfree(server
.masterauth
);
9494 server
.masterauth
= zstrdup(o
->ptr
);
9495 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9496 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9498 addReplySds(c
,sdscatprintf(sdsempty(),
9499 "-ERR not supported CONFIG parameter %s\r\n",
9500 (char*)c
->argv
[2]->ptr
));
9505 addReply(c
,shared
.ok
);
9508 static void configGetCommand(redisClient
*c
) {
9509 robj
*o
= getDecodedObject(c
->argv
[2]);
9510 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9511 char *pattern
= o
->ptr
;
9515 decrRefCount(lenobj
);
9517 if (stringmatch(pattern
,"dbfilename",0)) {
9518 addReplyBulkCString(c
,"dbfilename");
9519 addReplyBulkCString(c
,server
.dbfilename
);
9522 if (stringmatch(pattern
,"requirepass",0)) {
9523 addReplyBulkCString(c
,"requirepass");
9524 addReplyBulkCString(c
,server
.requirepass
);
9527 if (stringmatch(pattern
,"masterauth",0)) {
9528 addReplyBulkCString(c
,"masterauth");
9529 addReplyBulkCString(c
,server
.masterauth
);
9532 if (stringmatch(pattern
,"maxmemory",0)) {
9535 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9536 addReplyBulkCString(c
,"maxmemory");
9537 addReplyBulkCString(c
,buf
);
9541 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9544 static void configCommand(redisClient
*c
) {
9545 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9546 if (c
->argc
!= 4) goto badarity
;
9547 configSetCommand(c
);
9548 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9549 if (c
->argc
!= 3) goto badarity
;
9550 configGetCommand(c
);
9551 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9552 if (c
->argc
!= 2) goto badarity
;
9553 server
.stat_numcommands
= 0;
9554 server
.stat_numconnections
= 0;
9555 server
.stat_expiredkeys
= 0;
9556 server
.stat_starttime
= time(NULL
);
9557 addReply(c
,shared
.ok
);
9559 addReplySds(c
,sdscatprintf(sdsempty(),
9560 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9565 addReplySds(c
,sdscatprintf(sdsempty(),
9566 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9567 (char*) c
->argv
[1]->ptr
));
9570 /* =========================== Pubsub implementation ======================== */
9572 static void freePubsubPattern(void *p
) {
9573 pubsubPattern
*pat
= p
;
9575 decrRefCount(pat
->pattern
);
9579 static int listMatchPubsubPattern(void *a
, void *b
) {
9580 pubsubPattern
*pa
= a
, *pb
= b
;
9582 return (pa
->client
== pb
->client
) &&
9583 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9586 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9587 * 0 if the client was already subscribed to that channel. */
9588 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9589 struct dictEntry
*de
;
9590 list
*clients
= NULL
;
9593 /* Add the channel to the client -> channels hash table */
9594 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9596 incrRefCount(channel
);
9597 /* Add the client to the channel -> list of clients hash table */
9598 de
= dictFind(server
.pubsub_channels
,channel
);
9600 clients
= listCreate();
9601 dictAdd(server
.pubsub_channels
,channel
,clients
);
9602 incrRefCount(channel
);
9604 clients
= dictGetEntryVal(de
);
9606 listAddNodeTail(clients
,c
);
9608 /* Notify the client */
9609 addReply(c
,shared
.mbulk3
);
9610 addReply(c
,shared
.subscribebulk
);
9611 addReplyBulk(c
,channel
);
9612 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9616 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9617 * 0 if the client was not subscribed to the specified channel. */
9618 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9619 struct dictEntry
*de
;
9624 /* Remove the channel from the client -> channels hash table */
9625 incrRefCount(channel
); /* channel may be just a pointer to the same object
9626 we have in the hash tables. Protect it... */
9627 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9629 /* Remove the client from the channel -> clients list hash table */
9630 de
= dictFind(server
.pubsub_channels
,channel
);
9632 clients
= dictGetEntryVal(de
);
9633 ln
= listSearchKey(clients
,c
);
9635 listDelNode(clients
,ln
);
9636 if (listLength(clients
) == 0) {
9637 /* Free the list and associated hash entry at all if this was
9638 * the latest client, so that it will be possible to abuse
9639 * Redis PUBSUB creating millions of channels. */
9640 dictDelete(server
.pubsub_channels
,channel
);
9643 /* Notify the client */
9645 addReply(c
,shared
.mbulk3
);
9646 addReply(c
,shared
.unsubscribebulk
);
9647 addReplyBulk(c
,channel
);
9648 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9649 listLength(c
->pubsub_patterns
));
9652 decrRefCount(channel
); /* it is finally safe to release it */
9656 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9657 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9660 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9663 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9664 incrRefCount(pattern
);
9665 pat
= zmalloc(sizeof(*pat
));
9666 pat
->pattern
= getDecodedObject(pattern
);
9668 listAddNodeTail(server
.pubsub_patterns
,pat
);
9670 /* Notify the client */
9671 addReply(c
,shared
.mbulk3
);
9672 addReply(c
,shared
.psubscribebulk
);
9673 addReplyBulk(c
,pattern
);
9674 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9678 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9679 * 0 if the client was not subscribed to the specified channel. */
9680 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9685 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9686 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9688 listDelNode(c
->pubsub_patterns
,ln
);
9690 pat
.pattern
= pattern
;
9691 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9692 listDelNode(server
.pubsub_patterns
,ln
);
9694 /* Notify the client */
9696 addReply(c
,shared
.mbulk3
);
9697 addReply(c
,shared
.punsubscribebulk
);
9698 addReplyBulk(c
,pattern
);
9699 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9700 listLength(c
->pubsub_patterns
));
9702 decrRefCount(pattern
);
9706 /* Unsubscribe from all the channels. Return the number of channels the
9707 * client was subscribed from. */
9708 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9709 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9713 while((de
= dictNext(di
)) != NULL
) {
9714 robj
*channel
= dictGetEntryKey(de
);
9716 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9718 dictReleaseIterator(di
);
9722 /* Unsubscribe from all the patterns. Return the number of patterns the
9723 * client was subscribed from. */
9724 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9729 listRewind(c
->pubsub_patterns
,&li
);
9730 while ((ln
= listNext(&li
)) != NULL
) {
9731 robj
*pattern
= ln
->value
;
9733 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9738 /* Publish a message */
9739 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9741 struct dictEntry
*de
;
9745 /* Send to clients listening for that channel */
9746 de
= dictFind(server
.pubsub_channels
,channel
);
9748 list
*list
= dictGetEntryVal(de
);
9752 listRewind(list
,&li
);
9753 while ((ln
= listNext(&li
)) != NULL
) {
9754 redisClient
*c
= ln
->value
;
9756 addReply(c
,shared
.mbulk3
);
9757 addReply(c
,shared
.messagebulk
);
9758 addReplyBulk(c
,channel
);
9759 addReplyBulk(c
,message
);
9763 /* Send to clients listening to matching channels */
9764 if (listLength(server
.pubsub_patterns
)) {
9765 listRewind(server
.pubsub_patterns
,&li
);
9766 channel
= getDecodedObject(channel
);
9767 while ((ln
= listNext(&li
)) != NULL
) {
9768 pubsubPattern
*pat
= ln
->value
;
9770 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9771 sdslen(pat
->pattern
->ptr
),
9772 (char*)channel
->ptr
,
9773 sdslen(channel
->ptr
),0)) {
9774 addReply(pat
->client
,shared
.mbulk3
);
9775 addReply(pat
->client
,shared
.messagebulk
);
9776 addReplyBulk(pat
->client
,channel
);
9777 addReplyBulk(pat
->client
,message
);
9781 decrRefCount(channel
);
9786 static void subscribeCommand(redisClient
*c
) {
9789 for (j
= 1; j
< c
->argc
; j
++)
9790 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9793 static void unsubscribeCommand(redisClient
*c
) {
9795 pubsubUnsubscribeAllChannels(c
,1);
9800 for (j
= 1; j
< c
->argc
; j
++)
9801 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9805 static void psubscribeCommand(redisClient
*c
) {
9808 for (j
= 1; j
< c
->argc
; j
++)
9809 pubsubSubscribePattern(c
,c
->argv
[j
]);
9812 static void punsubscribeCommand(redisClient
*c
) {
9814 pubsubUnsubscribeAllPatterns(c
,1);
9819 for (j
= 1; j
< c
->argc
; j
++)
9820 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9824 static void publishCommand(redisClient
*c
) {
9825 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9826 addReplyLong(c
,receivers
);
9829 /* ================================= Debugging ============================== */
9831 static void debugCommand(redisClient
*c
) {
9832 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9834 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9835 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9836 addReply(c
,shared
.err
);
9840 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9841 addReply(c
,shared
.err
);
9844 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9845 addReply(c
,shared
.ok
);
9846 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9848 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9849 addReply(c
,shared
.err
);
9852 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9853 addReply(c
,shared
.ok
);
9854 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9855 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9859 addReply(c
,shared
.nokeyerr
);
9862 key
= dictGetEntryKey(de
);
9863 val
= dictGetEntryVal(de
);
9864 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9865 key
->storage
== REDIS_VM_SWAPPING
)) {
9869 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9870 strenc
= strencoding
[val
->encoding
];
9872 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9875 addReplySds(c
,sdscatprintf(sdsempty(),
9876 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9877 "encoding:%s serializedlength:%lld\r\n",
9878 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9879 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9881 addReplySds(c
,sdscatprintf(sdsempty(),
9882 "+Key at:%p refcount:%d, value swapped at: page %llu "
9883 "using %llu pages\r\n",
9884 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9885 (unsigned long long) key
->vm
.usedpages
));
9887 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9888 lookupKeyRead(c
->db
,c
->argv
[2]);
9889 addReply(c
,shared
.ok
);
9890 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9891 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9894 if (!server
.vm_enabled
) {
9895 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9899 addReply(c
,shared
.nokeyerr
);
9902 key
= dictGetEntryKey(de
);
9903 val
= dictGetEntryVal(de
);
9904 /* If the key is shared we want to create a copy */
9905 if (key
->refcount
> 1) {
9906 robj
*newkey
= dupStringObject(key
);
9908 key
= dictGetEntryKey(de
) = newkey
;
9911 if (key
->storage
!= REDIS_VM_MEMORY
) {
9912 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9913 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9914 dictGetEntryVal(de
) = NULL
;
9915 addReply(c
,shared
.ok
);
9917 addReply(c
,shared
.err
);
9920 addReplySds(c
,sdsnew(
9921 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9925 static void _redisAssert(char *estr
, char *file
, int line
) {
9926 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9927 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9928 #ifdef HAVE_BACKTRACE
9929 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9934 static void _redisPanic(char *msg
, char *file
, int line
) {
9935 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
9936 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
9937 #ifdef HAVE_BACKTRACE
9938 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9943 /* =================================== Main! ================================ */
9946 int linuxOvercommitMemoryValue(void) {
9947 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9951 if (fgets(buf
,64,fp
) == NULL
) {
9960 void linuxOvercommitMemoryWarning(void) {
9961 if (linuxOvercommitMemoryValue() == 0) {
9962 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.");
9965 #endif /* __linux__ */
9967 static void daemonize(void) {
9971 if (fork() != 0) exit(0); /* parent exits */
9972 setsid(); /* create a new session */
9974 /* Every output goes to /dev/null. If Redis is daemonized but
9975 * the 'logfile' is set to 'stdout' in the configuration file
9976 * it will not log at all. */
9977 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9978 dup2(fd
, STDIN_FILENO
);
9979 dup2(fd
, STDOUT_FILENO
);
9980 dup2(fd
, STDERR_FILENO
);
9981 if (fd
> STDERR_FILENO
) close(fd
);
9983 /* Try to write the pid file */
9984 fp
= fopen(server
.pidfile
,"w");
9986 fprintf(fp
,"%d\n",getpid());
9991 static void version() {
9992 printf("Redis server version %s\n", REDIS_VERSION
);
9996 static void usage() {
9997 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9998 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10002 int main(int argc
, char **argv
) {
10005 initServerConfig();
10007 if (strcmp(argv
[1], "-v") == 0 ||
10008 strcmp(argv
[1], "--version") == 0) version();
10009 if (strcmp(argv
[1], "--help") == 0) usage();
10010 resetServerSaveParams();
10011 loadServerConfig(argv
[1]);
10012 } else if ((argc
> 2)) {
10015 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'");
10017 if (server
.daemonize
) daemonize();
10019 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10021 linuxOvercommitMemoryWarning();
10023 start
= time(NULL
);
10024 if (server
.appendonly
) {
10025 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10026 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10028 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10029 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10031 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10032 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10034 aeDeleteEventLoop(server
.el
);
10038 /* ============================= Backtrace support ========================= */
10040 #ifdef HAVE_BACKTRACE
10041 static char *findFuncName(void *pointer
, unsigned long *offset
);
10043 static void *getMcontextEip(ucontext_t
*uc
) {
10044 #if defined(__FreeBSD__)
10045 return (void*) uc
->uc_mcontext
.mc_eip
;
10046 #elif defined(__dietlibc__)
10047 return (void*) uc
->uc_mcontext
.eip
;
10048 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10050 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10052 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10054 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10055 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10056 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10058 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10060 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10061 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10062 #elif defined(__ia64__) /* Linux IA64 */
10063 return (void*) uc
->uc_mcontext
.sc_ip
;
10069 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10071 char **messages
= NULL
;
10072 int i
, trace_size
= 0;
10073 unsigned long offset
=0;
10074 ucontext_t
*uc
= (ucontext_t
*) secret
;
10076 REDIS_NOTUSED(info
);
10078 redisLog(REDIS_WARNING
,
10079 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10080 infostring
= genRedisInfoString();
10081 redisLog(REDIS_WARNING
, "%s",infostring
);
10082 /* It's not safe to sdsfree() the returned string under memory
10083 * corruption conditions. Let it leak as we are going to abort */
10085 trace_size
= backtrace(trace
, 100);
10086 /* overwrite sigaction with caller's address */
10087 if (getMcontextEip(uc
) != NULL
) {
10088 trace
[1] = getMcontextEip(uc
);
10090 messages
= backtrace_symbols(trace
, trace_size
);
10092 for (i
=1; i
<trace_size
; ++i
) {
10093 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10095 p
= strchr(messages
[i
],'+');
10096 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10097 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10099 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10102 /* free(messages); Don't call free() with possibly corrupted memory. */
10106 static void setupSigSegvAction(void) {
10107 struct sigaction act
;
10109 sigemptyset (&act
.sa_mask
);
10110 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10111 * is used. Otherwise, sa_handler is used */
10112 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10113 act
.sa_sigaction
= segvHandler
;
10114 sigaction (SIGSEGV
, &act
, NULL
);
10115 sigaction (SIGBUS
, &act
, NULL
);
10116 sigaction (SIGFPE
, &act
, NULL
);
10117 sigaction (SIGILL
, &act
, NULL
);
10118 sigaction (SIGBUS
, &act
, NULL
);
10122 #include "staticsymbols.h"
10123 /* This function try to convert a pointer into a function name. It's used in
10124 * oreder to provide a backtrace under segmentation fault that's able to
10125 * display functions declared as static (otherwise the backtrace is useless). */
10126 static char *findFuncName(void *pointer
, unsigned long *offset
){
10128 unsigned long off
, minoff
= 0;
10130 /* Try to match against the Symbol with the smallest offset */
10131 for (i
=0; symsTable
[i
].pointer
; i
++) {
10132 unsigned long lp
= (unsigned long) pointer
;
10134 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10135 off
=lp
-symsTable
[i
].pointer
;
10136 if (ret
< 0 || off
< minoff
) {
10142 if (ret
== -1) return NULL
;
10144 return symsTable
[ret
].name
;
10146 #else /* HAVE_BACKTRACE */
10147 static void setupSigSegvAction(void) {
10149 #endif /* HAVE_BACKTRACE */